difftreelog
Merge pull request #620 from UniqueNetwork/test/burnItemPlaygrounds
in: master
Move burnItemTests to playgrounds
5 files changed
tests/src/app-promotion.test.tsdiffbeforeafterboth--- a/tests/src/app-promotion.test.ts
+++ b/tests/src/app-promotion.test.ts
@@ -34,7 +34,10 @@
let accounts: IKeyringPair[] = [];
const LOCKING_PERIOD = 20n; // 20 blocks of relay
const UNLOCKING_PERIOD = 10n; // 10 blocks of parachain
-const rewardAvailableInBlock = (stakedInBlock: bigint) => (stakedInBlock - stakedInBlock % LOCKING_PERIOD) + (LOCKING_PERIOD * 2n);
+const rewardAvailableInBlock = (stakedInBlock: bigint) => {
+ if (stakedInBlock % LOCKING_PERIOD === 0n) return stakedInBlock + 20n;
+ return (stakedInBlock - stakedInBlock % LOCKING_PERIOD) + (LOCKING_PERIOD * 2n);
+};
describe('App promotion', () => {
before(async function () {
tests/src/burnItem.test.tsdiffbeforeafterboth--- a/tests/src/burnItem.test.ts
+++ b/tests/src/burnItem.test.ts
@@ -14,289 +14,145 @@
// You should have received a copy of the GNU General Public License
// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
-import {default as usingApi, submitTransactionAsync, submitTransactionExpectFailAsync} from './substrate/substrate-api';
import {IKeyringPair} from '@polkadot/types/types';
-import {
- createCollectionExpectSuccess,
- createItemExpectSuccess,
- getGenericResult,
- normalizeAccountId,
- addCollectionAdminExpectSuccess,
- getBalance,
- setCollectionLimitsExpectSuccess,
- isTokenExists,
- requirePallets,
- Pallets,
-} from './util/helpers';
+import {expect, itSub, Pallets, usingPlaygrounds} from './util/playgrounds';
-import chai from 'chai';
-import chaiAsPromised from 'chai-as-promised';
-chai.use(chaiAsPromised);
-const expect = chai.expect;
-let alice: IKeyringPair;
-let bob: IKeyringPair;
+describe('integration test: ext. burnItem():', () => {
+ let donor: IKeyringPair;
+ let alice: IKeyringPair;
+ let bob: IKeyringPair;
-describe('integration test: ext. burnItem():', () => {
before(async () => {
- await usingApi(async (api, privateKeyWrapper) => {
- alice = privateKeyWrapper('//Alice');
- bob = privateKeyWrapper('//Bob');
+ await usingPlaygrounds(async (helper, privateKey) => {
+ donor = privateKey('//Alice');
+ [alice, bob] = await helper.arrange.createAccounts([100n, 100n], donor);
});
});
-
- it('Burn item in NFT collection', async () => {
- const createMode = 'NFT';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);
- await usingApi(async (api) => {
- const tx = api.tx.unique.burnItem(collectionId, tokenId, 1);
- const events = await submitTransactionAsync(alice, tx);
- const result = getGenericResult(events);
+ itSub('Burn item in NFT collection', async ({helper}) => {
+ const collection = await helper.nft.mintCollection(alice);
+ const token = await collection.mintToken(alice);
- expect(result.success).to.be.true;
- // Get the item
- expect(await isTokenExists(api, collectionId, tokenId)).to.be.false;
- });
+ await token.burn(alice);
+ expect(await token.doesExist()).to.be.false;
});
-
- it('Burn item in Fungible collection', async () => {
- const createMode = 'Fungible';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode, decimalPoints: 0}});
- await createItemExpectSuccess(alice, collectionId, createMode); // Helper creates 10 fungible tokens
- const tokenId = 0; // ignored
- await usingApi(async (api) => {
- // Destroy 1 of 10
- const tx = api.tx.unique.burnItem(collectionId, tokenId, 1);
- const events = await submitTransactionAsync(alice, tx);
- const result = getGenericResult(events);
-
- // Get alice balance
- const balance = await getBalance(api, collectionId, alice.address, 0);
+ itSub('Burn item in Fungible collection', async ({helper}) => {
+ const collection = await helper.ft.mintCollection(alice, {}, 10);
+ await collection.mint(alice, 10n);
- // What to expect
- expect(result.success).to.be.true;
- expect(balance).to.be.equal(9n);
- });
+ await collection.burnTokens(alice, 1n);
+ expect(await collection.getBalance({Substrate: alice.address})).to.eq(9n);
});
- it('Burn item in ReFungible collection', async function() {
- await requirePallets(this, [Pallets.ReFungible]);
+ itSub.ifWithPallets('Burn item in ReFungible collection', [Pallets.ReFungible], async function({helper}) {
+ const collection = await helper.rft.mintCollection(alice);
+ const token = await collection.mintToken(alice, 100n);
- const createMode = 'ReFungible';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);
+ await token.burn(alice, 90n);
+ expect(await token.getBalance({Substrate: alice.address})).to.eq(10n);
- await usingApi(async (api) => {
- const tx = api.tx.unique.burnItem(collectionId, tokenId, 100);
- const events = await submitTransactionAsync(alice, tx);
- const result = getGenericResult(events);
-
- // Get alice balance
- const balance = await getBalance(api, collectionId, alice.address, tokenId);
-
- // What to expect
- expect(result.success).to.be.true;
- expect(balance).to.be.equal(0n);
- });
+ await token.burn(alice, 10n);
+ expect(await token.getBalance({Substrate: alice.address})).to.eq(0n);
});
- it('Burn owned portion of item in ReFungible collection', async function() {
- await requirePallets(this, [Pallets.ReFungible]);
-
- const createMode = 'ReFungible';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);
-
- await usingApi(async (api) => {
- // Transfer 1/100 of the token to Bob
- const transfertx = api.tx.unique.transfer(normalizeAccountId(bob.address), collectionId, tokenId, 1);
- const events1 = await submitTransactionAsync(alice, transfertx);
- const result1 = getGenericResult(events1);
-
- // Get balances
- const bobBalanceBefore = await getBalance(api, collectionId, bob.address, tokenId);
- const aliceBalanceBefore = await getBalance(api, collectionId, alice.address, tokenId);
-
- // Bob burns his portion
- const tx = api.tx.unique.burnItem(collectionId, tokenId, 1);
- const events2 = await submitTransactionAsync(bob, tx);
- const result2 = getGenericResult(events2);
+ itSub.ifWithPallets('Burn owned portion of item in ReFungible collection', [Pallets.ReFungible], async function({helper}) {
+ const collection = await helper.rft.mintCollection(alice);
+ const token = await collection.mintToken(alice, 100n);
- // Get balances
- const bobBalanceAfter = await getBalance(api, collectionId, bob.address, tokenId);
- const aliceBalanceAfter = await getBalance(api, collectionId, alice.address, tokenId);
- // console.log(balance);
+ await token.transfer(alice, {Substrate: bob.address}, 1n);
- // What to expect before burning
- expect(result1.success).to.be.true;
- expect(aliceBalanceBefore).to.be.equal(99n);
- expect(bobBalanceBefore).to.be.equal(1n);
+ expect(await token.getBalance({Substrate: alice.address})).to.eq(99n);
+ expect(await token.getBalance({Substrate: bob.address})).to.eq(1n);
- // What to expect after burning
- expect(result2.success).to.be.true;
- expect(aliceBalanceAfter).to.be.equal(99n);
- expect(bobBalanceAfter).to.be.equal(0n);
- });
+ await token.burn(bob, 1n);
+ expect(await token.getBalance({Substrate: alice.address})).to.eq(99n);
+ expect(await token.getBalance({Substrate: bob.address})).to.eq(0n);
});
-
});
describe('integration test: ext. burnItem() with admin permissions:', () => {
+ let donor: IKeyringPair;
+ let alice: IKeyringPair;
+ let bob: IKeyringPair;
+
before(async () => {
- await usingApi(async (api, privateKeyWrapper) => {
- alice = privateKeyWrapper('//Alice');
- bob = privateKeyWrapper('//Bob');
+ await usingPlaygrounds(async (helper, privateKey) => {
+ donor = privateKey('//Alice');
+ [alice, bob] = await helper.arrange.createAccounts([100n, 100n], donor);
});
});
- it('Burn item in NFT collection', async () => {
- const createMode = 'NFT';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- await setCollectionLimitsExpectSuccess(alice, collectionId, {ownerCanTransfer: true});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);
- await addCollectionAdminExpectSuccess(alice, collectionId, bob.address);
+ itSub('Burn item in NFT collection', async ({helper}) => {
+ const collection = await helper.nft.mintCollection(alice);
+ await collection.setLimits(alice, {ownerCanTransfer: true});
+ await collection.addAdmin(alice, {Substrate: bob.address});
+ const token = await collection.mintToken(alice);
- await usingApi(async (api) => {
- const tx = api.tx.unique.burnFrom(collectionId, {Substrate: alice.address}, tokenId, 1);
- const events = await submitTransactionAsync(bob, tx);
- const result = getGenericResult(events);
-
- expect(result.success).to.be.true;
- // Get the item
- expect(await isTokenExists(api, collectionId, tokenId)).to.be.false;
- });
+ await token.burnFrom(bob, {Substrate: alice.address});
+ expect(await token.doesExist()).to.be.false;
});
- // TODO: burnFrom
- it('Burn item in Fungible collection', async () => {
- const createMode = 'Fungible';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode, decimalPoints: 0}});
- await setCollectionLimitsExpectSuccess(alice, collectionId, {ownerCanTransfer: true});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode); // Helper creates 10 fungible tokens
- await addCollectionAdminExpectSuccess(alice, collectionId, bob.address);
+ itSub('Burn item in Fungible collection', async ({helper}) => {
+ const collection = await helper.ft.mintCollection(alice, {}, 0);
+ await collection.setLimits(alice, {ownerCanTransfer: true});
+ await collection.addAdmin(alice, {Substrate: bob.address});
+ await collection.mint(alice, 10n);
- await usingApi(async (api) => {
- // Destroy 1 of 10
- const tx = api.tx.unique.burnFrom(collectionId, normalizeAccountId(alice.address), tokenId, 1);
- const events = await submitTransactionAsync(bob, tx);
- const result = getGenericResult(events);
-
- // Get alice balance
- const balance = await getBalance(api, collectionId, alice.address, 0);
-
- // What to expect
- expect(result.success).to.be.true;
- expect(balance).to.be.equal(9n);
- });
+ await collection.burnTokensFrom(bob, {Substrate: alice.address}, 1n);
+ expect(await collection.getBalance({Substrate: alice.address})).to.eq(9n);
});
- // TODO: burnFrom
- it('Burn item in ReFungible collection', async function() {
- await requirePallets(this, [Pallets.ReFungible]);
-
- const createMode = 'ReFungible';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- await setCollectionLimitsExpectSuccess(alice, collectionId, {ownerCanTransfer: true});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);
- await addCollectionAdminExpectSuccess(alice, collectionId, bob.address);
+ itSub.ifWithPallets('Burn item in ReFungible collection', [Pallets.ReFungible], async function({helper}) {
+ const collection = await helper.rft.mintCollection(alice);
+ await collection.setLimits(alice, {ownerCanTransfer: true});
+ await collection.addAdmin(alice, {Substrate: bob.address});
+ const token = await collection.mintToken(alice, 100n);
- await usingApi(async (api) => {
- const tx = api.tx.unique.burnFrom(collectionId, normalizeAccountId(alice.address), tokenId, 100);
- const events = await submitTransactionAsync(bob, tx);
- const result = getGenericResult(events);
- // Get alice balance
- expect(result.success).to.be.true;
- // Get the item
- expect(await isTokenExists(api, collectionId, tokenId)).to.be.false;
- });
+ await token.burnFrom(bob, {Substrate: alice.address}, 100n);
+ expect(await token.doesExist()).to.be.false;
});
});
describe('Negative integration test: ext. burnItem():', () => {
+ let donor: IKeyringPair;
+ let alice: IKeyringPair;
+ let bob: IKeyringPair;
+
before(async () => {
- await usingApi(async (api, privateKeyWrapper) => {
- alice = privateKeyWrapper('//Alice');
- bob = privateKeyWrapper('//Bob');
+ await usingPlaygrounds(async (helper, privateKey) => {
+ donor = privateKey('//Alice');
+ [alice, bob] = await helper.arrange.createAccounts([100n, 100n], donor);
});
});
- it('Burn a token that was never created', async () => {
- const createMode = 'NFT';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- const tokenId = 10;
-
- await usingApi(async (api) => {
- const tx = api.tx.unique.burnItem(collectionId, tokenId, 1);
- const badTransaction = async function () {
- await submitTransactionExpectFailAsync(alice, tx);
- };
- await expect(badTransaction()).to.be.rejected;
- });
-
+ itSub('Burn a token that was never created', async ({helper}) => {
+ const collection = await helper.nft.mintCollection(alice);
+ await expect(collection.burnToken(alice, 10)).to.be.rejectedWith('common.TokenNotFound');
});
- it('Burn a token using the address that does not own it', async () => {
- const createMode = 'NFT';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);
+ itSub('Burn a token using the address that does not own it', async ({helper}) => {
+ const collection = await helper.nft.mintCollection(alice);
+ const token = await collection.mintToken(alice);
- await usingApi(async (api) => {
- const tx = api.tx.unique.burnItem(collectionId, tokenId, 1);
- const badTransaction = async function () {
- await submitTransactionExpectFailAsync(bob, tx);
- };
- await expect(badTransaction()).to.be.rejected;
- });
-
+ await expect(token.burn(bob)).to.be.rejectedWith('common.NoPermission');
});
-
- it('Transfer a burned a token', async () => {
- const createMode = 'NFT';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
- const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);
-
- await usingApi(async (api) => {
- const burntx = api.tx.unique.burnItem(collectionId, tokenId, 1);
- const events1 = await submitTransactionAsync(alice, burntx);
- const result1 = getGenericResult(events1);
- expect(result1.success).to.be.true;
+ itSub('Transfer a burned token', async ({helper}) => {
+ const collection = await helper.nft.mintCollection(alice);
+ const token = await collection.mintToken(alice);
+ await token.burn(alice);
- const tx = api.tx.unique.transfer(normalizeAccountId(bob.address), collectionId, tokenId, 1);
- const badTransaction = async function () {
- await submitTransactionExpectFailAsync(alice, tx);
- };
- await expect(badTransaction()).to.be.rejected;
- });
-
+ await expect(token.transfer(alice, {Substrate: bob.address})).to.be.rejectedWith('common.TokenNotFound');
});
-
- it('Burn more than owned in Fungible collection', async () => {
- const createMode = 'Fungible';
- const collectionId = await createCollectionExpectSuccess({mode: {type: createMode, decimalPoints: 0}});
- // Helper creates 10 fungible tokens
- await createItemExpectSuccess(alice, collectionId, createMode);
- const tokenId = 0; // ignored
- await usingApi(async (api) => {
- // Destroy 11 of 10
- const tx = api.tx.unique.burnItem(collectionId, tokenId, 11);
- const badTransaction = async function () {
- await submitTransactionExpectFailAsync(alice, tx);
- };
- await expect(badTransaction()).to.be.rejected;
-
- // Get alice balance
- const balance = await getBalance(api, collectionId, alice.address, 0);
-
- // What to expect
- expect(balance).to.be.equal(10n);
- });
+ itSub('Burn more than owned in Fungible collection', async ({helper}) => {
+ const collection = await helper.ft.mintCollection(alice, {}, 0);
+ await collection.mint(alice, 10n);
+ await expect(collection.burnTokens(alice, 11n)).to.be.rejectedWith('common.TokenValueTooLow');
+ expect(await collection.getBalance({Substrate: alice.address})).to.eq(10n);
});
-
});
tests/src/fungible.test.tsdiffbeforeafterboth--- a/tests/src/fungible.test.ts
+++ b/tests/src/fungible.test.ts
@@ -101,10 +101,10 @@
const collection = await helper.ft.mintCollection(alice, {name: 'test', description: 'test', tokenPrefix: 'test'});
await collection.mint(alice, 500n);
- expect(await collection.isTokenExists(0)).to.be.true;
+ expect(await collection.doesTokenExist(0)).to.be.true;
expect(await collection.getBalance({Substrate: alice.address})).to.be.equal(500n);
expect(await collection.burnTokens(alice, 499n)).to.be.true;
- expect(await collection.isTokenExists(0)).to.be.true;
+ expect(await collection.doesTokenExist(0)).to.be.true;
expect(await collection.getBalance({Substrate: alice.address})).to.be.equal(1n);
});
@@ -112,9 +112,9 @@
const collection = await helper.ft.mintCollection(alice, {name: 'test', description: 'test', tokenPrefix: 'test'});
await collection.mint(alice, 500n);
- expect(await collection.isTokenExists(0)).to.be.true;
+ expect(await collection.doesTokenExist(0)).to.be.true;
expect(await collection.burnTokens(alice, 500n)).to.be.true;
- expect(await collection.isTokenExists(0)).to.be.true;
+ expect(await collection.doesTokenExist(0)).to.be.true;
expect(await collection.getBalance({Substrate: alice.address})).to.be.equal(0n);
expect(await collection.getTotalPieces()).to.be.equal(0n);
tests/src/refungible.test.tsdiffbeforeafterboth--- a/tests/src/refungible.test.ts
+++ b/tests/src/refungible.test.ts
@@ -122,10 +122,10 @@
itSub('Burn some pieces', async ({helper}) => {
const collection = await helper.rft.mintCollection(alice, {name: 'test', description: 'test', tokenPrefix: 'test'});
const token = await collection.mintToken(alice, 100n);
- expect(await collection.isTokenExists(token.tokenId)).to.be.true;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.true;
expect(await token.getBalance({Substrate: alice.address})).to.be.equal(100n);
expect(await token.burn(alice, 99n)).to.be.true;
- expect(await collection.isTokenExists(token.tokenId)).to.be.true;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.true;
expect(await token.getBalance({Substrate: alice.address})).to.be.equal(1n);
});
@@ -133,18 +133,18 @@
const collection = await helper.rft.mintCollection(alice, {name: 'test', description: 'test', tokenPrefix: 'test'});
const token = await collection.mintToken(alice, 100n);
- expect(await collection.isTokenExists(token.tokenId)).to.be.true;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.true;
expect(await token.getBalance({Substrate: alice.address})).to.be.equal(100n);
expect(await token.burn(alice, 100n)).to.be.true;
- expect(await collection.isTokenExists(token.tokenId)).to.be.false;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.false;
});
itSub('Burn some pieces for multiple users', async ({helper}) => {
const collection = await helper.rft.mintCollection(alice, {name: 'test', description: 'test', tokenPrefix: 'test'});
const token = await collection.mintToken(alice, 100n);
- expect(await collection.isTokenExists(token.tokenId)).to.be.true;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.true;
expect(await token.getBalance({Substrate: alice.address})).to.be.equal(100n);
expect(await token.transfer(alice, {Substrate: bob.address}, 60n)).to.be.true;
@@ -154,17 +154,17 @@
expect(await token.burn(alice, 40n)).to.be.true;
- expect(await collection.isTokenExists(token.tokenId)).to.be.true;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.true;
expect(await token.getBalance({Substrate: alice.address})).to.be.equal(0n);
expect(await token.burn(bob, 59n)).to.be.true;
expect(await token.getBalance({Substrate: bob.address})).to.be.equal(1n);
- expect(await collection.isTokenExists(token.tokenId)).to.be.true;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.true;
expect(await token.burn(bob, 1n)).to.be.true;
- expect(await collection.isTokenExists(token.tokenId)).to.be.false;
+ expect(await collection.doesTokenExist(token.tokenId)).to.be.false;
});
itSub('Set allowance for token', async ({helper}) => {
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, SignerOptions} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IStakingInfo, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314export class CrossAccountId implements ICrossAccountId {15 Substrate?: TSubstrateAccount;16 Ethereum?: TEthereumAccount;1718 constructor(account: ICrossAccountId) {19 if (account.Substrate) this.Substrate = account.Substrate;20 if (account.Ethereum) this.Ethereum = account.Ethereum;21 }2223 static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {24 switch (domain) {25 case 'Substrate': return new CrossAccountId({Substrate: account.address});26 case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();27 }28 }2930 static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {31 return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});32 }3334 static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {35 return encodeAddress(decodeAddress(address), ss58Format);36 }3738 static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {39 return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});40 }41 42 withNormalizedSubstrate(ss58Format = 42): CrossAccountId {43 if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);44 return this;45 }4647 static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {48 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));49 }5051 toEthereum(): CrossAccountId {52 if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});53 return this;54 }5556 static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {57 return evmToAddress(address, ss58Format);58 }5960 toSubstrate(ss58Format?: number): CrossAccountId {61 if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});62 return this;63 }64 65 toLowerCase(): CrossAccountId {66 if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();67 if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();68 return this;69 }70}7172const nesting = {73 toChecksumAddress(address: string): string {74 if (typeof address === 'undefined') return '';7576 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);7778 address = address.toLowerCase().replace(/^0x/i,'');79 const addressHash = keccakAsHex(address).replace(/^0x/i,'');80 const checksumAddress = ['0x'];8182 for (let i = 0; i < address.length; i++) {83 // If ith character is 8 to f then make it uppercase84 if (parseInt(addressHash[i], 16) > 7) {85 checksumAddress.push(address[i].toUpperCase());86 } else {87 checksumAddress.push(address[i]);88 }89 }90 return checksumAddress.join('');91 },92 tokenIdToAddress(collectionId: number, tokenId: number) {93 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);94 },95};9697class UniqueUtil {98 static transactionStatus = {99 NOT_READY: 'NotReady',100 FAIL: 'Fail',101 SUCCESS: 'Success',102 };103104 static chainLogType = {105 EXTRINSIC: 'extrinsic',106 RPC: 'rpc',107 };108109 static getTokenAccount(token: IToken): CrossAccountId {110 return new CrossAccountId({Ethereum: this.getTokenAddress(token)});111 }112113 static getTokenAddress(token: IToken): string {114 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);115 }116117 static getDefaultLogger(): ILogger {118 return {119 log(msg: any, level = 'INFO') {120 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));121 },122 level: {123 ERROR: 'ERROR',124 WARNING: 'WARNING',125 INFO: 'INFO',126 },127 };128 }129130 static vec2str(arr: string[] | number[]) {131 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');132 }133134 static str2vec(string: string) {135 if (typeof string !== 'string') return string;136 return Array.from(string).map(x => x.charCodeAt(0));137 }138139 static fromSeed(seed: string, ss58Format = 42) {140 const keyring = new Keyring({type: 'sr25519', ss58Format});141 return keyring.addFromUri(seed);142 }143144 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {145 if (creationResult.status !== this.transactionStatus.SUCCESS) {146 throw Error('Unable to create collection!');147 }148149 let collectionId = null;150 creationResult.result.events.forEach(({event: {data, method, section}}) => {151 if ((section === 'common') && (method === 'CollectionCreated')) {152 collectionId = parseInt(data[0].toString(), 10);153 }154 });155156 if (collectionId === null) {157 throw Error('No CollectionCreated event was found!');158 }159160 return collectionId;161 }162163 static extractTokensFromCreationResult(creationResult: ITransactionResult): {164 success: boolean, 165 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],166 } {167 if (creationResult.status !== this.transactionStatus.SUCCESS) {168 throw Error('Unable to create tokens!');169 }170 let success = false;171 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];172 creationResult.result.events.forEach(({event: {data, method, section}}) => {173 if (method === 'ExtrinsicSuccess') {174 success = true;175 } else if ((section === 'common') && (method === 'ItemCreated')) {176 tokens.push({177 collectionId: parseInt(data[0].toString(), 10),178 tokenId: parseInt(data[1].toString(), 10),179 owner: data[2].toHuman(),180 amount: data[3].toBigInt(),181 });182 }183 });184 return {success, tokens};185 }186187 static extractTokensFromBurnResult(burnResult: ITransactionResult): {188 success: boolean, 189 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],190 } {191 if (burnResult.status !== this.transactionStatus.SUCCESS) {192 throw Error('Unable to burn tokens!');193 }194 let success = false;195 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];196 burnResult.result.events.forEach(({event: {data, method, section}}) => {197 if (method === 'ExtrinsicSuccess') {198 success = true;199 } else if ((section === 'common') && (method === 'ItemDestroyed')) {200 tokens.push({201 collectionId: parseInt(data[0].toString(), 10),202 tokenId: parseInt(data[1].toString(), 10),203 owner: data[2].toHuman(),204 amount: data[3].toBigInt(),205 });206 }207 });208 return {success, tokens};209 }210211 static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {212 let eventId = null;213 events.forEach(({event: {data, method, section}}) => {214 if ((section === expectedSection) && (method === expectedMethod)) {215 eventId = parseInt(data[0].toString(), 10);216 }217 });218219 if (eventId === null) {220 throw Error(`No ${expectedMethod} event was found!`);221 }222 return eventId === collectionId;223 }224225 static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {226 const normalizeAddress = (address: string | ICrossAccountId) => {227 if(typeof address === 'string') return address;228 const obj = {} as any;229 Object.keys(address).forEach(k => {230 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];231 });232 if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);233 if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();234 return address;235 };236 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;237 events.forEach(({event: {data, method, section}}) => {238 if ((section === 'common') && (method === 'Transfer')) {239 const hData = (data as any).toJSON();240 transfer = {241 collectionId: hData[0],242 tokenId: hData[1],243 from: normalizeAddress(hData[2]),244 to: normalizeAddress(hData[3]),245 amount: BigInt(hData[4]),246 };247 }248 });249 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;250 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);251 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);252 isSuccess = isSuccess && amount === transfer.amount;253 return isSuccess;254 }255}256257class UniqueEventHelper {258 private static extractIndex(index: any): [number, number] | string {259 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];260 return index.toJSON();261 }262263 private static extractSub(data: any, subTypes: any): {[key: string]: any} {264 let obj: any = {};265 let index = 0;266267 if (data.entries) {268 for(const [key, value] of data.entries()) {269 obj[key] = this.extractData(value, subTypes[index]);270 index++;271 }272 } else obj = data.toJSON();273274 return obj;275 }276 277 private static extractData(data: any, type: any): any {278 if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();279 if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();280 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);281 return data.toHuman();282 }283284 public static extractEvents(records: ITransactionResult): IEvent[] {285 const parsedEvents: IEvent[] = [];286287 records.result.events.forEach((record) => {288 const {event, phase} = record;289 const types = (event as any).typeDef;290291 const eventData: IEvent = {292 section: event.section.toString(),293 method: event.method.toString(),294 index: this.extractIndex(event.index),295 data: [],296 phase: phase.toJSON(),297 };298299 event.data.forEach((val: any, index: number) => {300 eventData.data.push(this.extractData(val, types[index]));301 });302303 parsedEvents.push(eventData);304 });305306 return parsedEvents;307 }308}309310class ChainHelperBase {311 transactionStatus = UniqueUtil.transactionStatus;312 chainLogType = UniqueUtil.chainLogType;313 util: typeof UniqueUtil;314 eventHelper: typeof UniqueEventHelper;315 logger: ILogger;316 api: ApiPromise | null;317 forcedNetwork: TUniqueNetworks | null;318 network: TUniqueNetworks | null;319 chainLog: IUniqueHelperLog[];320321 constructor(logger?: ILogger) {322 this.util = UniqueUtil;323 this.eventHelper = UniqueEventHelper;324 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();325 this.logger = logger;326 this.api = null;327 this.forcedNetwork = null;328 this.network = null;329 this.chainLog = [];330 }331332 clearChainLog(): void {333 this.chainLog = [];334 }335336 forceNetwork(value: TUniqueNetworks): void {337 this.forcedNetwork = value;338 }339340 async connect(wsEndpoint: string, listeners?: IApiListeners) {341 if (this.api !== null) throw Error('Already connected');342 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);343 this.api = api;344 this.network = network;345 }346347 async disconnect() {348 if (this.api === null) return;349 await this.api.disconnect();350 this.api = null;351 this.network = null;352 }353354 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {355 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;356 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;357 return 'opal';358 }359360 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {361 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});362 await api.isReady;363364 const network = await this.detectNetwork(api);365366 await api.disconnect();367368 return network;369 }370371 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{372 api: ApiPromise;373 network: TUniqueNetworks;374 }> {375 if(typeof network === 'undefined' || network === null) network = 'opal';376 const supportedRPC = {377 opal: {378 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,379 },380 quartz: {381 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,382 },383 unique: {384 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,385 },386 };387 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);388 const rpc = supportedRPC[network];389390 // TODO: investigate how to replace rpc in runtime391 // api._rpcCore.addUserInterfaces(rpc);392393 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});394395 await api.isReadyOrError;396397 if (typeof listeners === 'undefined') listeners = {};398 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {399 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;400 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);401 }402403 return {api, network};404 }405406 getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {407 const {events, status} = data;408 if (status.isReady) {409 return this.transactionStatus.NOT_READY;410 }411 if (status.isBroadcast) {412 return this.transactionStatus.NOT_READY;413 }414 if (status.isInBlock || status.isFinalized) {415 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');416 if (errors.length > 0) {417 return this.transactionStatus.FAIL;418 }419 if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {420 return this.transactionStatus.SUCCESS;421 }422 }423424 return this.transactionStatus.FAIL;425 }426427 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {428 const sign = (callback: any) => {429 if(options !== null) return transaction.signAndSend(sender, options, callback);430 return transaction.signAndSend(sender, callback);431 };432 // eslint-disable-next-line no-async-promise-executor433 return new Promise(async (resolve, reject) => {434 try {435 const unsub = await sign((result: any) => {436 const status = this.getTransactionStatus(result);437438 if (status === this.transactionStatus.SUCCESS) {439 this.logger.log(`${label} successful`);440 unsub();441 resolve({result, status});442 } else if (status === this.transactionStatus.FAIL) {443 let moduleError = null;444445 if (result.hasOwnProperty('dispatchError')) {446 const dispatchError = result['dispatchError'];447448 if (dispatchError) {449 if (dispatchError.isModule) {450 const modErr = dispatchError.asModule;451 const errorMeta = dispatchError.registry.findMetaError(modErr);452453 moduleError = `${errorMeta.section}.${errorMeta.name}`;454 } else {455 moduleError = dispatchError.toHuman();456 }457 } else {458 this.logger.log(result, this.logger.level.ERROR);459 }460 }461462 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);463 unsub();464 reject({status, moduleError, result});465 }466 });467 } catch (e) {468 this.logger.log(e, this.logger.level.ERROR);469 reject(e);470 }471 });472 }473474 constructApiCall(apiCall: string, params: any[]) {475 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);476 let call = this.api as any;477 for(const part of apiCall.slice(4).split('.')) {478 call = call[part];479 }480 return call(...params);481 }482483 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {484 if(this.api === null) throw Error('API not initialized');485 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);486487 const startTime = (new Date()).getTime();488 let result: ITransactionResult;489 let events: IEvent[] = [];490 try {491 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;492 events = this.eventHelper.extractEvents(result);493 }494 catch(e) {495 if(!(e as object).hasOwnProperty('status')) throw e;496 result = e as ITransactionResult;497 }498499 const endTime = (new Date()).getTime();500501 const log = {502 executedAt: endTime,503 executionTime: endTime - startTime,504 type: this.chainLogType.EXTRINSIC,505 status: result.status,506 call: extrinsic,507 signer: this.getSignerAddress(sender),508 params,509 } as IUniqueHelperLog;510511 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;512 if(events.length > 0) log.events = events;513514 this.chainLog.push(log);515516 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);517 return result;518 }519520 async callRpc(rpc: string, params?: any[]) {521 if(typeof params === 'undefined') params = [];522 if(this.api === null) throw Error('API not initialized');523 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);524525 const startTime = (new Date()).getTime();526 let result;527 let error = null;528 const log = {529 type: this.chainLogType.RPC,530 call: rpc,531 params,532 } as IUniqueHelperLog;533534 try {535 result = await this.constructApiCall(rpc, params);536 }537 catch(e) {538 error = e;539 }540541 const endTime = (new Date()).getTime();542543 log.executedAt = endTime;544 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';545 log.executionTime = endTime - startTime;546547 this.chainLog.push(log);548549 if(error !== null) throw error;550551 return result;552 }553554 getSignerAddress(signer: IKeyringPair | string): string {555 if(typeof signer === 'string') return signer;556 return signer.address;557 }558559 fetchAllPalletNames(): string[] {560 if(this.api === null) throw Error('API not initialized');561 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());562 }563564 fetchMissingPalletNames(requiredPallets: string[]): string[] {565 const palletNames = this.fetchAllPalletNames();566 return requiredPallets.filter(p => !palletNames.includes(p));567 }568}569570571class HelperGroup {572 helper: UniqueHelper;573574 constructor(uniqueHelper: UniqueHelper) {575 this.helper = uniqueHelper;576 }577}578579580class CollectionGroup extends HelperGroup {581 /**582 * Get number of blocks when sponsored transaction is available.583 *584 * @param collectionId ID of collection585 * @param tokenId ID of token586 * @param addressObj address for which the sponsorship is checked587 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});588 * @returns number of blocks or null if sponsorship hasn't been set589 */590 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {591 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();592 }593594 /**595 * Get the number of created collections.596 *597 * @returns number of created collections598 */599 async getTotalCount(): Promise<number> {600 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();601 }602603 /**604 * Get information about the collection with additional data,605 * including the number of tokens it contains, its administrators,606 * the normalized address of the collection's owner, and decoded name and description.607 *608 * @param collectionId ID of collection609 * @example await getData(2)610 * @returns collection information object611 */612 async getData(collectionId: number): Promise<{613 id: number;614 name: string;615 description: string;616 tokensCount: number;617 admins: CrossAccountId[];618 normalizedOwner: TSubstrateAccount;619 raw: any620 } | null> {621 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);622 const humanCollection = collection.toHuman(), collectionData = {623 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],624 raw: humanCollection,625 } as any, jsonCollection = collection.toJSON();626 if (humanCollection === null) return null;627 collectionData.raw.limits = jsonCollection.limits;628 collectionData.raw.permissions = jsonCollection.permissions;629 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);630 for (const key of ['name', 'description']) {631 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);632 }633634 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))635 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)636 : 0;637 collectionData.admins = await this.getAdmins(collectionId);638639 return collectionData;640 }641642 /**643 * Get the addresses of the collection's administrators, optionally normalized.644 *645 * @param collectionId ID of collection646 * @param normalize whether to normalize the addresses to the default ss58 format647 * @example await getAdmins(1)648 * @returns array of administrators649 */650 async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {651 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();652653 return normalize654 ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())655 : admins;656 }657658 /**659 * Get the addresses added to the collection allow-list, optionally normalized.660 * @param collectionId ID of collection661 * @param normalize whether to normalize the addresses to the default ss58 format662 * @example await getAllowList(1)663 * @returns array of allow-listed addresses664 */665 async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {666 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();667 return normalize668 ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())669 : allowListed;670 }671672 /**673 * Get the effective limits of the collection instead of null for default values674 *675 * @param collectionId ID of collection676 * @example await getEffectiveLimits(2)677 * @returns object of collection limits678 */679 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {680 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();681 }682683 /**684 * Burns the collection if the signer has sufficient permissions and collection is empty.685 *686 * @param signer keyring of signer687 * @param collectionId ID of collection688 * @example await helper.collection.burn(aliceKeyring, 3);689 * @returns ```true``` if extrinsic success, otherwise ```false```690 */691 async burn(signer: TSigner, collectionId: number): Promise<boolean> {692 const result = await this.helper.executeExtrinsic(693 signer,694 'api.tx.unique.destroyCollection', [collectionId],695 true,696 );697698 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');699 }700701 /**702 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.703 *704 * @param signer keyring of signer705 * @param collectionId ID of collection706 * @param sponsorAddress Sponsor substrate address707 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")708 * @returns ```true``` if extrinsic success, otherwise ```false```709 */710 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {711 const result = await this.helper.executeExtrinsic(712 signer,713 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],714 true,715 );716717 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');718 }719720 /**721 * Confirms consent to sponsor the collection on behalf of the signer.722 *723 * @param signer keyring of signer724 * @param collectionId ID of collection725 * @example confirmSponsorship(aliceKeyring, 10)726 * @returns ```true``` if extrinsic success, otherwise ```false```727 */728 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {729 const result = await this.helper.executeExtrinsic(730 signer,731 'api.tx.unique.confirmSponsorship', [collectionId],732 true,733 );734735 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');736 }737738 /**739 * Removes the sponsor of a collection, regardless if it consented or not.740 *741 * @param signer keyring of signer742 * @param collectionId ID of collection743 * @example removeSponsor(aliceKeyring, 10)744 * @returns ```true``` if extrinsic success, otherwise ```false```745 */746 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {747 const result = await this.helper.executeExtrinsic(748 signer,749 'api.tx.unique.removeCollectionSponsor', [collectionId],750 true,751 );752753 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');754 }755756 /**757 * Sets the limits of the collection. At least one limit must be specified for a correct call.758 *759 * @param signer keyring of signer760 * @param collectionId ID of collection761 * @param limits collection limits object762 * @example763 * await setLimits(764 * aliceKeyring,765 * 10,766 * {767 * sponsorTransferTimeout: 0,768 * ownerCanDestroy: false769 * }770 * )771 * @returns ```true``` if extrinsic success, otherwise ```false```772 */773 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {774 const result = await this.helper.executeExtrinsic(775 signer,776 'api.tx.unique.setCollectionLimits', [collectionId, limits],777 true,778 );779780 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');781 }782783 /**784 * Changes the owner of the collection to the new Substrate address.785 *786 * @param signer keyring of signer787 * @param collectionId ID of collection788 * @param ownerAddress substrate address of new owner789 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")790 * @returns ```true``` if extrinsic success, otherwise ```false```791 */792 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {793 const result = await this.helper.executeExtrinsic(794 signer,795 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],796 true,797 );798799 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');800 }801802 /**803 * Adds a collection administrator.804 *805 * @param signer keyring of signer806 * @param collectionId ID of collection807 * @param adminAddressObj Administrator address (substrate or ethereum)808 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})809 * @returns ```true``` if extrinsic success, otherwise ```false```810 */811 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {812 const result = await this.helper.executeExtrinsic(813 signer,814 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],815 true,816 );817818 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');819 }820821 /**822 * Removes a collection administrator.823 *824 * @param signer keyring of signer825 * @param collectionId ID of collection826 * @param adminAddressObj Administrator address (substrate or ethereum)827 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})828 * @returns ```true``` if extrinsic success, otherwise ```false```829 */830 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {831 const result = await this.helper.executeExtrinsic(832 signer,833 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],834 true,835 );836837 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');838 }839840 /**841 * Check if user is in allow list.842 * 843 * @param collectionId ID of collection844 * @param user Account to check845 * @example await getAdmins(1)846 * @returns is user in allow list847 */848 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {849 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();850 }851852 /**853 * Adds an address to allow list854 * @param signer keyring of signer855 * @param collectionId ID of collection856 * @param addressObj address to add to the allow list857 * @returns ```true``` if extrinsic success, otherwise ```false```858 */859 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {860 const result = await this.helper.executeExtrinsic(861 signer,862 'api.tx.unique.addToAllowList', [collectionId, addressObj],863 true,864 );865866 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');867 }868869 /**870 * Removes an address from allow list871 *872 * @param signer keyring of signer873 * @param collectionId ID of collection874 * @param addressObj address to remove from the allow list875 * @returns ```true``` if extrinsic success, otherwise ```false```876 */877 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {878 const result = await this.helper.executeExtrinsic(879 signer,880 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],881 true,882 );883884 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');885 }886887 /**888 * Sets onchain permissions for selected collection.889 *890 * @param signer keyring of signer891 * @param collectionId ID of collection892 * @param permissions collection permissions object893 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});894 * @returns ```true``` if extrinsic success, otherwise ```false```895 */896 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {897 const result = await this.helper.executeExtrinsic(898 signer,899 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],900 true,901 );902903 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');904 }905906 /**907 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.908 *909 * @param signer keyring of signer910 * @param collectionId ID of collection911 * @param permissions nesting permissions object912 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});913 * @returns ```true``` if extrinsic success, otherwise ```false```914 */915 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {916 return await this.setPermissions(signer, collectionId, {nesting: permissions});917 }918919 /**920 * Disables nesting for selected collection.921 *922 * @param signer keyring of signer923 * @param collectionId ID of collection924 * @example disableNesting(aliceKeyring, 10);925 * @returns ```true``` if extrinsic success, otherwise ```false```926 */927 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {928 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});929 }930931 /**932 * Sets onchain properties to the collection.933 *934 * @param signer keyring of signer935 * @param collectionId ID of collection936 * @param properties array of property objects937 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);938 * @returns ```true``` if extrinsic success, otherwise ```false```939 */940 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {941 const result = await this.helper.executeExtrinsic(942 signer,943 'api.tx.unique.setCollectionProperties', [collectionId, properties],944 true,945 );946947 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');948 }949950 /**951 * Get collection properties.952 * 953 * @param collectionId ID of collection954 * @param propertyKeys optionally filter the returned properties to only these keys955 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);956 * @returns array of key-value pairs957 */958 async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {959 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();960 }961962 /**963 * Deletes onchain properties from the collection.964 *965 * @param signer keyring of signer966 * @param collectionId ID of collection967 * @param propertyKeys array of property keys to delete968 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);969 * @returns ```true``` if extrinsic success, otherwise ```false```970 */971 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {972 const result = await this.helper.executeExtrinsic(973 signer,974 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],975 true,976 );977978 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');979 }980981 /**982 * Changes the owner of the token.983 *984 * @param signer keyring of signer985 * @param collectionId ID of collection986 * @param tokenId ID of token987 * @param addressObj address of a new owner988 * @param amount amount of tokens to be transfered. For NFT must be set to 1n989 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})990 * @returns true if the token success, otherwise false991 */992 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {993 const result = await this.helper.executeExtrinsic(994 signer,995 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],996 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,997 );998999 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1000 }10011002 /**1003 *1004 * Change ownership of a token(s) on behalf of the owner.1005 *1006 * @param signer keyring of signer1007 * @param collectionId ID of collection1008 * @param tokenId ID of token1009 * @param fromAddressObj address on behalf of which the token will be sent1010 * @param toAddressObj new token owner1011 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1012 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1013 * @returns true if the token success, otherwise false1014 */1015 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1016 const result = await this.helper.executeExtrinsic(1017 signer,1018 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1019 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1020 );1021 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1022 }10231024 /**1025 *1026 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1027 *1028 * @param signer keyring of signer1029 * @param collectionId ID of collection1030 * @param tokenId ID of token1031 * @param amount amount of tokens to be burned. For NFT must be set to 1n1032 * @example burnToken(aliceKeyring, 10, 5);1033 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1034 */1035 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1036 const burnResult = await this.helper.executeExtrinsic(1037 signer,1038 'api.tx.unique.burnItem', [collectionId, tokenId, amount],1039 true, // `Unable to burn token for ${label}`,1040 );1041 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1042 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1043 return burnedTokens.success;1044 }10451046 /**1047 * Destroys a concrete instance of NFT on behalf of the owner1048 *1049 * @param signer keyring of signer1050 * @param collectionId ID of collection1051 * @param tokenId ID of token1052 * @param fromAddressObj address on behalf of which the token will be burnt1053 * @param amount amount of tokens to be burned. For NFT must be set to 1n1054 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1055 * @returns ```true``` if extrinsic success, otherwise ```false```1056 */1057 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1058 const burnResult = await this.helper.executeExtrinsic(1059 signer,1060 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1061 true, // `Unable to burn token from for ${label}`,1062 );1063 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1064 return burnedTokens.success && burnedTokens.tokens.length > 0;1065 }10661067 /**1068 * Set, change, or remove approved address to transfer the ownership of the NFT.1069 *1070 * @param signer keyring of signer1071 * @param collectionId ID of collection1072 * @param tokenId ID of token1073 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1074 * @param amount amount of token to be approved. For NFT must be set to 1n1075 * @returns ```true``` if extrinsic success, otherwise ```false```1076 */1077 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1078 const approveResult = await this.helper.executeExtrinsic(1079 signer,1080 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1081 true, // `Unable to approve token for ${label}`,1082 );10831084 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1085 }10861087 /**1088 * Get the amount of token pieces approved to transfer or burn. Normally 0.1089 *1090 * @param collectionId ID of collection1091 * @param tokenId ID of token1092 * @param toAccountObj address which is approved to use token pieces1093 * @param fromAccountObj address which may have allowed the use of its owned tokens1094 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1095 * @returns number of approved to transfer pieces1096 */1097 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1098 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1099 }11001101 /**1102 * Get the last created token ID in a collection1103 *1104 * @param collectionId ID of collection1105 * @example getLastTokenId(10);1106 * @returns id of the last created token1107 */1108 async getLastTokenId(collectionId: number): Promise<number> {1109 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1110 }11111112 /**1113 * Check if token exists1114 *1115 * @param collectionId ID of collection1116 * @param tokenId ID of token1117 * @example isTokenExists(10, 20);1118 * @returns true if the token exists, otherwise false1119 */1120 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {1121 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1122 }1123}11241125class NFTnRFT extends CollectionGroup {1126 /**1127 * Get tokens owned by account1128 *1129 * @param collectionId ID of collection1130 * @param addressObj tokens owner1131 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1132 * @returns array of token ids owned by account1133 */1134 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1135 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1136 }11371138 /**1139 * Get token data1140 *1141 * @param collectionId ID of collection1142 * @param tokenId ID of token1143 * @param propertyKeys optionally filter the token properties to only these keys1144 * @param blockHashAt optionally query the data at some block with this hash1145 * @example getToken(10, 5);1146 * @returns human readable token data1147 */1148 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1149 properties: IProperty[];1150 owner: CrossAccountId;1151 normalizedOwner: CrossAccountId;1152 }| null> {1153 let tokenData;1154 if(typeof blockHashAt === 'undefined') {1155 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1156 }1157 else {1158 if(propertyKeys.length == 0) {1159 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1160 if(!collection) return null;1161 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1162 }1163 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1164 }1165 tokenData = tokenData.toHuman();1166 if (tokenData === null || tokenData.owner === null) return null;1167 const owner = {} as any;1168 for (const key of Object.keys(tokenData.owner)) {1169 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate' 1170 ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key]) 1171 : tokenData.owner[key];1172 }1173 tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1174 return tokenData;1175 }11761177 /**1178 * Set permissions to change token properties1179 *1180 * @param signer keyring of signer1181 * @param collectionId ID of collection1182 * @param permissions permissions to change a property by the collection admin or token owner1183 * @example setTokenPropertyPermissions(1184 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1185 * )1186 * @returns true if extrinsic success otherwise false1187 */1188 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1189 const result = await this.helper.executeExtrinsic(1190 signer,1191 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1192 true,1193 );11941195 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1196 }11971198 /**1199 * Get token property permissions.1200 * 1201 * @param collectionId ID of collection1202 * @param propertyKeys optionally filter the returned property permissions to only these keys1203 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1204 * @returns array of key-permission pairs1205 */1206 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1207 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1208 }12091210 /**1211 * Set token properties1212 *1213 * @param signer keyring of signer1214 * @param collectionId ID of collection1215 * @param tokenId ID of token1216 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1217 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1218 * @returns ```true``` if extrinsic success, otherwise ```false```1219 */1220 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1221 const result = await this.helper.executeExtrinsic(1222 signer,1223 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1224 true,1225 );12261227 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1228 }12291230 /**1231 * Get properties, metadata assigned to a token.1232 * 1233 * @param collectionId ID of collection1234 * @param tokenId ID of token1235 * @param propertyKeys optionally filter the returned properties to only these keys1236 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1237 * @returns array of key-value pairs1238 */1239 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1240 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1241 }12421243 /**1244 * Delete the provided properties of a token1245 * @param signer keyring of signer1246 * @param collectionId ID of collection1247 * @param tokenId ID of token1248 * @param propertyKeys property keys to be deleted1249 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1250 * @returns ```true``` if extrinsic success, otherwise ```false```1251 */1252 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1253 const result = await this.helper.executeExtrinsic(1254 signer,1255 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1256 true,1257 );12581259 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1260 }12611262 /**1263 * Mint new collection1264 *1265 * @param signer keyring of signer1266 * @param collectionOptions basic collection options and properties1267 * @param mode NFT or RFT type of a collection1268 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1269 * @returns object of the created collection1270 */1271 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1272 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1273 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1274 for (const key of ['name', 'description', 'tokenPrefix']) {1275 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);1276 }1277 const creationResult = await this.helper.executeExtrinsic(1278 signer,1279 'api.tx.unique.createCollectionEx', [collectionOptions],1280 true, // errorLabel,1281 );1282 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1283 }12841285 getCollectionObject(_collectionId: number): any {1286 return null;1287 }12881289 getTokenObject(_collectionId: number, _tokenId: number): any {1290 return null;1291 }1292}129312941295class NFTGroup extends NFTnRFT {1296 /**1297 * Get collection object1298 * @param collectionId ID of collection1299 * @example getCollectionObject(2);1300 * @returns instance of UniqueNFTCollection1301 */1302 getCollectionObject(collectionId: number): UniqueNFTCollection {1303 return new UniqueNFTCollection(collectionId, this.helper);1304 }13051306 /**1307 * Get token object1308 * @param collectionId ID of collection1309 * @param tokenId ID of token1310 * @example getTokenObject(10, 5);1311 * @returns instance of UniqueNFTToken1312 */1313 getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1314 return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1315 }13161317 /**1318 * Get token's owner1319 * @param collectionId ID of collection1320 * @param tokenId ID of token1321 * @param blockHashAt optionally query the data at the block with this hash1322 * @example getTokenOwner(10, 5);1323 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1324 */1325 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1326 let owner;1327 if (typeof blockHashAt === 'undefined') {1328 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1329 } else {1330 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1331 }1332 return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1333 }13341335 /**1336 * Is token approved to transfer1337 * @param collectionId ID of collection1338 * @param tokenId ID of token1339 * @param toAccountObj address to be approved1340 * @returns ```true``` if extrinsic success, otherwise ```false```1341 */1342 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1343 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1344 }13451346 /**1347 * Changes the owner of the token.1348 *1349 * @param signer keyring of signer1350 * @param collectionId ID of collection1351 * @param tokenId ID of token1352 * @param addressObj address of a new owner1353 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1354 * @returns ```true``` if extrinsic success, otherwise ```false```1355 */1356 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1357 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1358 }13591360 /**1361 *1362 * Change ownership of a NFT on behalf of the owner.1363 *1364 * @param signer keyring of signer1365 * @param collectionId ID of collection1366 * @param tokenId ID of token1367 * @param fromAddressObj address on behalf of which the token will be sent1368 * @param toAddressObj new token owner1369 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1370 * @returns ```true``` if extrinsic success, otherwise ```false```1371 */1372 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1373 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1374 }13751376 /**1377 * Recursively find the address that owns the token1378 * @param collectionId ID of collection1379 * @param tokenId ID of token1380 * @param blockHashAt1381 * @example getTokenTopmostOwner(10, 5);1382 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1383 */1384 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1385 let owner;1386 if (typeof blockHashAt === 'undefined') {1387 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1388 } else {1389 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1390 }13911392 if (owner === null) return null;13931394 return owner.toHuman();1395 }13961397 /**1398 * Get tokens nested in the provided token1399 * @param collectionId ID of collection1400 * @param tokenId ID of token1401 * @param blockHashAt optionally query the data at the block with this hash1402 * @example getTokenChildren(10, 5);1403 * @returns tokens whose depth of nesting is <= 51404 */1405 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1406 let children;1407 if(typeof blockHashAt === 'undefined') {1408 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1409 } else {1410 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1411 }14121413 return children.toJSON().map((x: any) => {1414 return {collectionId: x.collection, tokenId: x.token};1415 });1416 }14171418 /**1419 * Nest one token into another1420 * @param signer keyring of signer1421 * @param tokenObj token to be nested1422 * @param rootTokenObj token to be parent1423 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1424 * @returns ```true``` if extrinsic success, otherwise ```false```1425 */1426 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1427 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1428 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1429 if(!result) {1430 throw Error('Unable to nest token!');1431 }1432 return result;1433 }14341435 /**1436 * Remove token from nested state1437 * @param signer keyring of signer1438 * @param tokenObj token to unnest1439 * @param rootTokenObj parent of a token1440 * @param toAddressObj address of a new token owner1441 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1442 * @returns ```true``` if extrinsic success, otherwise ```false```1443 */1444 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1445 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1446 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1447 if(!result) {1448 throw Error('Unable to unnest token!');1449 }1450 return result;1451 }14521453 /**1454 * Mint new collection1455 * @param signer keyring of signer1456 * @param collectionOptions Collection options1457 * @example1458 * mintCollection(aliceKeyring, {1459 * name: 'New',1460 * description: 'New collection',1461 * tokenPrefix: 'NEW',1462 * })1463 * @returns object of the created collection1464 */1465 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1466 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1467 }14681469 /**1470 * Mint new token1471 * @param signer keyring of signer1472 * @param data token data1473 * @returns created token object1474 */1475 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1476 const creationResult = await this.helper.executeExtrinsic(1477 signer,1478 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1479 nft: {1480 properties: data.properties,1481 },1482 }],1483 true,1484 );1485 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1486 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1487 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1488 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1489 }14901491 /**1492 * Mint multiple NFT tokens1493 * @param signer keyring of signer1494 * @param collectionId ID of collection1495 * @param tokens array of tokens with owner and properties1496 * @example1497 * mintMultipleTokens(aliceKeyring, 10, [{1498 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1499 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1500 * },{1501 * owner: {Ethereum: "0x9F0583DbB855d..."},1502 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1503 * }]);1504 * @returns ```true``` if extrinsic success, otherwise ```false```1505 */1506 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1507 const creationResult = await this.helper.executeExtrinsic(1508 signer,1509 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1510 true,1511 );1512 const collection = this.getCollectionObject(collectionId);1513 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1514 }15151516 /**1517 * Mint multiple NFT tokens with one owner1518 * @param signer keyring of signer1519 * @param collectionId ID of collection1520 * @param owner tokens owner1521 * @param tokens array of tokens with owner and properties1522 * @example1523 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1524 * properties: [{1525 * key: "gender",1526 * value: "female",1527 * },{1528 * key: "age",1529 * value: "33",1530 * }],1531 * }]);1532 * @returns array of newly created tokens1533 */1534 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1535 const rawTokens = [];1536 for (const token of tokens) {1537 const raw = {NFT: {properties: token.properties}};1538 rawTokens.push(raw);1539 }1540 const creationResult = await this.helper.executeExtrinsic(1541 signer,1542 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1543 true,1544 );1545 const collection = this.getCollectionObject(collectionId);1546 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1547 }15481549 /**1550 * Set, change, or remove approved address to transfer the ownership of the NFT.1551 *1552 * @param signer keyring of signer1553 * @param collectionId ID of collection1554 * @param tokenId ID of token1555 * @param toAddressObj address to approve1556 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1557 * @returns ```true``` if extrinsic success, otherwise ```false```1558 */1559 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1560 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1561 }1562}156315641565class RFTGroup extends NFTnRFT {1566 /**1567 * Get collection object1568 * @param collectionId ID of collection1569 * @example getCollectionObject(2);1570 * @returns instance of UniqueRFTCollection1571 */1572 getCollectionObject(collectionId: number): UniqueRFTCollection {1573 return new UniqueRFTCollection(collectionId, this.helper);1574 }15751576 /**1577 * Get token object1578 * @param collectionId ID of collection1579 * @param tokenId ID of token1580 * @example getTokenObject(10, 5);1581 * @returns instance of UniqueNFTToken1582 */1583 getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1584 return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1585 }15861587 /**1588 * Get top 10 token owners with the largest number of pieces1589 * @param collectionId ID of collection1590 * @param tokenId ID of token1591 * @example getTokenTop10Owners(10, 5);1592 * @returns array of top 10 owners1593 */1594 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1595 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1596 }15971598 /**1599 * Get number of pieces owned by address1600 * @param collectionId ID of collection1601 * @param tokenId ID of token1602 * @param addressObj address token owner1603 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1604 * @returns number of pieces ownerd by address1605 */1606 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1607 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1608 }16091610 /**1611 * Transfer pieces of token to another address1612 * @param signer keyring of signer1613 * @param collectionId ID of collection1614 * @param tokenId ID of token1615 * @param addressObj address of a new owner1616 * @param amount number of pieces to be transfered1617 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1618 * @returns ```true``` if extrinsic success, otherwise ```false```1619 */1620 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1621 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1622 }16231624 /**1625 * Change ownership of some pieces of RFT on behalf of the owner.1626 * @param signer keyring of signer1627 * @param collectionId ID of collection1628 * @param tokenId ID of token1629 * @param fromAddressObj address on behalf of which the token will be sent1630 * @param toAddressObj new token owner1631 * @param amount number of pieces to be transfered1632 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1633 * @returns ```true``` if extrinsic success, otherwise ```false```1634 */1635 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1636 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1637 }16381639 /**1640 * Mint new collection1641 * @param signer keyring of signer1642 * @param collectionOptions Collection options1643 * @example1644 * mintCollection(aliceKeyring, {1645 * name: 'New',1646 * description: 'New collection',1647 * tokenPrefix: 'NEW',1648 * })1649 * @returns object of the created collection1650 */1651 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1652 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1653 }16541655 /**1656 * Mint new token1657 * @param signer keyring of signer1658 * @param data token data1659 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1660 * @returns created token object1661 */1662 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1663 const creationResult = await this.helper.executeExtrinsic(1664 signer,1665 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1666 refungible: {1667 pieces: data.pieces,1668 properties: data.properties,1669 },1670 }],1671 true,1672 );1673 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1674 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1675 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1676 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1677 }16781679 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1680 throw Error('Not implemented');1681 const creationResult = await this.helper.executeExtrinsic(1682 signer,1683 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1684 true, // `Unable to mint RFT tokens for ${label}`,1685 );1686 const collection = this.getCollectionObject(collectionId);1687 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1688 }16891690 /**1691 * Mint multiple RFT tokens with one owner1692 * @param signer keyring of signer1693 * @param collectionId ID of collection1694 * @param owner tokens owner1695 * @param tokens array of tokens with properties and pieces1696 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1697 * @returns array of newly created RFT tokens1698 */1699 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1700 const rawTokens = [];1701 for (const token of tokens) {1702 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1703 rawTokens.push(raw);1704 }1705 const creationResult = await this.helper.executeExtrinsic(1706 signer,1707 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1708 true,1709 );1710 const collection = this.getCollectionObject(collectionId);1711 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1712 }17131714 /**1715 * Destroys a concrete instance of RFT.1716 * @param signer keyring of signer1717 * @param collectionId ID of collection1718 * @param tokenId ID of token1719 * @param amount number of pieces to be burnt1720 * @example burnToken(aliceKeyring, 10, 5);1721 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1722 */1723 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1724 return await super.burnToken(signer, collectionId, tokenId, amount);1725 }17261727 /**1728 * Destroys a concrete instance of RFT on behalf of the owner.1729 * @param signer keyring of signer1730 * @param collectionId ID of collection1731 * @param tokenId ID of token1732 * @param fromAddressObj address on behalf of which the token will be burnt1733 * @param amount number of pieces to be burnt1734 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1735 * @returns ```true``` if extrinsic success, otherwise ```false```1736 */1737 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1738 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1739 }17401741 /**1742 * Set, change, or remove approved address to transfer the ownership of the RFT.1743 *1744 * @param signer keyring of signer1745 * @param collectionId ID of collection1746 * @param tokenId ID of token1747 * @param toAddressObj address to approve1748 * @param amount number of pieces to be approved1749 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1750 * @returns true if the token success, otherwise false1751 */1752 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1753 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1754 }17551756 /**1757 * Get total number of pieces1758 * @param collectionId ID of collection1759 * @param tokenId ID of token1760 * @example getTokenTotalPieces(10, 5);1761 * @returns number of pieces1762 */1763 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1764 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1765 }17661767 /**1768 * Change number of token pieces. Signer must be the owner of all token pieces.1769 * @param signer keyring of signer1770 * @param collectionId ID of collection1771 * @param tokenId ID of token1772 * @param amount new number of pieces1773 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1774 * @returns true if the repartion was success, otherwise false1775 */1776 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1777 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1778 const repartitionResult = await this.helper.executeExtrinsic(1779 signer,1780 'api.tx.unique.repartition', [collectionId, tokenId, amount],1781 true,1782 );1783 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1784 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1785 }1786}178717881789class FTGroup extends CollectionGroup {1790 /**1791 * Get collection object1792 * @param collectionId ID of collection1793 * @example getCollectionObject(2);1794 * @returns instance of UniqueFTCollection1795 */1796 getCollectionObject(collectionId: number): UniqueFTCollection {1797 return new UniqueFTCollection(collectionId, this.helper);1798 }17991800 /**1801 * Mint new fungible collection1802 * @param signer keyring of signer1803 * @param collectionOptions Collection options1804 * @param decimalPoints number of token decimals1805 * @example1806 * mintCollection(aliceKeyring, {1807 * name: 'New',1808 * description: 'New collection',1809 * tokenPrefix: 'NEW',1810 * }, 18)1811 * @returns newly created fungible collection1812 */1813 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {1814 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1815 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1816 collectionOptions.mode = {fungible: decimalPoints};1817 for (const key of ['name', 'description', 'tokenPrefix']) {1818 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);1819 }1820 const creationResult = await this.helper.executeExtrinsic(1821 signer,1822 'api.tx.unique.createCollectionEx', [collectionOptions],1823 true,1824 );1825 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1826 }18271828 /**1829 * Mint tokens1830 * @param signer keyring of signer1831 * @param collectionId ID of collection1832 * @param owner address owner of new tokens1833 * @param amount amount of tokens to be meanted1834 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1835 * @returns ```true``` if extrinsic success, otherwise ```false```1836 */1837 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1838 const creationResult = await this.helper.executeExtrinsic(1839 signer,1840 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1841 fungible: {1842 value: amount,1843 },1844 }],1845 true, // `Unable to mint fungible tokens for ${label}`,1846 );1847 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1848 }18491850 /**1851 * Mint multiple Fungible tokens with one owner1852 * @param signer keyring of signer1853 * @param collectionId ID of collection1854 * @param owner tokens owner1855 * @param tokens array of tokens with properties and pieces1856 * @returns ```true``` if extrinsic success, otherwise ```false```1857 */1858 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1859 const rawTokens = [];1860 for (const token of tokens) {1861 const raw = {Fungible: {Value: token.value}};1862 rawTokens.push(raw);1863 }1864 const creationResult = await this.helper.executeExtrinsic(1865 signer,1866 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1867 true,1868 );1869 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1870 }18711872 /**1873 * Get the top 10 owners with the largest balance for the Fungible collection1874 * @param collectionId ID of collection1875 * @example getTop10Owners(10);1876 * @returns array of ```ICrossAccountId```1877 */1878 async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {1879 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1880 }18811882 /**1883 * Get account balance1884 * @param collectionId ID of collection1885 * @param addressObj address of owner1886 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1887 * @returns amount of fungible tokens owned by address1888 */1889 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1890 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1891 }18921893 /**1894 * Transfer tokens to address1895 * @param signer keyring of signer1896 * @param collectionId ID of collection1897 * @param toAddressObj address recipient1898 * @param amount amount of tokens to be sent1899 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1900 * @returns ```true``` if extrinsic success, otherwise ```false```1901 */1902 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1903 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1904 }19051906 /**1907 * Transfer some tokens on behalf of the owner.1908 * @param signer keyring of signer1909 * @param collectionId ID of collection1910 * @param fromAddressObj address on behalf of which tokens will be sent1911 * @param toAddressObj address where token to be sent1912 * @param amount number of tokens to be sent1913 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1914 * @returns ```true``` if extrinsic success, otherwise ```false```1915 */1916 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1917 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1918 }19191920 /**1921 * Destroy some amount of tokens1922 * @param signer keyring of signer1923 * @param collectionId ID of collection1924 * @param amount amount of tokens to be destroyed1925 * @example burnTokens(aliceKeyring, 10, 1000n);1926 * @returns ```true``` if extrinsic success, otherwise ```false```1927 */1928 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1929 return await super.burnToken(signer, collectionId, 0, amount);1930 }19311932 /**1933 * Burn some tokens on behalf of the owner.1934 * @param signer keyring of signer1935 * @param collectionId ID of collection1936 * @param fromAddressObj address on behalf of which tokens will be burnt1937 * @param amount amount of tokens to be burnt1938 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1939 * @returns ```true``` if extrinsic success, otherwise ```false```1940 */1941 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1942 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);1943 }19441945 /**1946 * Get total collection supply1947 * @param collectionId1948 * @returns1949 */1950 async getTotalPieces(collectionId: number): Promise<bigint> {1951 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1952 }19531954 /**1955 * Set, change, or remove approved address to transfer tokens.1956 *1957 * @param signer keyring of signer1958 * @param collectionId ID of collection1959 * @param toAddressObj address to be approved1960 * @param amount amount of tokens to be approved1961 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1962 * @returns ```true``` if extrinsic success, otherwise ```false```1963 */1964 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1965 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1966 }19671968 /**1969 * Get amount of fungible tokens approved to transfer1970 * @param collectionId ID of collection1971 * @param fromAddressObj owner of tokens1972 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1973 * @returns number of tokens approved for the transfer1974 */1975 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1976 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1977 }1978}197919801981class ChainGroup extends HelperGroup {1982 /**1983 * Get system properties of a chain1984 * @example getChainProperties();1985 * @returns ss58Format, token decimals, and token symbol1986 */1987 getChainProperties(): IChainProperties {1988 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1989 return {1990 ss58Format: properties.ss58Format.toJSON(),1991 tokenDecimals: properties.tokenDecimals.toJSON(),1992 tokenSymbol: properties.tokenSymbol.toJSON(),1993 };1994 }19951996 /**1997 * Get chain header1998 * @example getLatestBlockNumber();1999 * @returns the number of the last block2000 */2001 async getLatestBlockNumber(): Promise<number> {2002 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2003 }20042005 /**2006 * Get block hash by block number2007 * @param blockNumber number of block2008 * @example getBlockHashByNumber(12345);2009 * @returns hash of a block2010 */2011 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2012 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2013 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2014 return blockHash;2015 }20162017 // TODO add docs2018 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2019 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2020 if (!blockHash) return null;2021 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2022 }20232024 /**2025 * Get account nonce2026 * @param address substrate address2027 * @example getNonce("5GrwvaEF5zXb26Fz...");2028 * @returns number, account's nonce2029 */2030 async getNonce(address: TSubstrateAccount): Promise<number> {2031 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();2032 }2033}203420352036class BalanceGroup extends HelperGroup {2037 getCollectionCreationPrice(): bigint {2038 return 2n * this.helper.balance.getOneTokenNominal();2039 }2040 /**2041 * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2042 * @example getOneTokenNominal()2043 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2044 */2045 getOneTokenNominal(): bigint {2046 const chainProperties = this.helper.chain.getChainProperties();2047 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2048 }20492050 /**2051 * Get substrate address balance2052 * @param address substrate address2053 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2054 * @returns amount of tokens on address2055 */2056 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2057 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2058 }20592060 /**2061 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2062 * @param address substrate address2063 * @returns2064 */2065 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2066 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2067 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2068 }20692070 /**2071 * Get ethereum address balance2072 * @param address ethereum address2073 * @example getEthereum("0x9F0583DbB855d...")2074 * @returns amount of tokens on address2075 */2076 async getEthereum(address: TEthereumAccount): Promise<bigint> {2077 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2078 }20792080 /**2081 * Transfer tokens to substrate address2082 * @param signer keyring of signer2083 * @param address substrate address of a recipient2084 * @param amount amount of tokens to be transfered2085 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2086 * @returns ```true``` if extrinsic success, otherwise ```false```2087 */2088 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2089 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}`*/);20902091 let transfer = {from: null, to: null, amount: 0n} as any;2092 result.result.events.forEach(({event: {data, method, section}}) => {2093 if ((section === 'balances') && (method === 'Transfer')) {2094 transfer = {2095 from: this.helper.address.normalizeSubstrate(data[0]),2096 to: this.helper.address.normalizeSubstrate(data[1]),2097 amount: BigInt(data[2]),2098 };2099 }2100 });2101 const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from 2102 && this.helper.address.normalizeSubstrate(address) === transfer.to 2103 && BigInt(amount) === transfer.amount;2104 return isSuccess;2105 }2106}210721082109class AddressGroup extends HelperGroup {2110 /**2111 * Normalizes the address to the specified ss58 format, by default ```42```.2112 * @param address substrate address2113 * @param ss58Format format for address conversion, by default ```42```2114 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2115 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2116 */2117 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2118 return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2119 }21202121 /**2122 * Get address in the connected chain format2123 * @param address substrate address2124 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2125 * @returns address in chain format2126 */2127 normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2128 return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2129 }21302131 /**2132 * Get substrate mirror of an ethereum address2133 * @param ethAddress ethereum address2134 * @param toChainFormat false for normalized account2135 * @example ethToSubstrate('0x9F0583DbB855d...')2136 * @returns substrate mirror of a provided ethereum address2137 */2138 ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2139 return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2140 }21412142 /**2143 * Get ethereum mirror of a substrate address2144 * @param subAddress substrate account2145 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2146 * @returns ethereum mirror of a provided substrate address2147 */2148 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2149 return CrossAccountId.translateSubToEth(subAddress);2150 }2151}21522153class StakingGroup extends HelperGroup {2154 /**2155 * Stake tokens for App Promotion2156 * @param signer keyring of signer2157 * @param amountToStake amount of tokens to stake2158 * @param label extra label for log2159 * @returns2160 */2161 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2162 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2163 const stakeResult = await this.helper.executeExtrinsic(2164 signer, 'api.tx.appPromotion.stake',2165 [amountToStake], true,2166 );2167 // TODO extract info from stakeResult2168 return true;2169 }21702171 /**2172 * Unstake tokens for App Promotion2173 * @param signer keyring of signer2174 * @param amountToUnstake amount of tokens to unstake2175 * @param label extra label for log2176 * @returns block number where balances will be unlocked2177 */2178 async unstake(signer: TSigner, label?: string): Promise<number> {2179 if(typeof label === 'undefined') label = `${signer.address}`;2180 const unstakeResult = await this.helper.executeExtrinsic(2181 signer, 'api.tx.appPromotion.unstake',2182 [], true,2183 );2184 // TODO extract block number fron events2185 return 1;2186 }21872188 /**2189 * Get total staked amount for address2190 * @param address substrate or ethereum address2191 * @returns total staked amount2192 */2193 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2194 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2195 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2196 }21972198 /**2199 * Get total staked per block2200 * @param address substrate or ethereum address2201 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2202 */2203 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2204 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2205 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2206 return { 2207 block: block.toBigInt(),2208 amount: amount.toBigInt(),2209 };2210 });2211 }22122213 /**2214 * Get total pending unstake amount for address2215 * @param address substrate or ethereum address2216 * @returns total pending unstake amount2217 */2218 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2219 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2220 }22212222 /**2223 * Get pending unstake amount per block for address2224 * @param address substrate or ethereum address2225 * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2226 */2227 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2228 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2229 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2230 return {2231 block: block.toBigInt(),2232 amount: amount.toBigInt(),2233 };2234 });2235 return result;2236 }2237}22382239export class UniqueHelper extends ChainHelperBase {2240 chain: ChainGroup;2241 balance: BalanceGroup;2242 address: AddressGroup;2243 collection: CollectionGroup;2244 nft: NFTGroup;2245 rft: RFTGroup;2246 ft: FTGroup;2247 staking: StakingGroup;22482249 constructor(logger?: ILogger) {2250 super(logger);2251 this.chain = new ChainGroup(this);2252 this.balance = new BalanceGroup(this);2253 this.address = new AddressGroup(this);2254 this.collection = new CollectionGroup(this);2255 this.nft = new NFTGroup(this);2256 this.rft = new RFTGroup(this);2257 this.ft = new FTGroup(this);2258 this.staking = new StakingGroup(this);2259 }2260}226122622263export class UniqueBaseCollection {2264 helper: UniqueHelper;2265 collectionId: number;22662267 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2268 this.collectionId = collectionId;2269 this.helper = uniqueHelper;2270 }22712272 async getData() {2273 return await this.helper.collection.getData(this.collectionId);2274 }22752276 async getLastTokenId() {2277 return await this.helper.collection.getLastTokenId(this.collectionId);2278 }22792280 async isTokenExists(tokenId: number) {2281 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2282 }22832284 async getAdmins() {2285 return await this.helper.collection.getAdmins(this.collectionId);2286 }22872288 async getAllowList() {2289 return await this.helper.collection.getAllowList(this.collectionId);2290 }22912292 async getEffectiveLimits() {2293 return await this.helper.collection.getEffectiveLimits(this.collectionId);2294 }22952296 async getProperties(propertyKeys?: string[] | null) {2297 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);2298 }22992300 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2301 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2302 }23032304 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2305 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2306 }23072308 async confirmSponsorship(signer: TSigner) {2309 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2310 }23112312 async removeSponsor(signer: TSigner) {2313 return await this.helper.collection.removeSponsor(signer, this.collectionId);2314 }23152316 async setLimits(signer: TSigner, limits: ICollectionLimits) {2317 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2318 }23192320 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2321 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2322 }23232324 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2325 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2326 }23272328 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2329 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2330 }23312332 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2333 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2334 }23352336 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2337 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2338 }23392340 async setProperties(signer: TSigner, properties: IProperty[]) {2341 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2342 }23432344 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2345 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2346 }23472348 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2349 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2350 }23512352 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2353 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2354 }23552356 async disableNesting(signer: TSigner) {2357 return await this.helper.collection.disableNesting(signer, this.collectionId);2358 }23592360 async burn(signer: TSigner) {2361 return await this.helper.collection.burn(signer, this.collectionId);2362 }2363}236423652366export class UniqueNFTCollection extends UniqueBaseCollection {2367 getTokenObject(tokenId: number) {2368 return new UniqueNFToken(tokenId, this);2369 }23702371 async getTokensByAddress(addressObj: ICrossAccountId) {2372 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2373 }23742375 async getToken(tokenId: number, blockHashAt?: string) {2376 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2377 }23782379 async getTokenOwner(tokenId: number, blockHashAt?: string) {2380 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2381 }23822383 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2384 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2385 }23862387 async getTokenChildren(tokenId: number, blockHashAt?: string) {2388 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2389 }23902391 async getPropertyPermissions(propertyKeys: string[] | null = null) {2392 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);2393 }23942395 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {2396 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2397 }23982399 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2400 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2401 }24022403 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2404 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2405 }24062407 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2408 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2409 }24102411 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2412 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2413 }24142415 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2416 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2417 }24182419 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2420 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2421 }24222423 async burnToken(signer: TSigner, tokenId: number) {2424 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2425 }24262427 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {2428 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);2429 }24302431 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2432 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2433 }24342435 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2436 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2437 }24382439 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2440 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2441 }24422443 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2444 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2445 }24462447 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2448 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2449 }2450}245124522453export class UniqueRFTCollection extends UniqueBaseCollection {2454 getTokenObject(tokenId: number) {2455 return new UniqueRFToken(tokenId, this);2456 }24572458 async getToken(tokenId: number, blockHashAt?: string) {2459 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);2460 }24612462 async getTokensByAddress(addressObj: ICrossAccountId) {2463 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2464 }24652466 async getTop10TokenOwners(tokenId: number) {2467 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2468 }24692470 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2471 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2472 }24732474 async getTokenTotalPieces(tokenId: number) {2475 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2476 }24772478 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2479 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2480 }24812482 async getPropertyPermissions(propertyKeys: string[] | null = null) {2483 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);2484 }24852486 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {2487 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2488 }24892490 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2491 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2492 }24932494 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2495 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2496 }24972498 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2499 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2500 }25012502 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2503 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2504 }25052506 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2507 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2508 }25092510 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {2511 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2512 }25132514 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2515 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2516 }25172518 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n) {2519 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);2520 }25212522 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2523 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2524 }25252526 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2527 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2528 }25292530 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2531 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2532 }2533}253425352536export class UniqueFTCollection extends UniqueBaseCollection {2537 async getBalance(addressObj: ICrossAccountId) {2538 return await this.helper.ft.getBalance(this.collectionId, addressObj);2539 }25402541 async getTotalPieces() {2542 return await this.helper.ft.getTotalPieces(this.collectionId);2543 }25442545 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2546 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2547 }25482549 async getTop10Owners() {2550 return await this.helper.ft.getTop10Owners(this.collectionId);2551 }25522553 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {2554 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);2555 }25562557 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {2558 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);2559 }25602561 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2562 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2563 }25642565 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2566 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2567 }25682569 async burnTokens(signer: TSigner, amount=1n) {2570 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2571 }25722573 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2574 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2575 }25762577 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2578 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2579 }2580}258125822583export class UniqueBaseToken {2584 collection: UniqueNFTCollection | UniqueRFTCollection;2585 collectionId: number;2586 tokenId: number;25872588 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2589 this.collection = collection;2590 this.collectionId = collection.collectionId;2591 this.tokenId = tokenId;2592 }25932594 async getNextSponsored(addressObj: ICrossAccountId) {2595 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2596 }25972598 async getProperties(propertyKeys?: string[] | null) {2599 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);2600 }26012602 async setProperties(signer: TSigner, properties: IProperty[]) {2603 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2604 }26052606 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2607 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2608 }26092610 nestingAccount() {2611 return this.collection.helper.util.getTokenAccount(this);2612 }2613}261426152616export class UniqueNFToken extends UniqueBaseToken {2617 collection: UniqueNFTCollection;26182619 constructor(tokenId: number, collection: UniqueNFTCollection) {2620 super(tokenId, collection);2621 this.collection = collection;2622 }26232624 async getData(blockHashAt?: string) {2625 return await this.collection.getToken(this.tokenId, blockHashAt);2626 }26272628 async getOwner(blockHashAt?: string) {2629 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2630 }26312632 async getTopmostOwner(blockHashAt?: string) {2633 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2634 }26352636 async getChildren(blockHashAt?: string) {2637 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2638 }26392640 async nest(signer: TSigner, toTokenObj: IToken) {2641 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2642 }26432644 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2645 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2646 }26472648 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2649 return await this.collection.transferToken(signer, this.tokenId, addressObj);2650 }26512652 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2653 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2654 }26552656 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2657 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2658 }26592660 async isApproved(toAddressObj: ICrossAccountId) {2661 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2662 }26632664 async burn(signer: TSigner) {2665 return await this.collection.burnToken(signer, this.tokenId);2666 }26672668 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {2669 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);2670 }2671}26722673export class UniqueRFToken extends UniqueBaseToken {2674 collection: UniqueRFTCollection;26752676 constructor(tokenId: number, collection: UniqueRFTCollection) {2677 super(tokenId, collection);2678 this.collection = collection;2679 }26802681 async getData(blockHashAt?: string) {2682 return await this.collection.getToken(this.tokenId, blockHashAt);2683 }26842685 async getTop10Owners() {2686 return await this.collection.getTop10TokenOwners(this.tokenId);2687 }26882689 async getBalance(addressObj: ICrossAccountId) {2690 return await this.collection.getTokenBalance(this.tokenId, addressObj);2691 }26922693 async getTotalPieces() {2694 return await this.collection.getTokenTotalPieces(this.tokenId);2695 }26962697 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2698 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2699 }27002701 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2702 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2703 }27042705 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2706 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2707 }27082709 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2710 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2711 }27122713 async repartition(signer: TSigner, amount: bigint) {2714 return await this.collection.repartitionToken(signer, this.tokenId, amount);2715 }27162717 async burn(signer: TSigner, amount=1n) {2718 return await this.collection.burnToken(signer, this.tokenId, amount);2719 }27202721 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2722 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);2723 }2724}