difftreelog
Merge pull request #574 from UniqueNetwork/feature/eth_passthrought
in: master
Feature/eth passthrought
19 files changed
pallets/common/src/erc.rsdiffbeforeafterboth--- a/pallets/common/src/erc.rs
+++ b/pallets/common/src/erc.rs
@@ -20,6 +20,7 @@
solidity_interface, solidity, ToLog,
types::*,
execution::{Result, Error},
+ weight,
};
pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId};
use pallet_evm_coder_substrate::dispatch_to_evm;
@@ -31,8 +32,12 @@
use alloc::format;
use crate::{
- Pallet, CollectionHandle, Config, CollectionProperties,
- eth::{convert_cross_account_to_uint256, convert_uint256_to_cross_account},
+ Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf,
+ eth::{
+ convert_cross_account_to_uint256, convert_uint256_to_cross_account,
+ convert_cross_account_to_tuple,
+ },
+ weights::WeightInfo,
};
/// Events for ethereum collection helper.
@@ -69,6 +74,7 @@
///
/// @param key Property key.
/// @param value Propery value.
+ #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]
fn set_collection_property(
&mut self,
caller: caller,
@@ -88,7 +94,10 @@
/// Delete collection property.
///
/// @param key Property key.
+ #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]
fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let key = <Vec<u8>>::from(key)
.try_into()
@@ -120,6 +129,8 @@
///
/// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.
fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
check_is_owner_or_admin(caller, self)?;
let sponsor = T::CrossAccountId::from_eth(sponsor);
@@ -138,6 +149,8 @@
caller: caller,
sponsor: uint256,
) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
check_is_owner_or_admin(caller, self)?;
let sponsor = convert_uint256_to_cross_account::<T>(sponsor);
@@ -146,7 +159,7 @@
save(self)
}
- // /// Whether there is a pending sponsor.
+ /// Whether there is a pending sponsor.
fn has_collection_pending_sponsor(&self) -> Result<bool> {
Ok(matches!(
self.collection.sponsorship,
@@ -158,6 +171,8 @@
///
/// @dev After setting the sponsor for the collection, it must be confirmed with this function.
fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {
+ self.consume_store_writes(1)?;
+
let caller = T::CrossAccountId::from_eth(caller);
if !self
.confirm_sponsorship(caller.as_sub())
@@ -170,6 +185,7 @@
/// Remove collection sponsor.
fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
check_is_owner_or_admin(caller, self)?;
self.remove_sponsor().map_err(dispatch_to_evm::<T>)?;
save(self)
@@ -206,6 +222,8 @@
/// @param value Value of the limit.
#[solidity(rename_selector = "setCollectionLimit")]
fn set_int_limit(&mut self, caller: caller, limit: string, value: uint32) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
check_is_owner_or_admin(caller, self)?;
let mut limits = self.limits.clone();
@@ -249,6 +267,8 @@
/// @param value Value of the limit.
#[solidity(rename_selector = "setCollectionLimit")]
fn set_bool_limit(&mut self, caller: caller, limit: string, value: bool) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
check_is_owner_or_admin(caller, self)?;
let mut limits = self.limits.clone();
@@ -275,7 +295,7 @@
}
/// Get contract address.
- fn contract_address(&self, _caller: caller) -> Result<address> {
+ fn contract_address(&self) -> Result<address> {
Ok(crate::eth::collection_id_to_address(self.id))
}
@@ -286,6 +306,8 @@
caller: caller,
new_admin: uint256,
) -> Result<void> {
+ self.consume_store_writes(2)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let new_admin = convert_uint256_to_cross_account::<T>(new_admin);
<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;
@@ -299,6 +321,8 @@
caller: caller,
admin: uint256,
) -> Result<void> {
+ self.consume_store_writes(2)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let admin = convert_uint256_to_cross_account::<T>(admin);
<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;
@@ -308,6 +332,8 @@
/// Add collection admin.
/// @param newAdmin Address of the added administrator.
fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {
+ self.consume_store_writes(2)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let new_admin = T::CrossAccountId::from_eth(new_admin);
<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;
@@ -318,6 +344,8 @@
///
/// @param admin Address of the removed administrator.
fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {
+ self.consume_store_writes(2)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let admin = T::CrossAccountId::from_eth(admin);
<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;
@@ -329,6 +357,8 @@
/// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'
#[solidity(rename_selector = "setCollectionNesting")]
fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
check_is_owner_or_admin(caller, self)?;
let mut permissions = self.collection.permissions.clone();
@@ -358,6 +388,8 @@
enable: bool,
collections: Vec<address>,
) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
if collections.is_empty() {
return Err("no addresses provided".into());
}
@@ -401,6 +433,8 @@
/// 0 for Normal
/// 1 for AllowList
fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
check_is_owner_or_admin(caller, self)?;
let permissions = CollectionPermissions {
access: Some(match mode {
@@ -420,30 +454,78 @@
save(self)
}
+ /// Checks that user allowed to operate with collection.
+ ///
+ /// @param user User address to check.
+ fn allowed(&self, user: address) -> Result<bool> {
+ Ok(Pallet::<T>::allowed(
+ self.id,
+ T::CrossAccountId::from_eth(user),
+ ))
+ }
+
/// Add the user to the allowed list.
///
/// @param user Address of a trusted user.
fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {
+ self.consume_store_writes(1)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let user = T::CrossAccountId::from_eth(user);
<Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;
Ok(())
}
+ /// Add substrate user to allowed list.
+ ///
+ /// @param user User substrate address.
+ fn add_to_collection_allow_list_substrate(
+ &mut self,
+ caller: caller,
+ user: uint256,
+ ) -> Result<void> {
+ self.consume_store_writes(1)?;
+
+ let caller = T::CrossAccountId::from_eth(caller);
+ let user = convert_uint256_to_cross_account::<T>(user);
+ Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;
+ Ok(())
+ }
+
/// Remove the user from the allowed list.
///
/// @param user Address of a removed user.
fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {
+ self.consume_store_writes(1)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let user = T::CrossAccountId::from_eth(user);
<Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;
Ok(())
}
+ /// Remove substrate user from allowed list.
+ ///
+ /// @param user User substrate address.
+ fn remove_from_collection_allow_list_substrate(
+ &mut self,
+ caller: caller,
+ user: uint256,
+ ) -> Result<void> {
+ self.consume_store_writes(1)?;
+
+ let caller = T::CrossAccountId::from_eth(caller);
+ let user = convert_uint256_to_cross_account::<T>(user);
+ Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;
+ Ok(())
+ }
+
/// Switch permission for minting.
///
/// @param mode Enable if "true".
fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {
+ self.consume_store_reads_and_writes(1, 1)?;
+
check_is_owner_or_admin(caller, self)?;
let permissions = CollectionPermissions {
mint_mode: Some(mode),
@@ -481,7 +563,7 @@
/// Returns collection type
///
/// @return `Fungible` or `NFT` or `ReFungible`
- fn unique_collection_type(&mut self) -> Result<string> {
+ fn unique_collection_type(&self) -> Result<string> {
let mode = match self.collection.mode {
CollectionMode::Fungible(_) => "Fungible",
CollectionMode::NFT => "NFT",
@@ -490,11 +572,23 @@
Ok(mode.into())
}
+ /// Get collection owner.
+ ///
+ /// @return Tuble with sponsor address and his substrate mirror.
+ /// If address is canonical then substrate mirror is zero and vice versa.
+ fn collection_owner(&self) -> Result<(address, uint256)> {
+ Ok(convert_cross_account_to_tuple::<T>(
+ &T::CrossAccountId::from_sub(self.owner.clone()),
+ ))
+ }
+
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
/// @param newOwner new owner account
fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {
+ self.consume_store_writes(1)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let new_owner = T::CrossAccountId::from_eth(new_owner);
self.set_owner_internal(caller, new_owner)
@@ -506,13 +600,25 @@
/// @dev Owner can be changed only by current owner
/// @param newOwner new owner substrate account
fn set_owner_substrate(&mut self, caller: caller, new_owner: uint256) -> Result<void> {
+ self.consume_store_writes(1)?;
+
let caller = T::CrossAccountId::from_eth(caller);
let new_owner = convert_uint256_to_cross_account::<T>(new_owner);
self.set_owner_internal(caller, new_owner)
.map_err(dispatch_to_evm::<T>)
}
+
+ // TODO: need implement AbiWriter for &Vec<T>
+ // fn collection_admins(&self) -> Result<Vec<(address, uint256)>> {
+ // let result = pallet_common::IsAdmin::<T>::iter_prefix((self.id,))
+ // .map(|(admin, _)| pallet_common::eth::convert_cross_account_to_tuple::<T>(&admin))
+ // .collect();
+ // Ok(result)
+ // }
}
+/// ### Note
+/// Do not forget to add: `self.consume_store_reads(1)?;`
fn check_is_owner_or_admin<T: Config>(
caller: caller,
collection: &CollectionHandle<T>,
@@ -524,9 +630,9 @@
Ok(caller)
}
+/// ### Note
+/// Do not forget to add: `self.consume_store_writes(1)?;`
fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {
- // TODO possibly delete for the lack of transaction
- collection.consume_store_writes(1)?;
collection
.check_is_internal()
.map_err(dispatch_to_evm::<T>)?;
pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -16,7 +16,7 @@
//! The module contains a number of functions for converting and checking ethereum identifiers.
-use evm_coder::types::uint256;
+use evm_coder::types::{uint256, address};
pub use pallet_evm::account::{Config, CrossAccountId};
use sp_core::H160;
use up_data_structs::CollectionId;
@@ -69,3 +69,19 @@
let account_id = T::AccountId::from(new_admin_arr);
T::CrossAccountId::from_sub(account_id)
}
+
+/// Convert `CrossAccountId` to `(address, uint256)`.
+pub fn convert_cross_account_to_tuple<T: Config>(
+ cross_account_id: &T::CrossAccountId,
+) -> (address, uint256)
+where
+ T::AccountId: AsRef<[u8; 32]>,
+{
+ if cross_account_id.is_canonical_substrate() {
+ let sub = convert_cross_account_to_uint256::<T>(cross_account_id);
+ (Default::default(), sub)
+ } else {
+ let eth = *cross_account_id.as_eth();
+ (eth, Default::default())
+ }
+}
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -112,7 +112,6 @@
RmrkBoundedTheme,
RmrkNftChild,
CollectionPermissions,
- SchemaVersion,
};
pub use pallet::*;
@@ -202,6 +201,21 @@
))
}
+ /// Consume gas for reading and writing.
+ pub fn consume_store_reads_and_writes(
+ &self,
+ reads: u64,
+ writes: u64,
+ ) -> evm_coder::execution::Result<()> {
+ let weight = <T as frame_system::Config>::DbWeight::get();
+ let reads = weight.read.saturating_mul(reads);
+ let writes = weight.read.saturating_mul(writes);
+ self.recorder
+ .consume_gas(T::GasWeightMapping::weight_to_gas(
+ reads.saturating_add(writes),
+ ))
+ }
+
/// Save collection to storage.
pub fn save(&self) -> DispatchResult {
<CollectionById<T>>::insert(self.id, &self.collection);
@@ -310,6 +324,8 @@
}
/// Changes collection owner to another account
+ /// #### Store read/writes
+ /// 1 writes
fn set_owner_internal(
&mut self,
caller: T::CrossAccountId,
@@ -1292,6 +1308,8 @@
}
/// Toggle `user` participation in the `collection`'s allow list.
+ /// #### Store read/writes
+ /// 1 writes
pub fn toggle_allowlist(
collection: &CollectionHandle<T>,
sender: &T::CrossAccountId,
@@ -1312,6 +1330,8 @@
}
/// Toggle `user` participation in the `collection`'s admin list.
+ /// #### Store read/writes
+ /// 2 writes
pub fn toggle_admin(
collection: &CollectionHandle<T>,
sender: &T::CrossAccountId,
pallets/evm-contract-helpers/src/eth.rsdiffbeforeafterboth--- a/pallets/evm-contract-helpers/src/eth.rs
+++ b/pallets/evm-contract-helpers/src/eth.rs
@@ -172,14 +172,9 @@
fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {
let sponsor =
Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;
- let result: (address, uint256) = if sponsor.is_canonical_substrate() {
- let sponsor = pallet_common::eth::convert_cross_account_to_uint256::<T>(&sponsor);
- (Default::default(), sponsor)
- } else {
- let sponsor = *sponsor.as_eth();
- (sponsor, Default::default())
- };
- Ok(result)
+ Ok(pallet_common::eth::convert_cross_account_to_tuple::<T>(
+ &sponsor,
+ ))
}
/// Check tat contract has confirmed sponsor.
pallets/fungible/src/stubs/UniqueFungible.rawdiffbeforeafterbothbinary blob — no preview
pallets/fungible/src/stubs/UniqueFungible.soldiffbeforeafterboth--- a/pallets/fungible/src/stubs/UniqueFungible.sol
+++ b/pallets/fungible/src/stubs/UniqueFungible.sol
@@ -22,7 +22,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xe54be640
+/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0
contract Collection is Dummy, ERC165 {
/// Set collection property.
///
@@ -255,6 +255,18 @@
dummy = 0;
}
+ /// Checks that user allowed to operate with collection.
+ ///
+ /// @param user User address to check.
+ /// @dev EVM selector for this function is: 0xd63a8e11,
+ /// or in textual repr: allowed(address)
+ function allowed(address user) public view returns (bool) {
+ require(false, stub_error);
+ user;
+ dummy;
+ return false;
+ }
+
/// Add the user to the allowed list.
///
/// @param user Address of a trusted user.
@@ -266,6 +278,17 @@
dummy = 0;
}
+ /// Add substrate user to allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xd06ad267,
+ /// or in textual repr: addToCollectionAllowListSubstrate(uint256)
+ function addToCollectionAllowListSubstrate(uint256 user) public {
+ require(false, stub_error);
+ user;
+ dummy = 0;
+ }
+
/// Remove the user from the allowed list.
///
/// @param user Address of a removed user.
@@ -277,6 +300,17 @@
dummy = 0;
}
+ /// Remove substrate user from allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xa31913ed,
+ /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256)
+ function removeFromCollectionAllowListSubstrate(uint256 user) public {
+ require(false, stub_error);
+ user;
+ dummy = 0;
+ }
+
/// Switch permission for minting.
///
/// @param mode Enable if "true".
@@ -325,6 +359,18 @@
return "";
}
+ /// Get collection owner.
+ ///
+ /// @return Tuble with sponsor address and his substrate mirror.
+ /// If address is canonical then substrate mirror is zero and vice versa.
+ /// @dev EVM selector for this function is: 0xdf727d3b,
+ /// or in textual repr: collectionOwner()
+ function collectionOwner() public view returns (Tuple6 memory) {
+ require(false, stub_error);
+ dummy;
+ return Tuple6(0x0000000000000000000000000000000000000000, 0);
+ }
+
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
pallets/nonfungible/src/stubs/UniqueNFT.rawdiffbeforeafterbothbinary blob — no preview
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -99,7 +99,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xe54be640
+/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0
contract Collection is Dummy, ERC165 {
/// Set collection property.
///
@@ -332,6 +332,18 @@
dummy = 0;
}
+ /// Checks that user allowed to operate with collection.
+ ///
+ /// @param user User address to check.
+ /// @dev EVM selector for this function is: 0xd63a8e11,
+ /// or in textual repr: allowed(address)
+ function allowed(address user) public view returns (bool) {
+ require(false, stub_error);
+ user;
+ dummy;
+ return false;
+ }
+
/// Add the user to the allowed list.
///
/// @param user Address of a trusted user.
@@ -343,6 +355,17 @@
dummy = 0;
}
+ /// Add substrate user to allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xd06ad267,
+ /// or in textual repr: addToCollectionAllowListSubstrate(uint256)
+ function addToCollectionAllowListSubstrate(uint256 user) public {
+ require(false, stub_error);
+ user;
+ dummy = 0;
+ }
+
/// Remove the user from the allowed list.
///
/// @param user Address of a removed user.
@@ -354,6 +377,17 @@
dummy = 0;
}
+ /// Remove substrate user from allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xa31913ed,
+ /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256)
+ function removeFromCollectionAllowListSubstrate(uint256 user) public {
+ require(false, stub_error);
+ user;
+ dummy = 0;
+ }
+
/// Switch permission for minting.
///
/// @param mode Enable if "true".
@@ -402,6 +436,18 @@
return "";
}
+ /// Get collection owner.
+ ///
+ /// @return Tuble with sponsor address and his substrate mirror.
+ /// If address is canonical then substrate mirror is zero and vice versa.
+ /// @dev EVM selector for this function is: 0xdf727d3b,
+ /// or in textual repr: collectionOwner()
+ function collectionOwner() public view returns (Tuple17 memory) {
+ require(false, stub_error);
+ dummy;
+ return Tuple17(0x0000000000000000000000000000000000000000, 0);
+ }
+
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
pallets/refungible/src/stubs/UniqueRefungible.rawdiffbeforeafterbothbinary blob — no preview
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungible.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungible.sol
@@ -99,7 +99,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xe54be640
+/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0
contract Collection is Dummy, ERC165 {
/// Set collection property.
///
@@ -332,6 +332,18 @@
dummy = 0;
}
+ /// Checks that user allowed to operate with collection.
+ ///
+ /// @param user User address to check.
+ /// @dev EVM selector for this function is: 0xd63a8e11,
+ /// or in textual repr: allowed(address)
+ function allowed(address user) public view returns (bool) {
+ require(false, stub_error);
+ user;
+ dummy;
+ return false;
+ }
+
/// Add the user to the allowed list.
///
/// @param user Address of a trusted user.
@@ -343,6 +355,17 @@
dummy = 0;
}
+ /// Add substrate user to allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xd06ad267,
+ /// or in textual repr: addToCollectionAllowListSubstrate(uint256)
+ function addToCollectionAllowListSubstrate(uint256 user) public {
+ require(false, stub_error);
+ user;
+ dummy = 0;
+ }
+
/// Remove the user from the allowed list.
///
/// @param user Address of a removed user.
@@ -354,6 +377,17 @@
dummy = 0;
}
+ /// Remove substrate user from allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xa31913ed,
+ /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256)
+ function removeFromCollectionAllowListSubstrate(uint256 user) public {
+ require(false, stub_error);
+ user;
+ dummy = 0;
+ }
+
/// Switch permission for minting.
///
/// @param mode Enable if "true".
@@ -402,6 +436,18 @@
return "";
}
+ /// Get collection owner.
+ ///
+ /// @return Tuble with sponsor address and his substrate mirror.
+ /// If address is canonical then substrate mirror is zero and vice versa.
+ /// @dev EVM selector for this function is: 0xdf727d3b,
+ /// or in textual repr: collectionOwner()
+ function collectionOwner() public view returns (Tuple17 memory) {
+ require(false, stub_error);
+ dummy;
+ return Tuple17(0x0000000000000000000000000000000000000000, 0);
+ }
+
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
tests/src/eth/allowlist.test.tsdiffbeforeafterboth--- a/tests/src/eth/allowlist.test.ts
+++ b/tests/src/eth/allowlist.test.ts
@@ -14,10 +14,22 @@
// 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 {IKeyringPair} from '@polkadot/types/types';
import {expect} from 'chai';
-import {contractHelpers, createEthAccountWithBalance, deployFlipper, itWeb3} from './util/helpers';
+import {isAllowlisted, normalizeAccountId} from '../util/helpers';
+import {
+ contractHelpers,
+ createEthAccount,
+ createEthAccountWithBalance,
+ deployFlipper,
+ evmCollection,
+ evmCollectionHelpers,
+ getCollectionAddressFromResult,
+ itWeb3,
+} from './util/helpers';
+import {itEth, usingEthPlaygrounds} from './util/playgrounds';
-describe('EVM allowlist', () => {
+describe('EVM contract allowlist', () => {
itWeb3('Contract allowlist can be toggled', async ({api, web3, privateKeyWrapper}) => {
const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
const flipper = await deployFlipper(web3, owner);
@@ -58,3 +70,79 @@
expect(await flipper.methods.getValue().call()).to.be.false;
});
});
+
+describe('EVM collection allowlist', () => {
+ let donor: IKeyringPair;
+
+ before(async function() {
+ await usingEthPlaygrounds(async (_helper, privateKey) => {
+ donor = privateKey('//Alice');
+ });
+ });
+
+ itEth('Collection allowlist can be added and removed by [eth] address', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const user = helper.eth.createAccount();
+
+ const {collectionAddress} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C');
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner);
+
+ expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false;
+ await collectionEvm.methods.addToCollectionAllowList(user).send({from: owner});
+ expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.true;
+
+ await collectionEvm.methods.removeFromCollectionAllowList(user).send({from: owner});
+ expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false;
+ });
+
+ itEth('Collection allowlist can be added and removed by [sub] address', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const user = donor;
+
+ const {collectionAddress, collectionId} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C');
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner);
+
+ expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false;
+ await collectionEvm.methods.addToCollectionAllowListSubstrate(user.addressRaw).send({from: owner});
+ expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.true;
+
+ await collectionEvm.methods.removeFromCollectionAllowListSubstrate(user.addressRaw).send({from: owner});
+ expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false;
+ });
+
+ itEth('Collection allowlist can not be add and remove [eth] address by not owner', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const notOwner = await helper.eth.createAccountWithBalance(donor);
+ const user = helper.eth.createAccount();
+
+ const {collectionAddress} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C');
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner);
+
+ expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false;
+ await expect(collectionEvm.methods.addToCollectionAllowList(user).call({from: notOwner})).to.be.rejectedWith('NoPermission');
+ expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false;
+ await collectionEvm.methods.addToCollectionAllowList(user).send({from: owner});
+
+ expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.true;
+ await expect(collectionEvm.methods.removeFromCollectionAllowList(user).call({from: notOwner})).to.be.rejectedWith('NoPermission');
+ expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.true;
+ });
+
+ itEth('Collection allowlist can not be add and remove [sub] address by not owner', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const notOwner = await helper.eth.createAccountWithBalance(donor);
+ const user = donor;
+
+ const {collectionAddress, collectionId} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C');
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner);
+
+ expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false;
+ await expect(collectionEvm.methods.addToCollectionAllowListSubstrate(user.addressRaw).call({from: notOwner})).to.be.rejectedWith('NoPermission');
+ expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false;
+ await collectionEvm.methods.addToCollectionAllowListSubstrate(user.addressRaw).send({from: owner});
+
+ expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.true;
+ await expect(collectionEvm.methods.removeFromCollectionAllowListSubstrate(user.addressRaw).call({from: notOwner})).to.be.rejectedWith('NoPermission');
+ expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.true;
+ });
+});
tests/src/eth/api/UniqueFungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueFungible.sol
+++ b/tests/src/eth/api/UniqueFungible.sol
@@ -13,7 +13,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xe54be640
+/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0
interface Collection is Dummy, ERC165 {
/// Set collection property.
///
@@ -164,6 +164,13 @@
/// or in textual repr: setCollectionAccess(uint8)
function setCollectionAccess(uint8 mode) external;
+ /// Checks that user allowed to operate with collection.
+ ///
+ /// @param user User address to check.
+ /// @dev EVM selector for this function is: 0xd63a8e11,
+ /// or in textual repr: allowed(address)
+ function allowed(address user) external view returns (bool);
+
/// Add the user to the allowed list.
///
/// @param user Address of a trusted user.
@@ -171,6 +178,13 @@
/// or in textual repr: addToCollectionAllowList(address)
function addToCollectionAllowList(address user) external;
+ /// Add substrate user to allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xd06ad267,
+ /// or in textual repr: addToCollectionAllowListSubstrate(uint256)
+ function addToCollectionAllowListSubstrate(uint256 user) external;
+
/// Remove the user from the allowed list.
///
/// @param user Address of a removed user.
@@ -178,6 +192,13 @@
/// or in textual repr: removeFromCollectionAllowList(address)
function removeFromCollectionAllowList(address user) external;
+ /// Remove substrate user from allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xa31913ed,
+ /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256)
+ function removeFromCollectionAllowListSubstrate(uint256 user) external;
+
/// Switch permission for minting.
///
/// @param mode Enable if "true".
@@ -208,6 +229,14 @@
/// or in textual repr: uniqueCollectionType()
function uniqueCollectionType() external returns (string memory);
+ /// Get collection owner.
+ ///
+ /// @return Tuble with sponsor address and his substrate mirror.
+ /// If address is canonical then substrate mirror is zero and vice versa.
+ /// @dev EVM selector for this function is: 0xdf727d3b,
+ /// or in textual repr: collectionOwner()
+ function collectionOwner() external view returns (Tuple6 memory);
+
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -65,7 +65,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xe54be640
+/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0
interface Collection is Dummy, ERC165 {
/// Set collection property.
///
@@ -216,6 +216,13 @@
/// or in textual repr: setCollectionAccess(uint8)
function setCollectionAccess(uint8 mode) external;
+ /// Checks that user allowed to operate with collection.
+ ///
+ /// @param user User address to check.
+ /// @dev EVM selector for this function is: 0xd63a8e11,
+ /// or in textual repr: allowed(address)
+ function allowed(address user) external view returns (bool);
+
/// Add the user to the allowed list.
///
/// @param user Address of a trusted user.
@@ -223,6 +230,13 @@
/// or in textual repr: addToCollectionAllowList(address)
function addToCollectionAllowList(address user) external;
+ /// Add substrate user to allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xd06ad267,
+ /// or in textual repr: addToCollectionAllowListSubstrate(uint256)
+ function addToCollectionAllowListSubstrate(uint256 user) external;
+
/// Remove the user from the allowed list.
///
/// @param user Address of a removed user.
@@ -230,6 +244,13 @@
/// or in textual repr: removeFromCollectionAllowList(address)
function removeFromCollectionAllowList(address user) external;
+ /// Remove substrate user from allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xa31913ed,
+ /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256)
+ function removeFromCollectionAllowListSubstrate(uint256 user) external;
+
/// Switch permission for minting.
///
/// @param mode Enable if "true".
@@ -260,6 +281,14 @@
/// or in textual repr: uniqueCollectionType()
function uniqueCollectionType() external returns (string memory);
+ /// Get collection owner.
+ ///
+ /// @return Tuble with sponsor address and his substrate mirror.
+ /// If address is canonical then substrate mirror is zero and vice versa.
+ /// @dev EVM selector for this function is: 0xdf727d3b,
+ /// or in textual repr: collectionOwner()
+ function collectionOwner() external view returns (Tuple17 memory);
+
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -65,7 +65,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xe54be640
+/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0
interface Collection is Dummy, ERC165 {
/// Set collection property.
///
@@ -216,6 +216,13 @@
/// or in textual repr: setCollectionAccess(uint8)
function setCollectionAccess(uint8 mode) external;
+ /// Checks that user allowed to operate with collection.
+ ///
+ /// @param user User address to check.
+ /// @dev EVM selector for this function is: 0xd63a8e11,
+ /// or in textual repr: allowed(address)
+ function allowed(address user) external view returns (bool);
+
/// Add the user to the allowed list.
///
/// @param user Address of a trusted user.
@@ -223,6 +230,13 @@
/// or in textual repr: addToCollectionAllowList(address)
function addToCollectionAllowList(address user) external;
+ /// Add substrate user to allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xd06ad267,
+ /// or in textual repr: addToCollectionAllowListSubstrate(uint256)
+ function addToCollectionAllowListSubstrate(uint256 user) external;
+
/// Remove the user from the allowed list.
///
/// @param user Address of a removed user.
@@ -230,6 +244,13 @@
/// or in textual repr: removeFromCollectionAllowList(address)
function removeFromCollectionAllowList(address user) external;
+ /// Remove substrate user from allowed list.
+ ///
+ /// @param user User substrate address.
+ /// @dev EVM selector for this function is: 0xa31913ed,
+ /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256)
+ function removeFromCollectionAllowListSubstrate(uint256 user) external;
+
/// Switch permission for minting.
///
/// @param mode Enable if "true".
@@ -260,6 +281,14 @@
/// or in textual repr: uniqueCollectionType()
function uniqueCollectionType() external returns (string memory);
+ /// Get collection owner.
+ ///
+ /// @return Tuble with sponsor address and his substrate mirror.
+ /// If address is canonical then substrate mirror is zero and vice versa.
+ /// @dev EVM selector for this function is: 0xdf727d3b,
+ /// or in textual repr: collectionOwner()
+ function collectionOwner() external view returns (Tuple17 memory);
+
/// Changes collection owner to another account
///
/// @dev Owner can be changed only by current owner
tests/src/eth/fungibleAbi.jsondiffbeforeafterboth--- a/tests/src/eth/fungibleAbi.json
+++ b/tests/src/eth/fungibleAbi.json
@@ -78,6 +78,15 @@
},
{
"inputs": [
+ { "internalType": "uint256", "name": "user", "type": "uint256" }
+ ],
+ "name": "addToCollectionAllowListSubstrate",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
{ "internalType": "address", "name": "owner", "type": "address" },
{ "internalType": "address", "name": "spender", "type": "address" }
],
@@ -88,6 +97,15 @@
},
{
"inputs": [
+ { "internalType": "address", "name": "user", "type": "address" }
+ ],
+ "name": "allowed",
+ "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [
{ "internalType": "address", "name": "spender", "type": "address" },
{ "internalType": "uint256", "name": "amount", "type": "uint256" }
],
@@ -116,6 +134,23 @@
"type": "function"
},
{
+ "inputs": [],
+ "name": "collectionOwner",
+ "outputs": [
+ {
+ "components": [
+ { "internalType": "address", "name": "field_0", "type": "address" },
+ { "internalType": "uint256", "name": "field_1", "type": "uint256" }
+ ],
+ "internalType": "struct Tuple6",
+ "name": "",
+ "type": "tuple"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
"inputs": [{ "internalType": "string", "name": "key", "type": "string" }],
"name": "collectionProperty",
"outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }],
@@ -261,6 +296,15 @@
"type": "function"
},
{
+ "inputs": [
+ { "internalType": "uint256", "name": "user", "type": "uint256" }
+ ],
+ "name": "removeFromCollectionAllowListSubstrate",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
"inputs": [{ "internalType": "uint8", "name": "mode", "type": "uint8" }],
"name": "setCollectionAccess",
"outputs": [],
tests/src/eth/nonFungibleAbi.jsondiffbeforeafterboth--- a/tests/src/eth/nonFungibleAbi.json
+++ b/tests/src/eth/nonFungibleAbi.json
@@ -109,6 +109,24 @@
},
{
"inputs": [
+ { "internalType": "uint256", "name": "user", "type": "uint256" }
+ ],
+ "name": "addToCollectionAllowListSubstrate",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ { "internalType": "address", "name": "user", "type": "address" }
+ ],
+ "name": "allowed",
+ "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [
{ "internalType": "address", "name": "approved", "type": "address" },
{ "internalType": "uint256", "name": "tokenId", "type": "uint256" }
],
@@ -146,6 +164,23 @@
"type": "function"
},
{
+ "inputs": [],
+ "name": "collectionOwner",
+ "outputs": [
+ {
+ "components": [
+ { "internalType": "address", "name": "field_0", "type": "address" },
+ { "internalType": "uint256", "name": "field_1", "type": "uint256" }
+ ],
+ "internalType": "struct Tuple17",
+ "name": "",
+ "type": "tuple"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
"inputs": [{ "internalType": "string", "name": "key", "type": "string" }],
"name": "collectionProperty",
"outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }],
@@ -376,6 +411,15 @@
},
{
"inputs": [
+ { "internalType": "uint256", "name": "user", "type": "uint256" }
+ ],
+ "name": "removeFromCollectionAllowListSubstrate",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
{ "internalType": "address", "name": "from", "type": "address" },
{ "internalType": "address", "name": "to", "type": "address" },
{ "internalType": "uint256", "name": "tokenId", "type": "uint256" }
tests/src/eth/reFungibleAbi.jsondiffbeforeafterboth--- a/tests/src/eth/reFungibleAbi.json
+++ b/tests/src/eth/reFungibleAbi.json
@@ -109,6 +109,24 @@
},
{
"inputs": [
+ { "internalType": "uint256", "name": "user", "type": "uint256" }
+ ],
+ "name": "addToCollectionAllowListSubstrate",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ { "internalType": "address", "name": "user", "type": "address" }
+ ],
+ "name": "allowed",
+ "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [
{ "internalType": "address", "name": "approved", "type": "address" },
{ "internalType": "uint256", "name": "tokenId", "type": "uint256" }
],
@@ -146,6 +164,23 @@
"type": "function"
},
{
+ "inputs": [],
+ "name": "collectionOwner",
+ "outputs": [
+ {
+ "components": [
+ { "internalType": "address", "name": "field_0", "type": "address" },
+ { "internalType": "uint256", "name": "field_1", "type": "uint256" }
+ ],
+ "internalType": "struct Tuple17",
+ "name": "",
+ "type": "tuple"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
"inputs": [{ "internalType": "string", "name": "key", "type": "string" }],
"name": "collectionProperty",
"outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }],
@@ -376,6 +411,15 @@
},
{
"inputs": [
+ { "internalType": "uint256", "name": "user", "type": "uint256" }
+ ],
+ "name": "removeFromCollectionAllowListSubstrate",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
{ "internalType": "address", "name": "from", "type": "address" },
{ "internalType": "address", "name": "to", "type": "address" },
{ "internalType": "uint256", "name": "tokenId", "type": "uint256" }
tests/src/util/helpers.tsdiffbeforeafterboth--- a/tests/src/util/helpers.ts
+++ b/tests/src/util/helpers.ts
@@ -1651,7 +1651,7 @@
});
}
-export async function isAllowlisted(api: ApiPromise, collectionId: number, address: string | CrossAccountId) {
+export async function isAllowlisted(api: ApiPromise, collectionId: number, address: string | CrossAccountId | IKeyringPair) {
return (await api.rpc.unique.allowed(collectionId, normalizeAccountId(address))).toJSON();
}
tests/src/util/playgrounds/unique.tsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314export const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};2021const nesting = {22 toChecksumAddress(address: string): string {23 if (typeof address === 'undefined') return '';2425 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2627 address = address.toLowerCase().replace(/^0x/i,'');28 const addressHash = keccakAsHex(address).replace(/^0x/i,'');29 const checksumAddress = ['0x'];3031 for (let i = 0; i < address.length; i++) {32 // If ith character is 8 to f then make it uppercase33 if (parseInt(addressHash[i], 16) > 7) {34 checksumAddress.push(address[i].toUpperCase());35 } else {36 checksumAddress.push(address[i]);37 }38 }39 return checksumAddress.join('');40 },41 tokenIdToAddress(collectionId: number, tokenId: number) {42 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);43 },44};4546class UniqueUtil {47 static transactionStatus = {48 NOT_READY: 'NotReady',49 FAIL: 'Fail',50 SUCCESS: 'Success',51 };5253 static chainLogType = {54 EXTRINSIC: 'extrinsic',55 RPC: 'rpc',56 };5758 static getNestingTokenAddress(collectionId: number, tokenId: number) {59 return nesting.tokenIdToAddress(collectionId, tokenId);60 }6162 static getDefaultLogger(): ILogger {63 return {64 log(msg: any, level = 'INFO') {65 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));66 },67 level: {68 ERROR: 'ERROR',69 WARNING: 'WARNING',70 INFO: 'INFO',71 },72 };73 }7475 static vec2str(arr: string[] | number[]) {76 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');77 }7879 static str2vec(string: string) {80 if (typeof string !== 'string') return string;81 return Array.from(string).map(x => x.charCodeAt(0));82 }8384 static fromSeed(seed: string, ss58Format = 42) {85 const keyring = new Keyring({type: 'sr25519', ss58Format});86 return keyring.addFromUri(seed);87 }8889 static normalizeSubstrateAddress(address: string, ss58Format = 42) {90 return encodeAddress(decodeAddress(address), ss58Format);91 }9293 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult) {94 if (creationResult.status !== this.transactionStatus.SUCCESS) {95 throw Error('Unable to create collection!');96 }9798 let collectionId = null;99 creationResult.result.events.forEach(({event: {data, method, section}}) => {100 if ((section === 'common') && (method === 'CollectionCreated')) {101 collectionId = parseInt(data[0].toString(), 10);102 }103 });104105 if (collectionId === null) {106 throw Error('No CollectionCreated event was found!');107 }108109 return collectionId;110 }111112 static extractTokensFromCreationResult(creationResult: ITransactionResult) {113 if (creationResult.status !== this.transactionStatus.SUCCESS) {114 throw Error('Unable to create tokens!');115 }116 let success = false;117 const tokens = [] as any;118 creationResult.result.events.forEach(({event: {data, method, section}}) => {119 if (method === 'ExtrinsicSuccess') {120 success = true;121 } else if ((section === 'common') && (method === 'ItemCreated')) {122 tokens.push({123 collectionId: parseInt(data[0].toString(), 10),124 tokenId: parseInt(data[1].toString(), 10),125 owner: data[2].toJSON(),126 });127 }128 });129 return {success, tokens};130 }131132 static extractTokensFromBurnResult(burnResult: ITransactionResult) {133 if (burnResult.status !== this.transactionStatus.SUCCESS) {134 throw Error('Unable to burn tokens!');135 }136 let success = false;137 const tokens = [] as any;138 burnResult.result.events.forEach(({event: {data, method, section}}) => {139 if (method === 'ExtrinsicSuccess') {140 success = true;141 } else if ((section === 'common') && (method === 'ItemDestroyed')) {142 tokens.push({143 collectionId: parseInt(data[0].toString(), 10),144 tokenId: parseInt(data[1].toString(), 10),145 owner: data[2].toJSON(),146 });147 }148 });149 return {success, tokens};150 }151152 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string) {153 let eventId = null;154 events.forEach(({event: {data, method, section}}) => {155 if ((section === expectedSection) && (method === expectedMethod)) {156 eventId = parseInt(data[0].toString(), 10);157 }158 });159160 if (eventId === null) {161 throw Error(`No ${expectedMethod} event was found!`);162 }163 return eventId === collectionId;164 }165166 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {167 const normalizeAddress = (address: string | ICrossAccountId) => {168 if(typeof address === 'string') return address;169 const obj = {} as any;170 Object.keys(address).forEach(k => {171 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];172 });173 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};174 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};175 return address;176 };177 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;178 events.forEach(({event: {data, method, section}}) => {179 if ((section === 'common') && (method === 'Transfer')) {180 const hData = (data as any).toJSON();181 transfer = {182 collectionId: hData[0],183 tokenId: hData[1],184 from: normalizeAddress(hData[2]),185 to: normalizeAddress(hData[3]),186 amount: BigInt(hData[4]),187 };188 }189 });190 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;191 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);193 isSuccess = isSuccess && amount === transfer.amount;194 return isSuccess;195 }196}197198199class ChainHelperBase {200 transactionStatus = UniqueUtil.transactionStatus;201 chainLogType = UniqueUtil.chainLogType;202 util: typeof UniqueUtil;203 logger: ILogger;204 api: ApiPromise | null;205 forcedNetwork: TUniqueNetworks | null;206 network: TUniqueNetworks | null;207 chainLog: IUniqueHelperLog[];208209 constructor(logger?: ILogger) {210 this.util = UniqueUtil;211 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();212 this.logger = logger;213 this.api = null;214 this.forcedNetwork = null;215 this.network = null;216 this.chainLog = [];217 }218219 clearChainLog(): void {220 this.chainLog = [];221 }222223 forceNetwork(value: TUniqueNetworks): void {224 this.forcedNetwork = value;225 }226227 async connect(wsEndpoint: string, listeners?: IApiListeners) {228 if (this.api !== null) throw Error('Already connected');229 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);230 this.api = api;231 this.network = network;232 }233234 async disconnect() {235 if (this.api === null) return;236 await this.api.disconnect();237 this.api = null;238 this.network = null;239 }240241 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {242 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;243 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;244 return 'opal';245 }246247 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {248 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});249 await api.isReady;250251 const network = await this.detectNetwork(api);252253 await api.disconnect();254255 return network;256 }257258 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{259 api: ApiPromise;260 network: TUniqueNetworks;261 }> {262 if(typeof network === 'undefined' || network === null) network = 'opal';263 const supportedRPC = {264 opal: {265 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,266 },267 quartz: {268 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,269 },270 unique: {271 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,272 },273 };274 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);275 const rpc = supportedRPC[network];276277 // TODO: investigate how to replace rpc in runtime278 // api._rpcCore.addUserInterfaces(rpc);279280 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});281282 await api.isReadyOrError;283284 if (typeof listeners === 'undefined') listeners = {};285 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {286 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;287 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);288 }289290 return {api, network};291 }292293 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {294 const {events, status} = data;295 if (status.isReady) {296 return this.transactionStatus.NOT_READY;297 }298 if (status.isBroadcast) {299 return this.transactionStatus.NOT_READY;300 }301 if (status.isInBlock || status.isFinalized) {302 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');303 if (errors.length > 0) {304 return this.transactionStatus.FAIL;305 }306 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {307 return this.transactionStatus.SUCCESS;308 }309 }310311 return this.transactionStatus.FAIL;312 }313314 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {315 const sign = (callback: any) => {316 if(options !== null) return transaction.signAndSend(sender, options, callback);317 return transaction.signAndSend(sender, callback);318 };319 // eslint-disable-next-line no-async-promise-executor320 return new Promise(async (resolve, reject) => {321 try {322 const unsub = await sign((result: any) => {323 const status = this.getTransactionStatus(result);324325 if (status === this.transactionStatus.SUCCESS) {326 this.logger.log(`${label} successful`);327 unsub();328 resolve({result, status});329 } else if (status === this.transactionStatus.FAIL) {330 let moduleError = null;331332 if (result.hasOwnProperty('dispatchError')) {333 const dispatchError = result['dispatchError'];334335 if (dispatchError && dispatchError.isModule) {336 const modErr = dispatchError.asModule;337 const errorMeta = dispatchError.registry.findMetaError(modErr);338339 moduleError = `${errorMeta.section}.${errorMeta.name}`;340 }341 else {342 this.logger.log(result, this.logger.level.ERROR);343 }344 }345346 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);347 unsub();348 reject({status, moduleError, result});349 }350 });351 } catch (e) {352 this.logger.log(e, this.logger.level.ERROR);353 reject(e);354 }355 });356 }357358 constructApiCall(apiCall: string, params: any[]) {359 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);360 let call = this.api as any;361 for(const part of apiCall.slice(4).split('.')) {362 call = call[part];363 }364 return call(...params);365 }366367 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false/*, failureMessage='expected success'*/) {368 if(this.api === null) throw Error('API not initialized');369 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);370371 const startTime = (new Date()).getTime();372 let result: ITransactionResult;373 let events = [];374 try {375 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;376 events = result.result.events.map((x: any) => x.toHuman());377 }378 catch(e) {379 if(!(e as object).hasOwnProperty('status')) throw e;380 result = e as ITransactionResult;381 }382383 const endTime = (new Date()).getTime();384385 const log = {386 executedAt: endTime,387 executionTime: endTime - startTime,388 type: this.chainLogType.EXTRINSIC,389 status: result.status,390 call: extrinsic,391 signer: this.getSignerAddress(sender),392 params,393 } as IUniqueHelperLog;394395 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;396 if(events.length > 0) log.events = events;397398 this.chainLog.push(log);399400 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);401 return result;402 }403404 async callRpc(rpc: string, params?: any[]) {405 if(typeof params === 'undefined') params = [];406 if(this.api === null) throw Error('API not initialized');407 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);408409 const startTime = (new Date()).getTime();410 let result;411 let error = null;412 const log = {413 type: this.chainLogType.RPC,414 call: rpc,415 params,416 } as IUniqueHelperLog;417418 try {419 result = await this.constructApiCall(rpc, params);420 }421 catch(e) {422 error = e;423 }424425 const endTime = (new Date()).getTime();426427 log.executedAt = endTime;428 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';429 log.executionTime = endTime - startTime;430431 this.chainLog.push(log);432433 if(error !== null) throw error;434435 return result;436 }437438 getSignerAddress(signer: IKeyringPair | string): string {439 if(typeof signer === 'string') return signer;440 return signer.address;441 }442443 fetchAllPalletNames(): string[] {444 if(this.api === null) throw Error('API not initialized');445 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());446 }447448 fetchMissingPalletNames(requiredPallets: string[]): string[] {449 const palletNames = this.fetchAllPalletNames();450 return requiredPallets.filter(p => !palletNames.includes(p));451 }452}453454455class HelperGroup {456 helper: UniqueHelper;457458 constructor(uniqueHelper: UniqueHelper) {459 this.helper = uniqueHelper;460 }461}462463464class CollectionGroup extends HelperGroup {465 /**466 * Get number of blocks when sponsored transaction is available.467 *468 * @param collectionId ID of collection469 * @param tokenId ID of token470 * @param addressObj address for which the sponsorship is checked471 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});472 * @returns number of blocks or null if sponsorship hasn't been set473 */474 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {475 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();476 }477478 /**479 * Get the number of created collections.480 *481 * @returns number of created collections482 */483 async getTotalCount(): Promise<number> {484 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();485 }486487 /**488 * Get information about the collection with additional data,489 * including the number of tokens it contains, its administrators,490 * the normalized address of the collection's owner, and decoded name and description.491 *492 * @param collectionId ID of collection493 * @example await getData(2)494 * @returns collection information object495 */496 async getData(collectionId: number): Promise<{497 id: number;498 name: string;499 description: string;500 tokensCount: number;501 admins: ICrossAccountId[];502 normalizedOwner: TSubstrateAccount;503 raw: any504 } | null> {505 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);506 const humanCollection = collection.toHuman(), collectionData = {507 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],508 raw: humanCollection,509 } as any, jsonCollection = collection.toJSON();510 if (humanCollection === null) return null;511 collectionData.raw.limits = jsonCollection.limits;512 collectionData.raw.permissions = jsonCollection.permissions;513 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);514 for (const key of ['name', 'description']) {515 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);516 }517518 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))519 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)520 : 0;521 collectionData.admins = await this.getAdmins(collectionId);522523 return collectionData;524 }525526 /**527 * Get the addresses of the collection's administrators, optionally normalized.528 *529 * @param collectionId ID of collection530 * @param normalize whether to normalize the addresses to the default ss58 format531 * @example await getAdmins(1)532 * @returns array of administrators533 */534 async getAdmins(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {535 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();536537 return normalize538 ? admins.map((address: any) => {539 return address.Substrate540 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}541 : address;542 })543 : admins;544 }545546 /**547 * Get the addresses added to the collection allow-list, optionally normalized.548 * @param collectionId ID of collection549 * @param normalize whether to normalize the addresses to the default ss58 format550 * @example await getAllowList(1)551 * @returns array of allow-listed addresses552 */553 async getAllowList(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {554 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();555 return normalize556 ? allowListed.map((address: any) => {557 return address.Substrate558 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}559 : address;560 })561 : allowListed;562 }563564 /**565 * Get the effective limits of the collection instead of null for default values566 *567 * @param collectionId ID of collection568 * @example await getEffectiveLimits(2)569 * @returns object of collection limits570 */571 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {572 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();573 }574575 /**576 * Burns the collection if the signer has sufficient permissions and collection is empty.577 *578 * @param signer keyring of signer579 * @param collectionId ID of collection580 * @example await helper.collection.burn(aliceKeyring, 3);581 * @returns ```true``` if extrinsic success, otherwise ```false```582 */583 async burn(signer: TSigner, collectionId: number): Promise<boolean> {584 const result = await this.helper.executeExtrinsic(585 signer,586 'api.tx.unique.destroyCollection', [collectionId],587 true,588 );589590 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');591 }592593 /**594 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.595 *596 * @param signer keyring of signer597 * @param collectionId ID of collection598 * @param sponsorAddress Sponsor substrate address599 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")600 * @returns ```true``` if extrinsic success, otherwise ```false```601 */602 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {603 const result = await this.helper.executeExtrinsic(604 signer,605 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],606 true,607 );608609 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');610 }611612 /**613 * Confirms consent to sponsor the collection on behalf of the signer.614 *615 * @param signer keyring of signer616 * @param collectionId ID of collection617 * @example confirmSponsorship(aliceKeyring, 10)618 * @returns ```true``` if extrinsic success, otherwise ```false```619 */620 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {621 const result = await this.helper.executeExtrinsic(622 signer,623 'api.tx.unique.confirmSponsorship', [collectionId],624 true,625 );626627 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');628 }629630 /**631 * Removes the sponsor of a collection, regardless if it consented or not.632 *633 * @param signer keyring of signer634 * @param collectionId ID of collection635 * @example removeSponsor(aliceKeyring, 10)636 * @returns ```true``` if extrinsic success, otherwise ```false```637 */638 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {639 const result = await this.helper.executeExtrinsic(640 signer,641 'api.tx.unique.removeCollectionSponsor', [collectionId],642 true,643 );644645 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');646 }647648 /**649 * Sets the limits of the collection. At least one limit must be specified for a correct call.650 *651 * @param signer keyring of signer652 * @param collectionId ID of collection653 * @param limits collection limits object654 * @example655 * await setLimits(656 * aliceKeyring,657 * 10,658 * {659 * sponsorTransferTimeout: 0,660 * ownerCanDestroy: false661 * }662 * )663 * @returns ```true``` if extrinsic success, otherwise ```false```664 */665 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {666 const result = await this.helper.executeExtrinsic(667 signer,668 'api.tx.unique.setCollectionLimits', [collectionId, limits],669 true,670 );671672 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');673 }674675 /**676 * Changes the owner of the collection to the new Substrate address.677 *678 * @param signer keyring of signer679 * @param collectionId ID of collection680 * @param ownerAddress substrate address of new owner681 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")682 * @returns ```true``` if extrinsic success, otherwise ```false```683 */684 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {685 const result = await this.helper.executeExtrinsic(686 signer,687 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],688 true,689 );690691 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');692 }693694 /**695 * Adds a collection administrator.696 *697 * @param signer keyring of signer698 * @param collectionId ID of collection699 * @param adminAddressObj Administrator address (substrate or ethereum)700 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})701 * @returns ```true``` if extrinsic success, otherwise ```false```702 */703 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {704 const result = await this.helper.executeExtrinsic(705 signer,706 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],707 true,708 );709710 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');711 }712713 /**714 * Removes a collection administrator.715 *716 * @param signer keyring of signer717 * @param collectionId ID of collection718 * @param adminAddressObj Administrator address (substrate or ethereum)719 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})720 * @returns ```true``` if extrinsic success, otherwise ```false```721 */722 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {723 const result = await this.helper.executeExtrinsic(724 signer,725 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],726 true,727 );728729 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');730 }731732 /**733 * Adds an address to allow list734 * @param signer keyring of signer735 * @param collectionId ID of collection736 * @param addressObj address to add to the allow list737 * @returns ```true``` if extrinsic success, otherwise ```false```738 */739 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {740 const result = await this.helper.executeExtrinsic(741 signer,742 'api.tx.unique.addToAllowList', [collectionId, addressObj],743 true,744 );745746 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');747 }748749 /**750 * Removes an address from allow list751 *752 * @param signer keyring of signer753 * @param collectionId ID of collection754 * @param addressObj address to remove from the allow list755 * @returns ```true``` if extrinsic success, otherwise ```false```756 */757 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {758 const result = await this.helper.executeExtrinsic(759 signer,760 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],761 true,762 );763764 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');765 }766767 /**768 * Sets onchain permissions for selected collection.769 *770 * @param signer keyring of signer771 * @param collectionId ID of collection772 * @param permissions collection permissions object773 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});774 * @returns ```true``` if extrinsic success, otherwise ```false```775 */776 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {777 const result = await this.helper.executeExtrinsic(778 signer,779 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],780 true,781 );782783 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');784 }785786 /**787 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.788 *789 * @param signer keyring of signer790 * @param collectionId ID of collection791 * @param permissions nesting permissions object792 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});793 * @returns ```true``` if extrinsic success, otherwise ```false```794 */795 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {796 return await this.setPermissions(signer, collectionId, {nesting: permissions});797 }798799 /**800 * Disables nesting for selected collection.801 *802 * @param signer keyring of signer803 * @param collectionId ID of collection804 * @example disableNesting(aliceKeyring, 10);805 * @returns ```true``` if extrinsic success, otherwise ```false```806 */807 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {808 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});809 }810811 /**812 * Sets onchain properties to the collection.813 *814 * @param signer keyring of signer815 * @param collectionId ID of collection816 * @param properties array of property objects817 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);818 * @returns ```true``` if extrinsic success, otherwise ```false```819 */820 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {821 const result = await this.helper.executeExtrinsic(822 signer,823 'api.tx.unique.setCollectionProperties', [collectionId, properties],824 true,825 );826827 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');828 }829830 /**831 * Deletes onchain properties from the collection.832 *833 * @param signer keyring of signer834 * @param collectionId ID of collection835 * @param propertyKeys array of property keys to delete836 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);837 * @returns ```true``` if extrinsic success, otherwise ```false```838 */839 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {840 const result = await this.helper.executeExtrinsic(841 signer,842 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],843 true,844 );845846 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');847 }848849 /**850 * Changes the owner of the token.851 *852 * @param signer keyring of signer853 * @param collectionId ID of collection854 * @param tokenId ID of token855 * @param addressObj address of a new owner856 * @param amount amount of tokens to be transfered. For NFT must be set to 1n857 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})858 * @returns true if the token success, otherwise false859 */860 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {861 const result = await this.helper.executeExtrinsic(862 signer,863 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],864 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,865 );866867 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);868 }869870 /**871 *872 * Change ownership of a token(s) on behalf of the owner.873 *874 * @param signer keyring of signer875 * @param collectionId ID of collection876 * @param tokenId ID of token877 * @param fromAddressObj address on behalf of which the token will be sent878 * @param toAddressObj new token owner879 * @param amount amount of tokens to be transfered. For NFT must be set to 1n880 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})881 * @returns true if the token success, otherwise false882 */883 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {884 const result = await this.helper.executeExtrinsic(885 signer,886 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],887 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,888 );889 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);890 }891892 /**893 *894 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.895 *896 * @param signer keyring of signer897 * @param collectionId ID of collection898 * @param tokenId ID of token899 * @param amount amount of tokens to be burned. For NFT must be set to 1n900 * @example burnToken(aliceKeyring, 10, 5);901 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```902 */903 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<{904 success: boolean,905 token: number | null906 }> {907 const burnResult = await this.helper.executeExtrinsic(908 signer,909 'api.tx.unique.burnItem', [collectionId, tokenId, amount],910 true, // `Unable to burn token for ${label}`,911 );912 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);913 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');914 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};915 }916917 /**918 * Destroys a concrete instance of NFT on behalf of the owner919 *920 * @param signer keyring of signer921 * @param collectionId ID of collection922 * @param fromAddressObj address on behalf of which the token will be burnt923 * @param tokenId ID of token924 * @param amount amount of tokens to be burned. For NFT must be set to 1n925 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})926 * @returns ```true``` if extrinsic success, otherwise ```false```927 */928 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, amount=1n): Promise<boolean> {929 const burnResult = await this.helper.executeExtrinsic(930 signer,931 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],932 true, // `Unable to burn token from for ${label}`,933 );934 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);935 return burnedTokens.success && burnedTokens.tokens.length > 0;936 }937938 /**939 * Set, change, or remove approved address to transfer the ownership of the NFT.940 *941 * @param signer keyring of signer942 * @param collectionId ID of collection943 * @param tokenId ID of token944 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens945 * @param amount amount of token to be approved. For NFT must be set to 1n946 * @returns ```true``` if extrinsic success, otherwise ```false```947 */948 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {949 const approveResult = await this.helper.executeExtrinsic(950 signer,951 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],952 true, // `Unable to approve token for ${label}`,953 );954955 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');956 }957958 /**959 * Get the amount of token pieces approved to transfer or burn. Normally 0.960 *961 * @param collectionId ID of collection962 * @param tokenId ID of token963 * @param toAccountObj address which is approved to use token pieces964 * @param fromAccountObj address which may have allowed the use of its owned tokens965 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})966 * @returns number of approved to transfer pieces967 */968 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {969 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();970 }971972 /**973 * Get the last created token ID in a collection974 *975 * @param collectionId ID of collection976 * @example getLastTokenId(10);977 * @returns id of the last created token978 */979 async getLastTokenId(collectionId: number): Promise<number> {980 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();981 }982983 /**984 * Check if token exists985 *986 * @param collectionId ID of collection987 * @param tokenId ID of token988 * @example isTokenExists(10, 20);989 * @returns true if the token exists, otherwise false990 */991 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {992 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();993 }994}995996class NFTnRFT extends CollectionGroup {997 /**998 * Get tokens owned by account999 *1000 * @param collectionId ID of collection1001 * @param addressObj tokens owner1002 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1003 * @returns array of token ids owned by account1004 */1005 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1006 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1007 }10081009 /**1010 * Get token data1011 *1012 * @param collectionId ID of collection1013 * @param tokenId ID of token1014 * @param propertyKeys optionally filter the token properties to only these keys1015 * @param blockHashAt optionally query the data at some block with this hash1016 * @example getToken(10, 5);1017 * @returns human readable token data1018 */1019 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1020 properties: IProperty[];1021 owner: ICrossAccountId;1022 normalizedOwner: ICrossAccountId;1023 }| null> {1024 let tokenData;1025 if(typeof blockHashAt === 'undefined') {1026 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1027 }1028 else {1029 if(propertyKeys.length == 0) {1030 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1031 if(!collection) return null;1032 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1033 }1034 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1035 }1036 tokenData = tokenData.toHuman();1037 if (tokenData === null || tokenData.owner === null) return null;1038 const owner = {} as any;1039 for (const key of Object.keys(tokenData.owner)) {1040 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1041 }1042 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1043 return tokenData;1044 }10451046 /**1047 * Set permissions to change token properties1048 *1049 * @param signer keyring of signer1050 * @param collectionId ID of collection1051 * @param permissions permissions to change a property by the collection owner or admin1052 * @example setTokenPropertyPermissions(1053 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1054 * )1055 * @returns true if extrinsic success otherwise false1056 */1057 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1058 const result = await this.helper.executeExtrinsic(1059 signer,1060 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1061 true,1062 );10631064 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1065 }10661067 /**1068 * Set token properties1069 *1070 * @param signer keyring of signer1071 * @param collectionId ID of collection1072 * @param tokenId ID of token1073 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1074 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1075 * @returns ```true``` if extrinsic success, otherwise ```false```1076 */1077 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1078 const result = await this.helper.executeExtrinsic(1079 signer,1080 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1081 true,1082 );10831084 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1085 }10861087 /**1088 * Delete the provided properties of a token1089 * @param signer keyring of signer1090 * @param collectionId ID of collection1091 * @param tokenId ID of token1092 * @param propertyKeys property keys to be deleted1093 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1094 * @returns ```true``` if extrinsic success, otherwise ```false```1095 */1096 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1097 const result = await this.helper.executeExtrinsic(1098 signer,1099 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1100 true,1101 );11021103 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1104 }11051106 /**1107 * Mint new collection1108 *1109 * @param signer keyring of signer1110 * @param collectionOptions basic collection options and properties1111 * @param mode NFT or RFT type of a collection1112 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1113 * @returns object of the created collection1114 */1115 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueCollectionBase> {1116 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1117 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1118 for (const key of ['name', 'description', 'tokenPrefix']) {1119 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1120 }1121 const creationResult = await this.helper.executeExtrinsic(1122 signer,1123 'api.tx.unique.createCollectionEx', [collectionOptions],1124 true, // errorLabel,1125 );1126 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1127 }11281129 getCollectionObject(_collectionId: number): any {1130 return null;1131 }11321133 getTokenObject(_collectionId: number, _tokenId: number): any {1134 return null;1135 }1136}113711381139class NFTGroup extends NFTnRFT {1140 /**1141 * Get collection object1142 * @param collectionId ID of collection1143 * @example getCollectionObject(2);1144 * @returns instance of UniqueNFTCollection1145 */1146 getCollectionObject(collectionId: number): UniqueNFTCollection {1147 return new UniqueNFTCollection(collectionId, this.helper);1148 }11491150 /**1151 * Get token object1152 * @param collectionId ID of collection1153 * @param tokenId ID of token1154 * @example getTokenObject(10, 5);1155 * @returns instance of UniqueNFTToken1156 */1157 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1158 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1159 }11601161 /**1162 * Get token's owner1163 * @param collectionId ID of collection1164 * @param tokenId ID of token1165 * @param blockHashAt optionally query the data at the block with this hash1166 * @example getTokenOwner(10, 5);1167 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1168 */1169 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1170 let owner;1171 if (typeof blockHashAt === 'undefined') {1172 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1173 } else {1174 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1175 }1176 return crossAccountIdFromLower(owner.toJSON());1177 }11781179 /**1180 * Is token approved to transfer1181 * @param collectionId ID of collection1182 * @param tokenId ID of token1183 * @param toAccountObj address to be approved1184 * @returns ```true``` if extrinsic success, otherwise ```false```1185 */1186 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1187 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1188 }11891190 /**1191 * Changes the owner of the token.1192 *1193 * @param signer keyring of signer1194 * @param collectionId ID of collection1195 * @param tokenId ID of token1196 * @param addressObj address of a new owner1197 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1198 * @returns ```true``` if extrinsic success, otherwise ```false```1199 */1200 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1201 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1202 }12031204 /**1205 *1206 * Change ownership of a NFT on behalf of the owner.1207 *1208 * @param signer keyring of signer1209 * @param collectionId ID of collection1210 * @param tokenId ID of token1211 * @param fromAddressObj address on behalf of which the token will be sent1212 * @param toAddressObj new token owner1213 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1214 * @returns ```true``` if extrinsic success, otherwise ```false```1215 */1216 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1217 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1218 }12191220 /**1221 * Recursively find the address that owns the token1222 * @param collectionId ID of collection1223 * @param tokenId ID of token1224 * @param blockHashAt1225 * @example getTokenTopmostOwner(10, 5);1226 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1227 */1228 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1229 let owner;1230 if (typeof blockHashAt === 'undefined') {1231 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1232 } else {1233 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1234 }12351236 if (owner === null) return null;12371238 owner = owner.toHuman();12391240 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1241 }12421243 /**1244 * Get tokens nested in the provided token1245 * @param collectionId ID of collection1246 * @param tokenId ID of token1247 * @param blockHashAt optionally query the data at the block with this hash1248 * @example getTokenChildren(10, 5);1249 * @returns tokens whose depth of nesting is <= 51250 */1251 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1252 let children;1253 if(typeof blockHashAt === 'undefined') {1254 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1255 } else {1256 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1257 }12581259 return children.toJSON().map((x: any) => {1260 return {collectionId: x.collection, tokenId: x.token};1261 });1262 }12631264 /**1265 * Nest one token into another1266 * @param signer keyring of signer1267 * @param tokenObj token to be nested1268 * @param rootTokenObj token to be parent1269 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1270 * @returns ```true``` if extrinsic success, otherwise ```false```1271 */1272 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1273 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1274 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1275 if(!result) {1276 throw Error('Unable to nest token!');1277 }1278 return result;1279 }12801281 /**1282 * Remove token from nested state1283 * @param signer keyring of signer1284 * @param tokenObj token to unnest1285 * @param rootTokenObj parent of a token1286 * @param toAddressObj address of a new token owner1287 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1288 * @returns ```true``` if extrinsic success, otherwise ```false```1289 */1290 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1291 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1292 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1293 if(!result) {1294 throw Error('Unable to unnest token!');1295 }1296 return result;1297 }12981299 /**1300 * Mint new collection1301 * @param signer keyring of signer1302 * @param collectionOptions Collection options1303 * @example1304 * mintCollection(aliceKeyring, {1305 * name: 'New',1306 * description: 'New collection',1307 * tokenPrefix: 'NEW',1308 * })1309 * @returns object of the created collection1310 */1311 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueNFTCollection> {1312 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1313 }13141315 /**1316 * Mint new token1317 * @param signer keyring of signer1318 * @param data token data1319 * @returns created token object1320 */1321 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFTToken> {1322 const creationResult = await this.helper.executeExtrinsic(1323 signer,1324 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1325 nft: {1326 properties: data.properties,1327 },1328 }],1329 true,1330 );1331 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1332 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1333 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1334 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1335 }13361337 /**1338 * Mint multiple NFT tokens1339 * @param signer keyring of signer1340 * @param collectionId ID of collection1341 * @param tokens array of tokens with owner and properties1342 * @example1343 * mintMultipleTokens(aliceKeyring, 10, [{1344 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1345 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1346 * },{1347 * owner: {Ethereum: "0x9F0583DbB855d..."},1348 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1349 * }]);1350 * @returns ```true``` if extrinsic success, otherwise ```false```1351 */1352 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1353 const creationResult = await this.helper.executeExtrinsic(1354 signer,1355 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1356 true,1357 );1358 const collection = this.getCollectionObject(collectionId);1359 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1360 }13611362 /**1363 * Mint multiple NFT tokens with one owner1364 * @param signer keyring of signer1365 * @param collectionId ID of collection1366 * @param owner tokens owner1367 * @param tokens array of tokens with owner and properties1368 * @example1369 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1370 * properties: [{1371 * key: "gender",1372 * value: "female",1373 * },{1374 * key: "age",1375 * value: "33",1376 * }],1377 * }]);1378 * @returns array of newly created tokens1379 */1380 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1381 const rawTokens = [];1382 for (const token of tokens) {1383 const raw = {NFT: {properties: token.properties}};1384 rawTokens.push(raw);1385 }1386 const creationResult = await this.helper.executeExtrinsic(1387 signer,1388 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1389 true,1390 );1391 const collection = this.getCollectionObject(collectionId);1392 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1393 }13941395 /**1396 * Set, change, or remove approved address to transfer the ownership of the NFT.1397 *1398 * @param signer keyring of signer1399 * @param collectionId ID of collection1400 * @param tokenId ID of token1401 * @param toAddressObj address to approve1402 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1403 * @returns ```true``` if extrinsic success, otherwise ```false```1404 */1405 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1406 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1407 }1408}140914101411class RFTGroup extends NFTnRFT {1412 /**1413 * Get collection object1414 * @param collectionId ID of collection1415 * @example getCollectionObject(2);1416 * @returns instance of UniqueRFTCollection1417 */1418 getCollectionObject(collectionId: number): UniqueRFTCollection {1419 return new UniqueRFTCollection(collectionId, this.helper);1420 }14211422 /**1423 * Get token object1424 * @param collectionId ID of collection1425 * @param tokenId ID of token1426 * @example getTokenObject(10, 5);1427 * @returns instance of UniqueNFTToken1428 */1429 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1430 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1431 }14321433 /**1434 * Get top 10 token owners with the largest number of pieces1435 * @param collectionId ID of collection1436 * @param tokenId ID of token1437 * @example getTokenTop10Owners(10, 5);1438 * @returns array of top 10 owners1439 */1440 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1441 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1442 }14431444 /**1445 * Get number of pieces owned by address1446 * @param collectionId ID of collection1447 * @param tokenId ID of token1448 * @param addressObj address token owner1449 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1450 * @returns number of pieces ownerd by address1451 */1452 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1453 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1454 }14551456 /**1457 * Transfer pieces of token to another address1458 * @param signer keyring of signer1459 * @param collectionId ID of collection1460 * @param tokenId ID of token1461 * @param addressObj address of a new owner1462 * @param amount number of pieces to be transfered1463 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1464 * @returns ```true``` if extrinsic success, otherwise ```false```1465 */1466 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1467 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1468 }14691470 /**1471 * Change ownership of some pieces of RFT on behalf of the owner.1472 * @param signer keyring of signer1473 * @param collectionId ID of collection1474 * @param tokenId ID of token1475 * @param fromAddressObj address on behalf of which the token will be sent1476 * @param toAddressObj new token owner1477 * @param amount number of pieces to be transfered1478 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1479 * @returns ```true``` if extrinsic success, otherwise ```false```1480 */1481 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1482 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1483 }14841485 /**1486 * Mint new collection1487 * @param signer keyring of signer1488 * @param collectionOptions Collection options1489 * @example1490 * mintCollection(aliceKeyring, {1491 * name: 'New',1492 * description: 'New collection',1493 * tokenPrefix: 'NEW',1494 * })1495 * @returns object of the created collection1496 */1497 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueRFTCollection> {1498 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1499 }15001501 /**1502 * Mint new token1503 * @param signer keyring of signer1504 * @param data token data1505 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1506 * @returns created token object1507 */1508 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFTToken> {1509 const creationResult = await this.helper.executeExtrinsic(1510 signer,1511 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1512 refungible: {1513 pieces: data.pieces,1514 properties: data.properties,1515 },1516 }],1517 true,1518 );1519 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1520 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1521 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1522 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1523 }15241525 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1526 throw Error('Not implemented');1527 const creationResult = await this.helper.executeExtrinsic(1528 signer,1529 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1530 true, // `Unable to mint RFT tokens for ${label}`,1531 );1532 const collection = this.getCollectionObject(collectionId);1533 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1534 }15351536 /**1537 * Mint multiple RFT tokens with one owner1538 * @param signer keyring of signer1539 * @param collectionId ID of collection1540 * @param owner tokens owner1541 * @param tokens array of tokens with properties and pieces1542 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1543 * @returns array of newly created RFT tokens1544 */1545 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1546 const rawTokens = [];1547 for (const token of tokens) {1548 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1549 rawTokens.push(raw);1550 }1551 const creationResult = await this.helper.executeExtrinsic(1552 signer,1553 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1554 true,1555 );1556 const collection = this.getCollectionObject(collectionId);1557 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1558 }15591560 /**1561 * Destroys a concrete instance of RFT.1562 * @param signer keyring of signer1563 * @param collectionId ID of collection1564 * @param tokenId ID of token1565 * @param amount number of pieces to be burnt1566 * @example burnToken(aliceKeyring, 10, 5);1567 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1568 */1569 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<{ success: boolean; token: number | null; }> {1570 return await super.burnToken(signer, collectionId, tokenId, amount);1571 }15721573 /**1574 * Set, change, or remove approved address to transfer the ownership of the RFT.1575 *1576 * @param signer keyring of signer1577 * @param collectionId ID of collection1578 * @param tokenId ID of token1579 * @param toAddressObj address to approve1580 * @param amount number of pieces to be approved1581 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1582 * @returns true if the token success, otherwise false1583 */1584 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1585 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1586 }15871588 /**1589 * Get total number of pieces1590 * @param collectionId ID of collection1591 * @param tokenId ID of token1592 * @example getTokenTotalPieces(10, 5);1593 * @returns number of pieces1594 */1595 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1596 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1597 }15981599 /**1600 * Change number of token pieces. Signer must be the owner of all token pieces.1601 * @param signer keyring of signer1602 * @param collectionId ID of collection1603 * @param tokenId ID of token1604 * @param amount new number of pieces1605 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1606 * @returns true if the repartion was success, otherwise false1607 */1608 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1609 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1610 const repartitionResult = await this.helper.executeExtrinsic(1611 signer,1612 'api.tx.unique.repartition', [collectionId, tokenId, amount],1613 true,1614 );1615 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1616 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1617 }1618}161916201621class FTGroup extends CollectionGroup {1622 /**1623 * Get collection object1624 * @param collectionId ID of collection1625 * @example getCollectionObject(2);1626 * @returns instance of UniqueFTCollection1627 */1628 getCollectionObject(collectionId: number): UniqueFTCollection {1629 return new UniqueFTCollection(collectionId, this.helper);1630 }16311632 /**1633 * Mint new fungible collection1634 * @param signer keyring of signer1635 * @param collectionOptions Collection options1636 * @param decimalPoints number of token decimals1637 * @example1638 * mintCollection(aliceKeyring, {1639 * name: 'New',1640 * description: 'New collection',1641 * tokenPrefix: 'NEW',1642 * }, 18)1643 * @returns newly created fungible collection1644 */1645 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0): Promise<UniqueFTCollection> {1646 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1647 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1648 collectionOptions.mode = {fungible: decimalPoints};1649 for (const key of ['name', 'description', 'tokenPrefix']) {1650 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1651 }1652 const creationResult = await this.helper.executeExtrinsic(1653 signer,1654 'api.tx.unique.createCollectionEx', [collectionOptions],1655 true,1656 );1657 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1658 }16591660 /**1661 * Mint tokens1662 * @param signer keyring of signer1663 * @param collectionId ID of collection1664 * @param owner address owner of new tokens1665 * @param amount amount of tokens to be meanted1666 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1667 * @returns ```true``` if extrinsic success, otherwise ```false```1668 */1669 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1670 const creationResult = await this.helper.executeExtrinsic(1671 signer,1672 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1673 fungible: {1674 value: amount,1675 },1676 }],1677 true, // `Unable to mint fungible tokens for ${label}`,1678 );1679 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1680 }16811682 /**1683 * Mint multiple Fungible tokens with one owner1684 * @param signer keyring of signer1685 * @param collectionId ID of collection1686 * @param owner tokens owner1687 * @param tokens array of tokens with properties and pieces1688 * @returns ```true``` if extrinsic success, otherwise ```false```1689 */1690 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1691 const rawTokens = [];1692 for (const token of tokens) {1693 const raw = {Fungible: {Value: token.value}};1694 rawTokens.push(raw);1695 }1696 const creationResult = await this.helper.executeExtrinsic(1697 signer,1698 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1699 true,1700 );1701 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1702 }17031704 /**1705 * Get the top 10 owners with the largest balance for the Fungible collection1706 * @param collectionId ID of collection1707 * @example getTop10Owners(10);1708 * @returns array of ```ICrossAccountId```1709 */1710 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1711 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1712 }17131714 /**1715 * Get account balance1716 * @param collectionId ID of collection1717 * @param addressObj address of owner1718 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1719 * @returns amount of fungible tokens owned by address1720 */1721 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1722 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1723 }17241725 /**1726 * Transfer tokens to address1727 * @param signer keyring of signer1728 * @param collectionId ID of collection1729 * @param toAddressObj address recipient1730 * @param amount amount of tokens to be sent1731 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1732 * @returns ```true``` if extrinsic success, otherwise ```false```1733 */1734 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1735 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1736 }17371738 /**1739 * Transfer some tokens on behalf of the owner.1740 * @param signer keyring of signer1741 * @param collectionId ID of collection1742 * @param fromAddressObj address on behalf of which tokens will be sent1743 * @param toAddressObj address where token to be sent1744 * @param amount number of tokens to be sent1745 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1746 * @returns ```true``` if extrinsic success, otherwise ```false```1747 */1748 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1749 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1750 }17511752 /**1753 * Destroy some amount of tokens1754 * @param signer keyring of signer1755 * @param collectionId ID of collection1756 * @param amount amount of tokens to be destroyed1757 * @example burnTokens(aliceKeyring, 10, 1000n);1758 * @returns ```true``` if extrinsic success, otherwise ```false```1759 */1760 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1761 return (await super.burnToken(signer, collectionId, 0, amount)).success;1762 }17631764 /**1765 * Burn some tokens on behalf of the owner.1766 * @param signer keyring of signer1767 * @param collectionId ID of collection1768 * @param fromAddressObj address on behalf of which tokens will be burnt1769 * @param amount amount of tokens to be burnt1770 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1771 * @returns ```true``` if extrinsic success, otherwise ```false```1772 */1773 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1774 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, amount);1775 }17761777 /**1778 * Get total collection supply1779 * @param collectionId1780 * @returns1781 */1782 async getTotalPieces(collectionId: number): Promise<bigint> {1783 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1784 }17851786 /**1787 * Set, change, or remove approved address to transfer tokens.1788 *1789 * @param signer keyring of signer1790 * @param collectionId ID of collection1791 * @param toAddressObj address to be approved1792 * @param amount amount of tokens to be approved1793 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1794 * @returns ```true``` if extrinsic success, otherwise ```false```1795 */1796 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1797 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1798 }17991800 /**1801 * Get amount of fungible tokens approved to transfer1802 * @param collectionId ID of collection1803 * @param fromAddressObj owner of tokens1804 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1805 * @returns number of tokens approved for the transfer1806 */1807 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1808 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1809 }1810}181118121813class ChainGroup extends HelperGroup {1814 /**1815 * Get system properties of a chain1816 * @example getChainProperties();1817 * @returns ss58Format, token decimals, and token symbol1818 */1819 getChainProperties(): IChainProperties {1820 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1821 return {1822 ss58Format: properties.ss58Format.toJSON(),1823 tokenDecimals: properties.tokenDecimals.toJSON(),1824 tokenSymbol: properties.tokenSymbol.toJSON(),1825 };1826 }18271828 /**1829 * Get chain header1830 * @example getLatestBlockNumber();1831 * @returns the number of the last block1832 */1833 async getLatestBlockNumber(): Promise<number> {1834 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1835 }18361837 /**1838 * Get block hash by block number1839 * @param blockNumber number of block1840 * @example getBlockHashByNumber(12345);1841 * @returns hash of a block1842 */1843 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1844 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1845 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1846 return blockHash;1847 }18481849 // TODO add docs1850 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {1851 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);1852 if (!blockHash) return null;1853 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;1854 }18551856 /**1857 * Get account nonce1858 * @param address substrate address1859 * @example getNonce("5GrwvaEF5zXb26Fz...");1860 * @returns number, account's nonce1861 */1862 async getNonce(address: TSubstrateAccount): Promise<number> {1863 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1864 }1865}186618671868class BalanceGroup extends HelperGroup {1869 /**1870 * Representation of the native token in the smallest unit1871 * @example getOneTokenNominal()1872 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1873 */1874 getOneTokenNominal(): bigint {1875 const chainProperties = this.helper.chain.getChainProperties();1876 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1877 }18781879 /**1880 * Get substrate address balance1881 * @param address substrate address1882 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1883 * @returns amount of tokens on address1884 */1885 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1886 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1887 }18881889 /**1890 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved1891 * @param address substrate address1892 * @returns1893 */1894 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {1895 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;1896 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};1897 }18981899 /**1900 * Get ethereum address balance1901 * @param address ethereum address1902 * @example getEthereum("0x9F0583DbB855d...")1903 * @returns amount of tokens on address1904 */1905 async getEthereum(address: TEthereumAccount): Promise<bigint> {1906 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1907 }19081909 /**1910 * Transfer tokens to substrate address1911 * @param signer keyring of signer1912 * @param address substrate address of a recipient1913 * @param amount amount of tokens to be transfered1914 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1915 * @returns ```true``` if extrinsic success, otherwise ```false```1916 */1917 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1918 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true/*, `Unable to transfer balance from ${this.helper.getSignerAddress(signer)} to ${address}`*/);19191920 let transfer = {from: null, to: null, amount: 0n} as any;1921 result.result.events.forEach(({event: {data, method, section}}) => {1922 if ((section === 'balances') && (method === 'Transfer')) {1923 transfer = {1924 from: this.helper.address.normalizeSubstrate(data[0]),1925 to: this.helper.address.normalizeSubstrate(data[1]),1926 amount: BigInt(data[2]),1927 };1928 }1929 });1930 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1931 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1932 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1933 return isSuccess;1934 }1935}193619371938class AddressGroup extends HelperGroup {1939 /**1940 * Normalizes the address to the specified ss58 format, by default ```42```.1941 * @param address substrate address1942 * @param ss58Format format for address conversion, by default ```42```1943 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1944 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1945 */1946 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1947 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1948 }19491950 /**1951 * Get address in the connected chain format1952 * @param address substrate address1953 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1954 * @returns address in chain format1955 */1956 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1957 const info = this.helper.chain.getChainProperties();1958 return encodeAddress(decodeAddress(address), info.ss58Format);1959 }19601961 /**1962 * Get substrate mirror of an ethereum address1963 * @param ethAddress ethereum address1964 * @param toChainFormat false for normalized account1965 * @example ethToSubstrate('0x9F0583DbB855d...')1966 * @returns substrate mirror of a provided ethereum address1967 */1968 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1969 if(!toChainFormat) return evmToAddress(ethAddress);1970 const info = this.helper.chain.getChainProperties();1971 return evmToAddress(ethAddress, info.ss58Format);1972 }19731974 /**1975 * Get ethereum mirror of a substrate address1976 * @param subAddress substrate account1977 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1978 * @returns ethereum mirror of a provided substrate address1979 */1980 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1981 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1982 }1983}19841985class StakingGroup extends HelperGroup {1986 /**1987 * Stake tokens for App Promotion1988 * @param signer keyring of signer1989 * @param amountToStake amount of tokens to stake1990 * @param label extra label for log1991 * @returns1992 */1993 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {1994 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;1995 const stakeResult = await this.helper.executeExtrinsic(1996 signer, 'api.tx.appPromotion.stake',1997 [amountToStake], true,1998 );1999 // TODO extract info from stakeResult2000 return true;2001 }20022003 /**2004 * Unstake tokens for App Promotion2005 * @param signer keyring of signer2006 * @param amountToUnstake amount of tokens to unstake2007 * @param label extra label for log2008 * @returns block number where balances will be unlocked2009 */2010 async unstake(signer: TSigner, label?: string): Promise<number> {2011 if(typeof label === 'undefined') label = `${signer.address}`;2012 const unstakeResult = await this.helper.executeExtrinsic(2013 signer, 'api.tx.appPromotion.unstake',2014 [], true,2015 );2016 // TODO extract block number fron events2017 return 1;2018 }20192020 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2021 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2022 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2023 }20242025 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<bigint[][]> {2026 return (await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2027 }20282029 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2030 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2031 }20322033 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<bigint[][]> {2034 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2035 }2036}20372038export class UniqueHelper extends ChainHelperBase {2039 chain: ChainGroup;2040 balance: BalanceGroup;2041 address: AddressGroup;2042 collection: CollectionGroup;2043 nft: NFTGroup;2044 rft: RFTGroup;2045 ft: FTGroup;2046 staking: StakingGroup;20472048 constructor(logger?: ILogger) {2049 super(logger);2050 this.chain = new ChainGroup(this);2051 this.balance = new BalanceGroup(this);2052 this.address = new AddressGroup(this);2053 this.collection = new CollectionGroup(this);2054 this.nft = new NFTGroup(this);2055 this.rft = new RFTGroup(this);2056 this.ft = new FTGroup(this);2057 this.staking = new StakingGroup(this);2058 }2059}206020612062class UniqueCollectionBase {2063 helper: UniqueHelper;2064 collectionId: number;20652066 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2067 this.collectionId = collectionId;2068 this.helper = uniqueHelper;2069 }20702071 async getData() {2072 return await this.helper.collection.getData(this.collectionId);2073 }20742075 async getLastTokenId() {2076 return await this.helper.collection.getLastTokenId(this.collectionId);2077 }20782079 async isTokenExists(tokenId: number) {2080 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2081 }20822083 async getAdmins() {2084 return await this.helper.collection.getAdmins(this.collectionId);2085 }20862087 async getAllowList() {2088 return await this.helper.collection.getAllowList(this.collectionId);2089 }20902091 async getEffectiveLimits() {2092 return await this.helper.collection.getEffectiveLimits(this.collectionId);2093 }20942095 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2096 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2097 }20982099 async confirmSponsorship(signer: TSigner) {2100 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2101 }21022103 async removeSponsor(signer: TSigner) {2104 return await this.helper.collection.removeSponsor(signer, this.collectionId);2105 }21062107 async setLimits(signer: TSigner, limits: ICollectionLimits) {2108 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2109 }21102111 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2112 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2113 }21142115 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2116 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2117 }21182119 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2120 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2121 }21222123 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2124 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2125 }21262127 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2128 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2129 }21302131 async setProperties(signer: TSigner, properties: IProperty[]) {2132 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2133 }21342135 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2136 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2137 }21382139 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2140 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2141 }21422143 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2144 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2145 }21462147 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2148 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2149 }21502151 async disableNesting(signer: TSigner) {2152 return await this.helper.collection.disableNesting(signer, this.collectionId);2153 }21542155 async burn(signer: TSigner) {2156 return await this.helper.collection.burn(signer, this.collectionId);2157 }2158}215921602161class UniqueNFTCollection extends UniqueCollectionBase {2162 getTokenObject(tokenId: number) {2163 return new UniqueNFTToken(tokenId, this);2164 }21652166 async getTokensByAddress(addressObj: ICrossAccountId) {2167 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2168 }21692170 async getToken(tokenId: number, blockHashAt?: string) {2171 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2172 }21732174 async getTokenOwner(tokenId: number, blockHashAt?: string) {2175 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2176 }21772178 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2179 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2180 }21812182 async getTokenChildren(tokenId: number, blockHashAt?: string) {2183 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2184 }21852186 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2187 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2188 }21892190 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2191 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2192 }21932194 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2195 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2196 }21972198 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2199 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2200 }22012202 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2203 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2204 }22052206 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2207 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2208 }22092210 async burnToken(signer: TSigner, tokenId: number) {2211 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2212 }22132214 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2215 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2216 }22172218 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2219 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2220 }22212222 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2223 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2224 }22252226 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2227 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2228 }22292230 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2231 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2232 }2233}223422352236class UniqueRFTCollection extends UniqueCollectionBase {2237 getTokenObject(tokenId: number) {2238 return new UniqueRFTToken(tokenId, this);2239 }22402241 async getTokensByAddress(addressObj: ICrossAccountId) {2242 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2243 }22442245 async getTop10TokenOwners(tokenId: number) {2246 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2247 }22482249 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2250 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2251 }22522253 async getTokenTotalPieces(tokenId: number) {2254 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2255 }22562257 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2258 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2259 }22602261 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2262 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2263 }22642265 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2266 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2267 }22682269 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2270 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2271 }22722273 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2274 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2275 }22762277 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2278 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2279 }22802281 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {2282 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2283 }22842285 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2286 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2287 }22882289 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2290 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2291 }22922293 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2294 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2295 }22962297 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2298 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2299 }2300}230123022303class UniqueFTCollection extends UniqueCollectionBase {2304 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {2305 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);2306 }23072308 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {2309 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);2310 }23112312 async getBalance(addressObj: ICrossAccountId) {2313 return await this.helper.ft.getBalance(this.collectionId, addressObj);2314 }23152316 async getTop10Owners() {2317 return await this.helper.ft.getTop10Owners(this.collectionId);2318 }23192320 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2321 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2322 }23232324 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2325 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2326 }23272328 async burnTokens(signer: TSigner, amount=1n) {2329 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2330 }23312332 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2333 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2334 }23352336 async getTotalPieces() {2337 return await this.helper.ft.getTotalPieces(this.collectionId);2338 }23392340 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2341 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2342 }23432344 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2345 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2346 }2347}234823492350class UniqueTokenBase implements IToken {2351 collection: UniqueNFTCollection | UniqueRFTCollection;2352 collectionId: number;2353 tokenId: number;23542355 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2356 this.collection = collection;2357 this.collectionId = collection.collectionId;2358 this.tokenId = tokenId;2359 }23602361 async getNextSponsored(addressObj: ICrossAccountId) {2362 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2363 }23642365 async setProperties(signer: TSigner, properties: IProperty[]) {2366 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2367 }23682369 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2370 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2371 }2372}237323742375class UniqueNFTToken extends UniqueTokenBase {2376 collection: UniqueNFTCollection;23772378 constructor(tokenId: number, collection: UniqueNFTCollection) {2379 super(tokenId, collection);2380 this.collection = collection;2381 }23822383 async getData(blockHashAt?: string) {2384 return await this.collection.getToken(this.tokenId, blockHashAt);2385 }23862387 async getOwner(blockHashAt?: string) {2388 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2389 }23902391 async getTopmostOwner(blockHashAt?: string) {2392 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2393 }23942395 async getChildren(blockHashAt?: string) {2396 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2397 }23982399 async nest(signer: TSigner, toTokenObj: IToken) {2400 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2401 }24022403 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2404 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2405 }24062407 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2408 return await this.collection.transferToken(signer, this.tokenId, addressObj);2409 }24102411 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2412 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2413 }24142415 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2416 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2417 }24182419 async isApproved(toAddressObj: ICrossAccountId) {2420 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2421 }24222423 async burn(signer: TSigner) {2424 return await this.collection.burnToken(signer, this.tokenId);2425 }2426}24272428class UniqueRFTToken extends UniqueTokenBase {2429 collection: UniqueRFTCollection;24302431 constructor(tokenId: number, collection: UniqueRFTCollection) {2432 super(tokenId, collection);2433 this.collection = collection;2434 }24352436 async getTop10Owners() {2437 return await this.collection.getTop10TokenOwners(this.tokenId);2438 }24392440 async getBalance(addressObj: ICrossAccountId) {2441 return await this.collection.getTokenBalance(this.tokenId, addressObj);2442 }24432444 async getTotalPieces() {2445 return await this.collection.getTokenTotalPieces(this.tokenId);2446 }24472448 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2449 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2450 }24512452 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2453 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2454 }24552456 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2457 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2458 }24592460 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2461 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2462 }24632464 async repartition(signer: TSigner, amount: bigint) {2465 return await this.collection.repartitionToken(signer, this.tokenId, amount);2466 }24672468 async burn(signer: TSigner, amount=1n) {2469 return await this.collection.burnToken(signer, this.tokenId, amount);2470 }2471}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314export const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};2021const nesting = {22 toChecksumAddress(address: string): string {23 if (typeof address === 'undefined') return '';2425 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2627 address = address.toLowerCase().replace(/^0x/i,'');28 const addressHash = keccakAsHex(address).replace(/^0x/i,'');29 const checksumAddress = ['0x'];3031 for (let i = 0; i < address.length; i++) {32 // If ith character is 8 to f then make it uppercase33 if (parseInt(addressHash[i], 16) > 7) {34 checksumAddress.push(address[i].toUpperCase());35 } else {36 checksumAddress.push(address[i]);37 }38 }39 return checksumAddress.join('');40 },41 tokenIdToAddress(collectionId: number, tokenId: number) {42 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);43 },44};4546class UniqueUtil {47 static transactionStatus = {48 NOT_READY: 'NotReady',49 FAIL: 'Fail',50 SUCCESS: 'Success',51 };5253 static chainLogType = {54 EXTRINSIC: 'extrinsic',55 RPC: 'rpc',56 };5758 static getNestingTokenAddress(collectionId: number, tokenId: number) {59 return nesting.tokenIdToAddress(collectionId, tokenId);60 }6162 static getDefaultLogger(): ILogger {63 return {64 log(msg: any, level = 'INFO') {65 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));66 },67 level: {68 ERROR: 'ERROR',69 WARNING: 'WARNING',70 INFO: 'INFO',71 },72 };73 }7475 static vec2str(arr: string[] | number[]) {76 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');77 }7879 static str2vec(string: string) {80 if (typeof string !== 'string') return string;81 return Array.from(string).map(x => x.charCodeAt(0));82 }8384 static fromSeed(seed: string, ss58Format = 42) {85 const keyring = new Keyring({type: 'sr25519', ss58Format});86 return keyring.addFromUri(seed);87 }8889 static normalizeSubstrateAddress(address: string, ss58Format = 42) {90 return encodeAddress(decodeAddress(address), ss58Format);91 }9293 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult) {94 if (creationResult.status !== this.transactionStatus.SUCCESS) {95 throw Error('Unable to create collection!');96 }9798 let collectionId = null;99 creationResult.result.events.forEach(({event: {data, method, section}}) => {100 if ((section === 'common') && (method === 'CollectionCreated')) {101 collectionId = parseInt(data[0].toString(), 10);102 }103 });104105 if (collectionId === null) {106 throw Error('No CollectionCreated event was found!');107 }108109 return collectionId;110 }111112 static extractTokensFromCreationResult(creationResult: ITransactionResult) {113 if (creationResult.status !== this.transactionStatus.SUCCESS) {114 throw Error('Unable to create tokens!');115 }116 let success = false;117 const tokens = [] as any;118 creationResult.result.events.forEach(({event: {data, method, section}}) => {119 if (method === 'ExtrinsicSuccess') {120 success = true;121 } else if ((section === 'common') && (method === 'ItemCreated')) {122 tokens.push({123 collectionId: parseInt(data[0].toString(), 10),124 tokenId: parseInt(data[1].toString(), 10),125 owner: data[2].toJSON(),126 });127 }128 });129 return {success, tokens};130 }131132 static extractTokensFromBurnResult(burnResult: ITransactionResult) {133 if (burnResult.status !== this.transactionStatus.SUCCESS) {134 throw Error('Unable to burn tokens!');135 }136 let success = false;137 const tokens = [] as any;138 burnResult.result.events.forEach(({event: {data, method, section}}) => {139 if (method === 'ExtrinsicSuccess') {140 success = true;141 } else if ((section === 'common') && (method === 'ItemDestroyed')) {142 tokens.push({143 collectionId: parseInt(data[0].toString(), 10),144 tokenId: parseInt(data[1].toString(), 10),145 owner: data[2].toJSON(),146 });147 }148 });149 return {success, tokens};150 }151152 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string) {153 let eventId = null;154 events.forEach(({event: {data, method, section}}) => {155 if ((section === expectedSection) && (method === expectedMethod)) {156 eventId = parseInt(data[0].toString(), 10);157 }158 });159160 if (eventId === null) {161 throw Error(`No ${expectedMethod} event was found!`);162 }163 return eventId === collectionId;164 }165166 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {167 const normalizeAddress = (address: string | ICrossAccountId) => {168 if(typeof address === 'string') return address;169 const obj = {} as any;170 Object.keys(address).forEach(k => {171 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];172 });173 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};174 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};175 return address;176 };177 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;178 events.forEach(({event: {data, method, section}}) => {179 if ((section === 'common') && (method === 'Transfer')) {180 const hData = (data as any).toJSON();181 transfer = {182 collectionId: hData[0],183 tokenId: hData[1],184 from: normalizeAddress(hData[2]),185 to: normalizeAddress(hData[3]),186 amount: BigInt(hData[4]),187 };188 }189 });190 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;191 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);193 isSuccess = isSuccess && amount === transfer.amount;194 return isSuccess;195 }196}197198199class ChainHelperBase {200 transactionStatus = UniqueUtil.transactionStatus;201 chainLogType = UniqueUtil.chainLogType;202 util: typeof UniqueUtil;203 logger: ILogger;204 api: ApiPromise | null;205 forcedNetwork: TUniqueNetworks | null;206 network: TUniqueNetworks | null;207 chainLog: IUniqueHelperLog[];208209 constructor(logger?: ILogger) {210 this.util = UniqueUtil;211 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();212 this.logger = logger;213 this.api = null;214 this.forcedNetwork = null;215 this.network = null;216 this.chainLog = [];217 }218219 clearChainLog(): void {220 this.chainLog = [];221 }222223 forceNetwork(value: TUniqueNetworks): void {224 this.forcedNetwork = value;225 }226227 async connect(wsEndpoint: string, listeners?: IApiListeners) {228 if (this.api !== null) throw Error('Already connected');229 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);230 this.api = api;231 this.network = network;232 }233234 async disconnect() {235 if (this.api === null) return;236 await this.api.disconnect();237 this.api = null;238 this.network = null;239 }240241 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {242 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;243 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;244 return 'opal';245 }246247 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {248 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});249 await api.isReady;250251 const network = await this.detectNetwork(api);252253 await api.disconnect();254255 return network;256 }257258 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{259 api: ApiPromise;260 network: TUniqueNetworks;261 }> {262 if(typeof network === 'undefined' || network === null) network = 'opal';263 const supportedRPC = {264 opal: {265 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,266 },267 quartz: {268 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,269 },270 unique: {271 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,272 },273 };274 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);275 const rpc = supportedRPC[network];276277 // TODO: investigate how to replace rpc in runtime278 // api._rpcCore.addUserInterfaces(rpc);279280 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});281282 await api.isReadyOrError;283284 if (typeof listeners === 'undefined') listeners = {};285 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {286 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;287 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);288 }289290 return {api, network};291 }292293 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {294 const {events, status} = data;295 if (status.isReady) {296 return this.transactionStatus.NOT_READY;297 }298 if (status.isBroadcast) {299 return this.transactionStatus.NOT_READY;300 }301 if (status.isInBlock || status.isFinalized) {302 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');303 if (errors.length > 0) {304 return this.transactionStatus.FAIL;305 }306 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {307 return this.transactionStatus.SUCCESS;308 }309 }310311 return this.transactionStatus.FAIL;312 }313314 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {315 const sign = (callback: any) => {316 if(options !== null) return transaction.signAndSend(sender, options, callback);317 return transaction.signAndSend(sender, callback);318 };319 // eslint-disable-next-line no-async-promise-executor320 return new Promise(async (resolve, reject) => {321 try {322 const unsub = await sign((result: any) => {323 const status = this.getTransactionStatus(result);324325 if (status === this.transactionStatus.SUCCESS) {326 this.logger.log(`${label} successful`);327 unsub();328 resolve({result, status});329 } else if (status === this.transactionStatus.FAIL) {330 let moduleError = null;331332 if (result.hasOwnProperty('dispatchError')) {333 const dispatchError = result['dispatchError'];334335 if (dispatchError && dispatchError.isModule) {336 const modErr = dispatchError.asModule;337 const errorMeta = dispatchError.registry.findMetaError(modErr);338339 moduleError = `${errorMeta.section}.${errorMeta.name}`;340 }341 else {342 this.logger.log(result, this.logger.level.ERROR);343 }344 }345346 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);347 unsub();348 reject({status, moduleError, result});349 }350 });351 } catch (e) {352 this.logger.log(e, this.logger.level.ERROR);353 reject(e);354 }355 });356 }357358 constructApiCall(apiCall: string, params: any[]) {359 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);360 let call = this.api as any;361 for(const part of apiCall.slice(4).split('.')) {362 call = call[part];363 }364 return call(...params);365 }366367 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false/*, failureMessage='expected success'*/) {368 if(this.api === null) throw Error('API not initialized');369 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);370371 const startTime = (new Date()).getTime();372 let result: ITransactionResult;373 let events = [];374 try {375 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;376 events = result.result.events.map((x: any) => x.toHuman());377 }378 catch(e) {379 if(!(e as object).hasOwnProperty('status')) throw e;380 result = e as ITransactionResult;381 }382383 const endTime = (new Date()).getTime();384385 const log = {386 executedAt: endTime,387 executionTime: endTime - startTime,388 type: this.chainLogType.EXTRINSIC,389 status: result.status,390 call: extrinsic,391 signer: this.getSignerAddress(sender),392 params,393 } as IUniqueHelperLog;394395 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;396 if(events.length > 0) log.events = events;397398 this.chainLog.push(log);399400 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);401 return result;402 }403404 async callRpc(rpc: string, params?: any[]) {405 if(typeof params === 'undefined') params = [];406 if(this.api === null) throw Error('API not initialized');407 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);408409 const startTime = (new Date()).getTime();410 let result;411 let error = null;412 const log = {413 type: this.chainLogType.RPC,414 call: rpc,415 params,416 } as IUniqueHelperLog;417418 try {419 result = await this.constructApiCall(rpc, params);420 }421 catch(e) {422 error = e;423 }424425 const endTime = (new Date()).getTime();426427 log.executedAt = endTime;428 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';429 log.executionTime = endTime - startTime;430431 this.chainLog.push(log);432433 if(error !== null) throw error;434435 return result;436 }437438 getSignerAddress(signer: IKeyringPair | string): string {439 if(typeof signer === 'string') return signer;440 return signer.address;441 }442443 fetchAllPalletNames(): string[] {444 if(this.api === null) throw Error('API not initialized');445 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());446 }447448 fetchMissingPalletNames(requiredPallets: string[]): string[] {449 const palletNames = this.fetchAllPalletNames();450 return requiredPallets.filter(p => !palletNames.includes(p));451 }452}453454455class HelperGroup {456 helper: UniqueHelper;457458 constructor(uniqueHelper: UniqueHelper) {459 this.helper = uniqueHelper;460 }461}462463464class CollectionGroup extends HelperGroup {465 /**466 * Get number of blocks when sponsored transaction is available.467 *468 * @param collectionId ID of collection469 * @param tokenId ID of token470 * @param addressObj address for which the sponsorship is checked471 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});472 * @returns number of blocks or null if sponsorship hasn't been set473 */474 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {475 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();476 }477478 /**479 * Get the number of created collections.480 *481 * @returns number of created collections482 */483 async getTotalCount(): Promise<number> {484 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();485 }486487 /**488 * Get information about the collection with additional data,489 * including the number of tokens it contains, its administrators,490 * the normalized address of the collection's owner, and decoded name and description.491 *492 * @param collectionId ID of collection493 * @example await getData(2)494 * @returns collection information object495 */496 async getData(collectionId: number): Promise<{497 id: number;498 name: string;499 description: string;500 tokensCount: number;501 admins: ICrossAccountId[];502 normalizedOwner: TSubstrateAccount;503 raw: any504 } | null> {505 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);506 const humanCollection = collection.toHuman(), collectionData = {507 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],508 raw: humanCollection,509 } as any, jsonCollection = collection.toJSON();510 if (humanCollection === null) return null;511 collectionData.raw.limits = jsonCollection.limits;512 collectionData.raw.permissions = jsonCollection.permissions;513 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);514 for (const key of ['name', 'description']) {515 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);516 }517518 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))519 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)520 : 0;521 collectionData.admins = await this.getAdmins(collectionId);522523 return collectionData;524 }525526 /**527 * Get the addresses of the collection's administrators, optionally normalized.528 *529 * @param collectionId ID of collection530 * @param normalize whether to normalize the addresses to the default ss58 format531 * @example await getAdmins(1)532 * @returns array of administrators533 */534 async getAdmins(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {535 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();536537 return normalize538 ? admins.map((address: any) => {539 return address.Substrate540 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}541 : address;542 })543 : admins;544 }545546 /**547 * Get the addresses added to the collection allow-list, optionally normalized.548 * @param collectionId ID of collection549 * @param normalize whether to normalize the addresses to the default ss58 format550 * @example await getAllowList(1)551 * @returns array of allow-listed addresses552 */553 async getAllowList(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {554 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();555 return normalize556 ? allowListed.map((address: any) => {557 return address.Substrate558 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}559 : address;560 })561 : allowListed;562 }563564 /**565 * Get the effective limits of the collection instead of null for default values566 *567 * @param collectionId ID of collection568 * @example await getEffectiveLimits(2)569 * @returns object of collection limits570 */571 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {572 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();573 }574575 /**576 * Burns the collection if the signer has sufficient permissions and collection is empty.577 *578 * @param signer keyring of signer579 * @param collectionId ID of collection580 * @example await helper.collection.burn(aliceKeyring, 3);581 * @returns ```true``` if extrinsic success, otherwise ```false```582 */583 async burn(signer: TSigner, collectionId: number): Promise<boolean> {584 const result = await this.helper.executeExtrinsic(585 signer,586 'api.tx.unique.destroyCollection', [collectionId],587 true,588 );589590 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');591 }592593 /**594 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.595 *596 * @param signer keyring of signer597 * @param collectionId ID of collection598 * @param sponsorAddress Sponsor substrate address599 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")600 * @returns ```true``` if extrinsic success, otherwise ```false```601 */602 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {603 const result = await this.helper.executeExtrinsic(604 signer,605 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],606 true,607 );608609 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');610 }611612 /**613 * Confirms consent to sponsor the collection on behalf of the signer.614 *615 * @param signer keyring of signer616 * @param collectionId ID of collection617 * @example confirmSponsorship(aliceKeyring, 10)618 * @returns ```true``` if extrinsic success, otherwise ```false```619 */620 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {621 const result = await this.helper.executeExtrinsic(622 signer,623 'api.tx.unique.confirmSponsorship', [collectionId],624 true,625 );626627 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');628 }629630 /**631 * Removes the sponsor of a collection, regardless if it consented or not.632 *633 * @param signer keyring of signer634 * @param collectionId ID of collection635 * @example removeSponsor(aliceKeyring, 10)636 * @returns ```true``` if extrinsic success, otherwise ```false```637 */638 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {639 const result = await this.helper.executeExtrinsic(640 signer,641 'api.tx.unique.removeCollectionSponsor', [collectionId],642 true,643 );644645 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');646 }647648 /**649 * Sets the limits of the collection. At least one limit must be specified for a correct call.650 *651 * @param signer keyring of signer652 * @param collectionId ID of collection653 * @param limits collection limits object654 * @example655 * await setLimits(656 * aliceKeyring,657 * 10,658 * {659 * sponsorTransferTimeout: 0,660 * ownerCanDestroy: false661 * }662 * )663 * @returns ```true``` if extrinsic success, otherwise ```false```664 */665 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {666 const result = await this.helper.executeExtrinsic(667 signer,668 'api.tx.unique.setCollectionLimits', [collectionId, limits],669 true,670 );671672 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');673 }674675 /**676 * Changes the owner of the collection to the new Substrate address.677 *678 * @param signer keyring of signer679 * @param collectionId ID of collection680 * @param ownerAddress substrate address of new owner681 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")682 * @returns ```true``` if extrinsic success, otherwise ```false```683 */684 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {685 const result = await this.helper.executeExtrinsic(686 signer,687 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],688 true,689 );690691 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');692 }693694 /**695 * Adds a collection administrator.696 *697 * @param signer keyring of signer698 * @param collectionId ID of collection699 * @param adminAddressObj Administrator address (substrate or ethereum)700 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})701 * @returns ```true``` if extrinsic success, otherwise ```false```702 */703 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {704 const result = await this.helper.executeExtrinsic(705 signer,706 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],707 true,708 );709710 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');711 }712713 /**714 * Removes a collection administrator.715 *716 * @param signer keyring of signer717 * @param collectionId ID of collection718 * @param adminAddressObj Administrator address (substrate or ethereum)719 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})720 * @returns ```true``` if extrinsic success, otherwise ```false```721 */722 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {723 const result = await this.helper.executeExtrinsic(724 signer,725 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],726 true,727 );728729 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');730 }731732 /**733 * Check if user is in allow list.734 * 735 * @param collectionId ID of collection736 * @param user Account to check737 * @example await getAdmins(1)738 * @returns is user in allow list739 */740 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {741 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();742 }743744 /**745 * Adds an address to allow list746 * @param signer keyring of signer747 * @param collectionId ID of collection748 * @param addressObj address to add to the allow list749 * @returns ```true``` if extrinsic success, otherwise ```false```750 */751 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {752 const result = await this.helper.executeExtrinsic(753 signer,754 'api.tx.unique.addToAllowList', [collectionId, addressObj],755 true,756 );757758 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');759 }760761 /**762 * Removes an address from allow list763 *764 * @param signer keyring of signer765 * @param collectionId ID of collection766 * @param addressObj address to remove from the allow list767 * @returns ```true``` if extrinsic success, otherwise ```false```768 */769 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {770 const result = await this.helper.executeExtrinsic(771 signer,772 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],773 true,774 );775776 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');777 }778779 /**780 * Sets onchain permissions for selected collection.781 *782 * @param signer keyring of signer783 * @param collectionId ID of collection784 * @param permissions collection permissions object785 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});786 * @returns ```true``` if extrinsic success, otherwise ```false```787 */788 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {789 const result = await this.helper.executeExtrinsic(790 signer,791 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],792 true,793 );794795 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');796 }797798 /**799 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.800 *801 * @param signer keyring of signer802 * @param collectionId ID of collection803 * @param permissions nesting permissions object804 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});805 * @returns ```true``` if extrinsic success, otherwise ```false```806 */807 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {808 return await this.setPermissions(signer, collectionId, {nesting: permissions});809 }810811 /**812 * Disables nesting for selected collection.813 *814 * @param signer keyring of signer815 * @param collectionId ID of collection816 * @example disableNesting(aliceKeyring, 10);817 * @returns ```true``` if extrinsic success, otherwise ```false```818 */819 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {820 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});821 }822823 /**824 * Sets onchain properties to the collection.825 *826 * @param signer keyring of signer827 * @param collectionId ID of collection828 * @param properties array of property objects829 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);830 * @returns ```true``` if extrinsic success, otherwise ```false```831 */832 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {833 const result = await this.helper.executeExtrinsic(834 signer,835 'api.tx.unique.setCollectionProperties', [collectionId, properties],836 true,837 );838839 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');840 }841842 /**843 * Deletes onchain properties from the collection.844 *845 * @param signer keyring of signer846 * @param collectionId ID of collection847 * @param propertyKeys array of property keys to delete848 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);849 * @returns ```true``` if extrinsic success, otherwise ```false```850 */851 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {852 const result = await this.helper.executeExtrinsic(853 signer,854 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],855 true,856 );857858 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');859 }860861 /**862 * Changes the owner of the token.863 *864 * @param signer keyring of signer865 * @param collectionId ID of collection866 * @param tokenId ID of token867 * @param addressObj address of a new owner868 * @param amount amount of tokens to be transfered. For NFT must be set to 1n869 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})870 * @returns true if the token success, otherwise false871 */872 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {873 const result = await this.helper.executeExtrinsic(874 signer,875 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],876 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,877 );878879 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);880 }881882 /**883 *884 * Change ownership of a token(s) on behalf of the owner.885 *886 * @param signer keyring of signer887 * @param collectionId ID of collection888 * @param tokenId ID of token889 * @param fromAddressObj address on behalf of which the token will be sent890 * @param toAddressObj new token owner891 * @param amount amount of tokens to be transfered. For NFT must be set to 1n892 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})893 * @returns true if the token success, otherwise false894 */895 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {896 const result = await this.helper.executeExtrinsic(897 signer,898 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],899 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,900 );901 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);902 }903904 /**905 *906 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.907 *908 * @param signer keyring of signer909 * @param collectionId ID of collection910 * @param tokenId ID of token911 * @param amount amount of tokens to be burned. For NFT must be set to 1n912 * @example burnToken(aliceKeyring, 10, 5);913 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```914 */915 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<{916 success: boolean,917 token: number | null918 }> {919 const burnResult = await this.helper.executeExtrinsic(920 signer,921 'api.tx.unique.burnItem', [collectionId, tokenId, amount],922 true, // `Unable to burn token for ${label}`,923 );924 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);925 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');926 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};927 }928929 /**930 * Destroys a concrete instance of NFT on behalf of the owner931 *932 * @param signer keyring of signer933 * @param collectionId ID of collection934 * @param fromAddressObj address on behalf of which the token will be burnt935 * @param tokenId ID of token936 * @param amount amount of tokens to be burned. For NFT must be set to 1n937 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})938 * @returns ```true``` if extrinsic success, otherwise ```false```939 */940 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, amount=1n): Promise<boolean> {941 const burnResult = await this.helper.executeExtrinsic(942 signer,943 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],944 true, // `Unable to burn token from for ${label}`,945 );946 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);947 return burnedTokens.success && burnedTokens.tokens.length > 0;948 }949950 /**951 * Set, change, or remove approved address to transfer the ownership of the NFT.952 *953 * @param signer keyring of signer954 * @param collectionId ID of collection955 * @param tokenId ID of token956 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens957 * @param amount amount of token to be approved. For NFT must be set to 1n958 * @returns ```true``` if extrinsic success, otherwise ```false```959 */960 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {961 const approveResult = await this.helper.executeExtrinsic(962 signer,963 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],964 true, // `Unable to approve token for ${label}`,965 );966967 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');968 }969970 /**971 * Get the amount of token pieces approved to transfer or burn. Normally 0.972 *973 * @param collectionId ID of collection974 * @param tokenId ID of token975 * @param toAccountObj address which is approved to use token pieces976 * @param fromAccountObj address which may have allowed the use of its owned tokens977 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})978 * @returns number of approved to transfer pieces979 */980 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {981 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();982 }983984 /**985 * Get the last created token ID in a collection986 *987 * @param collectionId ID of collection988 * @example getLastTokenId(10);989 * @returns id of the last created token990 */991 async getLastTokenId(collectionId: number): Promise<number> {992 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();993 }994995 /**996 * Check if token exists997 *998 * @param collectionId ID of collection999 * @param tokenId ID of token1000 * @example isTokenExists(10, 20);1001 * @returns true if the token exists, otherwise false1002 */1003 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {1004 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1005 }1006}10071008class NFTnRFT extends CollectionGroup {1009 /**1010 * Get tokens owned by account1011 *1012 * @param collectionId ID of collection1013 * @param addressObj tokens owner1014 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1015 * @returns array of token ids owned by account1016 */1017 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1018 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1019 }10201021 /**1022 * Get token data1023 *1024 * @param collectionId ID of collection1025 * @param tokenId ID of token1026 * @param propertyKeys optionally filter the token properties to only these keys1027 * @param blockHashAt optionally query the data at some block with this hash1028 * @example getToken(10, 5);1029 * @returns human readable token data1030 */1031 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1032 properties: IProperty[];1033 owner: ICrossAccountId;1034 normalizedOwner: ICrossAccountId;1035 }| null> {1036 let tokenData;1037 if(typeof blockHashAt === 'undefined') {1038 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1039 }1040 else {1041 if(propertyKeys.length == 0) {1042 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1043 if(!collection) return null;1044 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1045 }1046 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1047 }1048 tokenData = tokenData.toHuman();1049 if (tokenData === null || tokenData.owner === null) return null;1050 const owner = {} as any;1051 for (const key of Object.keys(tokenData.owner)) {1052 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1053 }1054 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1055 return tokenData;1056 }10571058 /**1059 * Set permissions to change token properties1060 *1061 * @param signer keyring of signer1062 * @param collectionId ID of collection1063 * @param permissions permissions to change a property by the collection owner or admin1064 * @example setTokenPropertyPermissions(1065 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1066 * )1067 * @returns true if extrinsic success otherwise false1068 */1069 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1070 const result = await this.helper.executeExtrinsic(1071 signer,1072 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1073 true,1074 );10751076 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1077 }10781079 /**1080 * Set token properties1081 *1082 * @param signer keyring of signer1083 * @param collectionId ID of collection1084 * @param tokenId ID of token1085 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1086 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1087 * @returns ```true``` if extrinsic success, otherwise ```false```1088 */1089 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1090 const result = await this.helper.executeExtrinsic(1091 signer,1092 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1093 true,1094 );10951096 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1097 }10981099 /**1100 * Delete the provided properties of a token1101 * @param signer keyring of signer1102 * @param collectionId ID of collection1103 * @param tokenId ID of token1104 * @param propertyKeys property keys to be deleted1105 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1106 * @returns ```true``` if extrinsic success, otherwise ```false```1107 */1108 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1109 const result = await this.helper.executeExtrinsic(1110 signer,1111 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1112 true,1113 );11141115 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1116 }11171118 /**1119 * Mint new collection1120 *1121 * @param signer keyring of signer1122 * @param collectionOptions basic collection options and properties1123 * @param mode NFT or RFT type of a collection1124 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1125 * @returns object of the created collection1126 */1127 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueCollectionBase> {1128 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1129 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1130 for (const key of ['name', 'description', 'tokenPrefix']) {1131 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1132 }1133 const creationResult = await this.helper.executeExtrinsic(1134 signer,1135 'api.tx.unique.createCollectionEx', [collectionOptions],1136 true, // errorLabel,1137 );1138 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1139 }11401141 getCollectionObject(_collectionId: number): any {1142 return null;1143 }11441145 getTokenObject(_collectionId: number, _tokenId: number): any {1146 return null;1147 }1148}114911501151class NFTGroup extends NFTnRFT {1152 /**1153 * Get collection object1154 * @param collectionId ID of collection1155 * @example getCollectionObject(2);1156 * @returns instance of UniqueNFTCollection1157 */1158 getCollectionObject(collectionId: number): UniqueNFTCollection {1159 return new UniqueNFTCollection(collectionId, this.helper);1160 }11611162 /**1163 * Get token object1164 * @param collectionId ID of collection1165 * @param tokenId ID of token1166 * @example getTokenObject(10, 5);1167 * @returns instance of UniqueNFTToken1168 */1169 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1170 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1171 }11721173 /**1174 * Get token's owner1175 * @param collectionId ID of collection1176 * @param tokenId ID of token1177 * @param blockHashAt optionally query the data at the block with this hash1178 * @example getTokenOwner(10, 5);1179 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1180 */1181 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1182 let owner;1183 if (typeof blockHashAt === 'undefined') {1184 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1185 } else {1186 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1187 }1188 return crossAccountIdFromLower(owner.toJSON());1189 }11901191 /**1192 * Is token approved to transfer1193 * @param collectionId ID of collection1194 * @param tokenId ID of token1195 * @param toAccountObj address to be approved1196 * @returns ```true``` if extrinsic success, otherwise ```false```1197 */1198 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1199 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1200 }12011202 /**1203 * Changes the owner of the token.1204 *1205 * @param signer keyring of signer1206 * @param collectionId ID of collection1207 * @param tokenId ID of token1208 * @param addressObj address of a new owner1209 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1210 * @returns ```true``` if extrinsic success, otherwise ```false```1211 */1212 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1213 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1214 }12151216 /**1217 *1218 * Change ownership of a NFT on behalf of the owner.1219 *1220 * @param signer keyring of signer1221 * @param collectionId ID of collection1222 * @param tokenId ID of token1223 * @param fromAddressObj address on behalf of which the token will be sent1224 * @param toAddressObj new token owner1225 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1226 * @returns ```true``` if extrinsic success, otherwise ```false```1227 */1228 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1229 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1230 }12311232 /**1233 * Recursively find the address that owns the token1234 * @param collectionId ID of collection1235 * @param tokenId ID of token1236 * @param blockHashAt1237 * @example getTokenTopmostOwner(10, 5);1238 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1239 */1240 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1241 let owner;1242 if (typeof blockHashAt === 'undefined') {1243 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1244 } else {1245 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1246 }12471248 if (owner === null) return null;12491250 owner = owner.toHuman();12511252 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1253 }12541255 /**1256 * Get tokens nested in the provided token1257 * @param collectionId ID of collection1258 * @param tokenId ID of token1259 * @param blockHashAt optionally query the data at the block with this hash1260 * @example getTokenChildren(10, 5);1261 * @returns tokens whose depth of nesting is <= 51262 */1263 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1264 let children;1265 if(typeof blockHashAt === 'undefined') {1266 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1267 } else {1268 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1269 }12701271 return children.toJSON().map((x: any) => {1272 return {collectionId: x.collection, tokenId: x.token};1273 });1274 }12751276 /**1277 * Nest one token into another1278 * @param signer keyring of signer1279 * @param tokenObj token to be nested1280 * @param rootTokenObj token to be parent1281 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1282 * @returns ```true``` if extrinsic success, otherwise ```false```1283 */1284 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1285 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1286 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1287 if(!result) {1288 throw Error('Unable to nest token!');1289 }1290 return result;1291 }12921293 /**1294 * Remove token from nested state1295 * @param signer keyring of signer1296 * @param tokenObj token to unnest1297 * @param rootTokenObj parent of a token1298 * @param toAddressObj address of a new token owner1299 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1300 * @returns ```true``` if extrinsic success, otherwise ```false```1301 */1302 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1303 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1304 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1305 if(!result) {1306 throw Error('Unable to unnest token!');1307 }1308 return result;1309 }13101311 /**1312 * Mint new collection1313 * @param signer keyring of signer1314 * @param collectionOptions Collection options1315 * @example1316 * mintCollection(aliceKeyring, {1317 * name: 'New',1318 * description: 'New collection',1319 * tokenPrefix: 'NEW',1320 * })1321 * @returns object of the created collection1322 */1323 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueNFTCollection> {1324 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1325 }13261327 /**1328 * Mint new token1329 * @param signer keyring of signer1330 * @param data token data1331 * @returns created token object1332 */1333 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFTToken> {1334 const creationResult = await this.helper.executeExtrinsic(1335 signer,1336 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1337 nft: {1338 properties: data.properties,1339 },1340 }],1341 true,1342 );1343 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1344 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1345 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1346 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1347 }13481349 /**1350 * Mint multiple NFT tokens1351 * @param signer keyring of signer1352 * @param collectionId ID of collection1353 * @param tokens array of tokens with owner and properties1354 * @example1355 * mintMultipleTokens(aliceKeyring, 10, [{1356 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1357 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1358 * },{1359 * owner: {Ethereum: "0x9F0583DbB855d..."},1360 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1361 * }]);1362 * @returns ```true``` if extrinsic success, otherwise ```false```1363 */1364 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1365 const creationResult = await this.helper.executeExtrinsic(1366 signer,1367 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1368 true,1369 );1370 const collection = this.getCollectionObject(collectionId);1371 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1372 }13731374 /**1375 * Mint multiple NFT tokens with one owner1376 * @param signer keyring of signer1377 * @param collectionId ID of collection1378 * @param owner tokens owner1379 * @param tokens array of tokens with owner and properties1380 * @example1381 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1382 * properties: [{1383 * key: "gender",1384 * value: "female",1385 * },{1386 * key: "age",1387 * value: "33",1388 * }],1389 * }]);1390 * @returns array of newly created tokens1391 */1392 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1393 const rawTokens = [];1394 for (const token of tokens) {1395 const raw = {NFT: {properties: token.properties}};1396 rawTokens.push(raw);1397 }1398 const creationResult = await this.helper.executeExtrinsic(1399 signer,1400 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1401 true,1402 );1403 const collection = this.getCollectionObject(collectionId);1404 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1405 }14061407 /**1408 * Set, change, or remove approved address to transfer the ownership of the NFT.1409 *1410 * @param signer keyring of signer1411 * @param collectionId ID of collection1412 * @param tokenId ID of token1413 * @param toAddressObj address to approve1414 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1415 * @returns ```true``` if extrinsic success, otherwise ```false```1416 */1417 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1418 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1419 }1420}142114221423class RFTGroup extends NFTnRFT {1424 /**1425 * Get collection object1426 * @param collectionId ID of collection1427 * @example getCollectionObject(2);1428 * @returns instance of UniqueRFTCollection1429 */1430 getCollectionObject(collectionId: number): UniqueRFTCollection {1431 return new UniqueRFTCollection(collectionId, this.helper);1432 }14331434 /**1435 * Get token object1436 * @param collectionId ID of collection1437 * @param tokenId ID of token1438 * @example getTokenObject(10, 5);1439 * @returns instance of UniqueNFTToken1440 */1441 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1442 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1443 }14441445 /**1446 * Get top 10 token owners with the largest number of pieces1447 * @param collectionId ID of collection1448 * @param tokenId ID of token1449 * @example getTokenTop10Owners(10, 5);1450 * @returns array of top 10 owners1451 */1452 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1453 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1454 }14551456 /**1457 * Get number of pieces owned by address1458 * @param collectionId ID of collection1459 * @param tokenId ID of token1460 * @param addressObj address token owner1461 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1462 * @returns number of pieces ownerd by address1463 */1464 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1465 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1466 }14671468 /**1469 * Transfer pieces of token to another address1470 * @param signer keyring of signer1471 * @param collectionId ID of collection1472 * @param tokenId ID of token1473 * @param addressObj address of a new owner1474 * @param amount number of pieces to be transfered1475 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1476 * @returns ```true``` if extrinsic success, otherwise ```false```1477 */1478 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1479 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1480 }14811482 /**1483 * Change ownership of some pieces of RFT on behalf of the owner.1484 * @param signer keyring of signer1485 * @param collectionId ID of collection1486 * @param tokenId ID of token1487 * @param fromAddressObj address on behalf of which the token will be sent1488 * @param toAddressObj new token owner1489 * @param amount number of pieces to be transfered1490 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1491 * @returns ```true``` if extrinsic success, otherwise ```false```1492 */1493 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1494 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1495 }14961497 /**1498 * Mint new collection1499 * @param signer keyring of signer1500 * @param collectionOptions Collection options1501 * @example1502 * mintCollection(aliceKeyring, {1503 * name: 'New',1504 * description: 'New collection',1505 * tokenPrefix: 'NEW',1506 * })1507 * @returns object of the created collection1508 */1509 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueRFTCollection> {1510 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1511 }15121513 /**1514 * Mint new token1515 * @param signer keyring of signer1516 * @param data token data1517 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1518 * @returns created token object1519 */1520 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFTToken> {1521 const creationResult = await this.helper.executeExtrinsic(1522 signer,1523 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1524 refungible: {1525 pieces: data.pieces,1526 properties: data.properties,1527 },1528 }],1529 true,1530 );1531 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1532 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1533 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1534 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1535 }15361537 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1538 throw Error('Not implemented');1539 const creationResult = await this.helper.executeExtrinsic(1540 signer,1541 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1542 true, // `Unable to mint RFT tokens for ${label}`,1543 );1544 const collection = this.getCollectionObject(collectionId);1545 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1546 }15471548 /**1549 * Mint multiple RFT tokens with one owner1550 * @param signer keyring of signer1551 * @param collectionId ID of collection1552 * @param owner tokens owner1553 * @param tokens array of tokens with properties and pieces1554 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1555 * @returns array of newly created RFT tokens1556 */1557 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1558 const rawTokens = [];1559 for (const token of tokens) {1560 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1561 rawTokens.push(raw);1562 }1563 const creationResult = await this.helper.executeExtrinsic(1564 signer,1565 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1566 true,1567 );1568 const collection = this.getCollectionObject(collectionId);1569 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1570 }15711572 /**1573 * Destroys a concrete instance of RFT.1574 * @param signer keyring of signer1575 * @param collectionId ID of collection1576 * @param tokenId ID of token1577 * @param amount number of pieces to be burnt1578 * @example burnToken(aliceKeyring, 10, 5);1579 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1580 */1581 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<{ success: boolean; token: number | null; }> {1582 return await super.burnToken(signer, collectionId, tokenId, amount);1583 }15841585 /**1586 * Set, change, or remove approved address to transfer the ownership of the RFT.1587 *1588 * @param signer keyring of signer1589 * @param collectionId ID of collection1590 * @param tokenId ID of token1591 * @param toAddressObj address to approve1592 * @param amount number of pieces to be approved1593 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1594 * @returns true if the token success, otherwise false1595 */1596 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1597 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1598 }15991600 /**1601 * Get total number of pieces1602 * @param collectionId ID of collection1603 * @param tokenId ID of token1604 * @example getTokenTotalPieces(10, 5);1605 * @returns number of pieces1606 */1607 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1608 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1609 }16101611 /**1612 * Change number of token pieces. Signer must be the owner of all token pieces.1613 * @param signer keyring of signer1614 * @param collectionId ID of collection1615 * @param tokenId ID of token1616 * @param amount new number of pieces1617 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1618 * @returns true if the repartion was success, otherwise false1619 */1620 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1621 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1622 const repartitionResult = await this.helper.executeExtrinsic(1623 signer,1624 'api.tx.unique.repartition', [collectionId, tokenId, amount],1625 true,1626 );1627 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1628 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1629 }1630}163116321633class FTGroup extends CollectionGroup {1634 /**1635 * Get collection object1636 * @param collectionId ID of collection1637 * @example getCollectionObject(2);1638 * @returns instance of UniqueFTCollection1639 */1640 getCollectionObject(collectionId: number): UniqueFTCollection {1641 return new UniqueFTCollection(collectionId, this.helper);1642 }16431644 /**1645 * Mint new fungible collection1646 * @param signer keyring of signer1647 * @param collectionOptions Collection options1648 * @param decimalPoints number of token decimals1649 * @example1650 * mintCollection(aliceKeyring, {1651 * name: 'New',1652 * description: 'New collection',1653 * tokenPrefix: 'NEW',1654 * }, 18)1655 * @returns newly created fungible collection1656 */1657 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0): Promise<UniqueFTCollection> {1658 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1659 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1660 collectionOptions.mode = {fungible: decimalPoints};1661 for (const key of ['name', 'description', 'tokenPrefix']) {1662 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1663 }1664 const creationResult = await this.helper.executeExtrinsic(1665 signer,1666 'api.tx.unique.createCollectionEx', [collectionOptions],1667 true,1668 );1669 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1670 }16711672 /**1673 * Mint tokens1674 * @param signer keyring of signer1675 * @param collectionId ID of collection1676 * @param owner address owner of new tokens1677 * @param amount amount of tokens to be meanted1678 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1679 * @returns ```true``` if extrinsic success, otherwise ```false```1680 */1681 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1682 const creationResult = await this.helper.executeExtrinsic(1683 signer,1684 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1685 fungible: {1686 value: amount,1687 },1688 }],1689 true, // `Unable to mint fungible tokens for ${label}`,1690 );1691 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1692 }16931694 /**1695 * Mint multiple Fungible tokens with one owner1696 * @param signer keyring of signer1697 * @param collectionId ID of collection1698 * @param owner tokens owner1699 * @param tokens array of tokens with properties and pieces1700 * @returns ```true``` if extrinsic success, otherwise ```false```1701 */1702 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1703 const rawTokens = [];1704 for (const token of tokens) {1705 const raw = {Fungible: {Value: token.value}};1706 rawTokens.push(raw);1707 }1708 const creationResult = await this.helper.executeExtrinsic(1709 signer,1710 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1711 true,1712 );1713 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1714 }17151716 /**1717 * Get the top 10 owners with the largest balance for the Fungible collection1718 * @param collectionId ID of collection1719 * @example getTop10Owners(10);1720 * @returns array of ```ICrossAccountId```1721 */1722 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1723 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1724 }17251726 /**1727 * Get account balance1728 * @param collectionId ID of collection1729 * @param addressObj address of owner1730 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1731 * @returns amount of fungible tokens owned by address1732 */1733 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1734 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1735 }17361737 /**1738 * Transfer tokens to address1739 * @param signer keyring of signer1740 * @param collectionId ID of collection1741 * @param toAddressObj address recipient1742 * @param amount amount of tokens to be sent1743 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1744 * @returns ```true``` if extrinsic success, otherwise ```false```1745 */1746 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1747 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1748 }17491750 /**1751 * Transfer some tokens on behalf of the owner.1752 * @param signer keyring of signer1753 * @param collectionId ID of collection1754 * @param fromAddressObj address on behalf of which tokens will be sent1755 * @param toAddressObj address where token to be sent1756 * @param amount number of tokens to be sent1757 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1758 * @returns ```true``` if extrinsic success, otherwise ```false```1759 */1760 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1761 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1762 }17631764 /**1765 * Destroy some amount of tokens1766 * @param signer keyring of signer1767 * @param collectionId ID of collection1768 * @param amount amount of tokens to be destroyed1769 * @example burnTokens(aliceKeyring, 10, 1000n);1770 * @returns ```true``` if extrinsic success, otherwise ```false```1771 */1772 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1773 return (await super.burnToken(signer, collectionId, 0, amount)).success;1774 }17751776 /**1777 * Burn some tokens on behalf of the owner.1778 * @param signer keyring of signer1779 * @param collectionId ID of collection1780 * @param fromAddressObj address on behalf of which tokens will be burnt1781 * @param amount amount of tokens to be burnt1782 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1783 * @returns ```true``` if extrinsic success, otherwise ```false```1784 */1785 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1786 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, amount);1787 }17881789 /**1790 * Get total collection supply1791 * @param collectionId1792 * @returns1793 */1794 async getTotalPieces(collectionId: number): Promise<bigint> {1795 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1796 }17971798 /**1799 * Set, change, or remove approved address to transfer tokens.1800 *1801 * @param signer keyring of signer1802 * @param collectionId ID of collection1803 * @param toAddressObj address to be approved1804 * @param amount amount of tokens to be approved1805 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1806 * @returns ```true``` if extrinsic success, otherwise ```false```1807 */1808 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1809 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1810 }18111812 /**1813 * Get amount of fungible tokens approved to transfer1814 * @param collectionId ID of collection1815 * @param fromAddressObj owner of tokens1816 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1817 * @returns number of tokens approved for the transfer1818 */1819 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1820 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1821 }1822}182318241825class ChainGroup extends HelperGroup {1826 /**1827 * Get system properties of a chain1828 * @example getChainProperties();1829 * @returns ss58Format, token decimals, and token symbol1830 */1831 getChainProperties(): IChainProperties {1832 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1833 return {1834 ss58Format: properties.ss58Format.toJSON(),1835 tokenDecimals: properties.tokenDecimals.toJSON(),1836 tokenSymbol: properties.tokenSymbol.toJSON(),1837 };1838 }18391840 /**1841 * Get chain header1842 * @example getLatestBlockNumber();1843 * @returns the number of the last block1844 */1845 async getLatestBlockNumber(): Promise<number> {1846 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1847 }18481849 /**1850 * Get block hash by block number1851 * @param blockNumber number of block1852 * @example getBlockHashByNumber(12345);1853 * @returns hash of a block1854 */1855 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1856 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1857 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1858 return blockHash;1859 }18601861 // TODO add docs1862 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {1863 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);1864 if (!blockHash) return null;1865 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;1866 }18671868 /**1869 * Get account nonce1870 * @param address substrate address1871 * @example getNonce("5GrwvaEF5zXb26Fz...");1872 * @returns number, account's nonce1873 */1874 async getNonce(address: TSubstrateAccount): Promise<number> {1875 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1876 }1877}187818791880class BalanceGroup extends HelperGroup {1881 /**1882 * Representation of the native token in the smallest unit1883 * @example getOneTokenNominal()1884 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1885 */1886 getOneTokenNominal(): bigint {1887 const chainProperties = this.helper.chain.getChainProperties();1888 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1889 }18901891 /**1892 * Get substrate address balance1893 * @param address substrate address1894 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1895 * @returns amount of tokens on address1896 */1897 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1898 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1899 }19001901 /**1902 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved1903 * @param address substrate address1904 * @returns1905 */1906 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {1907 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;1908 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};1909 }19101911 /**1912 * Get ethereum address balance1913 * @param address ethereum address1914 * @example getEthereum("0x9F0583DbB855d...")1915 * @returns amount of tokens on address1916 */1917 async getEthereum(address: TEthereumAccount): Promise<bigint> {1918 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1919 }19201921 /**1922 * Transfer tokens to substrate address1923 * @param signer keyring of signer1924 * @param address substrate address of a recipient1925 * @param amount amount of tokens to be transfered1926 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1927 * @returns ```true``` if extrinsic success, otherwise ```false```1928 */1929 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1930 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true/*, `Unable to transfer balance from ${this.helper.getSignerAddress(signer)} to ${address}`*/);19311932 let transfer = {from: null, to: null, amount: 0n} as any;1933 result.result.events.forEach(({event: {data, method, section}}) => {1934 if ((section === 'balances') && (method === 'Transfer')) {1935 transfer = {1936 from: this.helper.address.normalizeSubstrate(data[0]),1937 to: this.helper.address.normalizeSubstrate(data[1]),1938 amount: BigInt(data[2]),1939 };1940 }1941 });1942 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1943 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1944 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1945 return isSuccess;1946 }1947}194819491950class AddressGroup extends HelperGroup {1951 /**1952 * Normalizes the address to the specified ss58 format, by default ```42```.1953 * @param address substrate address1954 * @param ss58Format format for address conversion, by default ```42```1955 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1956 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1957 */1958 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1959 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1960 }19611962 /**1963 * Get address in the connected chain format1964 * @param address substrate address1965 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1966 * @returns address in chain format1967 */1968 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1969 const info = this.helper.chain.getChainProperties();1970 return encodeAddress(decodeAddress(address), info.ss58Format);1971 }19721973 /**1974 * Get substrate mirror of an ethereum address1975 * @param ethAddress ethereum address1976 * @param toChainFormat false for normalized account1977 * @example ethToSubstrate('0x9F0583DbB855d...')1978 * @returns substrate mirror of a provided ethereum address1979 */1980 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1981 if(!toChainFormat) return evmToAddress(ethAddress);1982 const info = this.helper.chain.getChainProperties();1983 return evmToAddress(ethAddress, info.ss58Format);1984 }19851986 /**1987 * Get ethereum mirror of a substrate address1988 * @param subAddress substrate account1989 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1990 * @returns ethereum mirror of a provided substrate address1991 */1992 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1993 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1994 }1995}19961997class StakingGroup extends HelperGroup {1998 /**1999 * Stake tokens for App Promotion2000 * @param signer keyring of signer2001 * @param amountToStake amount of tokens to stake2002 * @param label extra label for log2003 * @returns2004 */2005 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2006 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2007 const stakeResult = await this.helper.executeExtrinsic(2008 signer, 'api.tx.appPromotion.stake',2009 [amountToStake], true,2010 );2011 // TODO extract info from stakeResult2012 return true;2013 }20142015 /**2016 * Unstake tokens for App Promotion2017 * @param signer keyring of signer2018 * @param amountToUnstake amount of tokens to unstake2019 * @param label extra label for log2020 * @returns block number where balances will be unlocked2021 */2022 async unstake(signer: TSigner, label?: string): Promise<number> {2023 if(typeof label === 'undefined') label = `${signer.address}`;2024 const unstakeResult = await this.helper.executeExtrinsic(2025 signer, 'api.tx.appPromotion.unstake',2026 [], true,2027 );2028 // TODO extract block number fron events2029 return 1;2030 }20312032 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2033 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2034 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2035 }20362037 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<bigint[][]> {2038 return (await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2039 }20402041 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2042 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2043 }20442045 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<bigint[][]> {2046 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2047 }2048}20492050export class UniqueHelper extends ChainHelperBase {2051 chain: ChainGroup;2052 balance: BalanceGroup;2053 address: AddressGroup;2054 collection: CollectionGroup;2055 nft: NFTGroup;2056 rft: RFTGroup;2057 ft: FTGroup;2058 staking: StakingGroup;20592060 constructor(logger?: ILogger) {2061 super(logger);2062 this.chain = new ChainGroup(this);2063 this.balance = new BalanceGroup(this);2064 this.address = new AddressGroup(this);2065 this.collection = new CollectionGroup(this);2066 this.nft = new NFTGroup(this);2067 this.rft = new RFTGroup(this);2068 this.ft = new FTGroup(this);2069 this.staking = new StakingGroup(this);2070 }2071}207220732074class UniqueCollectionBase {2075 helper: UniqueHelper;2076 collectionId: number;20772078 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2079 this.collectionId = collectionId;2080 this.helper = uniqueHelper;2081 }20822083 async getData() {2084 return await this.helper.collection.getData(this.collectionId);2085 }20862087 async getLastTokenId() {2088 return await this.helper.collection.getLastTokenId(this.collectionId);2089 }20902091 async isTokenExists(tokenId: number) {2092 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2093 }20942095 async getAdmins() {2096 return await this.helper.collection.getAdmins(this.collectionId);2097 }20982099 async getAllowList() {2100 return await this.helper.collection.getAllowList(this.collectionId);2101 }21022103 async getEffectiveLimits() {2104 return await this.helper.collection.getEffectiveLimits(this.collectionId);2105 }21062107 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2108 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2109 }21102111 async confirmSponsorship(signer: TSigner) {2112 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2113 }21142115 async removeSponsor(signer: TSigner) {2116 return await this.helper.collection.removeSponsor(signer, this.collectionId);2117 }21182119 async setLimits(signer: TSigner, limits: ICollectionLimits) {2120 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2121 }21222123 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2124 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2125 }21262127 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2128 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2129 }21302131 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2132 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2133 }21342135 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2136 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2137 }21382139 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2140 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2141 }21422143 async setProperties(signer: TSigner, properties: IProperty[]) {2144 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2145 }21462147 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2148 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2149 }21502151 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2152 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2153 }21542155 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2156 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2157 }21582159 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2160 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2161 }21622163 async disableNesting(signer: TSigner) {2164 return await this.helper.collection.disableNesting(signer, this.collectionId);2165 }21662167 async burn(signer: TSigner) {2168 return await this.helper.collection.burn(signer, this.collectionId);2169 }2170}217121722173class UniqueNFTCollection extends UniqueCollectionBase {2174 getTokenObject(tokenId: number) {2175 return new UniqueNFTToken(tokenId, this);2176 }21772178 async getTokensByAddress(addressObj: ICrossAccountId) {2179 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2180 }21812182 async getToken(tokenId: number, blockHashAt?: string) {2183 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2184 }21852186 async getTokenOwner(tokenId: number, blockHashAt?: string) {2187 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2188 }21892190 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2191 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2192 }21932194 async getTokenChildren(tokenId: number, blockHashAt?: string) {2195 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2196 }21972198 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2199 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2200 }22012202 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2203 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2204 }22052206 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2207 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2208 }22092210 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2211 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2212 }22132214 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2215 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2216 }22172218 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2219 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2220 }22212222 async burnToken(signer: TSigner, tokenId: number) {2223 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2224 }22252226 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2227 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2228 }22292230 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2231 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2232 }22332234 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2235 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2236 }22372238 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2239 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2240 }22412242 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2243 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2244 }2245}224622472248class UniqueRFTCollection extends UniqueCollectionBase {2249 getTokenObject(tokenId: number) {2250 return new UniqueRFTToken(tokenId, this);2251 }22522253 async getTokensByAddress(addressObj: ICrossAccountId) {2254 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2255 }22562257 async getTop10TokenOwners(tokenId: number) {2258 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2259 }22602261 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2262 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2263 }22642265 async getTokenTotalPieces(tokenId: number) {2266 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2267 }22682269 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2270 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2271 }22722273 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2274 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2275 }22762277 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2278 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2279 }22802281 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2282 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2283 }22842285 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2286 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2287 }22882289 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2290 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2291 }22922293 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {2294 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2295 }22962297 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2298 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2299 }23002301 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2302 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2303 }23042305 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2306 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2307 }23082309 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2310 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2311 }2312}231323142315class UniqueFTCollection extends UniqueCollectionBase {2316 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {2317 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);2318 }23192320 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {2321 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);2322 }23232324 async getBalance(addressObj: ICrossAccountId) {2325 return await this.helper.ft.getBalance(this.collectionId, addressObj);2326 }23272328 async getTop10Owners() {2329 return await this.helper.ft.getTop10Owners(this.collectionId);2330 }23312332 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2333 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2334 }23352336 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2337 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2338 }23392340 async burnTokens(signer: TSigner, amount=1n) {2341 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2342 }23432344 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2345 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2346 }23472348 async getTotalPieces() {2349 return await this.helper.ft.getTotalPieces(this.collectionId);2350 }23512352 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2353 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2354 }23552356 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2357 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2358 }2359}236023612362class UniqueTokenBase implements IToken {2363 collection: UniqueNFTCollection | UniqueRFTCollection;2364 collectionId: number;2365 tokenId: number;23662367 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2368 this.collection = collection;2369 this.collectionId = collection.collectionId;2370 this.tokenId = tokenId;2371 }23722373 async getNextSponsored(addressObj: ICrossAccountId) {2374 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2375 }23762377 async setProperties(signer: TSigner, properties: IProperty[]) {2378 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2379 }23802381 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2382 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2383 }2384}238523862387class UniqueNFTToken extends UniqueTokenBase {2388 collection: UniqueNFTCollection;23892390 constructor(tokenId: number, collection: UniqueNFTCollection) {2391 super(tokenId, collection);2392 this.collection = collection;2393 }23942395 async getData(blockHashAt?: string) {2396 return await this.collection.getToken(this.tokenId, blockHashAt);2397 }23982399 async getOwner(blockHashAt?: string) {2400 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2401 }24022403 async getTopmostOwner(blockHashAt?: string) {2404 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2405 }24062407 async getChildren(blockHashAt?: string) {2408 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2409 }24102411 async nest(signer: TSigner, toTokenObj: IToken) {2412 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2413 }24142415 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2416 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2417 }24182419 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2420 return await this.collection.transferToken(signer, this.tokenId, addressObj);2421 }24222423 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2424 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2425 }24262427 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2428 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2429 }24302431 async isApproved(toAddressObj: ICrossAccountId) {2432 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2433 }24342435 async burn(signer: TSigner) {2436 return await this.collection.burnToken(signer, this.tokenId);2437 }2438}24392440class UniqueRFTToken extends UniqueTokenBase {2441 collection: UniqueRFTCollection;24422443 constructor(tokenId: number, collection: UniqueRFTCollection) {2444 super(tokenId, collection);2445 this.collection = collection;2446 }24472448 async getTop10Owners() {2449 return await this.collection.getTop10TokenOwners(this.tokenId);2450 }24512452 async getBalance(addressObj: ICrossAccountId) {2453 return await this.collection.getTokenBalance(this.tokenId, addressObj);2454 }24552456 async getTotalPieces() {2457 return await this.collection.getTokenTotalPieces(this.tokenId);2458 }24592460 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2461 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2462 }24632464 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2465 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2466 }24672468 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2469 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2470 }24712472 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2473 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2474 }24752476 async repartition(signer: TSigner, amount: bigint) {2477 return await this.collection.repartitionToken(signer, this.tokenId, amount);2478 }24792480 async burn(signer: TSigner, amount=1n) {2481 return await this.collection.burnToken(signer, this.tokenId, amount);2482 }2483}