difftreelog
chore implement transfer and burn for ERC-721
in: master
9 files changed
Makefilediffbeforeafterboth--- a/Makefile
+++ b/Makefile
@@ -41,10 +41,6 @@
UniqueRefungible.sol:
PACKAGE=pallet-refungible NAME=erc::gen_iface OUTPUT=$(TESTS_API)/$@ ./.maintain/scripts/generate_sol.sh
PACKAGE=pallet-refungible NAME=erc::gen_impl OUTPUT=$(REFUNGIBLE_EVM_STUBS)/$@ ./.maintain/scripts/generate_sol.sh
-
-UniqueRefungible.sol:
- PACKAGE=pallet-refungible NAME=erc::gen_iface OUTPUT=$(TESTS_API)/$@ ./.maintain/scripts/generate_sol.sh
- PACKAGE=pallet-refungible NAME=erc::gen_impl OUTPUT=$(REFUNGIBLE_EVM_STUBS)/$@ ./.maintain/scripts/generate_sol.sh
UniqueRefungibleToken.sol:
PACKAGE=pallet-refungible NAME=erc_token::gen_iface OUTPUT=$(TESTS_API)/$@ ./.maintain/scripts/generate_sol.sh
@@ -73,10 +69,6 @@
UniqueRefungibleToken: UniqueRefungibleToken.sol
INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_EVM_STUBS)/UniqueRefungibleToken.raw ./.maintain/scripts/compile_stub.sh
INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_TOKEN_EVM_ABI) ./.maintain/scripts/generate_abi.sh
-
-UniqueRefungible: UniqueRefungible.sol
- INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_EVM_STUBS)/UniqueRefungible.raw ./.maintain/scripts/compile_stub.sh
- INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_EVM_ABI) ./.maintain/scripts/generate_abi.sh
ContractHelpers: ContractHelpers.sol
INPUT=$(CONTRACT_HELPERS_STUBS)/$< OUTPUT=$(CONTRACT_HELPERS_STUBS)/ContractHelpers.raw ./.maintain/scripts/compile_stub.sh
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -34,8 +34,9 @@
CommonEvmHandler, CollectionCall,
static_property::{key, value as property_value},
},
+ eth::collection_id_to_address,
};
-use pallet_evm::{account::CrossAccountId, PrecompileHandle};
+use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm, PrecompileHandle};
use pallet_evm_coder_substrate::{call, dispatch_to_evm};
use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};
use sp_core::H160;
@@ -46,8 +47,8 @@
};
use crate::{
- AccountBalance, Config, CreateItemData, Pallet, RefungibleHandle, SelfWeightOf,
- TokenProperties, TokensMinted, weights::WeightInfo,
+ AccountBalance, Balance, Config, CreateItemData, Pallet, RefungibleHandle, SelfWeightOf,
+ TokenProperties, TokensMinted, TotalSupply, weights::WeightInfo,
};
/// @title A contract that allows to set and delete token properties and change token property permissions.
@@ -331,16 +332,49 @@
Err("not implemented".into())
}
- /// @dev Not implemented
+ /// @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE
+ /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
+ /// THEY MAY BE PERMANENTLY LOST
+ /// @dev Throws unless `msg.sender` is the current owner or an authorized
+ /// operator for this RFT. Throws if `from` is not the current owner. Throws
+ /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.
+ /// Throws if RFT pieces have multiple owners.
+ /// @param from The current owner of the NFT
+ /// @param to The new owner
+ /// @param tokenId The NFT to transfer
+ /// @param _value Not used for an NFT
+ #[weight(<SelfWeightOf<T>>::transfer_from_creating_removing())]
fn transfer_from(
&mut self,
- _caller: caller,
- _from: address,
- _to: address,
- _token_id: uint256,
+ caller: caller,
+ from: address,
+ to: address,
+ token_id: uint256,
_value: value,
) -> Result<void> {
- Err("not implemented".into())
+ let caller = T::CrossAccountId::from_eth(caller);
+ let from = T::CrossAccountId::from_eth(from);
+ let to = T::CrossAccountId::from_eth(to);
+ let token = token_id.try_into()?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ let balance = balance(&self, token, &from)?;
+ ensure_single_owner(&self, token, balance)?;
+
+ <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, balance, &budget)
+ .map_err(dispatch_to_evm::<T>)?;
+
+ <PalletEvm<T>>::deposit_log(
+ ERC721Events::Transfer {
+ from: *from.as_eth(),
+ to: *to.as_eth(),
+ token_id: token_id.into(),
+ }
+ .to_log(collection_id_to_address(self.id)),
+ );
+ Ok(())
}
/// @dev Not implemented
@@ -378,12 +412,48 @@
}
}
+/// Returns amount of pieces of `token` that `owner` have
+fn balance<T: Config>(
+ collection: &RefungibleHandle<T>,
+ token: TokenId,
+ owner: &T::CrossAccountId,
+) -> Result<u128> {
+ collection.consume_store_reads(1)?;
+ let balance = <Balance<T>>::get((collection.id, token, &owner));
+ Ok(balance)
+}
+
+/// Throws if `owner_balance` is lower than total amount of `token` pieces
+fn ensure_single_owner<T: Config>(
+ collection: &RefungibleHandle<T>,
+ token: TokenId,
+ owner_balance: u128,
+) -> Result<()> {
+ collection.consume_store_reads(1)?;
+ let total_supply = <TotalSupply<T>>::get((collection.id, token));
+ if total_supply != owner_balance {
+ return Err("token has multiple owners".into());
+ }
+ Ok(())
+}
+
/// @title ERC721 Token that can be irreversibly burned (destroyed).
#[solidity_interface(name = "ERC721Burnable")]
impl<T: Config> RefungibleHandle<T> {
- /// @dev Not implemented
- fn burn(&mut self, _caller: caller, _token_id: uint256, _value: value) -> Result<void> {
- Err("not implemented".into())
+ /// @notice Burns a specific ERC721 token.
+ /// @dev Throws unless `msg.sender` is the current RFT owner, or an authorized
+ /// operator of the current owner.
+ /// @param tokenId The RFT to approve
+ #[weight(<SelfWeightOf<T>>::burn_item_fully())]
+ fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ let token = token_id.try_into()?;
+
+ let balance = balance(&self, token, &caller)?;
+ ensure_single_owner(&self, token, balance)?;
+
+ <Pallet<T>>::burn(self, &caller, token, balance).map_err(dispatch_to_evm::<T>)?;
+ Ok(())
}
}
@@ -555,6 +625,75 @@
/// @title Unique extensions for ERC721.
#[solidity_interface(name = "ERC721UniqueExtensions")]
impl<T: Config> RefungibleHandle<T> {
+ /// @notice Transfer ownership of an RFT
+ /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
+ /// is the zero address. Throws if `tokenId` is not a valid RFT.
+ /// Throws if RFT pieces have multiple owners.
+ /// @param to The new owner
+ /// @param tokenId The RFT to transfer
+ /// @param _value Not used for an RFT
+ #[weight(<SelfWeightOf<T>>::transfer_creating_removing())]
+ fn transfer(
+ &mut self,
+ caller: caller,
+ to: address,
+ token_id: uint256,
+ _value: value,
+ ) -> Result<void> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ let to = T::CrossAccountId::from_eth(to);
+ let token = token_id.try_into()?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ let balance = balance(&self, token, &caller)?;
+ ensure_single_owner(&self, token, balance)?;
+
+ <Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)
+ .map_err(dispatch_to_evm::<T>)?;
+ <PalletEvm<T>>::deposit_log(
+ ERC721Events::Transfer {
+ from: *caller.as_eth(),
+ to: *to.as_eth(),
+ token_id: token_id.into(),
+ }
+ .to_log(collection_id_to_address(self.id)),
+ );
+ Ok(())
+ }
+
+ /// @notice Burns a specific ERC721 token.
+ /// @dev Throws unless `msg.sender` is the current owner or an authorized
+ /// operator for this RFT. Throws if `from` is not the current owner. Throws
+ /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.
+ /// Throws if RFT pieces have multiple owners.
+ /// @param from The current owner of the RFT
+ /// @param tokenId The RFT to transfer
+ /// @param _value Not used for an RFT
+ #[weight(<SelfWeightOf<T>>::burn_from())]
+ fn burn_from(
+ &mut self,
+ caller: caller,
+ from: address,
+ token_id: uint256,
+ _value: value,
+ ) -> Result<void> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ let from = T::CrossAccountId::from_eth(from);
+ let token = token_id.try_into()?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ let balance = balance(&self, token, &caller)?;
+ ensure_single_owner(&self, token, balance)?;
+
+ <Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)
+ .map_err(dispatch_to_evm::<T>)?;
+ Ok(())
+ }
+
/// @notice Returns next free RFT ID.
fn next_token_id(&self) -> Result<uint256> {
self.consume_store_reads(1)?;
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -454,6 +454,14 @@
<PalletStructure<T>>::unnest_if_nested(owner, collection.id, token);
<AccountBalance<T>>::insert((collection.id, owner), account_balance);
Self::burn_token_unchecked(collection, token)?;
+ <PalletEvm<T>>::deposit_log(
+ ERC721Events::Transfer {
+ from: *owner.as_eth(),
+ to: H160::default(),
+ token_id: token.into(),
+ }
+ .to_log(collection_id_to_address(collection.id)),
+ );
<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(
collection.id,
token,
pallets/refungible/src/stubs/UniqueRefungible.rawdiffbeforeafterbothbinary blob — no preview
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth51 event MintingFinished();51 event MintingFinished();52}52}5354// Selector: 0784ee6455contract ERC721UniqueExtensions is Dummy, ERC165 {56 // @notice Returns next free RFT ID.57 //58 // Selector: nextTokenId() 75794a3c59 function nextTokenId() public view returns (uint256) {60 require(false, stub_error);61 dummy;62 return 0;63 }6465 // Selector: mintBulk(address,uint256[]) 44a9945e66 function mintBulk(address to, uint256[] memory tokenIds)67 public68 returns (bool)69 {70 require(false, stub_error);71 to;72 tokenIds;73 dummy = 0;74 return false;75 }7677 // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 3654300678 function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)79 public80 returns (bool)81 {82 require(false, stub_error);83 to;84 tokens;85 dummy = 0;86 return false;87 }88}895390// Selector: 4136937754// Selector: 4136937791contract TokenProperties is Dummy, ERC165 {55contract TokenProperties is Dummy, ERC165 {56 // @notice Set permissions for token property.57 // @dev Throws error if `msg.sender` is not admin or owner of the collection.58 // @param key Property key.59 // @param is_mutable Permission to mutate property.60 // @param collection_admin Permission to mutate property by collection admin if property is mutable.61 // @param token_owner Permission to mutate property by token owner if property is mutable.62 //92 // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa63 // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa93 function setTokenPropertyPermission(64 function setTokenPropertyPermission(94 string memory key,65 string memory key,104 dummy = 0;75 dummy = 0;105 }76 }1067778 // @notice Set token property value.79 // @dev Throws error if `msg.sender` has no permission to edit the property.80 // @param tokenId ID of the token.81 // @param key Property key.82 // @param value Property value.83 //107 // Selector: setProperty(uint256,string,bytes) 1752d67b84 // Selector: setProperty(uint256,string,bytes) 1752d67b108 function setProperty(85 function setProperty(109 uint256 tokenId,86 uint256 tokenId,117 dummy = 0;94 dummy = 0;118 }95 }1199697 // @notice Delete token property value.98 // @dev Throws error if `msg.sender` has no permission to edit the property.99 // @param tokenId ID of the token.100 // @param key Property key.101 //120 // Selector: deleteProperty(uint256,string) 066111d1102 // Selector: deleteProperty(uint256,string) 066111d1121 function deleteProperty(uint256 tokenId, string memory key) public {103 function deleteProperty(uint256 tokenId, string memory key) public {122 require(false, stub_error);104 require(false, stub_error);125 dummy = 0;107 dummy = 0;126 }108 }127109110 // @notice Get token property value.128 // Throws error if key not found111 // @dev Throws error if key not found112 // @param tokenId ID of the token.113 // @param key Property key.114 // @return Property value bytes129 //115 //130 // Selector: property(uint256,string) 7228c327116 // Selector: property(uint256,string) 7228c327131 function property(uint256 tokenId, string memory key)117 function property(uint256 tokenId, string memory key)143129144// Selector: 42966c68130// Selector: 42966c68145contract ERC721Burnable is Dummy, ERC165 {131contract ERC721Burnable is Dummy, ERC165 {146 // @dev Not implemented132 // @notice Burns a specific ERC721 token.133 // @dev Throws unless `msg.sender` is the current RFT owner, or an authorized134 // operator of the current owner.135 // @param tokenId The RFT to approve147 //136 //148 // Selector: burn(uint256) 42966c68137 // Selector: burn(uint256) 42966c68149 function burn(uint256 tokenId) public {138 function burn(uint256 tokenId) public {155144156// Selector: 58800161145// Selector: 58800161157contract ERC721 is Dummy, ERC165, ERC721Events {146contract ERC721 is Dummy, ERC165, ERC721Events {147 // @notice Count all RFTs assigned to an owner148 // @dev RFTs assigned to the zero address are considered invalid, and this149 // function throws for queries about the zero address.150 // @param owner An address for whom to query the balance151 // @return The number of RFTs owned by `owner`, possibly zero152 //158 // Selector: balanceOf(address) 70a08231153 // Selector: balanceOf(address) 70a08231159 function balanceOf(address owner) public view returns (uint256) {154 function balanceOf(address owner) public view returns (uint256) {160 require(false, stub_error);155 require(false, stub_error);203 dummy = 0;198 dummy = 0;204 }199 }205200206 // @dev Not implemented201 // @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE202 // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE203 // THEY MAY BE PERMANENTLY LOST204 // @dev Throws unless `msg.sender` is the current owner or an authorized205 // operator for this RFT. Throws if `from` is not the current owner. Throws206 // if `to` is the zero address. Throws if `tokenId` is not a valid RFT.207 // Throws if RFT pieces have multiple owners.208 // @param from The current owner of the NFT209 // @param to The new owner210 // @param tokenId The NFT to transfer211 // @param _value Not used for an NFT207 //212 //208 // Selector: transferFrom(address,address,uint256) 23b872dd213 // Selector: transferFrom(address,address,uint256) 23b872dd209 function transferFrom(214 function transferFrom(266271267// Selector: 5b5e139f272// Selector: 5b5e139f268contract ERC721Metadata is Dummy, ERC165 {273contract ERC721Metadata is Dummy, ERC165 {274 // @notice A descriptive name for a collection of RFTs in this contract275 //269 // Selector: name() 06fdde03276 // Selector: name() 06fdde03270 function name() public view returns (string memory) {277 function name() public view returns (string memory) {271 require(false, stub_error);278 require(false, stub_error);272 dummy;279 dummy;273 return "";280 return "";274 }281 }275282283 // @notice An abbreviated name for RFTs in this contract284 //276 // Selector: symbol() 95d89b41285 // Selector: symbol() 95d89b41277 function symbol() public view returns (string memory) {286 function symbol() public view returns (string memory) {278 require(false, stub_error);287 require(false, stub_error);279 dummy;288 dummy;280 return "";289 return "";281 }290 }282291292 // @notice A distinct Uniform Resource Identifier (URI) for a given asset.293 //294 // @dev If the token has a `url` property and it is not empty, it is returned.295 // Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.296 // If the collection property `baseURI` is empty or absent, return "" (empty string)297 // otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix298 // otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).299 //283 // Returns token's const_metadata300 // @return token's const_metadata284 //301 //285 // Selector: tokenURI(uint256) c87b56dd302 // Selector: tokenURI(uint256) c87b56dd286 function tokenURI(uint256 tokenId) public view returns (string memory) {303 function tokenURI(uint256 tokenId) public view returns (string memory) {300 return false;317 return false;301 }318 }302319320 // @notice Function to mint token.303 // `token_id` should be obtained with `next_token_id` method,321 // @dev `tokenId` should be obtained with `nextTokenId` method,304 // unlike standard, you can't specify it manually322 // unlike standard, you can't specify it manually323 // @param to The new owner324 // @param tokenId ID of the minted RFT305 //325 //306 // Selector: mint(address,uint256) 40c10f19326 // Selector: mint(address,uint256) 40c10f19307 function mint(address to, uint256 tokenId) public returns (bool) {327 function mint(address to, uint256 tokenId) public returns (bool) {312 return false;332 return false;313 }333 }314334335 // @notice Function to mint token with the given tokenUri.315 // `token_id` should be obtained with `next_token_id` method,336 // @dev `tokenId` should be obtained with `nextTokenId` method,316 // unlike standard, you can't specify it manually337 // unlike standard, you can't specify it manually338 // @param to The new owner339 // @param tokenId ID of the minted RFT340 // @param tokenUri Token URI that would be stored in the RFT properties317 //341 //318 // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f342 // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f319 function mintWithTokenURI(343 function mintWithTokenURI(341365342// Selector: 780e9d63366// Selector: 780e9d63343contract ERC721Enumerable is Dummy, ERC165 {367contract ERC721Enumerable is Dummy, ERC165 {368 // @notice Enumerate valid RFTs369 // @param index A counter less than `totalSupply()`370 // @return The token identifier for the `index`th NFT,371 // (sort order not specified)372 //344 // Selector: tokenByIndex(uint256) 4f6ccce7373 // Selector: tokenByIndex(uint256) 4f6ccce7345 function tokenByIndex(uint256 index) public view returns (uint256) {374 function tokenByIndex(uint256 index) public view returns (uint256) {346 require(false, stub_error);375 require(false, stub_error);364 return 0;393 return 0;365 }394 }366395396 // @notice Count RFTs tracked by this contract397 // @return A count of valid RFTs tracked by this contract, where each one of398 // them has an assigned and queryable owner not equal to the zero address399 //367 // Selector: totalSupply() 18160ddd400 // Selector: totalSupply() 18160ddd368 function totalSupply() public view returns (uint256) {401 function totalSupply() public view returns (uint256) {369 require(false, stub_error);402 require(false, stub_error);599 }632 }600}633}634635// Selector: d74d154f636contract ERC721UniqueExtensions is Dummy, ERC165 {637 // @notice Transfer ownership of an RFT638 // @dev Throws unless `msg.sender` is the current owner. Throws if `to`639 // is the zero address. Throws if `tokenId` is not a valid RFT.640 // Throws if RFT pieces have multiple owners.641 // @param to The new owner642 // @param tokenId The RFT to transfer643 // @param _value Not used for an RFT644 //645 // Selector: transfer(address,uint256) a9059cbb646 function transfer(address to, uint256 tokenId) public {647 require(false, stub_error);648 to;649 tokenId;650 dummy = 0;651 }652653 // @notice Burns a specific ERC721 token.654 // @dev Throws unless `msg.sender` is the current owner or an authorized655 // operator for this RFT. Throws if `from` is not the current owner. Throws656 // if `to` is the zero address. Throws if `tokenId` is not a valid RFT.657 // Throws if RFT pieces have multiple owners.658 // @param from The current owner of the RFT659 // @param tokenId The RFT to transfer660 // @param _value Not used for an RFT661 //662 // Selector: burnFrom(address,uint256) 79cc6790663 function burnFrom(address from, uint256 tokenId) public {664 require(false, stub_error);665 from;666 tokenId;667 dummy = 0;668 }669670 // @notice Returns next free RFT ID.671 //672 // Selector: nextTokenId() 75794a3c673 function nextTokenId() public view returns (uint256) {674 require(false, stub_error);675 dummy;676 return 0;677 }678679 // @notice Function to mint multiple tokens.680 // @dev `tokenIds` should be an array of consecutive numbers and first number681 // should be obtained with `nextTokenId` method682 // @param to The new owner683 // @param tokenIds IDs of the minted RFTs684 //685 // Selector: mintBulk(address,uint256[]) 44a9945e686 function mintBulk(address to, uint256[] memory tokenIds)687 public688 returns (bool)689 {690 require(false, stub_error);691 to;692 tokenIds;693 dummy = 0;694 return false;695 }696697 // @notice Function to mint multiple tokens with the given tokenUris.698 // @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive699 // numbers and first number should be obtained with `nextTokenId` method700 // @param to The new owner701 // @param tokens array of pairs of token ID and token URI for minted tokens702 //703 // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006704 function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)705 public706 returns (bool)707 {708 require(false, stub_error);709 to;710 tokens;711 dummy = 0;712 return false;713 }714}601715602contract UniqueRefungible is716contract UniqueRefungible is603 Dummy,717 Dummy,pallets/refungible/src/stubs/UniqueRefungibleToken.rawdiffbeforeafterbothbinary blob — no preview
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -42,26 +42,15 @@
event MintingFinished();
}
-// Selector: 0784ee64
-interface ERC721UniqueExtensions is Dummy, ERC165 {
- // @notice Returns next free RFT ID.
- //
- // Selector: nextTokenId() 75794a3c
- function nextTokenId() external view returns (uint256);
-
- // Selector: mintBulk(address,uint256[]) 44a9945e
- function mintBulk(address to, uint256[] memory tokenIds)
- external
- returns (bool);
-
- // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006
- function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)
- external
- returns (bool);
-}
-
// Selector: 41369377
interface TokenProperties is Dummy, ERC165 {
+ // @notice Set permissions for token property.
+ // @dev Throws error if `msg.sender` is not admin or owner of the collection.
+ // @param key Property key.
+ // @param is_mutable Permission to mutate property.
+ // @param collection_admin Permission to mutate property by collection admin if property is mutable.
+ // @param token_owner Permission to mutate property by token owner if property is mutable.
+ //
// Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa
function setTokenPropertyPermission(
string memory key,
@@ -70,6 +59,12 @@
bool tokenOwner
) external;
+ // @notice Set token property value.
+ // @dev Throws error if `msg.sender` has no permission to edit the property.
+ // @param tokenId ID of the token.
+ // @param key Property key.
+ // @param value Property value.
+ //
// Selector: setProperty(uint256,string,bytes) 1752d67b
function setProperty(
uint256 tokenId,
@@ -77,10 +72,19 @@
bytes memory value
) external;
+ // @notice Delete token property value.
+ // @dev Throws error if `msg.sender` has no permission to edit the property.
+ // @param tokenId ID of the token.
+ // @param key Property key.
+ //
// Selector: deleteProperty(uint256,string) 066111d1
function deleteProperty(uint256 tokenId, string memory key) external;
- // Throws error if key not found
+ // @notice Get token property value.
+ // @dev Throws error if key not found
+ // @param tokenId ID of the token.
+ // @param key Property key.
+ // @return Property value bytes
//
// Selector: property(uint256,string) 7228c327
function property(uint256 tokenId, string memory key)
@@ -91,7 +95,10 @@
// Selector: 42966c68
interface ERC721Burnable is Dummy, ERC165 {
- // @dev Not implemented
+ // @notice Burns a specific ERC721 token.
+ // @dev Throws unless `msg.sender` is the current RFT owner, or an authorized
+ // operator of the current owner.
+ // @param tokenId The RFT to approve
//
// Selector: burn(uint256) 42966c68
function burn(uint256 tokenId) external;
@@ -99,6 +106,12 @@
// Selector: 58800161
interface ERC721 is Dummy, ERC165, ERC721Events {
+ // @notice Count all RFTs assigned to an owner
+ // @dev RFTs assigned to the zero address are considered invalid, and this
+ // function throws for queries about the zero address.
+ // @param owner An address for whom to query the balance
+ // @return The number of RFTs owned by `owner`, possibly zero
+ //
// Selector: balanceOf(address) 70a08231
function balanceOf(address owner) external view returns (uint256);
@@ -124,7 +137,17 @@
uint256 tokenId
) external;
- // @dev Not implemented
+ // @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE
+ // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
+ // THEY MAY BE PERMANENTLY LOST
+ // @dev Throws unless `msg.sender` is the current owner or an authorized
+ // operator for this RFT. Throws if `from` is not the current owner. Throws
+ // if `to` is the zero address. Throws if `tokenId` is not a valid RFT.
+ // Throws if RFT pieces have multiple owners.
+ // @param from The current owner of the NFT
+ // @param to The new owner
+ // @param tokenId The NFT to transfer
+ // @param _value Not used for an NFT
//
// Selector: transferFrom(address,address,uint256) 23b872dd
function transferFrom(
@@ -159,13 +182,25 @@
// Selector: 5b5e139f
interface ERC721Metadata is Dummy, ERC165 {
+ // @notice A descriptive name for a collection of RFTs in this contract
+ //
// Selector: name() 06fdde03
function name() external view returns (string memory);
+ // @notice An abbreviated name for RFTs in this contract
+ //
// Selector: symbol() 95d89b41
function symbol() external view returns (string memory);
- // Returns token's const_metadata
+ // @notice A distinct Uniform Resource Identifier (URI) for a given asset.
+ //
+ // @dev If the token has a `url` property and it is not empty, it is returned.
+ // Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.
+ // If the collection property `baseURI` is empty or absent, return "" (empty string)
+ // otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix
+ // otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).
+ //
+ // @return token's const_metadata
//
// Selector: tokenURI(uint256) c87b56dd
function tokenURI(uint256 tokenId) external view returns (string memory);
@@ -176,14 +211,21 @@
// Selector: mintingFinished() 05d2035b
function mintingFinished() external view returns (bool);
- // `token_id` should be obtained with `next_token_id` method,
- // unlike standard, you can't specify it manually
+ // @notice Function to mint token.
+ // @dev `tokenId` should be obtained with `nextTokenId` method,
+ // unlike standard, you can't specify it manually
+ // @param to The new owner
+ // @param tokenId ID of the minted RFT
//
// Selector: mint(address,uint256) 40c10f19
function mint(address to, uint256 tokenId) external returns (bool);
- // `token_id` should be obtained with `next_token_id` method,
- // unlike standard, you can't specify it manually
+ // @notice Function to mint token with the given tokenUri.
+ // @dev `tokenId` should be obtained with `nextTokenId` method,
+ // unlike standard, you can't specify it manually
+ // @param to The new owner
+ // @param tokenId ID of the minted RFT
+ // @param tokenUri Token URI that would be stored in the RFT properties
//
// Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f
function mintWithTokenURI(
@@ -200,6 +242,11 @@
// Selector: 780e9d63
interface ERC721Enumerable is Dummy, ERC165 {
+ // @notice Enumerate valid RFTs
+ // @param index A counter less than `totalSupply()`
+ // @return The token identifier for the `index`th NFT,
+ // (sort order not specified)
+ //
// Selector: tokenByIndex(uint256) 4f6ccce7
function tokenByIndex(uint256 index) external view returns (uint256);
@@ -211,6 +258,10 @@
view
returns (uint256);
+ // @notice Count RFTs tracked by this contract
+ // @return A count of valid RFTs tracked by this contract, where each one of
+ // them has an assigned and queryable owner not equal to the zero address
+ //
// Selector: totalSupply() 18160ddd
function totalSupply() external view returns (uint256);
}
@@ -363,6 +414,59 @@
function setCollectionMintMode(bool mode) external;
}
+// Selector: d74d154f
+interface ERC721UniqueExtensions is Dummy, ERC165 {
+ // @notice Transfer ownership of an RFT
+ // @dev Throws unless `msg.sender` is the current owner. Throws if `to`
+ // is the zero address. Throws if `tokenId` is not a valid RFT.
+ // Throws if RFT pieces have multiple owners.
+ // @param to The new owner
+ // @param tokenId The RFT to transfer
+ // @param _value Not used for an RFT
+ //
+ // Selector: transfer(address,uint256) a9059cbb
+ function transfer(address to, uint256 tokenId) external;
+
+ // @notice Burns a specific ERC721 token.
+ // @dev Throws unless `msg.sender` is the current owner or an authorized
+ // operator for this RFT. Throws if `from` is not the current owner. Throws
+ // if `to` is the zero address. Throws if `tokenId` is not a valid RFT.
+ // Throws if RFT pieces have multiple owners.
+ // @param from The current owner of the RFT
+ // @param tokenId The RFT to transfer
+ // @param _value Not used for an RFT
+ //
+ // Selector: burnFrom(address,uint256) 79cc6790
+ function burnFrom(address from, uint256 tokenId) external;
+
+ // @notice Returns next free RFT ID.
+ //
+ // Selector: nextTokenId() 75794a3c
+ function nextTokenId() external view returns (uint256);
+
+ // @notice Function to mint multiple tokens.
+ // @dev `tokenIds` should be an array of consecutive numbers and first number
+ // should be obtained with `nextTokenId` method
+ // @param to The new owner
+ // @param tokenIds IDs of the minted RFTs
+ //
+ // Selector: mintBulk(address,uint256[]) 44a9945e
+ function mintBulk(address to, uint256[] memory tokenIds)
+ external
+ returns (bool);
+
+ // @notice Function to mint multiple tokens with the given tokenUris.
+ // @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive
+ // numbers and first number should be obtained with `nextTokenId` method
+ // @param to The new owner
+ // @param tokens array of pairs of token ID and token URI for minted tokens
+ //
+ // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006
+ function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)
+ external
+ returns (bool);
+}
+
interface UniqueRefungible is
Dummy,
ERC165,
tests/src/eth/reFungible.test.tsdiffbeforeafterboth--- a/tests/src/eth/reFungible.test.ts
+++ b/tests/src/eth/reFungible.test.ts
@@ -14,8 +14,8 @@
// You should have received a copy of the GNU General Public License
// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
-import {createCollectionExpectSuccess} from '../util/helpers';
-import {collectionIdToAddress, createEthAccount, createEthAccountWithBalance, evmCollection, evmCollectionHelpers, GAS_ARGS, getCollectionAddressFromResult, itWeb3, normalizeEvents, tokenIdToAddress} from './util/helpers';
+import {createCollectionExpectSuccess, UNIQUE} from '../util/helpers';
+import {collectionIdToAddress, createEthAccount, createEthAccountWithBalance, evmCollection, evmCollectionHelpers, GAS_ARGS, getCollectionAddressFromResult, itWeb3, normalizeEvents, recordEthFee, tokenIdToAddress} from './util/helpers';
import reFungibleAbi from './reFungibleAbi.json';
import reFungibleTokenAbi from './reFungibleTokenAbi.json';
import {expect} from 'chai';
@@ -26,7 +26,7 @@
const helper = evmCollectionHelpers(web3, caller);
const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
- const contract = new web3.eth.Contract(reFungibleAbi as any, collectionIdAddress, {from: caller, ...GAS_ARGS});
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
const nextTokenId = await contract.methods.nextTokenId().call();
await contract.methods.mint(caller, nextTokenId).send();
const totalSupply = await contract.methods.totalSupply().call();
@@ -38,7 +38,7 @@
const helper = evmCollectionHelpers(web3, caller);
const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
- const contract = new web3.eth.Contract(reFungibleAbi as any, collectionIdAddress, {from: caller, ...GAS_ARGS});
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
{
const nextTokenId = await contract.methods.nextTokenId().call();
@@ -63,7 +63,7 @@
const helper = evmCollectionHelpers(web3, caller);
const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
- const contract = new web3.eth.Contract(reFungibleAbi as any, collectionIdAddress, {from: caller, ...GAS_ARGS});
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
const tokenId = await contract.methods.nextTokenId().call();
await contract.methods.mint(caller, tokenId).send();
@@ -79,7 +79,7 @@
const helper = evmCollectionHelpers(web3, caller);
const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
const {collectionIdAddress, collectionId} = await getCollectionAddressFromResult(api, result);
- const contract = new web3.eth.Contract(reFungibleAbi as any, collectionIdAddress, {from: caller, ...GAS_ARGS});
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
const tokenId = await contract.methods.nextTokenId().call();
await contract.methods.mint(caller, tokenId).send();
@@ -105,7 +105,7 @@
let result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
const receiver = createEthAccount(web3);
- const contract = evmCollection(web3, owner, collectionIdAddress);
+ const contract = evmCollection(web3, owner, collectionIdAddress, {type: 'ReFungible'});
const nextTokenId = await contract.methods.nextTokenId().call();
expect(nextTokenId).to.be.equal('1');
@@ -137,7 +137,7 @@
const helper = evmCollectionHelpers(web3, caller);
const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
- const contract = new web3.eth.Contract(reFungibleAbi as any, collectionIdAddress, {from: caller, ...GAS_ARGS});
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
const receiver = createEthAccount(web3);
@@ -189,8 +189,148 @@
expect(await contract.methods.tokenURI(+nextTokenId + 2).call()).to.be.equal('Test URI 2');
}
});
+
+ itWeb3('Can perform burn()', async ({web3, api, privateKeyWrapper}) => {
+ const caller = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const helper = evmCollectionHelpers(web3, caller);
+ const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
+ const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
+
+ const tokenId = await contract.methods.nextTokenId().call();
+ await contract.methods.mint(caller, tokenId).send();
+ {
+ const result = await contract.methods.burn(tokenId).send();
+ const events = normalizeEvents(result.events);
+
+ expect(events).to.be.deep.equal([
+ {
+ address: collectionIdAddress,
+ event: 'Transfer',
+ args: {
+ from: caller,
+ to: '0x0000000000000000000000000000000000000000',
+ tokenId: tokenId.toString(),
+ },
+ },
+ ]);
+ }
+ });
+
+ itWeb3('Can perform transferFrom()', async ({web3, api, privateKeyWrapper}) => {
+ const caller = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const helper = evmCollectionHelpers(web3, caller);
+ const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
+ const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
+
+ const receiver = createEthAccount(web3);
+
+ const tokenId = await contract.methods.nextTokenId().call();
+ await contract.methods.mint(caller, tokenId).send();
+ {
+ const result = await contract.methods.transferFrom(caller, receiver, tokenId).send();
+ const events = normalizeEvents(result.events);
+ expect(events).to.include.deep.members([
+ {
+ address: collectionIdAddress,
+ event: 'Transfer',
+ args: {
+ from: caller,
+ to: receiver,
+ tokenId: tokenId.toString(),
+ },
+ },
+ ]);
+ }
+
+ {
+ const balance = await contract.methods.balanceOf(receiver).call();
+ expect(+balance).to.equal(1);
+ }
+
+ {
+ const balance = await contract.methods.balanceOf(caller).call();
+ expect(+balance).to.equal(0);
+ }
+ });
+
+ itWeb3('Can perform transfer()', async ({web3, api, privateKeyWrapper}) => {
+ const caller = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const helper = evmCollectionHelpers(web3, caller);
+ const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
+ const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
+
+ const receiver = createEthAccount(web3);
+
+ const tokenId = await contract.methods.nextTokenId().call();
+ await contract.methods.mint(caller, tokenId).send();
+
+ {
+ const result = await contract.methods.transfer(receiver, tokenId).send();
+ const events = normalizeEvents(result.events);
+ expect(events).to.include.deep.members([
+ {
+ address: collectionIdAddress,
+ event: 'Transfer',
+ args: {
+ from: caller,
+ to: receiver,
+ tokenId: tokenId.toString(),
+ },
+ },
+ ]);
+ }
+
+ {
+ const balance = await contract.methods.balanceOf(caller).call();
+ expect(+balance).to.equal(0);
+ }
+
+ {
+ const balance = await contract.methods.balanceOf(receiver).call();
+ expect(+balance).to.equal(1);
+ }
+ });
});
+describe('RFT: Fees', () => {
+ itWeb3('transferFrom() call fee is less than 0.2UNQ', async ({web3, api, privateKeyWrapper}) => {
+ const caller = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const helper = evmCollectionHelpers(web3, caller);
+ const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
+ const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
+
+ const receiver = createEthAccount(web3);
+
+ const tokenId = await contract.methods.nextTokenId().call();
+ await contract.methods.mint(caller, tokenId).send();
+
+ const cost = await recordEthFee(api, caller, () => contract.methods.transferFrom(caller, receiver, tokenId).send());
+ expect(cost < BigInt(0.2 * Number(UNIQUE)));
+ expect(cost > 0n);
+ });
+
+ itWeb3('transfer() call fee is less than 0.2UNQ', async ({web3, api, privateKeyWrapper}) => {
+ const caller = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const helper = evmCollectionHelpers(web3, caller);
+ const result = await helper.methods.createRefungibleCollection('Mint collection', '6', '6').send();
+ const {collectionIdAddress} = await getCollectionAddressFromResult(api, result);
+ const contract = evmCollection(web3, caller, collectionIdAddress, {type: 'ReFungible'});
+
+ const receiver = createEthAccount(web3);
+
+ const tokenId = await contract.methods.nextTokenId().call();
+ await contract.methods.mint(caller, tokenId).send();
+
+ const cost = await recordEthFee(api, caller, () => contract.methods.transfer(receiver, tokenId).send());
+ expect(cost < BigInt(0.2 * Number(UNIQUE)));
+ expect(cost > 0n);
+ });
+});
+
describe('Common metadata', () => {
itWeb3('Returns collection name', async ({api, web3, privateKeyWrapper}) => {
const collection = await createCollectionExpectSuccess({
@@ -200,7 +340,7 @@
const caller = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
const address = collectionIdToAddress(collection);
- const contract = new web3.eth.Contract(reFungibleAbi as any, address, {from: caller, ...GAS_ARGS});
+ const contract = evmCollection(web3, caller, address, {type: 'ReFungible'});
const name = await contract.methods.name().call();
expect(name).to.equal('token name');
@@ -214,7 +354,7 @@
const caller = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
const address = collectionIdToAddress(collection);
- const contract = new web3.eth.Contract(reFungibleAbi as any, address, {from: caller, ...GAS_ARGS});
+ const contract = evmCollection(web3, caller, address, {type: 'ReFungible'});
const symbol = await contract.methods.symbol().call();
expect(symbol).to.equal('TOK');
tests/src/eth/reFungibleAbi.jsondiffbeforeafterboth--- a/tests/src/eth/reFungibleAbi.json
+++ b/tests/src/eth/reFungibleAbi.json
@@ -136,6 +136,16 @@
"type": "function"
},
{
+ "inputs": [
+ { "internalType": "address", "name": "from", "type": "address" },
+ { "internalType": "uint256", "name": "tokenId", "type": "uint256" }
+ ],
+ "name": "burnFrom",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
"inputs": [{ "internalType": "string", "name": "key", "type": "string" }],
"name": "collectionProperty",
"outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }],
@@ -498,6 +508,16 @@
},
{
"inputs": [
+ { "internalType": "address", "name": "to", "type": "address" },
+ { "internalType": "uint256", "name": "tokenId", "type": "uint256" }
+ ],
+ "name": "transfer",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
{ "internalType": "address", "name": "from", "type": "address" },
{ "internalType": "address", "name": "to", "type": "address" },
{ "internalType": "uint256", "name": "tokenId", "type": "uint256" }