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.soldiffbeforeafterboth1// SPDX-License-Identifier: OTHER2// This code is automatically generated34pragma solidity >=0.8.0 <0.9.0;56// Anonymous struct7struct Tuple0 {8 uint256 field_0;9 string field_1;10}1112// Common stubs holder13contract Dummy {14 uint8 dummy;15 string stub_error = "this contract is implemented in native";16}1718contract ERC165 is Dummy {19 function supportsInterface(bytes4 interfaceID)20 external21 view22 returns (bool)23 {24 require(false, stub_error);25 interfaceID;26 return true;27 }28}2930// Inline31contract ERC721Events {32 event Transfer(33 address indexed from,34 address indexed to,35 uint256 indexed tokenId36 );37 event Approval(38 address indexed owner,39 address indexed approved,40 uint256 indexed tokenId41 );42 event ApprovalForAll(43 address indexed owner,44 address indexed operator,45 bool approved46 );47}4849// Inline50contract ERC721MintableEvents {51 event MintingFinished();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}8990// Selector: 4136937791contract TokenProperties is Dummy, ERC165 {92 // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa93 function setTokenPropertyPermission(94 string memory key,95 bool isMutable,96 bool collectionAdmin,97 bool tokenOwner98 ) public {99 require(false, stub_error);100 key;101 isMutable;102 collectionAdmin;103 tokenOwner;104 dummy = 0;105 }106107 // Selector: setProperty(uint256,string,bytes) 1752d67b108 function setProperty(109 uint256 tokenId,110 string memory key,111 bytes memory value112 ) public {113 require(false, stub_error);114 tokenId;115 key;116 value;117 dummy = 0;118 }119120 // Selector: deleteProperty(uint256,string) 066111d1121 function deleteProperty(uint256 tokenId, string memory key) public {122 require(false, stub_error);123 tokenId;124 key;125 dummy = 0;126 }127128 // Throws error if key not found129 //130 // Selector: property(uint256,string) 7228c327131 function property(uint256 tokenId, string memory key)132 public133 view134 returns (bytes memory)135 {136 require(false, stub_error);137 tokenId;138 key;139 dummy;140 return hex"";141 }142}143144// Selector: 42966c68145contract ERC721Burnable is Dummy, ERC165 {146 // @dev Not implemented147 //148 // Selector: burn(uint256) 42966c68149 function burn(uint256 tokenId) public {150 require(false, stub_error);151 tokenId;152 dummy = 0;153 }154}155156// Selector: 58800161157contract ERC721 is Dummy, ERC165, ERC721Events {158 // Selector: balanceOf(address) 70a08231159 function balanceOf(address owner) public view returns (uint256) {160 require(false, stub_error);161 owner;162 dummy;163 return 0;164 }165166 // Selector: ownerOf(uint256) 6352211e167 function ownerOf(uint256 tokenId) public view returns (address) {168 require(false, stub_error);169 tokenId;170 dummy;171 return 0x0000000000000000000000000000000000000000;172 }173174 // @dev Not implemented175 //176 // Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672177 function safeTransferFromWithData(178 address from,179 address to,180 uint256 tokenId,181 bytes memory data182 ) public {183 require(false, stub_error);184 from;185 to;186 tokenId;187 data;188 dummy = 0;189 }190191 // @dev Not implemented192 //193 // Selector: safeTransferFrom(address,address,uint256) 42842e0e194 function safeTransferFrom(195 address from,196 address to,197 uint256 tokenId198 ) public {199 require(false, stub_error);200 from;201 to;202 tokenId;203 dummy = 0;204 }205206 // @dev Not implemented207 //208 // Selector: transferFrom(address,address,uint256) 23b872dd209 function transferFrom(210 address from,211 address to,212 uint256 tokenId213 ) public {214 require(false, stub_error);215 from;216 to;217 tokenId;218 dummy = 0;219 }220221 // @dev Not implemented222 //223 // Selector: approve(address,uint256) 095ea7b3224 function approve(address approved, uint256 tokenId) public {225 require(false, stub_error);226 approved;227 tokenId;228 dummy = 0;229 }230231 // @dev Not implemented232 //233 // Selector: setApprovalForAll(address,bool) a22cb465234 function setApprovalForAll(address operator, bool approved) public {235 require(false, stub_error);236 operator;237 approved;238 dummy = 0;239 }240241 // @dev Not implemented242 //243 // Selector: getApproved(uint256) 081812fc244 function getApproved(uint256 tokenId) public view returns (address) {245 require(false, stub_error);246 tokenId;247 dummy;248 return 0x0000000000000000000000000000000000000000;249 }250251 // @dev Not implemented252 //253 // Selector: isApprovedForAll(address,address) e985e9c5254 function isApprovedForAll(address owner, address operator)255 public256 view257 returns (address)258 {259 require(false, stub_error);260 owner;261 operator;262 dummy;263 return 0x0000000000000000000000000000000000000000;264 }265}266267// Selector: 5b5e139f268contract ERC721Metadata is Dummy, ERC165 {269 // Selector: name() 06fdde03270 function name() public view returns (string memory) {271 require(false, stub_error);272 dummy;273 return "";274 }275276 // Selector: symbol() 95d89b41277 function symbol() public view returns (string memory) {278 require(false, stub_error);279 dummy;280 return "";281 }282283 // Returns token's const_metadata284 //285 // Selector: tokenURI(uint256) c87b56dd286 function tokenURI(uint256 tokenId) public view returns (string memory) {287 require(false, stub_error);288 tokenId;289 dummy;290 return "";291 }292}293294// Selector: 68ccfe89295contract ERC721Mintable is Dummy, ERC165, ERC721MintableEvents {296 // Selector: mintingFinished() 05d2035b297 function mintingFinished() public view returns (bool) {298 require(false, stub_error);299 dummy;300 return false;301 }302303 // `token_id` should be obtained with `next_token_id` method,304 // unlike standard, you can't specify it manually305 //306 // Selector: mint(address,uint256) 40c10f19307 function mint(address to, uint256 tokenId) public returns (bool) {308 require(false, stub_error);309 to;310 tokenId;311 dummy = 0;312 return false;313 }314315 // `token_id` should be obtained with `next_token_id` method,316 // unlike standard, you can't specify it manually317 //318 // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f319 function mintWithTokenURI(320 address to,321 uint256 tokenId,322 string memory tokenUri323 ) public returns (bool) {324 require(false, stub_error);325 to;326 tokenId;327 tokenUri;328 dummy = 0;329 return false;330 }331332 // @dev Not implemented333 //334 // Selector: finishMinting() 7d64bcb4335 function finishMinting() public returns (bool) {336 require(false, stub_error);337 dummy = 0;338 return false;339 }340}341342// Selector: 780e9d63343contract ERC721Enumerable is Dummy, ERC165 {344 // Selector: tokenByIndex(uint256) 4f6ccce7345 function tokenByIndex(uint256 index) public view returns (uint256) {346 require(false, stub_error);347 index;348 dummy;349 return 0;350 }351352 // Not implemented353 //354 // Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59355 function tokenOfOwnerByIndex(address owner, uint256 index)356 public357 view358 returns (uint256)359 {360 require(false, stub_error);361 owner;362 index;363 dummy;364 return 0;365 }366367 // Selector: totalSupply() 18160ddd368 function totalSupply() public view returns (uint256) {369 require(false, stub_error);370 dummy;371 return 0;372 }373}374375// Selector: 7d9262e6376contract Collection is Dummy, ERC165 {377 // Set collection property.378 //379 // @param key Property key.380 // @param value Propery value.381 //382 // Selector: setCollectionProperty(string,bytes) 2f073f66383 function setCollectionProperty(string memory key, bytes memory value)384 public385 {386 require(false, stub_error);387 key;388 value;389 dummy = 0;390 }391392 // Delete collection property.393 //394 // @param key Property key.395 //396 // Selector: deleteCollectionProperty(string) 7b7debce397 function deleteCollectionProperty(string memory key) public {398 require(false, stub_error);399 key;400 dummy = 0;401 }402403 // Get collection property.404 //405 // @dev Throws error if key not found.406 //407 // @param key Property key.408 // @return bytes The property corresponding to the key.409 //410 // Selector: collectionProperty(string) cf24fd6d411 function collectionProperty(string memory key)412 public413 view414 returns (bytes memory)415 {416 require(false, stub_error);417 key;418 dummy;419 return hex"";420 }421422 // Set the sponsor of the collection.423 //424 // @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.425 //426 // @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.427 //428 // Selector: setCollectionSponsor(address) 7623402e429 function setCollectionSponsor(address sponsor) public {430 require(false, stub_error);431 sponsor;432 dummy = 0;433 }434435 // Collection sponsorship confirmation.436 //437 // @dev After setting the sponsor for the collection, it must be confirmed with this function.438 //439 // Selector: confirmCollectionSponsorship() 3c50e97a440 function confirmCollectionSponsorship() public {441 require(false, stub_error);442 dummy = 0;443 }444445 // Set limits for the collection.446 // @dev Throws error if limit not found.447 // @param limit Name of the limit. Valid names:448 // "accountTokenOwnershipLimit",449 // "sponsoredDataSize",450 // "sponsoredDataRateLimit",451 // "tokenLimit",452 // "sponsorTransferTimeout",453 // "sponsorApproveTimeout"454 // @param value Value of the limit.455 //456 // Selector: setCollectionLimit(string,uint32) 6a3841db457 function setCollectionLimit(string memory limit, uint32 value) public {458 require(false, stub_error);459 limit;460 value;461 dummy = 0;462 }463464 // Set limits for the collection.465 // @dev Throws error if limit not found.466 // @param limit Name of the limit. Valid names:467 // "ownerCanTransfer",468 // "ownerCanDestroy",469 // "transfersEnabled"470 // @param value Value of the limit.471 //472 // Selector: setCollectionLimit(string,bool) 993b7fba473 function setCollectionLimit(string memory limit, bool value) public {474 require(false, stub_error);475 limit;476 value;477 dummy = 0;478 }479480 // Get contract address.481 //482 // Selector: contractAddress() f6b4dfb4483 function contractAddress() public view returns (address) {484 require(false, stub_error);485 dummy;486 return 0x0000000000000000000000000000000000000000;487 }488489 // Add collection admin by substrate address.490 // @param new_admin Substrate administrator address.491 //492 // Selector: addCollectionAdminSubstrate(uint256) 5730062b493 function addCollectionAdminSubstrate(uint256 newAdmin) public {494 require(false, stub_error);495 newAdmin;496 dummy = 0;497 }498499 // Remove collection admin by substrate address.500 // @param admin Substrate administrator address.501 //502 // Selector: removeCollectionAdminSubstrate(uint256) 4048fcf9503 function removeCollectionAdminSubstrate(uint256 admin) public {504 require(false, stub_error);505 admin;506 dummy = 0;507 }508509 // Add collection admin.510 // @param new_admin Address of the added administrator.511 //512 // Selector: addCollectionAdmin(address) 92e462c7513 function addCollectionAdmin(address newAdmin) public {514 require(false, stub_error);515 newAdmin;516 dummy = 0;517 }518519 // Remove collection admin.520 //521 // @param new_admin Address of the removed administrator.522 //523 // Selector: removeCollectionAdmin(address) fafd7b42524 function removeCollectionAdmin(address admin) public {525 require(false, stub_error);526 admin;527 dummy = 0;528 }529530 // Toggle accessibility of collection nesting.531 //532 // @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'533 //534 // Selector: setCollectionNesting(bool) 112d4586535 function setCollectionNesting(bool enable) public {536 require(false, stub_error);537 enable;538 dummy = 0;539 }540541 // Toggle accessibility of collection nesting.542 //543 // @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'544 // @param collections Addresses of collections that will be available for nesting.545 //546 // Selector: setCollectionNesting(bool,address[]) 64872396547 function setCollectionNesting(bool enable, address[] memory collections)548 public549 {550 require(false, stub_error);551 enable;552 collections;553 dummy = 0;554 }555556 // Set the collection access method.557 // @param mode Access mode558 // 0 for Normal559 // 1 for AllowList560 //561 // Selector: setCollectionAccess(uint8) 41835d4c562 function setCollectionAccess(uint8 mode) public {563 require(false, stub_error);564 mode;565 dummy = 0;566 }567568 // Add the user to the allowed list.569 //570 // @param user Address of a trusted user.571 //572 // Selector: addToCollectionAllowList(address) 67844fe6573 function addToCollectionAllowList(address user) public {574 require(false, stub_error);575 user;576 dummy = 0;577 }578579 // Remove the user from the allowed list.580 //581 // @param user Address of a removed user.582 //583 // Selector: removeFromCollectionAllowList(address) 85c51acb584 function removeFromCollectionAllowList(address user) public {585 require(false, stub_error);586 user;587 dummy = 0;588 }589590 // Switch permission for minting.591 //592 // @param mode Enable if "true".593 //594 // Selector: setCollectionMintMode(bool) 00018e84595 function setCollectionMintMode(bool mode) public {596 require(false, stub_error);597 mode;598 dummy = 0;599 }600}601602contract UniqueRefungible is603 Dummy,604 ERC165,605 ERC721,606 ERC721Metadata,607 ERC721Enumerable,608 ERC721UniqueExtensions,609 ERC721Mintable,610 ERC721Burnable,611 Collection,612 TokenProperties613{}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" }