difftreelog
refactor Rename module in extrinsic
in: master
13 files changed
primitives/app_promotion_rpc/src/lib.rsdiffbeforeafterboth--- a/primitives/app_promotion_rpc/src/lib.rs
+++ b/primitives/app_promotion_rpc/src/lib.rs
@@ -16,11 +16,6 @@
#![cfg_attr(not(feature = "std"), no_std)]
-use up_data_structs::{
- CollectionId, TokenId, RpcCollection, CollectionStats, CollectionLimits, Property,
- PropertyKeyPermission, TokenData, TokenChild,
-};
-
use sp_std::vec::Vec;
use codec::Decode;
use sp_runtime::{
runtime/common/construct_runtime/mod.rsdiffbeforeafterboth--- a/runtime/common/construct_runtime/mod.rs
+++ b/runtime/common/construct_runtime/mod.rs
@@ -78,7 +78,7 @@
RmrkEquip: pallet_proxy_rmrk_equip::{Pallet, Call, Storage, Event<T>} = 72,
#[runtimes(opal)]
- Promotion: pallet_app_promotion::{Pallet, Call, Storage, Event<T>} = 73,
+ AppPromotion: pallet_app_promotion::{Pallet, Call, Storage, Event<T>} = 73,
// Frontier
EVM: pallet_evm::{Pallet, Config, Call, Storage, Event<T>} = 100,
tests/src/app-promotion.test.tsdiffbeforeafterboth--- a/tests/src/app-promotion.test.ts
+++ b/tests/src/app-promotion.test.ts
@@ -38,29 +38,20 @@
const palletAddress = calculatePalleteAddress('appstake');
let accounts: IKeyringPair[] = [];
-before(async function () {
- await usingPlaygrounds(async (helper, privateKeyWrapper) => {
- if (!getModuleNames(helper.api!).includes(Pallets.AppPromotion)) this.skip();
- alice = privateKeyWrapper('//Alice');
- palletAdmin = privateKeyWrapper('//Charlie'); // TODO use custom address
- await helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress({Substrate: palletAdmin.address})));
- nominal = helper.balance.getOneTokenNominal();
- await helper.balance.transferToSubstrate(alice, palletAdmin.address, 1000n * nominal);
- await helper.balance.transferToSubstrate(alice, palletAddress, 1000n * nominal);
- if (!promotionStartBlock) {
- promotionStartBlock = (await helper.api!.query.parachainSystem.lastRelayChainBlockNumber()).toNumber();
- }
- await helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.startAppPromotion(promotionStartBlock!)));
- accounts = await helper.arrange.createCrowd(100, 1000n, alice); // create accounts-pool to speed up tests
- });
-});
-
-after(async function () {
- await usingPlaygrounds(async (helper) => {
+describe('app-promotions.stake extrinsic', () => {
+ before(async function () {
+ await usingPlaygrounds(async (helper, privateKeyWrapper) => {
+ if (!getModuleNames(helper.api!).includes(Pallets.AppPromotion)) this.skip();
+ alice = privateKeyWrapper('//Alice');
+ palletAdmin = privateKeyWrapper('//Charlie'); // TODO use custom address
+ await helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address})));
+ nominal = helper.balance.getOneTokenNominal();
+ await helper.balance.transferToSubstrate(alice, palletAdmin.address, 1000n * nominal);
+ await helper.balance.transferToSubstrate(alice, palletAddress, 1000n * nominal);
+ accounts = await helper.arrange.createCrowd(100, 1000n, alice); // create accounts-pool to speed up tests
+ });
});
-});
-describe('app-promotions.stake extrinsic', () => {
it('should "lock" staking balance, add it to "staked" map, and increase "totalStaked" amount', async () => {
await usingPlaygrounds(async (helper) => {
const [staker, recepient] = [accounts.pop()!, accounts.pop()!];
@@ -264,11 +255,11 @@
await usingPlaygrounds(async (helper) => {
const nonAdmin = accounts.pop()!;
// nonAdmin can not set admin not from himself nor as a sudo
- await expect(helper.signTransaction(nonAdmin, helper.api!.tx.promotion.setAdminAddress({Substrate: nonAdmin.address}))).to.be.eventually.rejected;
- await expect(helper.signTransaction(nonAdmin, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress({Substrate: nonAdmin.address})))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(nonAdmin, helper.api!.tx.appPromotion.setAdminAddress({Substrate: nonAdmin.address}))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(nonAdmin, helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress({Substrate: nonAdmin.address})))).to.be.eventually.rejected;
// Alice can
- await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress({Substrate: palletAdmin.address})))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address})))).to.be.eventually.fulfilled;
});
});
@@ -279,12 +270,12 @@
const account = accounts.pop()!;
const ethAccount = helper.address.substrateToEth(account.address);
// Alice sets Ethereum address as a sudo. Then Substrate address back...
- await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress({Ethereum: ethAccount})))).to.be.eventually.fulfilled;
- await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress({Substrate: palletAdmin.address})))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress({Ethereum: ethAccount})))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address})))).to.be.eventually.fulfilled;
// ...It doesn't break anything;
const collection = await helper.nft.mintCollection(account, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
- await expect(helper.signTransaction(account, helper.api!.tx.promotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(account, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
});
});
@@ -293,11 +284,11 @@
const [oldAdmin, newAdmin, collectionOwner] = [accounts.pop()!, accounts.pop()!, accounts.pop()!];
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
- await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress(normalizeAccountId(oldAdmin))))).to.be.eventually.fulfilled;
- await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress(normalizeAccountId(newAdmin))))).to.be.eventually.fulfilled;
- await expect(helper.signTransaction(oldAdmin, helper.api!.tx.promotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress(normalizeAccountId(oldAdmin))))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(alice, helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress(normalizeAccountId(newAdmin))))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(oldAdmin, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
- await expect(helper.signTransaction(newAdmin, helper.api!.tx.promotion.sponsorCollection(collection.collectionId))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(newAdmin, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.eventually.fulfilled;
});
});
});
@@ -305,7 +296,7 @@
describe('App-promotion collection sponsoring', () => {
before(async function () {
await usingPlaygrounds(async (helper) => {
- const tx = helper.api!.tx.sudo.sudo(helper.api!.tx.promotion.setAdminAddress({Substrate: palletAdmin.address}));
+ const tx = helper.api!.tx.sudo.sudo(helper.api!.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address}));
await helper.signTransaction(alice, tx);
});
});
@@ -315,7 +306,7 @@
const [collectionOwner, tokenSender, receiver] = [accounts.pop()!, accounts.pop()!, accounts.pop()!];
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'Name', description: 'Description', tokenPrefix: 'Prefix', limits: {sponsorTransferTimeout: 0}});
const token = await collection.mintToken(collectionOwner, {Substrate: tokenSender.address});
- await helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collection.collectionId));
+ await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId));
const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress);
await token.transfer(tokenSender, {Substrate: receiver.address});
@@ -334,7 +325,7 @@
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
- await expect(helper.signTransaction(nonAdmin, helper.api!.tx.promotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(nonAdmin, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
expect((await collection.getData())?.raw.sponsorship).to.equal('Disabled');
});
});
@@ -345,19 +336,19 @@
// Can set sponsoring for collection without sponsor
const collectionWithoutSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'No-sponsor', description: 'New Collection', tokenPrefix: 'Promotion'});
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collectionWithoutSponsor.collectionId))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collectionWithoutSponsor.collectionId))).to.be.eventually.fulfilled;
expect((await collectionWithoutSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});
// Can set sponsoring for collection with unconfirmed sponsor
const collectionWithUnconfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Unconfirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address});
expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: oldSponsor.address});
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collectionWithUnconfirmedSponsor.collectionId))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collectionWithUnconfirmedSponsor.collectionId))).to.be.eventually.fulfilled;
expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});
// Can set sponsoring for collection with confirmed sponsor
const collectionWithConfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Confirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address});
await collectionWithConfirmedSponsor.confirmSponsorship(oldSponsor);
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collectionWithConfirmedSponsor.collectionId))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collectionWithConfirmedSponsor.collectionId))).to.be.eventually.fulfilled;
expect((await collectionWithConfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});
});
});
@@ -368,7 +359,7 @@
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
const collectionId = collection.collectionId;
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collectionId))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collectionId))).to.be.eventually.fulfilled;
// Collection limits still can be changed by the owner
expect(await collection.setLimits(collectionOwner, {sponsorTransferTimeout: 0})).to.be.true;
@@ -386,7 +377,7 @@
const limits = {ownerCanDestroy: true, ownerCanTransfer: true, sponsorTransferTimeout: 0};
const collectionWithLimits = await helper.nft.mintCollection(alice, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits});
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collectionWithLimits.collectionId))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collectionWithLimits.collectionId))).to.be.eventually.fulfilled;
expect((await collectionWithLimits.getData())?.raw.limits).to.be.deep.contain(limits);
});
});
@@ -396,12 +387,12 @@
const collectionOwner = accounts.pop()!;
// collection has never existed
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(999999999))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(999999999))).to.be.eventually.rejected;
// collection has been burned
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
await collection.burn(collectionOwner);
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.eventually.rejected;
});
});
});
@@ -412,9 +403,9 @@
const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!];
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collection.collectionId))).to.be.eventually.fulfilled;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.eventually.fulfilled;
- await expect(helper.signTransaction(nonAdmin, helper.api!.tx.promotion.stopSponsoringCollection(collection.collectionId))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(nonAdmin, helper.api!.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.eventually.rejected;
expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});
});
});
@@ -425,8 +416,8 @@
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits: {sponsorTransferTimeout: 0}});
const token = await collection.mintToken(collectionOwner, {Substrate: collectionOwner.address});
- await helper.signTransaction(palletAdmin, helper.api!.tx.promotion.sponsorCollection(collection.collectionId));
- await helper.signTransaction(palletAdmin, helper.api!.tx.promotion.stopSponsoringCollection(collection.collectionId));
+ await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.sponsorCollection(collection.collectionId));
+ await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.stopSponsoringCollection(collection.collectionId));
expect((await collection.getData())?.raw.sponsorship).to.be.equal('Disabled');
@@ -444,7 +435,7 @@
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: collectionOwner.address});
await collection.confirmSponsorship(collectionOwner);
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.stopSponsoringCollection(collection.collectionId))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.eventually.rejected;
expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: collectionOwner.address});
});
@@ -456,8 +447,8 @@
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
await collection.burn(collectionOwner);
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.stopSponsoringCollection(collection.collectionId))).to.be.eventually.rejected;
- await expect(helper.signTransaction(palletAdmin, helper.api!.tx.promotion.stopSponsoringCollection(999999999))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.eventually.rejected;
+ await expect(helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.stopSponsoringCollection(999999999))).to.be.eventually.rejected;
});
});
});
@@ -469,7 +460,7 @@
const flipper = await deployFlipper(web3, contractOwner);
const contractMethods = contractHelpers(web3, contractOwner);
- await helper.signTransaction(palletAdmin, api.tx.promotion.sponsorConract(flipper.options.address));
+ await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorConract(flipper.options.address));
expect(await contractMethods.methods.hasSponsor(flipper.options.address).call()).to.be.true;
expect((await api.query.evmContractHelpers.owner(flipper.options.address)).toJSON()).to.be.equal(contractOwner);
@@ -497,7 +488,7 @@
});
// set promotion sponsoring
- await helper.signTransaction(palletAdmin, api.tx.promotion.sponsorConract(flipper.options.address));
+ await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorConract(flipper.options.address));
// new sponsor is pallet address
expect(await contractMethods.methods.hasSponsor(flipper.options.address).call()).to.be.true;
@@ -517,7 +508,7 @@
const contractMethods = contractHelpers(web3, contractOwner);
// contract sponsored by pallet
- await helper.signTransaction(palletAdmin, api.tx.promotion.sponsorConract(flipper.options.address));
+ await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorConract(flipper.options.address));
// owner sets self sponsoring
await expect(contractMethods.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.not.rejected;
@@ -542,7 +533,7 @@
await expect(contractMethods.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.not.rejected;
// nonAdmin calls sponsorConract
- await expect(helper.signTransaction(nonAdmin, api.tx.promotion.sponsorConract(flipper.options.address))).to.be.rejected;
+ await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.sponsorConract(flipper.options.address))).to.be.rejected;
// contract still self-sponsored
expect((await api.query.evmContractHelpers.sponsoring(flipper.options.address)).toJSON()).to.deep.equal({
@@ -569,7 +560,7 @@
await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner});
await transferBalanceToEth(api, alice, flipper.options.address, 1000n);
- await helper.signTransaction(palletAdmin, api.tx.promotion.sponsorConract(flipper.options.address));
+ await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorConract(flipper.options.address));
await flipper.methods.flip().send({from: caller});
expect(await flipper.methods.getValue().call()).to.be.true;
@@ -591,8 +582,8 @@
await transferBalanceToEth(api, alice, flipper.options.address);
const contractHelper = contractHelpers(web3, contractOwner);
await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner});
- await helper.signTransaction(palletAdmin, api.tx.promotion.sponsorConract(flipper.options.address));
- await helper.signTransaction(palletAdmin, api.tx.promotion.stopSponsoringContract(flipper.options.address));
+ await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorConract(flipper.options.address));
+ await helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringContract(flipper.options.address));
expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.false;
expect((await api.query.evmContractHelpers.owner(flipper.options.address)).toJSON()).to.be.equal(contractOwner);
@@ -618,8 +609,8 @@
const contractOwner = (await createEthAccountWithBalance(api, web3, privateKeyWrapper)).toLowerCase();
const flipper = await deployFlipper(web3, contractOwner);
- await helper.signTransaction(palletAdmin, api.tx.promotion.sponsorConract(flipper.options.address));
- await expect(helper.signTransaction(nonAdmin, api.tx.promotion.stopSponsoringContract(flipper.options.address))).to.be.rejected;
+ await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorConract(flipper.options.address));
+ await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.stopSponsoringContract(flipper.options.address))).to.be.rejected;
});
});
@@ -631,7 +622,7 @@
const contractHelper = contractHelpers(web3, contractOwner);
await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.not.rejected;
- await expect(helper.signTransaction(nonAdmin, api.tx.promotion.stopSponsoringContract(flipper.options.address))).to.be.rejected;
+ await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.stopSponsoringContract(flipper.options.address))).to.be.rejected;
});
});
});
@@ -640,7 +631,7 @@
it('can not be called by non admin', async () => {
await usingPlaygrounds(async (helper) => {
const nonAdmin = accounts.pop()!;
- await expect(helper.signTransaction(nonAdmin, helper.api!.tx.promotion.payoutStakers(100))).to.be.rejected;
+ await expect(helper.signTransaction(nonAdmin, helper.api!.tx.appPromotion.payoutStakers(100))).to.be.rejected;
});
});
@@ -652,7 +643,7 @@
await helper.staking.stake(staker, 100n * nominal);
await helper.staking.stake(staker, 200n * nominal);
await waitForRelayBlock(helper.api!, 30);
- await helper.signTransaction(palletAdmin, helper.api!.tx.promotion.payoutStakers(100));
+ await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
const totalStakedPerBlock = (await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).map(s => s[1]);
expect(totalStakedPerBlock).to.be.deep.equal([calculateIncome(100n * nominal, 10n), calculateIncome(200n * nominal, 10n)]);
@@ -668,7 +659,7 @@
await helper.staking.stake(staker, 200n * nominal);
await waitForRelayBlock(helper.api!, 55);
- await helper.signTransaction(palletAdmin, helper.api!.tx.promotion.payoutStakers(100));
+ await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
const stakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
expect(stakedPerBlock[0][1]).to.be.equal(calculateIncome(100n * nominal, 10n, 2));
expect(stakedPerBlock[1][1]).to.be.equal(calculateIncome(200n * nominal, 10n, 2));
@@ -707,12 +698,12 @@
await helper.staking.stake(staker, 300n * nominal);
await waitForRelayBlock(helper.api!, 34);
- await helper.signTransaction(palletAdmin, helper.api!.tx.promotion.payoutStakers(100));
+ await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
let totalStakedPerBlock = (await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).map(s => s[1]);
expect(totalStakedPerBlock).to.deep.equal([calculateIncome(100n * nominal, 10n), calculateIncome(200n * nominal, 10n), calculateIncome(300n * nominal, 10n)]);
await waitForRelayBlock(helper.api!, 20);
- await helper.signTransaction(palletAdmin, helper.api!.tx.promotion.payoutStakers(100));
+ await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
totalStakedPerBlock = (await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).map(s => s[1]);
expect(totalStakedPerBlock).to.deep.equal([calculateIncome(100n * nominal, 10n, 2), calculateIncome(200n * nominal, 10n, 2), calculateIncome(300n * nominal, 10n, 2)]);
});
tests/src/interfaces/augment-api-consts.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-consts.ts
+++ b/tests/src/interfaces/augment-api-consts.ts
@@ -15,6 +15,30 @@
declare module '@polkadot/api-base/types/consts' {
interface AugmentedConsts<ApiType extends ApiTypes> {
+ appPromotion: {
+ /**
+ * In chain blocks.
+ **/
+ day: u32 & AugmentedConst<ApiType>;
+ intervalIncome: Perbill & AugmentedConst<ApiType>;
+ nominal: u128 & AugmentedConst<ApiType>;
+ /**
+ * The app's pallet id, used for deriving its sovereign account ID.
+ **/
+ palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
+ /**
+ * In relay blocks.
+ **/
+ pendingInterval: u32 & AugmentedConst<ApiType>;
+ /**
+ * In relay blocks.
+ **/
+ recalculationInterval: u32 & AugmentedConst<ApiType>;
+ /**
+ * Generic const
+ **/
+ [key: string]: Codec;
+ };
balances: {
/**
* The minimum amount required to keep an account open.
@@ -61,30 +85,6 @@
* Number of blocks that pass between treasury balance updates due to inflation
**/
inflationBlockInterval: u32 & AugmentedConst<ApiType>;
- /**
- * Generic const
- **/
- [key: string]: Codec;
- };
- promotion: {
- /**
- * In chain blocks.
- **/
- day: u32 & AugmentedConst<ApiType>;
- intervalIncome: Perbill & AugmentedConst<ApiType>;
- nominal: u128 & AugmentedConst<ApiType>;
- /**
- * The app's pallet id, used for deriving its sovereign account ID.
- **/
- palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
- /**
- * In relay blocks.
- **/
- pendingInterval: u32 & AugmentedConst<ApiType>;
- /**
- * In relay blocks.
- **/
- recalculationInterval: u32 & AugmentedConst<ApiType>;
/**
* Generic const
**/
tests/src/interfaces/augment-api-errors.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-errors.ts
+++ b/tests/src/interfaces/augment-api-errors.ts
@@ -11,6 +11,29 @@
declare module '@polkadot/api-base/types/errors' {
interface AugmentedErrors<ApiType extends ApiTypes> {
+ appPromotion: {
+ /**
+ * Error due to action requiring admin to be set
+ **/
+ AdminNotSet: AugmentedError<ApiType>;
+ /**
+ * An error related to the fact that an invalid argument was passed to perform an action
+ **/
+ InvalidArgument: AugmentedError<ApiType>;
+ /**
+ * No permission to perform an action
+ **/
+ NoPermission: AugmentedError<ApiType>;
+ /**
+ * Insufficient funds to perform an action
+ **/
+ NotSufficientFounds: AugmentedError<ApiType>;
+ PendingForBlockOverflow: AugmentedError<ApiType>;
+ /**
+ * Generic error
+ **/
+ [key: string]: AugmentedError<ApiType>;
+ };
balances: {
/**
* Beneficiary account must pre-exist
@@ -430,28 +453,6 @@
* The message's weight could not be determined.
**/
UnweighableMessage: AugmentedError<ApiType>;
- /**
- * Generic error
- **/
- [key: string]: AugmentedError<ApiType>;
- };
- promotion: {
- /**
- * Error due to action requiring admin to be set
- **/
- AdminNotSet: AugmentedError<ApiType>;
- /**
- * An error related to the fact that an invalid argument was passed to perform an action
- **/
- InvalidArgument: AugmentedError<ApiType>;
- /**
- * No permission to perform an action
- **/
- NoPermission: AugmentedError<ApiType>;
- /**
- * Insufficient funds to perform an action
- **/
- NotSufficientFounds: AugmentedError<ApiType>;
/**
* Generic error
**/
tests/src/interfaces/augment-api-events.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-events.ts
+++ b/tests/src/interfaces/augment-api-events.ts
@@ -15,6 +15,13 @@
declare module '@polkadot/api-base/types/events' {
interface AugmentedEvents<ApiType extends ApiTypes> {
+ appPromotion: {
+ StakingRecalculation: AugmentedEvent<ApiType, [AccountId32, u128, u128]>;
+ /**
+ * Generic event
+ **/
+ [key: string]: AugmentedEvent<ApiType>;
+ };
balances: {
/**
* A balance was set by root.
@@ -355,13 +362,6 @@
* \[ destination, result \]
**/
VersionChangeNotified: AugmentedEvent<ApiType, [XcmV1MultiLocation, u32]>;
- /**
- * Generic event
- **/
- [key: string]: AugmentedEvent<ApiType>;
- };
- promotion: {
- StakingRecalculation: AugmentedEvent<ApiType, [AccountId32, u128, u128]>;
/**
* Generic event
**/
tests/src/interfaces/augment-api-query.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-query.ts
+++ b/tests/src/interfaces/augment-api-query.ts
@@ -17,6 +17,35 @@
declare module '@polkadot/api-base/types/storage' {
interface AugmentedQueries<ApiType extends ApiTypes> {
+ appPromotion: {
+ admin: AugmentedQuery<ApiType, () => Observable<Option<AccountId32>>, []> & QueryableStorageEntry<ApiType, []>;
+ /**
+ * Stores hash a record for which the last revenue recalculation was performed.
+ * If `None`, then recalculation has not yet been performed or calculations have been completed for all stakers.
+ **/
+ nextCalculatedRecord: AugmentedQuery<ApiType, () => Observable<Option<ITuple<[AccountId32, u32]>>>, []> & QueryableStorageEntry<ApiType, []>;
+ /**
+ * Amount of tokens pending unstake per user per block.
+ **/
+ pendingUnstake: AugmentedQuery<ApiType, (arg: u32 | AnyNumber | Uint8Array) => Observable<Vec<ITuple<[AccountId32, u128]>>>, [u32]> & QueryableStorageEntry<ApiType, [u32]>;
+ /**
+ * Amount of tokens staked by account in the blocknumber.
+ **/
+ staked: AugmentedQuery<ApiType, (arg1: AccountId32 | string | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<ITuple<[u128, u32]>>, [AccountId32, u32]> & QueryableStorageEntry<ApiType, [AccountId32, u32]>;
+ /**
+ * Amount of stakes for an Account
+ **/
+ stakesPerAccount: AugmentedQuery<ApiType, (arg: AccountId32 | string | Uint8Array) => Observable<u8>, [AccountId32]> & QueryableStorageEntry<ApiType, [AccountId32]>;
+ /**
+ * A block when app-promotion has started .I think this is redundant, because we only need `NextInterestBlock`.
+ **/
+ startBlock: AugmentedQuery<ApiType, () => Observable<u32>, []> & QueryableStorageEntry<ApiType, []>;
+ totalStaked: AugmentedQuery<ApiType, () => Observable<u128>, []> & QueryableStorageEntry<ApiType, []>;
+ /**
+ * Generic query
+ **/
+ [key: string]: QueryableStorageEntry<ApiType>;
+ };
balances: {
/**
* The Balances pallet example of storing the balance of an account.
@@ -505,39 +534,6 @@
* in the trie.
**/
validationData: AugmentedQuery<ApiType, () => Observable<Option<PolkadotPrimitivesV2PersistedValidationData>>, []> & QueryableStorageEntry<ApiType, []>;
- /**
- * Generic query
- **/
- [key: string]: QueryableStorageEntry<ApiType>;
- };
- promotion: {
- admin: AugmentedQuery<ApiType, () => Observable<Option<AccountId32>>, []> & QueryableStorageEntry<ApiType, []>;
- /**
- * Stores hash a record for which the last revenue recalculation was performed.
- * If `None`, then recalculation has not yet been performed or calculations have been completed for all stakers.
- **/
- nextCalculatedRecord: AugmentedQuery<ApiType, () => Observable<Option<ITuple<[AccountId32, u32]>>>, []> & QueryableStorageEntry<ApiType, []>;
- /**
- * Next target block when interest is recalculated
- **/
- nextInterestBlock: AugmentedQuery<ApiType, () => Observable<u32>, []> & QueryableStorageEntry<ApiType, []>;
- /**
- * Amount of tokens pending unstake per user per block.
- **/
- pendingUnstake: AugmentedQuery<ApiType, (arg1: AccountId32 | string | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<u128>, [AccountId32, u32]> & QueryableStorageEntry<ApiType, [AccountId32, u32]>;
- /**
- * Amount of tokens staked by account in the blocknumber.
- **/
- staked: AugmentedQuery<ApiType, (arg1: AccountId32 | string | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<ITuple<[u128, u32]>>, [AccountId32, u32]> & QueryableStorageEntry<ApiType, [AccountId32, u32]>;
- /**
- * Amount of stakes for an Account
- **/
- stakesPerAccount: AugmentedQuery<ApiType, (arg: AccountId32 | string | Uint8Array) => Observable<u8>, [AccountId32]> & QueryableStorageEntry<ApiType, [AccountId32]>;
- /**
- * A block when app-promotion has started .I think this is redundant, because we only need `NextInterestBlock`.
- **/
- startBlock: AugmentedQuery<ApiType, () => Observable<u32>, []> & QueryableStorageEntry<ApiType, []>;
- totalStaked: AugmentedQuery<ApiType, () => Observable<u128>, []> & QueryableStorageEntry<ApiType, []>;
/**
* Generic query
**/
tests/src/interfaces/augment-api-tx.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-tx.ts
+++ b/tests/src/interfaces/augment-api-tx.ts
@@ -17,6 +17,20 @@
declare module '@polkadot/api-base/types/submittable' {
interface AugmentedSubmittables<ApiType extends ApiTypes> {
+ appPromotion: {
+ payoutStakers: AugmentedSubmittable<(stakersNumber: Option<u8> | null | Uint8Array | u8 | AnyNumber) => SubmittableExtrinsic<ApiType>, [Option<u8>]>;
+ setAdminAddress: AugmentedSubmittable<(admin: PalletEvmAccountBasicCrossAccountIdRepr | { Substrate: any } | { Ethereum: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [PalletEvmAccountBasicCrossAccountIdRepr]>;
+ sponsorCollection: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
+ sponsorConract: AugmentedSubmittable<(contractId: H160 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [H160]>;
+ stake: AugmentedSubmittable<(amount: u128 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u128]>;
+ stopSponsoringCollection: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
+ stopSponsoringContract: AugmentedSubmittable<(contractId: H160 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [H160]>;
+ unstake: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
+ /**
+ * Generic tx
+ **/
+ [key: string]: SubmittableExtrinsicFunction<ApiType>;
+ };
balances: {
/**
* Exactly as `transfer`, except the origin must be root and the source account may be
@@ -370,22 +384,6 @@
* fees.
**/
teleportAssets: AugmentedSubmittable<(dest: XcmVersionedMultiLocation | { V0: any } | { V1: any } | string | Uint8Array, beneficiary: XcmVersionedMultiLocation | { V0: any } | { V1: any } | string | Uint8Array, assets: XcmVersionedMultiAssets | { V0: any } | { V1: any } | string | Uint8Array, feeAssetItem: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [XcmVersionedMultiLocation, XcmVersionedMultiLocation, XcmVersionedMultiAssets, u32]>;
- /**
- * Generic tx
- **/
- [key: string]: SubmittableExtrinsicFunction<ApiType>;
- };
- promotion: {
- payoutStakers: AugmentedSubmittable<(stakersNumber: Option<u8> | null | Uint8Array | u8 | AnyNumber) => SubmittableExtrinsic<ApiType>, [Option<u8>]>;
- setAdminAddress: AugmentedSubmittable<(admin: PalletEvmAccountBasicCrossAccountIdRepr | { Substrate: any } | { Ethereum: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [PalletEvmAccountBasicCrossAccountIdRepr]>;
- sponsorCollection: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
- sponsorConract: AugmentedSubmittable<(contractId: H160 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [H160]>;
- stake: AugmentedSubmittable<(amount: u128 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u128]>;
- startAppPromotion: AugmentedSubmittable<(promotionStartRelayBlock: Option<u32> | null | Uint8Array | u32 | AnyNumber) => SubmittableExtrinsic<ApiType>, [Option<u32>]>;
- stopAppPromotion: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
- stopSponsoringCollection: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
- stopSponsoringContract: AugmentedSubmittable<(contractId: H160 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [H160]>;
- unstake: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
/**
* Generic tx
**/
tests/src/interfaces/default/types.tsdiffbeforeafterboth--- a/tests/src/interfaces/default/types.ts
+++ b/tests/src/interfaces/default/types.ts
@@ -812,11 +812,6 @@
readonly asSetAdminAddress: {
readonly admin: PalletEvmAccountBasicCrossAccountIdRepr;
} & Struct;
- readonly isStartAppPromotion: boolean;
- readonly asStartAppPromotion: {
- readonly promotionStartRelayBlock: Option<u32>;
- } & Struct;
- readonly isStopAppPromotion: boolean;
readonly isStake: boolean;
readonly asStake: {
readonly amount: u128;
@@ -842,7 +837,7 @@
readonly asPayoutStakers: {
readonly stakersNumber: Option<u8>;
} & Struct;
- readonly type: 'SetAdminAddress' | 'StartAppPromotion' | 'StopAppPromotion' | 'Stake' | 'Unstake' | 'SponsorCollection' | 'StopSponsoringCollection' | 'SponsorConract' | 'StopSponsoringContract' | 'PayoutStakers';
+ readonly type: 'SetAdminAddress' | 'Stake' | 'Unstake' | 'SponsorCollection' | 'StopSponsoringCollection' | 'SponsorConract' | 'StopSponsoringContract' | 'PayoutStakers';
}
/** @name PalletAppPromotionError */
@@ -850,8 +845,9 @@
readonly isAdminNotSet: boolean;
readonly isNoPermission: boolean;
readonly isNotSufficientFounds: boolean;
+ readonly isPendingForBlockOverflow: boolean;
readonly isInvalidArgument: boolean;
- readonly type: 'AdminNotSet' | 'NoPermission' | 'NotSufficientFounds' | 'InvalidArgument';
+ readonly type: 'AdminNotSet' | 'NoPermission' | 'NotSufficientFounds' | 'PendingForBlockOverflow' | 'InvalidArgument';
}
/** @name PalletAppPromotionEvent */
tests/src/interfaces/lookup.tsdiffbeforeafterboth--- a/tests/src/interfaces/lookup.ts
+++ b/tests/src/interfaces/lookup.ts
@@ -2460,10 +2460,6 @@
set_admin_address: {
admin: 'PalletEvmAccountBasicCrossAccountIdRepr',
},
- start_app_promotion: {
- promotionStartRelayBlock: 'Option<u32>',
- },
- stop_app_promotion: 'Null',
stake: {
amount: 'u128',
},
@@ -3103,19 +3099,19 @@
_enum: ['PermissionError', 'NoAvailableBaseId', 'NoAvailablePartId', 'BaseDoesntExist', 'NeedsDefaultThemeFirst', 'PartDoesntExist', 'NoEquippableOnFixedPart']
},
/**
- * Lookup412: pallet_app_promotion::pallet::Error<T>
+ * Lookup415: pallet_app_promotion::pallet::Error<T>
**/
PalletAppPromotionError: {
- _enum: ['AdminNotSet', 'NoPermission', 'NotSufficientFounds', 'InvalidArgument']
+ _enum: ['AdminNotSet', 'NoPermission', 'NotSufficientFounds', 'PendingForBlockOverflow', 'InvalidArgument']
},
/**
- * Lookup415: pallet_evm::pallet::Error<T>
+ * Lookup418: pallet_evm::pallet::Error<T>
**/
PalletEvmError: {
_enum: ['BalanceLow', 'FeeOverflow', 'PaymentOverflow', 'WithdrawFailed', 'GasPriceTooLow', 'InvalidNonce']
},
/**
- * Lookup418: fp_rpc::TransactionStatus
+ * Lookup421: fp_rpc::TransactionStatus
**/
FpRpcTransactionStatus: {
transactionHash: 'H256',
@@ -3127,11 +3123,11 @@
logsBloom: 'EthbloomBloom'
},
/**
- * Lookup420: ethbloom::Bloom
+ * Lookup423: ethbloom::Bloom
**/
EthbloomBloom: '[u8;256]',
/**
- * Lookup422: ethereum::receipt::ReceiptV3
+ * Lookup425: ethereum::receipt::ReceiptV3
**/
EthereumReceiptReceiptV3: {
_enum: {
@@ -3141,7 +3137,7 @@
}
},
/**
- * Lookup423: ethereum::receipt::EIP658ReceiptData
+ * Lookup426: ethereum::receipt::EIP658ReceiptData
**/
EthereumReceiptEip658ReceiptData: {
statusCode: 'u8',
@@ -3150,7 +3146,7 @@
logs: 'Vec<EthereumLog>'
},
/**
- * Lookup424: ethereum::block::Block<ethereum::transaction::TransactionV2>
+ * Lookup427: ethereum::block::Block<ethereum::transaction::TransactionV2>
**/
EthereumBlock: {
header: 'EthereumHeader',
@@ -3158,7 +3154,7 @@
ommers: 'Vec<EthereumHeader>'
},
/**
- * Lookup425: ethereum::header::Header
+ * Lookup428: ethereum::header::Header
**/
EthereumHeader: {
parentHash: 'H256',
@@ -3178,23 +3174,23 @@
nonce: 'EthereumTypesHashH64'
},
/**
- * Lookup426: ethereum_types::hash::H64
+ * Lookup429: ethereum_types::hash::H64
**/
EthereumTypesHashH64: '[u8;8]',
/**
- * Lookup431: pallet_ethereum::pallet::Error<T>
+ * Lookup434: pallet_ethereum::pallet::Error<T>
**/
PalletEthereumError: {
_enum: ['InvalidSignature', 'PreLogExists']
},
/**
- * Lookup432: pallet_evm_coder_substrate::pallet::Error<T>
+ * Lookup435: pallet_evm_coder_substrate::pallet::Error<T>
**/
PalletEvmCoderSubstrateError: {
_enum: ['OutOfGas', 'OutOfFund']
},
/**
- * Lookup433: up_data_structs::SponsorshipState<pallet_evm::account::BasicCrossAccountIdRepr<sp_core::crypto::AccountId32>>
+ * Lookup436: up_data_structs::SponsorshipState<pallet_evm::account::BasicCrossAccountIdRepr<sp_core::crypto::AccountId32>>
**/
UpDataStructsSponsorshipStateBasicCrossAccountIdRepr: {
_enum: {
@@ -3204,25 +3200,25 @@
}
},
/**
- * Lookup434: pallet_evm_contract_helpers::SponsoringModeT
+ * Lookup437: pallet_evm_contract_helpers::SponsoringModeT
**/
PalletEvmContractHelpersSponsoringModeT: {
_enum: ['Disabled', 'Allowlisted', 'Generous']
},
/**
- * Lookup436: pallet_evm_contract_helpers::pallet::Error<T>
+ * Lookup439: pallet_evm_contract_helpers::pallet::Error<T>
**/
PalletEvmContractHelpersError: {
_enum: ['NoPermission', 'NoPendingSponsor']
},
/**
- * Lookup437: pallet_evm_migration::pallet::Error<T>
+ * Lookup440: pallet_evm_migration::pallet::Error<T>
**/
PalletEvmMigrationError: {
_enum: ['AccountNotEmpty', 'AccountIsNotMigrating']
},
/**
- * Lookup439: sp_runtime::MultiSignature
+ * Lookup442: sp_runtime::MultiSignature
**/
SpRuntimeMultiSignature: {
_enum: {
@@ -3232,43 +3228,43 @@
}
},
/**
- * Lookup440: sp_core::ed25519::Signature
+ * Lookup443: sp_core::ed25519::Signature
**/
SpCoreEd25519Signature: '[u8;64]',
/**
- * Lookup442: sp_core::sr25519::Signature
+ * Lookup445: sp_core::sr25519::Signature
**/
SpCoreSr25519Signature: '[u8;64]',
/**
- * Lookup443: sp_core::ecdsa::Signature
+ * Lookup446: sp_core::ecdsa::Signature
**/
SpCoreEcdsaSignature: '[u8;65]',
/**
- * Lookup446: frame_system::extensions::check_spec_version::CheckSpecVersion<T>
+ * Lookup449: frame_system::extensions::check_spec_version::CheckSpecVersion<T>
**/
FrameSystemExtensionsCheckSpecVersion: 'Null',
/**
- * Lookup447: frame_system::extensions::check_genesis::CheckGenesis<T>
+ * Lookup450: frame_system::extensions::check_genesis::CheckGenesis<T>
**/
FrameSystemExtensionsCheckGenesis: 'Null',
/**
- * Lookup450: frame_system::extensions::check_nonce::CheckNonce<T>
+ * Lookup453: frame_system::extensions::check_nonce::CheckNonce<T>
**/
FrameSystemExtensionsCheckNonce: 'Compact<u32>',
/**
- * Lookup451: frame_system::extensions::check_weight::CheckWeight<T>
+ * Lookup454: frame_system::extensions::check_weight::CheckWeight<T>
**/
FrameSystemExtensionsCheckWeight: 'Null',
/**
- * Lookup452: pallet_template_transaction_payment::ChargeTransactionPayment<opal_runtime::Runtime>
+ * Lookup455: pallet_template_transaction_payment::ChargeTransactionPayment<opal_runtime::Runtime>
**/
PalletTemplateTransactionPaymentChargeTransactionPayment: 'Compact<u128>',
/**
- * Lookup453: opal_runtime::Runtime
+ * Lookup456: opal_runtime::Runtime
**/
OpalRuntimeRuntime: 'Null',
/**
- * Lookup454: pallet_ethereum::FakeTransactionFinalizer<opal_runtime::Runtime>
+ * Lookup457: pallet_ethereum::FakeTransactionFinalizer<opal_runtime::Runtime>
**/
PalletEthereumFakeTransactionFinalizer: 'Null'
};
tests/src/interfaces/types-lookup.tsdiffbeforeafterboth--- a/tests/src/interfaces/types-lookup.ts
+++ b/tests/src/interfaces/types-lookup.ts
@@ -2665,11 +2665,6 @@
readonly asSetAdminAddress: {
readonly admin: PalletEvmAccountBasicCrossAccountIdRepr;
} & Struct;
- readonly isStartAppPromotion: boolean;
- readonly asStartAppPromotion: {
- readonly promotionStartRelayBlock: Option<u32>;
- } & Struct;
- readonly isStopAppPromotion: boolean;
readonly isStake: boolean;
readonly asStake: {
readonly amount: u128;
@@ -2695,7 +2690,7 @@
readonly asPayoutStakers: {
readonly stakersNumber: Option<u8>;
} & Struct;
- readonly type: 'SetAdminAddress' | 'StartAppPromotion' | 'StopAppPromotion' | 'Stake' | 'Unstake' | 'SponsorCollection' | 'StopSponsoringCollection' | 'SponsorConract' | 'StopSponsoringContract' | 'PayoutStakers';
+ readonly type: 'SetAdminAddress' | 'Stake' | 'Unstake' | 'SponsorCollection' | 'StopSponsoringCollection' | 'SponsorConract' | 'StopSponsoringContract' | 'PayoutStakers';
}
/** @name PalletEvmCall (306) */
@@ -3291,16 +3286,17 @@
readonly type: 'PermissionError' | 'NoAvailableBaseId' | 'NoAvailablePartId' | 'BaseDoesntExist' | 'NeedsDefaultThemeFirst' | 'PartDoesntExist' | 'NoEquippableOnFixedPart';
}
- /** @name PalletAppPromotionError (412) */
+ /** @name PalletAppPromotionError (415) */
interface PalletAppPromotionError extends Enum {
readonly isAdminNotSet: boolean;
readonly isNoPermission: boolean;
readonly isNotSufficientFounds: boolean;
+ readonly isPendingForBlockOverflow: boolean;
readonly isInvalidArgument: boolean;
- readonly type: 'AdminNotSet' | 'NoPermission' | 'NotSufficientFounds' | 'InvalidArgument';
+ readonly type: 'AdminNotSet' | 'NoPermission' | 'NotSufficientFounds' | 'PendingForBlockOverflow' | 'InvalidArgument';
}
- /** @name PalletEvmError (415) */
+ /** @name PalletEvmError (418) */
interface PalletEvmError extends Enum {
readonly isBalanceLow: boolean;
readonly isFeeOverflow: boolean;
@@ -3311,7 +3307,7 @@
readonly type: 'BalanceLow' | 'FeeOverflow' | 'PaymentOverflow' | 'WithdrawFailed' | 'GasPriceTooLow' | 'InvalidNonce';
}
- /** @name FpRpcTransactionStatus (418) */
+ /** @name FpRpcTransactionStatus (421) */
interface FpRpcTransactionStatus extends Struct {
readonly transactionHash: H256;
readonly transactionIndex: u32;
@@ -3322,10 +3318,10 @@
readonly logsBloom: EthbloomBloom;
}
- /** @name EthbloomBloom (420) */
+ /** @name EthbloomBloom (423) */
interface EthbloomBloom extends U8aFixed {}
- /** @name EthereumReceiptReceiptV3 (422) */
+ /** @name EthereumReceiptReceiptV3 (425) */
interface EthereumReceiptReceiptV3 extends Enum {
readonly isLegacy: boolean;
readonly asLegacy: EthereumReceiptEip658ReceiptData;
@@ -3336,7 +3332,7 @@
readonly type: 'Legacy' | 'Eip2930' | 'Eip1559';
}
- /** @name EthereumReceiptEip658ReceiptData (423) */
+ /** @name EthereumReceiptEip658ReceiptData (426) */
interface EthereumReceiptEip658ReceiptData extends Struct {
readonly statusCode: u8;
readonly usedGas: U256;
@@ -3344,14 +3340,14 @@
readonly logs: Vec<EthereumLog>;
}
- /** @name EthereumBlock (424) */
+ /** @name EthereumBlock (427) */
interface EthereumBlock extends Struct {
readonly header: EthereumHeader;
readonly transactions: Vec<EthereumTransactionTransactionV2>;
readonly ommers: Vec<EthereumHeader>;
}
- /** @name EthereumHeader (425) */
+ /** @name EthereumHeader (428) */
interface EthereumHeader extends Struct {
readonly parentHash: H256;
readonly ommersHash: H256;
@@ -3370,24 +3366,24 @@
readonly nonce: EthereumTypesHashH64;
}
- /** @name EthereumTypesHashH64 (426) */
+ /** @name EthereumTypesHashH64 (429) */
interface EthereumTypesHashH64 extends U8aFixed {}
- /** @name PalletEthereumError (431) */
+ /** @name PalletEthereumError (434) */
interface PalletEthereumError extends Enum {
readonly isInvalidSignature: boolean;
readonly isPreLogExists: boolean;
readonly type: 'InvalidSignature' | 'PreLogExists';
}
- /** @name PalletEvmCoderSubstrateError (432) */
+ /** @name PalletEvmCoderSubstrateError (435) */
interface PalletEvmCoderSubstrateError extends Enum {
readonly isOutOfGas: boolean;
readonly isOutOfFund: boolean;
readonly type: 'OutOfGas' | 'OutOfFund';
}
- /** @name UpDataStructsSponsorshipStateBasicCrossAccountIdRepr (433) */
+ /** @name UpDataStructsSponsorshipStateBasicCrossAccountIdRepr (436) */
interface UpDataStructsSponsorshipStateBasicCrossAccountIdRepr extends Enum {
readonly isDisabled: boolean;
readonly isUnconfirmed: boolean;
@@ -3397,7 +3393,7 @@
readonly type: 'Disabled' | 'Unconfirmed' | 'Confirmed';
}
- /** @name PalletEvmContractHelpersSponsoringModeT (434) */
+ /** @name PalletEvmContractHelpersSponsoringModeT (437) */
interface PalletEvmContractHelpersSponsoringModeT extends Enum {
readonly isDisabled: boolean;
readonly isAllowlisted: boolean;
@@ -3405,21 +3401,21 @@
readonly type: 'Disabled' | 'Allowlisted' | 'Generous';
}
- /** @name PalletEvmContractHelpersError (436) */
+ /** @name PalletEvmContractHelpersError (439) */
interface PalletEvmContractHelpersError extends Enum {
readonly isNoPermission: boolean;
readonly isNoPendingSponsor: boolean;
readonly type: 'NoPermission' | 'NoPendingSponsor';
}
- /** @name PalletEvmMigrationError (437) */
+ /** @name PalletEvmMigrationError (440) */
interface PalletEvmMigrationError extends Enum {
readonly isAccountNotEmpty: boolean;
readonly isAccountIsNotMigrating: boolean;
readonly type: 'AccountNotEmpty' | 'AccountIsNotMigrating';
}
- /** @name SpRuntimeMultiSignature (439) */
+ /** @name SpRuntimeMultiSignature (442) */
interface SpRuntimeMultiSignature extends Enum {
readonly isEd25519: boolean;
readonly asEd25519: SpCoreEd25519Signature;
@@ -3430,34 +3426,34 @@
readonly type: 'Ed25519' | 'Sr25519' | 'Ecdsa';
}
- /** @name SpCoreEd25519Signature (440) */
+ /** @name SpCoreEd25519Signature (443) */
interface SpCoreEd25519Signature extends U8aFixed {}
- /** @name SpCoreSr25519Signature (442) */
+ /** @name SpCoreSr25519Signature (445) */
interface SpCoreSr25519Signature extends U8aFixed {}
- /** @name SpCoreEcdsaSignature (443) */
+ /** @name SpCoreEcdsaSignature (446) */
interface SpCoreEcdsaSignature extends U8aFixed {}
- /** @name FrameSystemExtensionsCheckSpecVersion (446) */
+ /** @name FrameSystemExtensionsCheckSpecVersion (449) */
type FrameSystemExtensionsCheckSpecVersion = Null;
- /** @name FrameSystemExtensionsCheckGenesis (447) */
+ /** @name FrameSystemExtensionsCheckGenesis (450) */
type FrameSystemExtensionsCheckGenesis = Null;
- /** @name FrameSystemExtensionsCheckNonce (450) */
+ /** @name FrameSystemExtensionsCheckNonce (453) */
interface FrameSystemExtensionsCheckNonce extends Compact<u32> {}
- /** @name FrameSystemExtensionsCheckWeight (451) */
+ /** @name FrameSystemExtensionsCheckWeight (454) */
type FrameSystemExtensionsCheckWeight = Null;
- /** @name PalletTemplateTransactionPaymentChargeTransactionPayment (452) */
+ /** @name PalletTemplateTransactionPaymentChargeTransactionPayment (455) */
interface PalletTemplateTransactionPaymentChargeTransactionPayment extends Compact<u128> {}
- /** @name OpalRuntimeRuntime (453) */
+ /** @name OpalRuntimeRuntime (456) */
type OpalRuntimeRuntime = Null;
- /** @name PalletEthereumFakeTransactionFinalizer (454) */
+ /** @name PalletEthereumFakeTransactionFinalizer (457) */
type PalletEthereumFakeTransactionFinalizer = Null;
} // declare module
tests/src/util/helpers.tsdiffbeforeafterboth--- a/tests/src/util/helpers.ts
+++ b/tests/src/util/helpers.ts
@@ -48,7 +48,7 @@
Fungible = 'fungible',
NFT = 'nonfungible',
Scheduler = 'scheduler',
- AppPromotion = 'promotion',
+ AppPromotion = 'apppromotion',
}
export async function isUnique(): Promise<boolean> {
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';1314const 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};202122const nesting = {23 toChecksumAddress(address: string): string {24 if (typeof address === 'undefined') return '';2526 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2728 address = address.toLowerCase().replace(/^0x/i,'');29 const addressHash = keccakAsHex(address).replace(/^0x/i,'');30 const checksumAddress = ['0x'];3132 for (let i = 0; i < address.length; i++) {33 // If ith character is 8 to f then make it uppercase34 if (parseInt(addressHash[i], 16) > 7) {35 checksumAddress.push(address[i].toUpperCase());36 } else {37 checksumAddress.push(address[i]);38 }39 }40 return checksumAddress.join('');41 },42 tokenIdToAddress(collectionId: number, tokenId: number) {43 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);44 },45};4647class UniqueUtil {48 static transactionStatus = {49 NOT_READY: 'NotReady',50 FAIL: 'Fail',51 SUCCESS: 'Success',52 };5354 static chainLogType = {55 EXTRINSIC: 'extrinsic',56 RPC: 'rpc',57 };5859 static getNestingTokenAddress(collectionId: number, tokenId: number) {60 return nesting.tokenIdToAddress(collectionId, tokenId);61 }6263 static getDefaultLogger(): ILogger {64 return {65 log(msg: any, level = 'INFO') {66 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));67 },68 level: {69 ERROR: 'ERROR',70 WARNING: 'WARNING',71 INFO: 'INFO',72 },73 };74 }7576 static vec2str(arr: string[] | number[]) {77 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');78 }7980 static str2vec(string: string) {81 if (typeof string !== 'string') return string;82 return Array.from(string).map(x => x.charCodeAt(0));83 }8485 static fromSeed(seed: string, ss58Format = 42) {86 const keyring = new Keyring({type: 'sr25519', ss58Format});87 return keyring.addFromUri(seed);88 }8990 static normalizeSubstrateAddress(address: string, ss58Format = 42) {91 return encodeAddress(decodeAddress(address), ss58Format);92 }9394 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult, label = 'new collection') {95 if (creationResult.status !== this.transactionStatus.SUCCESS) {96 throw Error(`Unable to create collection for ${label}`);97 }9899 let collectionId = null;100 creationResult.result.events.forEach(({event: {data, method, section}}) => {101 if ((section === 'common') && (method === 'CollectionCreated')) {102 collectionId = parseInt(data[0].toString(), 10);103 }104 });105106 if (collectionId === null) {107 throw Error(`No CollectionCreated event for ${label}`);108 }109110 return collectionId;111 }112113 static extractTokensFromCreationResult(creationResult: ITransactionResult, label = 'new tokens') {114 if (creationResult.status !== this.transactionStatus.SUCCESS) {115 throw Error(`Unable to create tokens for ${label}`);116 }117 let success = false;118 const tokens = [] as any;119 creationResult.result.events.forEach(({event: {data, method, section}}) => {120 if (method === 'ExtrinsicSuccess') {121 success = true;122 } else if ((section === 'common') && (method === 'ItemCreated')) {123 tokens.push({124 collectionId: parseInt(data[0].toString(), 10),125 tokenId: parseInt(data[1].toString(), 10),126 owner: data[2].toJSON(),127 });128 }129 });130 return {success, tokens};131 }132133 static extractTokensFromBurnResult(burnResult: ITransactionResult, label = 'burned tokens') {134 if (burnResult.status !== this.transactionStatus.SUCCESS) {135 throw Error(`Unable to burn tokens for ${label}`);136 }137 let success = false;138 const tokens = [] as any;139 burnResult.result.events.forEach(({event: {data, method, section}}) => {140 if (method === 'ExtrinsicSuccess') {141 success = true;142 } else if ((section === 'common') && (method === 'ItemDestroyed')) {143 tokens.push({144 collectionId: parseInt(data[0].toString(), 10),145 tokenId: parseInt(data[1].toString(), 10),146 owner: data[2].toJSON(),147 });148 }149 });150 return {success, tokens};151 }152153 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string, label?: string) {154 let eventId = null;155 events.forEach(({event: {data, method, section}}) => {156 if ((section === expectedSection) && (method === expectedMethod)) {157 eventId = parseInt(data[0].toString(), 10);158 }159 });160161 if (eventId === null) {162 throw Error(`No ${expectedMethod} event for ${label}`);163 }164 return eventId === collectionId;165 }166167 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {168 const normalizeAddress = (address: string | ICrossAccountId) => {169 if(typeof address === 'string') return address;170 const obj = {} as any;171 Object.keys(address).forEach(k => {172 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];173 });174 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};175 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};176 return address;177 };178 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;179 events.forEach(({event: {data, method, section}}) => {180 if ((section === 'common') && (method === 'Transfer')) {181 const hData = (data as any).toJSON();182 transfer = {183 collectionId: hData[0],184 tokenId: hData[1],185 from: normalizeAddress(hData[2]),186 to: normalizeAddress(hData[3]),187 amount: BigInt(hData[4]),188 };189 }190 });191 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);193 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);194 isSuccess = isSuccess && amount === transfer.amount;195 return isSuccess;196 }197}198199200class ChainHelperBase {201 transactionStatus = UniqueUtil.transactionStatus;202 chainLogType = UniqueUtil.chainLogType;203 util: typeof UniqueUtil;204 logger: ILogger;205 api: ApiPromise | null;206 forcedNetwork: TUniqueNetworks | null;207 network: TUniqueNetworks | null;208 chainLog: IUniqueHelperLog[];209210 constructor(logger?: ILogger) {211 this.util = UniqueUtil;212 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();213 this.logger = logger;214 this.api = null;215 this.forcedNetwork = null;216 this.network = null;217 this.chainLog = [];218 }219220 clearChainLog(): void {221 this.chainLog = [];222 }223224 forceNetwork(value: TUniqueNetworks): void {225 this.forcedNetwork = value;226 }227228 async connect(wsEndpoint: string, listeners?: IApiListeners) {229 if (this.api !== null) throw Error('Already connected');230 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);231 this.api = api;232 this.network = network;233 }234235 async disconnect() {236 if (this.api === null) return;237 await this.api.disconnect();238 this.api = null;239 this.network = null;240 }241242 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {243 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;244 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;245 return 'opal';246 }247248 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {249 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});250 await api.isReady;251252 const network = await this.detectNetwork(api);253254 await api.disconnect();255256 return network;257 }258259 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 260 api: ApiPromise; 261 network: TUniqueNetworks; 262 }> {263 if(typeof network === 'undefined' || network === null) network = 'opal';264 const supportedRPC = {265 opal: {266 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,267 },268 quartz: {269 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,270 },271 unique: {272 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,273 },274 };275 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);276 const rpc = supportedRPC[network];277278 // TODO: investigate how to replace rpc in runtime279 // api._rpcCore.addUserInterfaces(rpc);280281 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});282283 await api.isReadyOrError;284285 if (typeof listeners === 'undefined') listeners = {};286 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {287 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;288 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);289 }290291 return {api, network};292 }293294 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {295 const {events, status} = data;296 if (status.isReady) {297 return this.transactionStatus.NOT_READY;298 }299 if (status.isBroadcast) {300 return this.transactionStatus.NOT_READY;301 }302 if (status.isInBlock || status.isFinalized) {303 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');304 if (errors.length > 0) {305 return this.transactionStatus.FAIL;306 }307 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {308 return this.transactionStatus.SUCCESS;309 }310 }311312 return this.transactionStatus.FAIL;313 }314315 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {316 const sign = (callback: any) => {317 if(options !== null) return transaction.signAndSend(sender, options, callback);318 return transaction.signAndSend(sender, callback);319 };320 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 params,392 } as IUniqueHelperLog;393394 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;395 if(events.length > 0) log.events = events;396397 this.chainLog.push(log);398399 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(failureMessage);400 return result;401 }402403 async callRpc(rpc: string, params?: any[]) {404 if(typeof params === 'undefined') params = [];405 if(this.api === null) throw Error('API not initialized');406 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);407408 const startTime = (new Date()).getTime();409 let result;410 let error = null;411 const log = {412 type: this.chainLogType.RPC,413 call: rpc,414 params,415 } as IUniqueHelperLog;416417 try {418 result = await this.constructApiCall(rpc, params);419 }420 catch(e) {421 error = e;422 }423424 const endTime = (new Date()).getTime();425426 log.executedAt = endTime;427 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';428 log.executionTime = endTime - startTime;429430 this.chainLog.push(log);431432 if(error !== null) throw error;433434 return result;435 }436437 getSignerAddress(signer: IKeyringPair | string): string {438 if(typeof signer === 'string') return signer;439 return signer.address;440 }441}442443444class HelperGroup {445 helper: UniqueHelper;446447 constructor(uniqueHelper: UniqueHelper) {448 this.helper = uniqueHelper;449 }450}451452453class CollectionGroup extends HelperGroup {454 /**455 * Get number of blocks when sponsored transaction is available.456 *457 * @param collectionId ID of collection458 * @param tokenId ID of token459 * @param addressObj address for which the sponsorship is checked460 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});461 * @returns number of blocks or null if sponsorship hasn't been set462 */463 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {464 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();465 }466467 /**468 * Get the number of created collections.469 * 470 * @returns number of created collections471 */472 async getTotalCount(): Promise<number> {473 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();474 }475476 /**477 * Get information about the collection with additional data, including the number of tokens it contains, its administrators, the normalized address of the collection's owner, and decoded name and description.478 * 479 * @param collectionId ID of collection480 * @example await getData(2)481 * @returns collection information object482 */483 async getData(collectionId: number): Promise<{484 id: number;485 name: string;486 description: string;487 tokensCount: number;488 admins: ICrossAccountId[];489 normalizedOwner: TSubstrateAccount;490 raw: any491 } | null> {492 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);493 const humanCollection = collection.toHuman(), collectionData = {494 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],495 raw: humanCollection,496 } as any, jsonCollection = collection.toJSON();497 if (humanCollection === null) return null;498 collectionData.raw.limits = jsonCollection.limits;499 collectionData.raw.permissions = jsonCollection.permissions;500 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);501 for (const key of ['name', 'description']) {502 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);503 }504505 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) : 0;506 collectionData.admins = await this.getAdmins(collectionId);507508 return collectionData;509 }510511 /**512 * Get the normalized addresses of the collection's administrators.513 * 514 * @param collectionId ID of collection515 * @example await getAdmins(1)516 * @returns array of administrators517 */518 async getAdmins(collectionId: number): Promise<ICrossAccountId[]> {519 const normalized = [];520 for(const admin of (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman()) {521 if(admin.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(admin.Substrate)});522 else normalized.push(admin);523 }524 return normalized;525 }526527 /**528 * Get the normalized addresses added to the collection allow-list.529 * @param collectionId ID of collection530 * @example await getAllowList(1)531 * @returns array of allow-listed addresses532 */533 async getAllowList(collectionId: number): Promise<ICrossAccountId[]> {534 const normalized = [];535 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();536 for (const address of allowListed) {537 if (address.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(address.Substrate)});538 else normalized.push(address);539 }540 return normalized;541 }542543 /**544 * Get the effective limits of the collection instead of null for default values545 * 546 * @param collectionId ID of collection547 * @example await getEffectiveLimits(2)548 * @returns object of collection limits549 */550 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {551 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();552 }553554 /**555 * Burns the collection if the signer has sufficient permissions and collection is empty.556 * 557 * @param signer keyring of signer558 * @param collectionId ID of collection559 * @param label extra label for log560 * @example await helper.collection.burn(aliceKeyring, 3);561 * @returns ```true``` if extrinsic success, otherwise ```false```562 */563 async burn(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {564 if(typeof label === 'undefined') label = `collection #${collectionId}`;565 const result = await this.helper.executeExtrinsic(566 signer,567 'api.tx.unique.destroyCollection', [collectionId],568 true, `Unable to burn collection for ${label}`,569 );570571 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed', label);572 }573574 /**575 * Sets the sponsor for the collection (Requires the Substrate address).576 * 577 * @param signer keyring of signer578 * @param collectionId ID of collection579 * @param sponsorAddress Sponsor substrate address580 * @param label extra label for log581 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")582 * @returns ```true``` if extrinsic success, otherwise ```false```583 */584 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount, label?: string): Promise<boolean> {585 if(typeof label === 'undefined') label = `collection #${collectionId}`;586 const result = await this.helper.executeExtrinsic(587 signer,588 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],589 true, `Unable to set collection sponsor for ${label}`,590 );591592 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet', label);593 }594595 /**596 * Confirms consent to sponsor the collection on behalf of the signer.597 * 598 * @param signer keyring of signer599 * @param collectionId ID of collection600 * @param label extra label for log601 * @example confirmSponsorship(aliceKeyring, 10)602 * @returns ```true``` if extrinsic success, otherwise ```false```603 */604 async confirmSponsorship(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {605 if(typeof label === 'undefined') label = `collection #${collectionId}`;606 const result = await this.helper.executeExtrinsic(607 signer,608 'api.tx.unique.confirmSponsorship', [collectionId],609 true, `Unable to confirm collection sponsorship for ${label}`,610 );611612 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed', label);613 }614615 /**616 * Sets the limits of the collection. At least one limit must be specified for a correct call.617 * 618 * @param signer keyring of signer619 * @param collectionId ID of collection620 * @param limits collection limits object621 * @param label extra label for log622 * @example623 * await setLimits(624 * aliceKeyring,625 * 10,626 * {627 * sponsorTransferTimeout: 0,628 * ownerCanDestroy: false629 * }630 * )631 * @returns ```true``` if extrinsic success, otherwise ```false```632 */633 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits, label?: string): Promise<boolean> {634 if(typeof label === 'undefined') label = `collection #${collectionId}`;635 const result = await this.helper.executeExtrinsic(636 signer,637 'api.tx.unique.setCollectionLimits', [collectionId, limits],638 true, `Unable to set collection limits for ${label}`,639 );640641 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet', label);642 }643644 /**645 * Changes the owner of the collection to the new Substrate address.646 * 647 * @param signer keyring of signer648 * @param collectionId ID of collection649 * @param ownerAddress substrate address of new owner650 * @param label extra label for log651 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")652 * @returns ```true``` if extrinsic success, otherwise ```false```653 */654 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount, label?: string): Promise<boolean> {655 if(typeof label === 'undefined') label = `collection #${collectionId}`;656 const result = await this.helper.executeExtrinsic(657 signer,658 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],659 true, `Unable to change collection owner for ${label}`,660 );661662 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged', label);663 }664665 /**666 * Adds a collection administrator. 667 * 668 * @param signer keyring of signer669 * @param collectionId ID of collection670 * @param adminAddressObj Administrator address (substrate or ethereum)671 * @param label extra label for log672 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})673 * @returns ```true``` if extrinsic success, otherwise ```false```674 */675 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {676 if(typeof label === 'undefined') label = `collection #${collectionId}`;677 const result = await this.helper.executeExtrinsic(678 signer,679 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],680 true, `Unable to add collection admin for ${label}`,681 );682683 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded', label);684 }685686 /**687 * Adds an address to allow list 688 * @param signer keyring of signer689 * @param collectionId ID of collection690 * @param addressObj address to add to the allow list691 * @param label extra label for log692 * @returns ```true``` if extrinsic success, otherwise ```false```693 */694 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId, label?: string): Promise<boolean> {695 if(typeof label === 'undefined') label = `collection #${collectionId}`;696 const result = await this.helper.executeExtrinsic(697 signer,698 'api.tx.unique.addToAllowList', [collectionId, addressObj],699 true, `Unable to add address to allow list for ${label}`,700 );701702 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');703 }704705 /**706 * Removes a collection administrator.707 * 708 * @param signer keyring of signer709 * @param collectionId ID of collection710 * @param adminAddressObj Administrator address (substrate or ethereum)711 * @param label extra label for log712 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})713 * @returns ```true``` if extrinsic success, otherwise ```false```714 */715 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {716 if(typeof label === 'undefined') label = `collection #${collectionId}`;717 const result = await this.helper.executeExtrinsic(718 signer,719 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],720 true, `Unable to remove collection admin for ${label}`,721 );722723 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved', label);724 }725726 /**727 * Sets onchain permissions for selected collection.728 * 729 * @param signer keyring of signer730 * @param collectionId ID of collection731 * @param permissions collection permissions object732 * @param label extra label for log733 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});734 * @returns ```true``` if extrinsic success, otherwise ```false```735 */736 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions, label?: string): Promise<boolean> {737 if(typeof label === 'undefined') label = `collection #${collectionId}`;738 const result = await this.helper.executeExtrinsic(739 signer,740 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],741 true, `Unable to set collection permissions for ${label}`,742 );743744 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet', label);745 }746747 /**748 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.749 * 750 * @param signer keyring of signer751 * @param collectionId ID of collection752 * @param permissions nesting permissions object753 * @param label extra label for log754 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});755 * @returns ```true``` if extrinsic success, otherwise ```false```756 */757 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions, label?: string): Promise<boolean> {758 return await this.setPermissions(signer, collectionId, {nesting: permissions}, label);759 }760761 /**762 * Disables nesting for selected collection.763 * 764 * @param signer keyring of signer765 * @param collectionId ID of collection766 * @param label extra label for log767 * @example disableNesting(aliceKeyring, 10);768 * @returns ```true``` if extrinsic success, otherwise ```false```769 */770 async disableNesting(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {771 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}}, label);772 }773774 /**775 * Sets onchain properties to the collection.776 * 777 * @param signer keyring of signer778 * @param collectionId ID of collection779 * @param properties array of property objects780 * @param label extra label for log781 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);782 * @returns ```true``` if extrinsic success, otherwise ```false```783 */784 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[], label?: string): Promise<boolean> {785 if(typeof label === 'undefined') label = `collection #${collectionId}`;786 const result = await this.helper.executeExtrinsic(787 signer,788 'api.tx.unique.setCollectionProperties', [collectionId, properties],789 true, `Unable to set collection properties for ${label}`,790 );791792 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet', label);793 }794795 /**796 * Deletes onchain properties from the collection.797 * 798 * @param signer keyring of signer799 * @param collectionId ID of collection800 * @param propertyKeys array of property keys to delete801 * @param label802 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);803 * @returns ```true``` if extrinsic success, otherwise ```false```804 */805 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[], label?: string): Promise<boolean> {806 if(typeof label === 'undefined') label = `collection #${collectionId}`;807 const result = await this.helper.executeExtrinsic(808 signer,809 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],810 true, `Unable to delete collection properties for ${label}`,811 );812813 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted', label);814 }815816 /**817 * Changes the owner of the token.818 * 819 * @param signer keyring of signer820 * @param collectionId ID of collection821 * @param tokenId ID of token822 * @param addressObj address of a new owner823 * @param amount amount of tokens to be transfered. For NFT must be set to 1n824 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})825 * @returns true if the token success, otherwise false826 */827 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {828 const result = await this.helper.executeExtrinsic(829 signer,830 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],831 true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,832 );833834 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);835 }836837 /**838 * 839 * Change ownership of a token(s) on behalf of the owner. 840 * 841 * @param signer keyring of signer842 * @param collectionId ID of collection843 * @param tokenId ID of token844 * @param fromAddressObj address on behalf of which the token will be sent845 * @param toAddressObj new token owner846 * @param amount amount of tokens to be transfered. For NFT must be set to 1n847 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})848 * @returns true if the token success, otherwise false849 */850 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {851 const result = await this.helper.executeExtrinsic(852 signer,853 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],854 true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,855 );856 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);857 }858859 /**860 * 861 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.862 * 863 * @param signer keyring of signer864 * @param collectionId ID of collection865 * @param tokenId ID of token866 * @param label 867 * @param amount amount of tokens to be burned. For NFT must be set to 1n868 * @example burnToken(aliceKeyring, 10, 5);869 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```870 */871 async burnToken(signer: TSigner, collectionId: number, tokenId: number, label?: string, amount=1n): Promise<{872 success: boolean,873 token: number | null874 }> {875 if(typeof label === 'undefined') label = `collection #${collectionId}`;876 const burnResult = await this.helper.executeExtrinsic(877 signer,878 'api.tx.unique.burnItem', [collectionId, tokenId, amount],879 true, `Unable to burn token for ${label}`,880 );881 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);882 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');883 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};884 }885886 /**887 * Destroys a concrete instance of NFT on behalf of the owner888 * 889 * @param signer keyring of signer890 * @param collectionId ID of collection891 * @param fromAddressObj address on behalf of which the token will be burnt892 * @param tokenId ID of token893 * @param label 894 * @param amount amount of tokens to be burned. For NFT must be set to 1n895 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})896 * @returns ```true``` if extrinsic success, otherwise ```false```897 */898 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, label?: string, amount=1n): Promise<boolean> {899 if(typeof label === 'undefined') label = `collection #${collectionId}`;900 const burnResult = await this.helper.executeExtrinsic(901 signer,902 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],903 true, `Unable to burn token from for ${label}`,904 );905 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);906 return burnedTokens.success && burnedTokens.tokens.length > 0;907 }908909 /**910 * Set, change, or remove approved address to transfer the ownership of the NFT.911 * 912 * @param signer keyring of signer913 * @param collectionId ID of collection914 * @param tokenId ID of token915 * @param toAddressObj 916 * @param label 917 * @param amount amount of token to be approved. For NFT must be set to 1n918 * @returns ```true``` if extrinsic success, otherwise ```false```919 */920 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=1n) {921 if(typeof label === 'undefined') label = `collection #${collectionId}`;922 const approveResult = await this.helper.executeExtrinsic(923 signer, 924 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],925 true, `Unable to approve token for ${label}`,926 );927928 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved', label);929 }930931 /**932 * Get the amount of token pieces approved to transfer933 * @param collectionId ID of collection934 * @param tokenId ID of token935 * @param toAccountObj 936 * @param fromAccountObj937 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})938 * @returns number of approved to transfer pieces939 */940 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {941 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();942 }943944 /**945 * Get the last created token id946 * @param collectionId ID of collection947 * @example getLastTokenId(10);948 * @returns id of the last created token949 */950 async getLastTokenId(collectionId: number): Promise<number> {951 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();952 }953954 /**955 * Check if token exists956 * @param collectionId ID of collection957 * @param tokenId ID of token958 * @example isTokenExists(10, 20);959 * @returns true if the token exists, otherwise false960 */961 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {962 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();963 }964}965966class NFTnRFT extends CollectionGroup {967 /**968 * Get tokens owned by account969 * 970 * @param collectionId ID of collection971 * @param addressObj tokens owner972 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})973 * @returns array of token ids owned by account974 */975 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {976 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();977 }978979 /**980 * Get token data981 * @param collectionId ID of collection982 * @param tokenId ID of token983 * @param blockHashAt 984 * @param propertyKeys985 * @example getToken(10, 5);986 * @returns human readable token data 987 */988 async getToken(collectionId: number, tokenId: number, blockHashAt?: string, propertyKeys?: string[]): Promise<{989 properties: IProperty[];990 owner: ICrossAccountId;991 normalizedOwner: ICrossAccountId;992 }| null> {993 let tokenData;994 if(typeof blockHashAt === 'undefined') {995 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);996 }997 else {998 if(typeof propertyKeys === 'undefined') {999 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1000 if(!collection) return null;1001 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1002 }1003 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1004 }1005 tokenData = tokenData.toHuman();1006 if (tokenData === null || tokenData.owner === null) return null;1007 const owner = {} as any;1008 for (const key of Object.keys(tokenData.owner)) {1009 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1010 }1011 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1012 return tokenData;1013 }10141015 /**1016 * Set permissions to change token properties1017 * @param signer keyring of signer1018 * @param collectionId ID of collection1019 * @param permissions permissions to change a property by the collection owner or admin1020 * @param label 1021 * @example setTokenPropertyPermissions(1022 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1023 * )1024 * @returns true if extrinsic success otherwise false1025 */1026 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[], label?: string): Promise<boolean> {1027 if(typeof label === 'undefined') label = `collection #${collectionId}`;1028 const result = await this.helper.executeExtrinsic(1029 signer,1030 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1031 true, `Unable to set token property permissions for ${label}`,1032 );10331034 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet', label);1035 }10361037 /**1038 * Set token properties1039 * @param signer keyring of signer1040 * @param collectionId ID of collection1041 * @param tokenId ID of token1042 * @param properties 1043 * @param label 1044 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1045 * @returns ```true``` if extrinsic success, otherwise ```false```1046 */1047 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[], label?: string): Promise<boolean> {1048 if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1049 const result = await this.helper.executeExtrinsic(1050 signer,1051 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1052 true, `Unable to set token properties for ${label}`,1053 );10541055 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet', label);1056 }10571058 /**1059 * Delete the provided properties of a token1060 * @param signer keyring of signer1061 * @param collectionId ID of collection1062 * @param tokenId ID of token1063 * @param propertyKeys property keys to be deleted 1064 * @param label 1065 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1066 * @returns ```true``` if extrinsic success, otherwise ```false```1067 */1068 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[], label?: string): Promise<boolean> {1069 if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1070 const result = await this.helper.executeExtrinsic(1071 signer,1072 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1073 true, `Unable to delete token properties for ${label}`,1074 );10751076 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted', label);1077 }10781079 /**1080 * Mint new collection1081 * @param signer keyring of signer1082 * @param collectionOptions basic collection options and properties 1083 * @param mode NFT or RFT type of a collection1084 * @param errorLabel 1085 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1086 * @returns object of the created collection1087 */1088 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT', errorLabel = 'Unable to mint collection'): Promise<UniqueCollectionBase> {1089 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1090 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1091 for (const key of ['name', 'description', 'tokenPrefix']) {1092 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);1093 }1094 const creationResult = await this.helper.executeExtrinsic(1095 signer,1096 'api.tx.unique.createCollectionEx', [collectionOptions],1097 true, errorLabel,1098 );1099 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1100 }11011102 getCollectionObject(collectionId: number): any {1103 return null;1104 }11051106 getTokenObject(collectionId: number, tokenId: number): any {1107 return null;1108 }1109}111011111112class NFTGroup extends NFTnRFT {1113 /**1114 * Get collection object1115 * @param collectionId ID of collection1116 * @example getCollectionObject(2);1117 * @returns instance of UniqueNFTCollection1118 */1119 getCollectionObject(collectionId: number): UniqueNFTCollection {1120 return new UniqueNFTCollection(collectionId, this.helper);1121 }11221123 /**1124 * Get token object1125 * @param collectionId ID of collection1126 * @param tokenId ID of token1127 * @example getTokenObject(10, 5);1128 * @returns instance of UniqueNFTToken1129 */1130 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1131 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1132 }11331134 /**1135 * Get token's owner1136 * @param collectionId ID of collection1137 * @param tokenId ID of token1138 * @param blockHashAt 1139 * @example getTokenOwner(10, 5);1140 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1141 */1142 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1143 let owner;1144 if (typeof blockHashAt === 'undefined') {1145 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1146 } else {1147 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1148 }1149 return crossAccountIdFromLower(owner.toJSON());1150 }11511152 /**1153 * Is token approved to transfer1154 * @param collectionId ID of collection1155 * @param tokenId ID of token1156 * @param toAccountObj address to be approved1157 * @returns ```true``` if extrinsic success, otherwise ```false```1158 */1159 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1160 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1161 }11621163 /**1164 * Changes the owner of the token.1165 * 1166 * @param signer keyring of signer1167 * @param collectionId ID of collection1168 * @param tokenId ID of token1169 * @param addressObj address of a new owner1170 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1171 * @returns ```true``` if extrinsic success, otherwise ```false```1172 */1173 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1174 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1175 }11761177 /**1178 * 1179 * Change ownership of a NFT on behalf of the owner. 1180 * 1181 * @param signer keyring of signer1182 * @param collectionId ID of collection1183 * @param tokenId ID of token1184 * @param fromAddressObj address on behalf of which the token will be sent1185 * @param toAddressObj new token owner1186 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1187 * @returns ```true``` if extrinsic success, otherwise ```false```1188 */1189 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1190 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1191 }11921193 /**1194 * Recursively find the address that owns the token1195 * @param collectionId ID of collection1196 * @param tokenId ID of token1197 * @param blockHashAt 1198 * @example getTokenTopmostOwner(10, 5);1199 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1200 */1201 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1202 let owner;1203 if (typeof blockHashAt === 'undefined') {1204 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1205 } else {1206 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1207 }12081209 if (owner === null) return null;12101211 owner = owner.toHuman();12121213 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1214 }12151216 /**1217 * Get tokens nested in the provided token1218 * @param collectionId ID of collection1219 * @param tokenId ID of token1220 * @param blockHashAt 1221 * @example getTokenChildren(10, 5);1222 * @returns tokens whose depth of nesting is <= 5 1223 */1224 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1225 let children;1226 if(typeof blockHashAt === 'undefined') {1227 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1228 } else {1229 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1230 }12311232 return children.toJSON().map((x: any) => {1233 return {collectionId: x.collection, tokenId: x.token};1234 });1235 }12361237 /**1238 * Nest one token into another1239 * @param signer keyring of signer1240 * @param tokenObj token to be nested1241 * @param rootTokenObj token to be parent1242 * @param label 1243 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1244 * @returns ```true``` if extrinsic success, otherwise ```false```1245 */1246 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, label='nest token'): Promise<boolean> {1247 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1248 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1249 if(!result) {1250 throw Error(`Unable to nest token for ${label}`);1251 }1252 return result;1253 }12541255 /**1256 * Remove token from nested state1257 * @param signer keyring of signer1258 * @param tokenObj token to unnest1259 * @param rootTokenObj parent of a token1260 * @param toAddressObj address of a new token owner 1261 * @param label 1262 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1263 * @returns ```true``` if extrinsic success, otherwise ```false```1264 */1265 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId, label='unnest token'): Promise<boolean> {1266 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1267 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1268 if(!result) {1269 throw Error(`Unable to unnest token for ${label}`);1270 }1271 return result;1272 }12731274 /**1275 * Mint new collection1276 * @param signer keyring of signer1277 * @param collectionOptions Collection options1278 * @param label 1279 * @example 1280 * mintCollection(aliceKeyring, {1281 * name: 'New',1282 * description: 'New collection',1283 * tokenPrefix: 'NEW',1284 * })1285 * @returns object of the created collection1286 */1287 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueNFTCollection> {1288 return await super.mintCollection(signer, collectionOptions, 'NFT', `Unable to mint NFT collection for ${label}`) as UniqueNFTCollection;1289 }12901291 /**1292 * Mint new token1293 * @param signer keyring of signer1294 * @param data token data1295 * @param label 1296 * @returns created token object1297 */1298 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }, label?: string): Promise<UniqueNFTToken> {1299 if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1300 const creationResult = await this.helper.executeExtrinsic(1301 signer,1302 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1303 nft: {1304 properties: data.properties,1305 },1306 }],1307 true, `Unable to mint NFT token for ${label}`,1308 );1309 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1310 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1311 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1312 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1313 }13141315 /**1316 * Mint multiple NFT tokens1317 * @param signer keyring of signer1318 * @param collectionId ID of collection1319 * @param tokens array of tokens with owner and properties1320 * @param label 1321 * @example 1322 * mintMultipleTokens(aliceKeyring, 10, [{1323 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1324 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1325 * },{1326 * owner: {Ethereum: "0x9F0583DbB855d..."},1327 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1328 * }]);1329 * @returns ```true``` if extrinsic success, otherwise ```false```1330 */1331 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1332 if(typeof label === 'undefined') label = `collection #${collectionId}`;1333 const creationResult = await this.helper.executeExtrinsic(1334 signer,1335 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1336 true, `Unable to mint NFT tokens for ${label}`,1337 );1338 const collection = this.getCollectionObject(collectionId);1339 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1340 }13411342 /**1343 * Mint multiple NFT tokens with one owner1344 * @param signer keyring of signer1345 * @param collectionId ID of collection1346 * @param owner tokens owner1347 * @param tokens array of tokens with owner and properties1348 * @param label 1349 * @example1350 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1351 * properties: [{1352 * key: "gender",1353 * value: "female",1354 * },{1355 * key: "age",1356 * value: "33",1357 * }],1358 * }]);1359 * @returns array of newly created tokens1360 */1361 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1362 if(typeof label === 'undefined') label = `collection #${collectionId}`;1363 const rawTokens = [];1364 for (const token of tokens) {1365 const raw = {NFT: {properties: token.properties}};1366 rawTokens.push(raw);1367 }1368 const creationResult = await this.helper.executeExtrinsic(1369 signer,1370 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1371 true, `Unable to mint NFT tokens for ${label}`,1372 );1373 const collection = this.getCollectionObject(collectionId);1374 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1375 }13761377 /**1378 * Destroys a concrete instance of NFT.1379 * @param signer keyring of signer1380 * @param collectionId ID of collection1381 * @param tokenId ID of token1382 * @param label 1383 * @example burnToken(aliceKeyring, 10, 5);1384 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1385 */1386 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string): Promise<{ success: boolean; token: number | null; }> {1387 return await super.burnToken(signer, collectionId, tokenId, label, 1n);1388 }13891390 /**1391 * Set, change, or remove approved address to transfer the ownership of the NFT.1392 * 1393 * @param signer keyring of signer1394 * @param collectionId ID of collection1395 * @param tokenId ID of token1396 * @param toAddressObj address to approve1397 * @param label 1398 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1399 * @returns ```true``` if extrinsic success, otherwise ```false```1400 */1401 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {1402 return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, 1n);1403 }1404}140514061407class RFTGroup extends NFTnRFT {1408 /**1409 * Get collection object1410 * @param collectionId ID of collection1411 * @example getCollectionObject(2);1412 * @returns instance of UniqueRFTCollection1413 */1414 getCollectionObject(collectionId: number): UniqueRFTCollection {1415 return new UniqueRFTCollection(collectionId, this.helper);1416 }14171418 /**1419 * Get token object1420 * @param collectionId ID of collection1421 * @param tokenId ID of token1422 * @example getTokenObject(10, 5);1423 * @returns instance of UniqueNFTToken1424 */1425 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1426 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1427 }14281429 /**1430 * Get top 10 token owners with the largest number of pieces 1431 * @param collectionId ID of collection1432 * @param tokenId ID of token1433 * @example getTokenTop10Owners(10, 5);1434 * @returns array of top 10 owners1435 */1436 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1437 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1438 }14391440 /**1441 * Get number of pieces owned by address1442 * @param collectionId ID of collection1443 * @param tokenId ID of token1444 * @param addressObj address token owner1445 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1446 * @returns number of pieces ownerd by address1447 */1448 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1449 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1450 }14511452 /**1453 * Transfer pieces of token to another address1454 * @param signer keyring of signer1455 * @param collectionId ID of collection1456 * @param tokenId ID of token1457 * @param addressObj address of a new owner1458 * @param amount number of pieces to be transfered1459 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1460 * @returns ```true``` if extrinsic success, otherwise ```false```1461 */1462 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=100n): Promise<boolean> {1463 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1464 }14651466 /**1467 * Change ownership of some pieces of RFT on behalf of the owner. 1468 * @param signer keyring of signer1469 * @param collectionId ID of collection1470 * @param tokenId ID of token1471 * @param fromAddressObj address on behalf of which the token will be sent1472 * @param toAddressObj new token owner1473 * @param amount number of pieces to be transfered1474 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1475 * @returns ```true``` if extrinsic success, otherwise ```false```1476 */1477 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n): Promise<boolean> {1478 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1479 }14801481 /**1482 * Mint new collection1483 * @param signer keyring of signer1484 * @param collectionOptions Collection options1485 * @param label 1486 * @example1487 * mintCollection(aliceKeyring, {1488 * name: 'New',1489 * description: 'New collection',1490 * tokenPrefix: 'NEW',1491 * })1492 * @returns object of the created collection1493 */1494 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueRFTCollection> {1495 return await super.mintCollection(signer, collectionOptions, 'RFT', `Unable to mint RFT collection for ${label}`) as UniqueRFTCollection;1496 }14971498 /**1499 * Mint new token1500 * @param signer keyring of signer1501 * @param data token data1502 * @param label 1503 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1504 * @returns created token object1505 */1506 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }, label?: string): Promise<UniqueRFTToken> {1507 if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1508 const creationResult = await this.helper.executeExtrinsic(1509 signer,1510 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1511 refungible: {1512 pieces: data.pieces,1513 properties: data.properties,1514 },1515 }],1516 true, `Unable to mint RFT token for ${label}`,1517 );1518 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1519 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1520 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1521 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1522 }15231524 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1525 throw Error('Not implemented');1526 if(typeof label === 'undefined') label = `collection #${collectionId}`;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, label).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 * @param label 1543 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1544 * @returns array of newly created RFT tokens1545 */1546 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1547 if(typeof label === 'undefined') label = `collection #${collectionId}`;1548 const rawTokens = [];1549 for (const token of tokens) {1550 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1551 rawTokens.push(raw);1552 }1553 const creationResult = await this.helper.executeExtrinsic(1554 signer,1555 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1556 true, `Unable to mint RFT tokens for ${label}`,1557 );1558 const collection = this.getCollectionObject(collectionId);1559 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1560 }15611562 /**1563 * Destroys a concrete instance of RFT.1564 * @param signer keyring of signer1565 * @param collectionId ID of collection1566 * @param tokenId ID of token1567 * @param label 1568 * @param amount number of pieces to be burnt1569 * @example burnToken(aliceKeyring, 10, 5);1570 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1571 */1572 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string, amount=100n): Promise<{ success: boolean; token: number | null; }> {1573 return await super.burnToken(signer, collectionId, tokenId, label, amount);1574 }15751576 /**1577 * Set, change, or remove approved address to transfer the ownership of the RFT.1578 * 1579 * @param signer keyring of signer1580 * @param collectionId ID of collection1581 * @param tokenId ID of token1582 * @param toAddressObj address to approve1583 * @param label 1584 * @param amount number of pieces to be approved1585 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1586 * @returns true if the token success, otherwise false1587 */1588 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=100n) {1589 return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, amount);1590 }15911592 /**1593 * Get total number of pieces1594 * @param collectionId ID of collection1595 * @param tokenId ID of token1596 * @example getTokenTotalPieces(10, 5);1597 * @returns number of pieces1598 */1599 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1600 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1601 }16021603 /**1604 * Change number of token pieces. Signer must be the owner of all token pieces.1605 * @param signer keyring of signer1606 * @param collectionId ID of collection1607 * @param tokenId ID of token1608 * @param amount new number of pieces1609 * @param label 1610 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1611 * @returns true if the repartion was success, otherwise false1612 */1613 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint, label?: string): Promise<boolean> {1614 if(typeof label === 'undefined') label = `collection #${collectionId}`;1615 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1616 const repartitionResult = await this.helper.executeExtrinsic(1617 signer,1618 'api.tx.unique.repartition', [collectionId, tokenId, amount],1619 true, `Unable to repartition RFT token for ${label}`,1620 );1621 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated', label);1622 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed', label);1623 }1624}162516261627class FTGroup extends CollectionGroup {1628 /**1629 * Get collection object1630 * @param collectionId ID of collection1631 * @example getCollectionObject(2);1632 * @returns instance of UniqueFTCollection1633 */1634 getCollectionObject(collectionId: number): UniqueFTCollection {1635 return new UniqueFTCollection(collectionId, this.helper);1636 }16371638 /**1639 * Mint new fungible collection1640 * @param signer keyring of signer1641 * @param collectionOptions Collection options1642 * @param decimalPoints number of token decimals 1643 * @param errorLabel 1644 * @example1645 * mintCollection(aliceKeyring, {1646 * name: 'New',1647 * description: 'New collection',1648 * tokenPrefix: 'NEW',1649 * }, 18)1650 * @returns newly created fungible collection1651 */1652 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0, errorLabel = 'Unable to mint collection'): Promise<UniqueFTCollection> {1653 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1654 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1655 collectionOptions.mode = {fungible: decimalPoints};1656 for (const key of ['name', 'description', 'tokenPrefix']) {1657 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);1658 }1659 const creationResult = await this.helper.executeExtrinsic(1660 signer,1661 'api.tx.unique.createCollectionEx', [collectionOptions],1662 true, errorLabel,1663 );1664 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1665 }16661667 /**1668 * Mint tokens1669 * @param signer keyring of signer1670 * @param collectionId ID of collection1671 * @param owner address owner of new tokens1672 * @param amount amount of tokens to be meanted1673 * @param label 1674 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1675 * @returns ```true``` if extrinsic success, otherwise ```false``` 1676 */1677 async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint, label?: string): Promise<boolean> {1678 if(typeof label === 'undefined') label = `collection #${collectionId}`;1679 const creationResult = await this.helper.executeExtrinsic(1680 signer,1681 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1682 fungible: {1683 value: amount,1684 },1685 }],1686 true, `Unable to mint fungible tokens for ${label}`,1687 );1688 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1689 }16901691 /**1692 * Mint multiple Fungible tokens with one owner1693 * @param signer keyring of signer1694 * @param collectionId ID of collection1695 * @param owner tokens owner1696 * @param tokens array of tokens with properties and pieces1697 * @param label 1698 * @returns ```true``` if extrinsic success, otherwise ```false``` 1699 */1700 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string): Promise<boolean> {1701 if(typeof label === 'undefined') label = `collection #${collectionId}`;1702 const rawTokens = [];1703 for (const token of tokens) {1704 const raw = {Fungible: {Value: token.value}};1705 rawTokens.push(raw);1706 }1707 const creationResult = await this.helper.executeExtrinsic(1708 signer,1709 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1710 true, `Unable to mint RFT tokens for ${label}`,1711 );1712 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1713 }17141715 /**1716 * Get the top 10 owners with the largest balance for the Fungible collection 1717 * @param collectionId ID of collection1718 * @example getTop10Owners(10);1719 * @returns array of ```ICrossAccountId```1720 */1721 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1722 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1723 }17241725 /**1726 * Get account balance1727 * @param collectionId ID of collection1728 * @param addressObj address of owner1729 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1730 * @returns amount of fungible tokens owned by address1731 */1732 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1733 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1734 }17351736 /**1737 * Transfer tokens to address1738 * @param signer keyring of signer1739 * @param collectionId ID of collection1740 * @param toAddressObj address recepient1741 * @param amount amount of tokens to be sent1742 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1743 * @returns ```true``` if extrinsic success, otherwise ```false``` 1744 */1745 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount: bigint) {1746 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1747 }17481749 /**1750 * Transfer some tokens on behalf of the owner.1751 * @param signer keyring of signer1752 * @param collectionId ID of collection1753 * @param fromAddressObj address on behalf of which tokens will be sent1754 * @param toAddressObj address where token to be sent1755 * @param amount number of tokens to be sent1756 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1757 * @returns ```true``` if extrinsic success, otherwise ```false``` 1758 */1759 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {1760 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1761 }17621763 /**1764 * Destroy some amount of tokens1765 * @param signer keyring of signer1766 * @param collectionId ID of collection1767 * @param amount amount of tokens to be destroyed1768 * @param label 1769 * @example burnTokens(aliceKeyring, 10, 1000n);1770 * @returns ```true``` if extrinsic success, otherwise ```false``` 1771 */1772 async burnTokens(signer: IKeyringPair, collectionId: number, amount=100n, label?: string): Promise<boolean> {1773 return (await super.burnToken(signer, collectionId, 0, label, 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 * @param label 1783 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1784 * @returns ```true``` if extrinsic success, otherwise ```false``` 1785 */1786 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=100n, label?: string): Promise<boolean> {1787 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, label, amount);1788 }17891790 /**1791 * Get total collection supply1792 * @param collectionId 1793 * @returns 1794 */1795 async getTotalPieces(collectionId: number): Promise<bigint> {1796 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1797 }17981799 /**1800 * Set, change, or remove approved address to transfer tokens.1801 * 1802 * @param signer keyring of signer1803 * @param collectionId ID of collection1804 * @param toAddressObj address to be approved1805 * @param amount amount of tokens to be approved1806 * @param label 1807 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1808 * @returns ```true``` if extrinsic success, otherwise ```false``` 1809 */1810 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {1811 return super.approveToken(signer, collectionId, 0, toAddressObj, label, amount);1812 }18131814 /**1815 * Get amount of fungible tokens approved to transfer1816 * @param collectionId ID of collection1817 * @param fromAddressObj owner of tokens1818 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1819 * @returns number of tokens approved for the transfer1820 */1821 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1822 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1823 }1824}182518261827class ChainGroup extends HelperGroup {1828 /**1829 * Get system properties of a chain1830 * @example getChainProperties();1831 * @returns ss58Format, token decimals, and token symbol1832 */1833 getChainProperties(): IChainProperties {1834 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1835 return {1836 ss58Format: properties.ss58Format.toJSON(),1837 tokenDecimals: properties.tokenDecimals.toJSON(),1838 tokenSymbol: properties.tokenSymbol.toJSON(),1839 };1840 }18411842 /**1843 * Get chain header1844 * @example getLatestBlockNumber();1845 * @returns the number of the last block1846 */1847 async getLatestBlockNumber(): Promise<number> {1848 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1849 }18501851 /**1852 * Get block hash by block number1853 * @param blockNumber number of block1854 * @example getBlockHashByNumber(12345);1855 * @returns hash of a block1856 */1857 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1858 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1859 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1860 return blockHash;1861 }18621863 // TODO add docs1864 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {1865 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);1866 if (!blockHash) return null;1867 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;1868 }18691870 /**1871 * Get account nonce1872 * @param address substrate address1873 * @example getNonce("5GrwvaEF5zXb26Fz...");1874 * @returns number, account's nonce1875 */1876 async getNonce(address: TSubstrateAccount): Promise<number> {1877 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1878 }1879}188018811882class BalanceGroup extends HelperGroup {1883 /**1884 * Representation of the native token in the smallest unit1885 * @example getOneTokenNominal()1886 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1887 */1888 getOneTokenNominal(): bigint {1889 const chainProperties = this.helper.chain.getChainProperties();1890 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1891 }18921893 /**1894 * Get substrate address balance1895 * @param address substrate address1896 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1897 * @returns amount of tokens on address1898 */1899 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1900 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1901 }19021903 /**1904 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved1905 * @param address substrate address1906 * @returns 1907 */1908 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {1909 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;1910 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};1911 }19121913 /**1914 * Get ethereum address balance1915 * @param address ethereum address1916 * @example getEthereum("0x9F0583DbB855d...")1917 * @returns amount of tokens on address1918 */1919 async getEthereum(address: TEthereumAccount): Promise<bigint> {1920 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1921 }19221923 /**1924 * Transfer tokens to substrate address1925 * @param signer keyring of signer1926 * @param address substrate address of a recepient1927 * @param amount amount of tokens to be transfered1928 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1929 * @returns ```true``` if extrinsic success, otherwise ```false```1930 */1931 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1932 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}`);19331934 let transfer = {from: null, to: null, amount: 0n} as any;1935 result.result.events.forEach(({event: {data, method, section}}) => {1936 if ((section === 'balances') && (method === 'Transfer')) {1937 transfer = {1938 from: this.helper.address.normalizeSubstrate(data[0]),1939 to: this.helper.address.normalizeSubstrate(data[1]),1940 amount: BigInt(data[2]),1941 };1942 }1943 });1944 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1945 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1946 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1947 return isSuccess;1948 }1949}195019511952class AddressGroup extends HelperGroup {1953 /**1954 * Normalizes the address to the specified ss58 format, by default ```42```.1955 * @param address substrate address1956 * @param ss58Format format for address conversion, by default ```42```1957 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1958 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1959 */1960 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1961 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1962 }19631964 /**1965 * Get address in the connected chain format1966 * @param address substrate address1967 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1968 * @returns address in chain format1969 */1970 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1971 const info = this.helper.chain.getChainProperties();1972 return encodeAddress(decodeAddress(address), info.ss58Format);1973 }19741975 /**1976 * Get substrate mirror of an ethereum address1977 * @param ethAddress ethereum address1978 * @param toChainFormat false for normalized account1979 * @example ethToSubstrate('0x9F0583DbB855d...')1980 * @returns substrate mirror of a provided ethereum address1981 */1982 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1983 if(!toChainFormat) return evmToAddress(ethAddress);1984 const info = this.helper.chain.getChainProperties();1985 return evmToAddress(ethAddress, info.ss58Format);1986 }19871988 /**1989 * Get ethereum mirror of a substrate address1990 * @param subAddress substrate account1991 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1992 * @returns ethereum mirror of a provided substrate address1993 */1994 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1995 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1996 }1997}19981999class StakingGroup extends HelperGroup {2000 /**2001 * Stake tokens for App Promotion2002 * @param signer keyring of signer2003 * @param amountToStake amount of tokens to stake2004 * @param label extra label for log2005 * @returns2006 */2007 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2008 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2009 const stakeResult = await this.helper.executeExtrinsic(2010 signer,2011 'api.tx.promotion.stake', [amountToStake],2012 true, `stake failed for ${label}`,2013 );2014 // TODO extract info from stakeResult2015 return true;2016 }20172018 /**2019 * Unstake tokens for App Promotion2020 * @param signer keyring of signer2021 * @param amountToUnstake amount of tokens to unstake2022 * @param label extra label for log2023 * @returns 2024 */2025 async unstake(signer: TSigner, label?: string): Promise<boolean> {2026 if(typeof label === 'undefined') label = `${signer.address}`;2027 const unstakeResult = await this.helper.executeExtrinsic(2028 signer,2029 'api.tx.promotion.unstake', [],2030 true, `unstake failed for ${label}`,2031 );2032 // TODO extract info from unstakeResult2033 return true;2034 }20352036 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2037 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2038 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2039 }20402041 async getTotalStakingLocked(address: ICrossAccountId): Promise<bigint> {2042 return (await this.helper.callRpc('api.rpc.appPromotion.totalStakingLocked', [address])).toBigInt();2043 }20442045 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<bigint[][]> {2046 return (await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2047 }20482049 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2050 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2051 }2052 2053 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<bigint[][]> {2054 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2055 }2056}20572058export class UniqueHelper extends ChainHelperBase {2059 chain: ChainGroup;2060 balance: BalanceGroup;2061 address: AddressGroup;2062 collection: CollectionGroup;2063 nft: NFTGroup;2064 rft: RFTGroup;2065 ft: FTGroup;2066 staking: StakingGroup;20672068 constructor(logger?: ILogger) {2069 super(logger);2070 this.chain = new ChainGroup(this);2071 this.balance = new BalanceGroup(this);2072 this.address = new AddressGroup(this);2073 this.collection = new CollectionGroup(this);2074 this.nft = new NFTGroup(this);2075 this.rft = new RFTGroup(this);2076 this.ft = new FTGroup(this);2077 this.staking = new StakingGroup(this);2078 } 2079}208020812082class UniqueCollectionBase {2083 helper: UniqueHelper;2084 collectionId: number;20852086 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2087 this.collectionId = collectionId;2088 this.helper = uniqueHelper;2089 }20902091 async getData() {2092 return await this.helper.collection.getData(this.collectionId);2093 }20942095 async getLastTokenId() {2096 return await this.helper.collection.getLastTokenId(this.collectionId);2097 }20982099 async isTokenExists(tokenId: number) {2100 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2101 }21022103 async getAdmins() {2104 return await this.helper.collection.getAdmins(this.collectionId);2105 }21062107 async getAllowList() {2108 return await this.helper.collection.getAllowList(this.collectionId);2109 }21102111 async getEffectiveLimits() {2112 return await this.helper.collection.getEffectiveLimits(this.collectionId);2113 }21142115 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount, label?: string) {2116 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress, label);2117 }21182119 async confirmSponsorship(signer: TSigner, label?: string) {2120 return await this.helper.collection.confirmSponsorship(signer, this.collectionId, label);2121 }21222123 async setLimits(signer: TSigner, limits: ICollectionLimits, label?: string) {2124 return await this.helper.collection.setLimits(signer, this.collectionId, limits, label);2125 }21262127 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount, label?: string) {2128 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress, label);2129 }21302131 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2132 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj, label);2133 }21342135 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId, label?: string) {2136 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj, label);2137 }21382139 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2140 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj, label);2141 }21422143 async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2144 return await this.helper.collection.setProperties(signer, this.collectionId, properties, label);2145 }21462147 async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2148 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys, label);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, label?: string) {2156 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions, label);2157 }21582159 async enableNesting(signer: TSigner, permissions: INestingPermissions, label?: string) {2160 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions, label);2161 }21622163 async disableNesting(signer: TSigner, label?: string) {2164 return await this.helper.collection.disableNesting(signer, this.collectionId, label);2165 }21662167 async burn(signer: TSigner, label?: string) {2168 return await this.helper.collection.burn(signer, this.collectionId, label);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, label?: string) {2207 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label);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, properties?: IProperty[], label?: string) {2215 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties}, label);2216 }22172218 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string) {2219 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens, label);2220 }22212222 async burnToken(signer: TSigner, tokenId: number, label?: string) {2223 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId, label);2224 }22252226 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2227 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2228 }22292230 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2231 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2232 }22332234 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2235 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2236 }22372238 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken, label?: string) {2239 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj, label);2240 }22412242 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2243 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj, label);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=100n) {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=100n) {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=100n, label?: string) {2278 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label, 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, label?: string) {2286 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount, label);2287 }22882289 async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[], label?: string) {2290 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties}, label);2291 }22922293 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string) {2294 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens, label);2295 }22962297 async burnToken(signer: TSigner, tokenId: number, amount=100n, label?: string) {2298 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, label, amount);2299 }23002301 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2302 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2303 }23042305 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2306 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2307 }23082309 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2310 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2311 }2312}231323142315class UniqueFTCollection extends UniqueCollectionBase {2316 async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint, label?: string) {2317 return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount, label);2318 }23192320 async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string) {2321 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens, label);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: bigint) {2333 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2334 }23352336 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {2337 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2338 }23392340 async burnTokens(signer: TSigner, amount: bigint, label?: string) {2341 return await this.helper.ft.burnTokens(signer, this.collectionId, amount, label);2342 }23432344 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount: bigint, label?: string) {2345 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount, label);2346 }23472348 async getTotalPieces() {2349 return await this.helper.ft.getTotalPieces(this.collectionId);2350 }23512352 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2353 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount, label);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[], label?: string) {2378 return await this.collection.setTokenProperties(signer, this.tokenId, properties, label);2379 }23802381 async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2382 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys, label);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, label?: string) {2412 return await this.collection.nestToken(signer, this.tokenId, toTokenObj, label);2413 }24142415 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2416 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj, label);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, label?: string) {2428 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, label);2429 }24302431 async isApproved(toAddressObj: ICrossAccountId) {2432 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2433 }24342435 async burn(signer: TSigner, label?: string) {2436 return await this.collection.burnToken(signer, this.tokenId, label);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=100n) {2461 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2462 }24632464 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2465 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2466 }24672468 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2469 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount, label);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, label?: string) {2477 return await this.collection.repartitionToken(signer, this.tokenId, amount, label);2478 }24792480 async burn(signer: TSigner, amount=100n, label?: string) {2481 return await this.collection.burnToken(signer, this.tokenId, amount, label);2482 }2483}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';1314const 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};202122const nesting = {23 toChecksumAddress(address: string): string {24 if (typeof address === 'undefined') return '';2526 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2728 address = address.toLowerCase().replace(/^0x/i,'');29 const addressHash = keccakAsHex(address).replace(/^0x/i,'');30 const checksumAddress = ['0x'];3132 for (let i = 0; i < address.length; i++) {33 // If ith character is 8 to f then make it uppercase34 if (parseInt(addressHash[i], 16) > 7) {35 checksumAddress.push(address[i].toUpperCase());36 } else {37 checksumAddress.push(address[i]);38 }39 }40 return checksumAddress.join('');41 },42 tokenIdToAddress(collectionId: number, tokenId: number) {43 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);44 },45};4647class UniqueUtil {48 static transactionStatus = {49 NOT_READY: 'NotReady',50 FAIL: 'Fail',51 SUCCESS: 'Success',52 };5354 static chainLogType = {55 EXTRINSIC: 'extrinsic',56 RPC: 'rpc',57 };5859 static getNestingTokenAddress(collectionId: number, tokenId: number) {60 return nesting.tokenIdToAddress(collectionId, tokenId);61 }6263 static getDefaultLogger(): ILogger {64 return {65 log(msg: any, level = 'INFO') {66 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));67 },68 level: {69 ERROR: 'ERROR',70 WARNING: 'WARNING',71 INFO: 'INFO',72 },73 };74 }7576 static vec2str(arr: string[] | number[]) {77 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');78 }7980 static str2vec(string: string) {81 if (typeof string !== 'string') return string;82 return Array.from(string).map(x => x.charCodeAt(0));83 }8485 static fromSeed(seed: string, ss58Format = 42) {86 const keyring = new Keyring({type: 'sr25519', ss58Format});87 return keyring.addFromUri(seed);88 }8990 static normalizeSubstrateAddress(address: string, ss58Format = 42) {91 return encodeAddress(decodeAddress(address), ss58Format);92 }9394 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult, label = 'new collection') {95 if (creationResult.status !== this.transactionStatus.SUCCESS) {96 throw Error(`Unable to create collection for ${label}`);97 }9899 let collectionId = null;100 creationResult.result.events.forEach(({event: {data, method, section}}) => {101 if ((section === 'common') && (method === 'CollectionCreated')) {102 collectionId = parseInt(data[0].toString(), 10);103 }104 });105106 if (collectionId === null) {107 throw Error(`No CollectionCreated event for ${label}`);108 }109110 return collectionId;111 }112113 static extractTokensFromCreationResult(creationResult: ITransactionResult, label = 'new tokens') {114 if (creationResult.status !== this.transactionStatus.SUCCESS) {115 throw Error(`Unable to create tokens for ${label}`);116 }117 let success = false;118 const tokens = [] as any;119 creationResult.result.events.forEach(({event: {data, method, section}}) => {120 if (method === 'ExtrinsicSuccess') {121 success = true;122 } else if ((section === 'common') && (method === 'ItemCreated')) {123 tokens.push({124 collectionId: parseInt(data[0].toString(), 10),125 tokenId: parseInt(data[1].toString(), 10),126 owner: data[2].toJSON(),127 });128 }129 });130 return {success, tokens};131 }132133 static extractTokensFromBurnResult(burnResult: ITransactionResult, label = 'burned tokens') {134 if (burnResult.status !== this.transactionStatus.SUCCESS) {135 throw Error(`Unable to burn tokens for ${label}`);136 }137 let success = false;138 const tokens = [] as any;139 burnResult.result.events.forEach(({event: {data, method, section}}) => {140 if (method === 'ExtrinsicSuccess') {141 success = true;142 } else if ((section === 'common') && (method === 'ItemDestroyed')) {143 tokens.push({144 collectionId: parseInt(data[0].toString(), 10),145 tokenId: parseInt(data[1].toString(), 10),146 owner: data[2].toJSON(),147 });148 }149 });150 return {success, tokens};151 }152153 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string, label?: string) {154 let eventId = null;155 events.forEach(({event: {data, method, section}}) => {156 if ((section === expectedSection) && (method === expectedMethod)) {157 eventId = parseInt(data[0].toString(), 10);158 }159 });160161 if (eventId === null) {162 throw Error(`No ${expectedMethod} event for ${label}`);163 }164 return eventId === collectionId;165 }166167 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {168 const normalizeAddress = (address: string | ICrossAccountId) => {169 if(typeof address === 'string') return address;170 const obj = {} as any;171 Object.keys(address).forEach(k => {172 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];173 });174 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};175 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};176 return address;177 };178 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;179 events.forEach(({event: {data, method, section}}) => {180 if ((section === 'common') && (method === 'Transfer')) {181 const hData = (data as any).toJSON();182 transfer = {183 collectionId: hData[0],184 tokenId: hData[1],185 from: normalizeAddress(hData[2]),186 to: normalizeAddress(hData[3]),187 amount: BigInt(hData[4]),188 };189 }190 });191 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);193 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);194 isSuccess = isSuccess && amount === transfer.amount;195 return isSuccess;196 }197}198199200class ChainHelperBase {201 transactionStatus = UniqueUtil.transactionStatus;202 chainLogType = UniqueUtil.chainLogType;203 util: typeof UniqueUtil;204 logger: ILogger;205 api: ApiPromise | null;206 forcedNetwork: TUniqueNetworks | null;207 network: TUniqueNetworks | null;208 chainLog: IUniqueHelperLog[];209210 constructor(logger?: ILogger) {211 this.util = UniqueUtil;212 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();213 this.logger = logger;214 this.api = null;215 this.forcedNetwork = null;216 this.network = null;217 this.chainLog = [];218 }219220 clearChainLog(): void {221 this.chainLog = [];222 }223224 forceNetwork(value: TUniqueNetworks): void {225 this.forcedNetwork = value;226 }227228 async connect(wsEndpoint: string, listeners?: IApiListeners) {229 if (this.api !== null) throw Error('Already connected');230 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);231 this.api = api;232 this.network = network;233 }234235 async disconnect() {236 if (this.api === null) return;237 await this.api.disconnect();238 this.api = null;239 this.network = null;240 }241242 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {243 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;244 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;245 return 'opal';246 }247248 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {249 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});250 await api.isReady;251252 const network = await this.detectNetwork(api);253254 await api.disconnect();255256 return network;257 }258259 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 260 api: ApiPromise; 261 network: TUniqueNetworks; 262 }> {263 if(typeof network === 'undefined' || network === null) network = 'opal';264 const supportedRPC = {265 opal: {266 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,267 },268 quartz: {269 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,270 },271 unique: {272 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,273 },274 };275 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);276 const rpc = supportedRPC[network];277278 // TODO: investigate how to replace rpc in runtime279 // api._rpcCore.addUserInterfaces(rpc);280281 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});282283 await api.isReadyOrError;284285 if (typeof listeners === 'undefined') listeners = {};286 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {287 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;288 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);289 }290291 return {api, network};292 }293294 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {295 const {events, status} = data;296 if (status.isReady) {297 return this.transactionStatus.NOT_READY;298 }299 if (status.isBroadcast) {300 return this.transactionStatus.NOT_READY;301 }302 if (status.isInBlock || status.isFinalized) {303 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');304 if (errors.length > 0) {305 return this.transactionStatus.FAIL;306 }307 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {308 return this.transactionStatus.SUCCESS;309 }310 }311312 return this.transactionStatus.FAIL;313 }314315 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {316 const sign = (callback: any) => {317 if(options !== null) return transaction.signAndSend(sender, options, callback);318 return transaction.signAndSend(sender, callback);319 };320 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 params,392 } as IUniqueHelperLog;393394 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;395 if(events.length > 0) log.events = events;396397 this.chainLog.push(log);398399 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(failureMessage);400 return result;401 }402403 async callRpc(rpc: string, params?: any[]) {404 if(typeof params === 'undefined') params = [];405 if(this.api === null) throw Error('API not initialized');406 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);407408 const startTime = (new Date()).getTime();409 let result;410 let error = null;411 const log = {412 type: this.chainLogType.RPC,413 call: rpc,414 params,415 } as IUniqueHelperLog;416417 try {418 result = await this.constructApiCall(rpc, params);419 }420 catch(e) {421 error = e;422 }423424 const endTime = (new Date()).getTime();425426 log.executedAt = endTime;427 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';428 log.executionTime = endTime - startTime;429430 this.chainLog.push(log);431432 if(error !== null) throw error;433434 return result;435 }436437 getSignerAddress(signer: IKeyringPair | string): string {438 if(typeof signer === 'string') return signer;439 return signer.address;440 }441}442443444class HelperGroup {445 helper: UniqueHelper;446447 constructor(uniqueHelper: UniqueHelper) {448 this.helper = uniqueHelper;449 }450}451452453class CollectionGroup extends HelperGroup {454 /**455 * Get number of blocks when sponsored transaction is available.456 *457 * @param collectionId ID of collection458 * @param tokenId ID of token459 * @param addressObj address for which the sponsorship is checked460 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});461 * @returns number of blocks or null if sponsorship hasn't been set462 */463 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {464 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();465 }466467 /**468 * Get the number of created collections.469 * 470 * @returns number of created collections471 */472 async getTotalCount(): Promise<number> {473 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();474 }475476 /**477 * Get information about the collection with additional data, including the number of tokens it contains, its administrators, the normalized address of the collection's owner, and decoded name and description.478 * 479 * @param collectionId ID of collection480 * @example await getData(2)481 * @returns collection information object482 */483 async getData(collectionId: number): Promise<{484 id: number;485 name: string;486 description: string;487 tokensCount: number;488 admins: ICrossAccountId[];489 normalizedOwner: TSubstrateAccount;490 raw: any491 } | null> {492 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);493 const humanCollection = collection.toHuman(), collectionData = {494 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],495 raw: humanCollection,496 } as any, jsonCollection = collection.toJSON();497 if (humanCollection === null) return null;498 collectionData.raw.limits = jsonCollection.limits;499 collectionData.raw.permissions = jsonCollection.permissions;500 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);501 for (const key of ['name', 'description']) {502 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);503 }504505 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) : 0;506 collectionData.admins = await this.getAdmins(collectionId);507508 return collectionData;509 }510511 /**512 * Get the normalized addresses of the collection's administrators.513 * 514 * @param collectionId ID of collection515 * @example await getAdmins(1)516 * @returns array of administrators517 */518 async getAdmins(collectionId: number): Promise<ICrossAccountId[]> {519 const normalized = [];520 for(const admin of (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman()) {521 if(admin.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(admin.Substrate)});522 else normalized.push(admin);523 }524 return normalized;525 }526527 /**528 * Get the normalized addresses added to the collection allow-list.529 * @param collectionId ID of collection530 * @example await getAllowList(1)531 * @returns array of allow-listed addresses532 */533 async getAllowList(collectionId: number): Promise<ICrossAccountId[]> {534 const normalized = [];535 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();536 for (const address of allowListed) {537 if (address.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(address.Substrate)});538 else normalized.push(address);539 }540 return normalized;541 }542543 /**544 * Get the effective limits of the collection instead of null for default values545 * 546 * @param collectionId ID of collection547 * @example await getEffectiveLimits(2)548 * @returns object of collection limits549 */550 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {551 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();552 }553554 /**555 * Burns the collection if the signer has sufficient permissions and collection is empty.556 * 557 * @param signer keyring of signer558 * @param collectionId ID of collection559 * @param label extra label for log560 * @example await helper.collection.burn(aliceKeyring, 3);561 * @returns ```true``` if extrinsic success, otherwise ```false```562 */563 async burn(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {564 if(typeof label === 'undefined') label = `collection #${collectionId}`;565 const result = await this.helper.executeExtrinsic(566 signer,567 'api.tx.unique.destroyCollection', [collectionId],568 true, `Unable to burn collection for ${label}`,569 );570571 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed', label);572 }573574 /**575 * Sets the sponsor for the collection (Requires the Substrate address).576 * 577 * @param signer keyring of signer578 * @param collectionId ID of collection579 * @param sponsorAddress Sponsor substrate address580 * @param label extra label for log581 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")582 * @returns ```true``` if extrinsic success, otherwise ```false```583 */584 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount, label?: string): Promise<boolean> {585 if(typeof label === 'undefined') label = `collection #${collectionId}`;586 const result = await this.helper.executeExtrinsic(587 signer,588 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],589 true, `Unable to set collection sponsor for ${label}`,590 );591592 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet', label);593 }594595 /**596 * Confirms consent to sponsor the collection on behalf of the signer.597 * 598 * @param signer keyring of signer599 * @param collectionId ID of collection600 * @param label extra label for log601 * @example confirmSponsorship(aliceKeyring, 10)602 * @returns ```true``` if extrinsic success, otherwise ```false```603 */604 async confirmSponsorship(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {605 if(typeof label === 'undefined') label = `collection #${collectionId}`;606 const result = await this.helper.executeExtrinsic(607 signer,608 'api.tx.unique.confirmSponsorship', [collectionId],609 true, `Unable to confirm collection sponsorship for ${label}`,610 );611612 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed', label);613 }614615 /**616 * Sets the limits of the collection. At least one limit must be specified for a correct call.617 * 618 * @param signer keyring of signer619 * @param collectionId ID of collection620 * @param limits collection limits object621 * @param label extra label for log622 * @example623 * await setLimits(624 * aliceKeyring,625 * 10,626 * {627 * sponsorTransferTimeout: 0,628 * ownerCanDestroy: false629 * }630 * )631 * @returns ```true``` if extrinsic success, otherwise ```false```632 */633 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits, label?: string): Promise<boolean> {634 if(typeof label === 'undefined') label = `collection #${collectionId}`;635 const result = await this.helper.executeExtrinsic(636 signer,637 'api.tx.unique.setCollectionLimits', [collectionId, limits],638 true, `Unable to set collection limits for ${label}`,639 );640641 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet', label);642 }643644 /**645 * Changes the owner of the collection to the new Substrate address.646 * 647 * @param signer keyring of signer648 * @param collectionId ID of collection649 * @param ownerAddress substrate address of new owner650 * @param label extra label for log651 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")652 * @returns ```true``` if extrinsic success, otherwise ```false```653 */654 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount, label?: string): Promise<boolean> {655 if(typeof label === 'undefined') label = `collection #${collectionId}`;656 const result = await this.helper.executeExtrinsic(657 signer,658 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],659 true, `Unable to change collection owner for ${label}`,660 );661662 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged', label);663 }664665 /**666 * Adds a collection administrator. 667 * 668 * @param signer keyring of signer669 * @param collectionId ID of collection670 * @param adminAddressObj Administrator address (substrate or ethereum)671 * @param label extra label for log672 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})673 * @returns ```true``` if extrinsic success, otherwise ```false```674 */675 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {676 if(typeof label === 'undefined') label = `collection #${collectionId}`;677 const result = await this.helper.executeExtrinsic(678 signer,679 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],680 true, `Unable to add collection admin for ${label}`,681 );682683 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded', label);684 }685686 /**687 * Adds an address to allow list 688 * @param signer keyring of signer689 * @param collectionId ID of collection690 * @param addressObj address to add to the allow list691 * @param label extra label for log692 * @returns ```true``` if extrinsic success, otherwise ```false```693 */694 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId, label?: string): Promise<boolean> {695 if(typeof label === 'undefined') label = `collection #${collectionId}`;696 const result = await this.helper.executeExtrinsic(697 signer,698 'api.tx.unique.addToAllowList', [collectionId, addressObj],699 true, `Unable to add address to allow list for ${label}`,700 );701702 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');703 }704705 /**706 * Removes a collection administrator.707 * 708 * @param signer keyring of signer709 * @param collectionId ID of collection710 * @param adminAddressObj Administrator address (substrate or ethereum)711 * @param label extra label for log712 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})713 * @returns ```true``` if extrinsic success, otherwise ```false```714 */715 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {716 if(typeof label === 'undefined') label = `collection #${collectionId}`;717 const result = await this.helper.executeExtrinsic(718 signer,719 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],720 true, `Unable to remove collection admin for ${label}`,721 );722723 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved', label);724 }725726 /**727 * Sets onchain permissions for selected collection.728 * 729 * @param signer keyring of signer730 * @param collectionId ID of collection731 * @param permissions collection permissions object732 * @param label extra label for log733 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});734 * @returns ```true``` if extrinsic success, otherwise ```false```735 */736 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions, label?: string): Promise<boolean> {737 if(typeof label === 'undefined') label = `collection #${collectionId}`;738 const result = await this.helper.executeExtrinsic(739 signer,740 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],741 true, `Unable to set collection permissions for ${label}`,742 );743744 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet', label);745 }746747 /**748 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.749 * 750 * @param signer keyring of signer751 * @param collectionId ID of collection752 * @param permissions nesting permissions object753 * @param label extra label for log754 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});755 * @returns ```true``` if extrinsic success, otherwise ```false```756 */757 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions, label?: string): Promise<boolean> {758 return await this.setPermissions(signer, collectionId, {nesting: permissions}, label);759 }760761 /**762 * Disables nesting for selected collection.763 * 764 * @param signer keyring of signer765 * @param collectionId ID of collection766 * @param label extra label for log767 * @example disableNesting(aliceKeyring, 10);768 * @returns ```true``` if extrinsic success, otherwise ```false```769 */770 async disableNesting(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {771 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}}, label);772 }773774 /**775 * Sets onchain properties to the collection.776 * 777 * @param signer keyring of signer778 * @param collectionId ID of collection779 * @param properties array of property objects780 * @param label extra label for log781 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);782 * @returns ```true``` if extrinsic success, otherwise ```false```783 */784 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[], label?: string): Promise<boolean> {785 if(typeof label === 'undefined') label = `collection #${collectionId}`;786 const result = await this.helper.executeExtrinsic(787 signer,788 'api.tx.unique.setCollectionProperties', [collectionId, properties],789 true, `Unable to set collection properties for ${label}`,790 );791792 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet', label);793 }794795 /**796 * Deletes onchain properties from the collection.797 * 798 * @param signer keyring of signer799 * @param collectionId ID of collection800 * @param propertyKeys array of property keys to delete801 * @param label802 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);803 * @returns ```true``` if extrinsic success, otherwise ```false```804 */805 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[], label?: string): Promise<boolean> {806 if(typeof label === 'undefined') label = `collection #${collectionId}`;807 const result = await this.helper.executeExtrinsic(808 signer,809 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],810 true, `Unable to delete collection properties for ${label}`,811 );812813 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted', label);814 }815816 /**817 * Changes the owner of the token.818 * 819 * @param signer keyring of signer820 * @param collectionId ID of collection821 * @param tokenId ID of token822 * @param addressObj address of a new owner823 * @param amount amount of tokens to be transfered. For NFT must be set to 1n824 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})825 * @returns true if the token success, otherwise false826 */827 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {828 const result = await this.helper.executeExtrinsic(829 signer,830 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],831 true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,832 );833834 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);835 }836837 /**838 * 839 * Change ownership of a token(s) on behalf of the owner. 840 * 841 * @param signer keyring of signer842 * @param collectionId ID of collection843 * @param tokenId ID of token844 * @param fromAddressObj address on behalf of which the token will be sent845 * @param toAddressObj new token owner846 * @param amount amount of tokens to be transfered. For NFT must be set to 1n847 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})848 * @returns true if the token success, otherwise false849 */850 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {851 const result = await this.helper.executeExtrinsic(852 signer,853 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],854 true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,855 );856 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);857 }858859 /**860 * 861 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.862 * 863 * @param signer keyring of signer864 * @param collectionId ID of collection865 * @param tokenId ID of token866 * @param label 867 * @param amount amount of tokens to be burned. For NFT must be set to 1n868 * @example burnToken(aliceKeyring, 10, 5);869 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```870 */871 async burnToken(signer: TSigner, collectionId: number, tokenId: number, label?: string, amount=1n): Promise<{872 success: boolean,873 token: number | null874 }> {875 if(typeof label === 'undefined') label = `collection #${collectionId}`;876 const burnResult = await this.helper.executeExtrinsic(877 signer,878 'api.tx.unique.burnItem', [collectionId, tokenId, amount],879 true, `Unable to burn token for ${label}`,880 );881 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);882 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');883 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};884 }885886 /**887 * Destroys a concrete instance of NFT on behalf of the owner888 * 889 * @param signer keyring of signer890 * @param collectionId ID of collection891 * @param fromAddressObj address on behalf of which the token will be burnt892 * @param tokenId ID of token893 * @param label 894 * @param amount amount of tokens to be burned. For NFT must be set to 1n895 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})896 * @returns ```true``` if extrinsic success, otherwise ```false```897 */898 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, label?: string, amount=1n): Promise<boolean> {899 if(typeof label === 'undefined') label = `collection #${collectionId}`;900 const burnResult = await this.helper.executeExtrinsic(901 signer,902 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],903 true, `Unable to burn token from for ${label}`,904 );905 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);906 return burnedTokens.success && burnedTokens.tokens.length > 0;907 }908909 /**910 * Set, change, or remove approved address to transfer the ownership of the NFT.911 * 912 * @param signer keyring of signer913 * @param collectionId ID of collection914 * @param tokenId ID of token915 * @param toAddressObj 916 * @param label 917 * @param amount amount of token to be approved. For NFT must be set to 1n918 * @returns ```true``` if extrinsic success, otherwise ```false```919 */920 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=1n) {921 if(typeof label === 'undefined') label = `collection #${collectionId}`;922 const approveResult = await this.helper.executeExtrinsic(923 signer, 924 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],925 true, `Unable to approve token for ${label}`,926 );927928 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved', label);929 }930931 /**932 * Get the amount of token pieces approved to transfer933 * @param collectionId ID of collection934 * @param tokenId ID of token935 * @param toAccountObj 936 * @param fromAccountObj937 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})938 * @returns number of approved to transfer pieces939 */940 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {941 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();942 }943944 /**945 * Get the last created token id946 * @param collectionId ID of collection947 * @example getLastTokenId(10);948 * @returns id of the last created token949 */950 async getLastTokenId(collectionId: number): Promise<number> {951 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();952 }953954 /**955 * Check if token exists956 * @param collectionId ID of collection957 * @param tokenId ID of token958 * @example isTokenExists(10, 20);959 * @returns true if the token exists, otherwise false960 */961 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {962 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();963 }964}965966class NFTnRFT extends CollectionGroup {967 /**968 * Get tokens owned by account969 * 970 * @param collectionId ID of collection971 * @param addressObj tokens owner972 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})973 * @returns array of token ids owned by account974 */975 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {976 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();977 }978979 /**980 * Get token data981 * @param collectionId ID of collection982 * @param tokenId ID of token983 * @param blockHashAt 984 * @param propertyKeys985 * @example getToken(10, 5);986 * @returns human readable token data 987 */988 async getToken(collectionId: number, tokenId: number, blockHashAt?: string, propertyKeys?: string[]): Promise<{989 properties: IProperty[];990 owner: ICrossAccountId;991 normalizedOwner: ICrossAccountId;992 }| null> {993 let tokenData;994 if(typeof blockHashAt === 'undefined') {995 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);996 }997 else {998 if(typeof propertyKeys === 'undefined') {999 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1000 if(!collection) return null;1001 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1002 }1003 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1004 }1005 tokenData = tokenData.toHuman();1006 if (tokenData === null || tokenData.owner === null) return null;1007 const owner = {} as any;1008 for (const key of Object.keys(tokenData.owner)) {1009 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1010 }1011 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1012 return tokenData;1013 }10141015 /**1016 * Set permissions to change token properties1017 * @param signer keyring of signer1018 * @param collectionId ID of collection1019 * @param permissions permissions to change a property by the collection owner or admin1020 * @param label 1021 * @example setTokenPropertyPermissions(1022 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1023 * )1024 * @returns true if extrinsic success otherwise false1025 */1026 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[], label?: string): Promise<boolean> {1027 if(typeof label === 'undefined') label = `collection #${collectionId}`;1028 const result = await this.helper.executeExtrinsic(1029 signer,1030 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1031 true, `Unable to set token property permissions for ${label}`,1032 );10331034 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet', label);1035 }10361037 /**1038 * Set token properties1039 * @param signer keyring of signer1040 * @param collectionId ID of collection1041 * @param tokenId ID of token1042 * @param properties 1043 * @param label 1044 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1045 * @returns ```true``` if extrinsic success, otherwise ```false```1046 */1047 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[], label?: string): Promise<boolean> {1048 if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1049 const result = await this.helper.executeExtrinsic(1050 signer,1051 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1052 true, `Unable to set token properties for ${label}`,1053 );10541055 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet', label);1056 }10571058 /**1059 * Delete the provided properties of a token1060 * @param signer keyring of signer1061 * @param collectionId ID of collection1062 * @param tokenId ID of token1063 * @param propertyKeys property keys to be deleted 1064 * @param label 1065 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1066 * @returns ```true``` if extrinsic success, otherwise ```false```1067 */1068 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[], label?: string): Promise<boolean> {1069 if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1070 const result = await this.helper.executeExtrinsic(1071 signer,1072 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1073 true, `Unable to delete token properties for ${label}`,1074 );10751076 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted', label);1077 }10781079 /**1080 * Mint new collection1081 * @param signer keyring of signer1082 * @param collectionOptions basic collection options and properties 1083 * @param mode NFT or RFT type of a collection1084 * @param errorLabel 1085 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1086 * @returns object of the created collection1087 */1088 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT', errorLabel = 'Unable to mint collection'): Promise<UniqueCollectionBase> {1089 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1090 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1091 for (const key of ['name', 'description', 'tokenPrefix']) {1092 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);1093 }1094 const creationResult = await this.helper.executeExtrinsic(1095 signer,1096 'api.tx.unique.createCollectionEx', [collectionOptions],1097 true, errorLabel,1098 );1099 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1100 }11011102 getCollectionObject(collectionId: number): any {1103 return null;1104 }11051106 getTokenObject(collectionId: number, tokenId: number): any {1107 return null;1108 }1109}111011111112class NFTGroup extends NFTnRFT {1113 /**1114 * Get collection object1115 * @param collectionId ID of collection1116 * @example getCollectionObject(2);1117 * @returns instance of UniqueNFTCollection1118 */1119 getCollectionObject(collectionId: number): UniqueNFTCollection {1120 return new UniqueNFTCollection(collectionId, this.helper);1121 }11221123 /**1124 * Get token object1125 * @param collectionId ID of collection1126 * @param tokenId ID of token1127 * @example getTokenObject(10, 5);1128 * @returns instance of UniqueNFTToken1129 */1130 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1131 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1132 }11331134 /**1135 * Get token's owner1136 * @param collectionId ID of collection1137 * @param tokenId ID of token1138 * @param blockHashAt 1139 * @example getTokenOwner(10, 5);1140 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1141 */1142 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1143 let owner;1144 if (typeof blockHashAt === 'undefined') {1145 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1146 } else {1147 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1148 }1149 return crossAccountIdFromLower(owner.toJSON());1150 }11511152 /**1153 * Is token approved to transfer1154 * @param collectionId ID of collection1155 * @param tokenId ID of token1156 * @param toAccountObj address to be approved1157 * @returns ```true``` if extrinsic success, otherwise ```false```1158 */1159 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1160 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1161 }11621163 /**1164 * Changes the owner of the token.1165 * 1166 * @param signer keyring of signer1167 * @param collectionId ID of collection1168 * @param tokenId ID of token1169 * @param addressObj address of a new owner1170 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1171 * @returns ```true``` if extrinsic success, otherwise ```false```1172 */1173 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1174 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1175 }11761177 /**1178 * 1179 * Change ownership of a NFT on behalf of the owner. 1180 * 1181 * @param signer keyring of signer1182 * @param collectionId ID of collection1183 * @param tokenId ID of token1184 * @param fromAddressObj address on behalf of which the token will be sent1185 * @param toAddressObj new token owner1186 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1187 * @returns ```true``` if extrinsic success, otherwise ```false```1188 */1189 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1190 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1191 }11921193 /**1194 * Recursively find the address that owns the token1195 * @param collectionId ID of collection1196 * @param tokenId ID of token1197 * @param blockHashAt 1198 * @example getTokenTopmostOwner(10, 5);1199 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1200 */1201 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1202 let owner;1203 if (typeof blockHashAt === 'undefined') {1204 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1205 } else {1206 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1207 }12081209 if (owner === null) return null;12101211 owner = owner.toHuman();12121213 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1214 }12151216 /**1217 * Get tokens nested in the provided token1218 * @param collectionId ID of collection1219 * @param tokenId ID of token1220 * @param blockHashAt 1221 * @example getTokenChildren(10, 5);1222 * @returns tokens whose depth of nesting is <= 5 1223 */1224 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1225 let children;1226 if(typeof blockHashAt === 'undefined') {1227 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1228 } else {1229 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1230 }12311232 return children.toJSON().map((x: any) => {1233 return {collectionId: x.collection, tokenId: x.token};1234 });1235 }12361237 /**1238 * Nest one token into another1239 * @param signer keyring of signer1240 * @param tokenObj token to be nested1241 * @param rootTokenObj token to be parent1242 * @param label 1243 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1244 * @returns ```true``` if extrinsic success, otherwise ```false```1245 */1246 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, label='nest token'): Promise<boolean> {1247 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1248 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1249 if(!result) {1250 throw Error(`Unable to nest token for ${label}`);1251 }1252 return result;1253 }12541255 /**1256 * Remove token from nested state1257 * @param signer keyring of signer1258 * @param tokenObj token to unnest1259 * @param rootTokenObj parent of a token1260 * @param toAddressObj address of a new token owner 1261 * @param label 1262 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1263 * @returns ```true``` if extrinsic success, otherwise ```false```1264 */1265 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId, label='unnest token'): Promise<boolean> {1266 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1267 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1268 if(!result) {1269 throw Error(`Unable to unnest token for ${label}`);1270 }1271 return result;1272 }12731274 /**1275 * Mint new collection1276 * @param signer keyring of signer1277 * @param collectionOptions Collection options1278 * @param label 1279 * @example 1280 * mintCollection(aliceKeyring, {1281 * name: 'New',1282 * description: 'New collection',1283 * tokenPrefix: 'NEW',1284 * })1285 * @returns object of the created collection1286 */1287 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueNFTCollection> {1288 return await super.mintCollection(signer, collectionOptions, 'NFT', `Unable to mint NFT collection for ${label}`) as UniqueNFTCollection;1289 }12901291 /**1292 * Mint new token1293 * @param signer keyring of signer1294 * @param data token data1295 * @param label 1296 * @returns created token object1297 */1298 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }, label?: string): Promise<UniqueNFTToken> {1299 if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1300 const creationResult = await this.helper.executeExtrinsic(1301 signer,1302 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1303 nft: {1304 properties: data.properties,1305 },1306 }],1307 true, `Unable to mint NFT token for ${label}`,1308 );1309 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1310 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1311 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1312 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1313 }13141315 /**1316 * Mint multiple NFT tokens1317 * @param signer keyring of signer1318 * @param collectionId ID of collection1319 * @param tokens array of tokens with owner and properties1320 * @param label 1321 * @example 1322 * mintMultipleTokens(aliceKeyring, 10, [{1323 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1324 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1325 * },{1326 * owner: {Ethereum: "0x9F0583DbB855d..."},1327 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1328 * }]);1329 * @returns ```true``` if extrinsic success, otherwise ```false```1330 */1331 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1332 if(typeof label === 'undefined') label = `collection #${collectionId}`;1333 const creationResult = await this.helper.executeExtrinsic(1334 signer,1335 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1336 true, `Unable to mint NFT tokens for ${label}`,1337 );1338 const collection = this.getCollectionObject(collectionId);1339 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1340 }13411342 /**1343 * Mint multiple NFT tokens with one owner1344 * @param signer keyring of signer1345 * @param collectionId ID of collection1346 * @param owner tokens owner1347 * @param tokens array of tokens with owner and properties1348 * @param label 1349 * @example1350 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1351 * properties: [{1352 * key: "gender",1353 * value: "female",1354 * },{1355 * key: "age",1356 * value: "33",1357 * }],1358 * }]);1359 * @returns array of newly created tokens1360 */1361 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1362 if(typeof label === 'undefined') label = `collection #${collectionId}`;1363 const rawTokens = [];1364 for (const token of tokens) {1365 const raw = {NFT: {properties: token.properties}};1366 rawTokens.push(raw);1367 }1368 const creationResult = await this.helper.executeExtrinsic(1369 signer,1370 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1371 true, `Unable to mint NFT tokens for ${label}`,1372 );1373 const collection = this.getCollectionObject(collectionId);1374 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1375 }13761377 /**1378 * Destroys a concrete instance of NFT.1379 * @param signer keyring of signer1380 * @param collectionId ID of collection1381 * @param tokenId ID of token1382 * @param label 1383 * @example burnToken(aliceKeyring, 10, 5);1384 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1385 */1386 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string): Promise<{ success: boolean; token: number | null; }> {1387 return await super.burnToken(signer, collectionId, tokenId, label, 1n);1388 }13891390 /**1391 * Set, change, or remove approved address to transfer the ownership of the NFT.1392 * 1393 * @param signer keyring of signer1394 * @param collectionId ID of collection1395 * @param tokenId ID of token1396 * @param toAddressObj address to approve1397 * @param label 1398 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1399 * @returns ```true``` if extrinsic success, otherwise ```false```1400 */1401 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {1402 return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, 1n);1403 }1404}140514061407class RFTGroup extends NFTnRFT {1408 /**1409 * Get collection object1410 * @param collectionId ID of collection1411 * @example getCollectionObject(2);1412 * @returns instance of UniqueRFTCollection1413 */1414 getCollectionObject(collectionId: number): UniqueRFTCollection {1415 return new UniqueRFTCollection(collectionId, this.helper);1416 }14171418 /**1419 * Get token object1420 * @param collectionId ID of collection1421 * @param tokenId ID of token1422 * @example getTokenObject(10, 5);1423 * @returns instance of UniqueNFTToken1424 */1425 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1426 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1427 }14281429 /**1430 * Get top 10 token owners with the largest number of pieces 1431 * @param collectionId ID of collection1432 * @param tokenId ID of token1433 * @example getTokenTop10Owners(10, 5);1434 * @returns array of top 10 owners1435 */1436 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1437 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1438 }14391440 /**1441 * Get number of pieces owned by address1442 * @param collectionId ID of collection1443 * @param tokenId ID of token1444 * @param addressObj address token owner1445 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1446 * @returns number of pieces ownerd by address1447 */1448 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1449 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1450 }14511452 /**1453 * Transfer pieces of token to another address1454 * @param signer keyring of signer1455 * @param collectionId ID of collection1456 * @param tokenId ID of token1457 * @param addressObj address of a new owner1458 * @param amount number of pieces to be transfered1459 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1460 * @returns ```true``` if extrinsic success, otherwise ```false```1461 */1462 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=100n): Promise<boolean> {1463 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1464 }14651466 /**1467 * Change ownership of some pieces of RFT on behalf of the owner. 1468 * @param signer keyring of signer1469 * @param collectionId ID of collection1470 * @param tokenId ID of token1471 * @param fromAddressObj address on behalf of which the token will be sent1472 * @param toAddressObj new token owner1473 * @param amount number of pieces to be transfered1474 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1475 * @returns ```true``` if extrinsic success, otherwise ```false```1476 */1477 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n): Promise<boolean> {1478 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1479 }14801481 /**1482 * Mint new collection1483 * @param signer keyring of signer1484 * @param collectionOptions Collection options1485 * @param label 1486 * @example1487 * mintCollection(aliceKeyring, {1488 * name: 'New',1489 * description: 'New collection',1490 * tokenPrefix: 'NEW',1491 * })1492 * @returns object of the created collection1493 */1494 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueRFTCollection> {1495 return await super.mintCollection(signer, collectionOptions, 'RFT', `Unable to mint RFT collection for ${label}`) as UniqueRFTCollection;1496 }14971498 /**1499 * Mint new token1500 * @param signer keyring of signer1501 * @param data token data1502 * @param label 1503 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1504 * @returns created token object1505 */1506 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }, label?: string): Promise<UniqueRFTToken> {1507 if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1508 const creationResult = await this.helper.executeExtrinsic(1509 signer,1510 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1511 refungible: {1512 pieces: data.pieces,1513 properties: data.properties,1514 },1515 }],1516 true, `Unable to mint RFT token for ${label}`,1517 );1518 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1519 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1520 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1521 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1522 }15231524 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1525 throw Error('Not implemented');1526 if(typeof label === 'undefined') label = `collection #${collectionId}`;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, label).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 * @param label 1543 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1544 * @returns array of newly created RFT tokens1545 */1546 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1547 if(typeof label === 'undefined') label = `collection #${collectionId}`;1548 const rawTokens = [];1549 for (const token of tokens) {1550 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1551 rawTokens.push(raw);1552 }1553 const creationResult = await this.helper.executeExtrinsic(1554 signer,1555 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1556 true, `Unable to mint RFT tokens for ${label}`,1557 );1558 const collection = this.getCollectionObject(collectionId);1559 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1560 }15611562 /**1563 * Destroys a concrete instance of RFT.1564 * @param signer keyring of signer1565 * @param collectionId ID of collection1566 * @param tokenId ID of token1567 * @param label 1568 * @param amount number of pieces to be burnt1569 * @example burnToken(aliceKeyring, 10, 5);1570 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1571 */1572 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string, amount=100n): Promise<{ success: boolean; token: number | null; }> {1573 return await super.burnToken(signer, collectionId, tokenId, label, amount);1574 }15751576 /**1577 * Set, change, or remove approved address to transfer the ownership of the RFT.1578 * 1579 * @param signer keyring of signer1580 * @param collectionId ID of collection1581 * @param tokenId ID of token1582 * @param toAddressObj address to approve1583 * @param label 1584 * @param amount number of pieces to be approved1585 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1586 * @returns true if the token success, otherwise false1587 */1588 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=100n) {1589 return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, amount);1590 }15911592 /**1593 * Get total number of pieces1594 * @param collectionId ID of collection1595 * @param tokenId ID of token1596 * @example getTokenTotalPieces(10, 5);1597 * @returns number of pieces1598 */1599 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1600 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1601 }16021603 /**1604 * Change number of token pieces. Signer must be the owner of all token pieces.1605 * @param signer keyring of signer1606 * @param collectionId ID of collection1607 * @param tokenId ID of token1608 * @param amount new number of pieces1609 * @param label 1610 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1611 * @returns true if the repartion was success, otherwise false1612 */1613 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint, label?: string): Promise<boolean> {1614 if(typeof label === 'undefined') label = `collection #${collectionId}`;1615 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1616 const repartitionResult = await this.helper.executeExtrinsic(1617 signer,1618 'api.tx.unique.repartition', [collectionId, tokenId, amount],1619 true, `Unable to repartition RFT token for ${label}`,1620 );1621 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated', label);1622 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed', label);1623 }1624}162516261627class FTGroup extends CollectionGroup {1628 /**1629 * Get collection object1630 * @param collectionId ID of collection1631 * @example getCollectionObject(2);1632 * @returns instance of UniqueFTCollection1633 */1634 getCollectionObject(collectionId: number): UniqueFTCollection {1635 return new UniqueFTCollection(collectionId, this.helper);1636 }16371638 /**1639 * Mint new fungible collection1640 * @param signer keyring of signer1641 * @param collectionOptions Collection options1642 * @param decimalPoints number of token decimals 1643 * @param errorLabel 1644 * @example1645 * mintCollection(aliceKeyring, {1646 * name: 'New',1647 * description: 'New collection',1648 * tokenPrefix: 'NEW',1649 * }, 18)1650 * @returns newly created fungible collection1651 */1652 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0, errorLabel = 'Unable to mint collection'): Promise<UniqueFTCollection> {1653 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1654 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1655 collectionOptions.mode = {fungible: decimalPoints};1656 for (const key of ['name', 'description', 'tokenPrefix']) {1657 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);1658 }1659 const creationResult = await this.helper.executeExtrinsic(1660 signer,1661 'api.tx.unique.createCollectionEx', [collectionOptions],1662 true, errorLabel,1663 );1664 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1665 }16661667 /**1668 * Mint tokens1669 * @param signer keyring of signer1670 * @param collectionId ID of collection1671 * @param owner address owner of new tokens1672 * @param amount amount of tokens to be meanted1673 * @param label 1674 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1675 * @returns ```true``` if extrinsic success, otherwise ```false``` 1676 */1677 async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint, label?: string): Promise<boolean> {1678 if(typeof label === 'undefined') label = `collection #${collectionId}`;1679 const creationResult = await this.helper.executeExtrinsic(1680 signer,1681 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1682 fungible: {1683 value: amount,1684 },1685 }],1686 true, `Unable to mint fungible tokens for ${label}`,1687 );1688 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1689 }16901691 /**1692 * Mint multiple Fungible tokens with one owner1693 * @param signer keyring of signer1694 * @param collectionId ID of collection1695 * @param owner tokens owner1696 * @param tokens array of tokens with properties and pieces1697 * @param label 1698 * @returns ```true``` if extrinsic success, otherwise ```false``` 1699 */1700 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string): Promise<boolean> {1701 if(typeof label === 'undefined') label = `collection #${collectionId}`;1702 const rawTokens = [];1703 for (const token of tokens) {1704 const raw = {Fungible: {Value: token.value}};1705 rawTokens.push(raw);1706 }1707 const creationResult = await this.helper.executeExtrinsic(1708 signer,1709 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1710 true, `Unable to mint RFT tokens for ${label}`,1711 );1712 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1713 }17141715 /**1716 * Get the top 10 owners with the largest balance for the Fungible collection 1717 * @param collectionId ID of collection1718 * @example getTop10Owners(10);1719 * @returns array of ```ICrossAccountId```1720 */1721 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1722 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1723 }17241725 /**1726 * Get account balance1727 * @param collectionId ID of collection1728 * @param addressObj address of owner1729 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1730 * @returns amount of fungible tokens owned by address1731 */1732 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1733 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1734 }17351736 /**1737 * Transfer tokens to address1738 * @param signer keyring of signer1739 * @param collectionId ID of collection1740 * @param toAddressObj address recepient1741 * @param amount amount of tokens to be sent1742 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1743 * @returns ```true``` if extrinsic success, otherwise ```false``` 1744 */1745 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount: bigint) {1746 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1747 }17481749 /**1750 * Transfer some tokens on behalf of the owner.1751 * @param signer keyring of signer1752 * @param collectionId ID of collection1753 * @param fromAddressObj address on behalf of which tokens will be sent1754 * @param toAddressObj address where token to be sent1755 * @param amount number of tokens to be sent1756 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1757 * @returns ```true``` if extrinsic success, otherwise ```false``` 1758 */1759 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {1760 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1761 }17621763 /**1764 * Destroy some amount of tokens1765 * @param signer keyring of signer1766 * @param collectionId ID of collection1767 * @param amount amount of tokens to be destroyed1768 * @param label 1769 * @example burnTokens(aliceKeyring, 10, 1000n);1770 * @returns ```true``` if extrinsic success, otherwise ```false``` 1771 */1772 async burnTokens(signer: IKeyringPair, collectionId: number, amount=100n, label?: string): Promise<boolean> {1773 return (await super.burnToken(signer, collectionId, 0, label, 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 * @param label 1783 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1784 * @returns ```true``` if extrinsic success, otherwise ```false``` 1785 */1786 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=100n, label?: string): Promise<boolean> {1787 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, label, amount);1788 }17891790 /**1791 * Get total collection supply1792 * @param collectionId 1793 * @returns 1794 */1795 async getTotalPieces(collectionId: number): Promise<bigint> {1796 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1797 }17981799 /**1800 * Set, change, or remove approved address to transfer tokens.1801 * 1802 * @param signer keyring of signer1803 * @param collectionId ID of collection1804 * @param toAddressObj address to be approved1805 * @param amount amount of tokens to be approved1806 * @param label 1807 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1808 * @returns ```true``` if extrinsic success, otherwise ```false``` 1809 */1810 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {1811 return super.approveToken(signer, collectionId, 0, toAddressObj, label, amount);1812 }18131814 /**1815 * Get amount of fungible tokens approved to transfer1816 * @param collectionId ID of collection1817 * @param fromAddressObj owner of tokens1818 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1819 * @returns number of tokens approved for the transfer1820 */1821 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1822 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1823 }1824}182518261827class ChainGroup extends HelperGroup {1828 /**1829 * Get system properties of a chain1830 * @example getChainProperties();1831 * @returns ss58Format, token decimals, and token symbol1832 */1833 getChainProperties(): IChainProperties {1834 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1835 return {1836 ss58Format: properties.ss58Format.toJSON(),1837 tokenDecimals: properties.tokenDecimals.toJSON(),1838 tokenSymbol: properties.tokenSymbol.toJSON(),1839 };1840 }18411842 /**1843 * Get chain header1844 * @example getLatestBlockNumber();1845 * @returns the number of the last block1846 */1847 async getLatestBlockNumber(): Promise<number> {1848 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1849 }18501851 /**1852 * Get block hash by block number1853 * @param blockNumber number of block1854 * @example getBlockHashByNumber(12345);1855 * @returns hash of a block1856 */1857 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1858 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1859 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1860 return blockHash;1861 }18621863 // TODO add docs1864 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {1865 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);1866 if (!blockHash) return null;1867 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;1868 }18691870 /**1871 * Get account nonce1872 * @param address substrate address1873 * @example getNonce("5GrwvaEF5zXb26Fz...");1874 * @returns number, account's nonce1875 */1876 async getNonce(address: TSubstrateAccount): Promise<number> {1877 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1878 }1879}188018811882class BalanceGroup extends HelperGroup {1883 /**1884 * Representation of the native token in the smallest unit1885 * @example getOneTokenNominal()1886 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1887 */1888 getOneTokenNominal(): bigint {1889 const chainProperties = this.helper.chain.getChainProperties();1890 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1891 }18921893 /**1894 * Get substrate address balance1895 * @param address substrate address1896 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1897 * @returns amount of tokens on address1898 */1899 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1900 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1901 }19021903 /**1904 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved1905 * @param address substrate address1906 * @returns 1907 */1908 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {1909 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;1910 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};1911 }19121913 /**1914 * Get ethereum address balance1915 * @param address ethereum address1916 * @example getEthereum("0x9F0583DbB855d...")1917 * @returns amount of tokens on address1918 */1919 async getEthereum(address: TEthereumAccount): Promise<bigint> {1920 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1921 }19221923 /**1924 * Transfer tokens to substrate address1925 * @param signer keyring of signer1926 * @param address substrate address of a recepient1927 * @param amount amount of tokens to be transfered1928 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1929 * @returns ```true``` if extrinsic success, otherwise ```false```1930 */1931 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1932 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}`);19331934 let transfer = {from: null, to: null, amount: 0n} as any;1935 result.result.events.forEach(({event: {data, method, section}}) => {1936 if ((section === 'balances') && (method === 'Transfer')) {1937 transfer = {1938 from: this.helper.address.normalizeSubstrate(data[0]),1939 to: this.helper.address.normalizeSubstrate(data[1]),1940 amount: BigInt(data[2]),1941 };1942 }1943 });1944 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1945 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1946 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1947 return isSuccess;1948 }1949}195019511952class AddressGroup extends HelperGroup {1953 /**1954 * Normalizes the address to the specified ss58 format, by default ```42```.1955 * @param address substrate address1956 * @param ss58Format format for address conversion, by default ```42```1957 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1958 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1959 */1960 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1961 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1962 }19631964 /**1965 * Get address in the connected chain format1966 * @param address substrate address1967 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1968 * @returns address in chain format1969 */1970 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1971 const info = this.helper.chain.getChainProperties();1972 return encodeAddress(decodeAddress(address), info.ss58Format);1973 }19741975 /**1976 * Get substrate mirror of an ethereum address1977 * @param ethAddress ethereum address1978 * @param toChainFormat false for normalized account1979 * @example ethToSubstrate('0x9F0583DbB855d...')1980 * @returns substrate mirror of a provided ethereum address1981 */1982 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1983 if(!toChainFormat) return evmToAddress(ethAddress);1984 const info = this.helper.chain.getChainProperties();1985 return evmToAddress(ethAddress, info.ss58Format);1986 }19871988 /**1989 * Get ethereum mirror of a substrate address1990 * @param subAddress substrate account1991 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1992 * @returns ethereum mirror of a provided substrate address1993 */1994 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1995 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1996 }1997}19981999class StakingGroup extends HelperGroup {2000 /**2001 * Stake tokens for App Promotion2002 * @param signer keyring of signer2003 * @param amountToStake amount of tokens to stake2004 * @param label extra label for log2005 * @returns2006 */2007 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2008 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2009 const stakeResult = await this.helper.executeExtrinsic(2010 signer,2011 'api.tx.appPromotion.stake', [amountToStake],2012 true, `stake failed for ${label}`,2013 );2014 // TODO extract info from stakeResult2015 return true;2016 }20172018 /**2019 * Unstake tokens for App Promotion2020 * @param signer keyring of signer2021 * @param amountToUnstake amount of tokens to unstake2022 * @param label extra label for log2023 * @returns 2024 */2025 async unstake(signer: TSigner, label?: string): Promise<boolean> {2026 if(typeof label === 'undefined') label = `${signer.address}`;2027 const unstakeResult = await this.helper.executeExtrinsic(2028 signer,2029 'api.tx.appPromotion.unstake', [],2030 true, `unstake failed for ${label}`,2031 );2032 // TODO extract info from unstakeResult2033 return true;2034 }20352036 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2037 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2038 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2039 }20402041 async getTotalStakingLocked(address: ICrossAccountId): Promise<bigint> {2042 return (await this.helper.callRpc('api.rpc.appPromotion.totalStakingLocked', [address])).toBigInt();2043 }20442045 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<bigint[][]> {2046 return (await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2047 }20482049 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2050 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2051 }2052 2053 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<bigint[][]> {2054 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);2055 }2056}20572058export class UniqueHelper extends ChainHelperBase {2059 chain: ChainGroup;2060 balance: BalanceGroup;2061 address: AddressGroup;2062 collection: CollectionGroup;2063 nft: NFTGroup;2064 rft: RFTGroup;2065 ft: FTGroup;2066 staking: StakingGroup;20672068 constructor(logger?: ILogger) {2069 super(logger);2070 this.chain = new ChainGroup(this);2071 this.balance = new BalanceGroup(this);2072 this.address = new AddressGroup(this);2073 this.collection = new CollectionGroup(this);2074 this.nft = new NFTGroup(this);2075 this.rft = new RFTGroup(this);2076 this.ft = new FTGroup(this);2077 this.staking = new StakingGroup(this);2078 } 2079}208020812082class UniqueCollectionBase {2083 helper: UniqueHelper;2084 collectionId: number;20852086 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2087 this.collectionId = collectionId;2088 this.helper = uniqueHelper;2089 }20902091 async getData() {2092 return await this.helper.collection.getData(this.collectionId);2093 }20942095 async getLastTokenId() {2096 return await this.helper.collection.getLastTokenId(this.collectionId);2097 }20982099 async isTokenExists(tokenId: number) {2100 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2101 }21022103 async getAdmins() {2104 return await this.helper.collection.getAdmins(this.collectionId);2105 }21062107 async getAllowList() {2108 return await this.helper.collection.getAllowList(this.collectionId);2109 }21102111 async getEffectiveLimits() {2112 return await this.helper.collection.getEffectiveLimits(this.collectionId);2113 }21142115 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount, label?: string) {2116 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress, label);2117 }21182119 async confirmSponsorship(signer: TSigner, label?: string) {2120 return await this.helper.collection.confirmSponsorship(signer, this.collectionId, label);2121 }21222123 async setLimits(signer: TSigner, limits: ICollectionLimits, label?: string) {2124 return await this.helper.collection.setLimits(signer, this.collectionId, limits, label);2125 }21262127 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount, label?: string) {2128 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress, label);2129 }21302131 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2132 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj, label);2133 }21342135 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId, label?: string) {2136 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj, label);2137 }21382139 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2140 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj, label);2141 }21422143 async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2144 return await this.helper.collection.setProperties(signer, this.collectionId, properties, label);2145 }21462147 async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2148 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys, label);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, label?: string) {2156 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions, label);2157 }21582159 async enableNesting(signer: TSigner, permissions: INestingPermissions, label?: string) {2160 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions, label);2161 }21622163 async disableNesting(signer: TSigner, label?: string) {2164 return await this.helper.collection.disableNesting(signer, this.collectionId, label);2165 }21662167 async burn(signer: TSigner, label?: string) {2168 return await this.helper.collection.burn(signer, this.collectionId, label);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, label?: string) {2207 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label);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, properties?: IProperty[], label?: string) {2215 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties}, label);2216 }22172218 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string) {2219 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens, label);2220 }22212222 async burnToken(signer: TSigner, tokenId: number, label?: string) {2223 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId, label);2224 }22252226 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2227 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2228 }22292230 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2231 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2232 }22332234 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2235 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2236 }22372238 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken, label?: string) {2239 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj, label);2240 }22412242 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2243 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj, label);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=100n) {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=100n) {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=100n, label?: string) {2278 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label, 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, label?: string) {2286 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount, label);2287 }22882289 async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[], label?: string) {2290 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties}, label);2291 }22922293 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string) {2294 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens, label);2295 }22962297 async burnToken(signer: TSigner, tokenId: number, amount=100n, label?: string) {2298 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, label, amount);2299 }23002301 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2302 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2303 }23042305 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2306 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2307 }23082309 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2310 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2311 }2312}231323142315class UniqueFTCollection extends UniqueCollectionBase {2316 async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint, label?: string) {2317 return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount, label);2318 }23192320 async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string) {2321 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens, label);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: bigint) {2333 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2334 }23352336 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {2337 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2338 }23392340 async burnTokens(signer: TSigner, amount: bigint, label?: string) {2341 return await this.helper.ft.burnTokens(signer, this.collectionId, amount, label);2342 }23432344 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount: bigint, label?: string) {2345 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount, label);2346 }23472348 async getTotalPieces() {2349 return await this.helper.ft.getTotalPieces(this.collectionId);2350 }23512352 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2353 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount, label);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[], label?: string) {2378 return await this.collection.setTokenProperties(signer, this.tokenId, properties, label);2379 }23802381 async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2382 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys, label);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, label?: string) {2412 return await this.collection.nestToken(signer, this.tokenId, toTokenObj, label);2413 }24142415 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2416 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj, label);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, label?: string) {2428 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, label);2429 }24302431 async isApproved(toAddressObj: ICrossAccountId) {2432 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2433 }24342435 async burn(signer: TSigner, label?: string) {2436 return await this.collection.burnToken(signer, this.tokenId, label);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=100n) {2461 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2462 }24632464 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2465 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2466 }24672468 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2469 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount, label);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, label?: string) {2477 return await this.collection.repartitionToken(signer, this.tokenId, amount, label);2478 }24792480 async burn(signer: TSigner, amount=100n, label?: string) {2481 return await this.collection.burnToken(signer, this.tokenId, amount, label);2482 }2483}