difftreelog
Merge pull request #571 from UniqueNetwork/test/intermittent-playgrounds-update
in: master
Tests (utility in playgrounds): various modifications and additions
5 files changed
tests/package.jsondiffbeforeafterboth--- a/tests/package.json
+++ b/tests/package.json
@@ -64,6 +64,7 @@
"testBurnItem": "mocha --timeout 9999999 -r ts-node/register ./**/burnItem.test.ts",
"testAdminTransferAndBurn": "mocha --timeout 9999999 -r ts-node/register ./**/adminTransferAndBurn.test.ts",
"testSetMintPermission": "mocha --timeout 9999999 -r ts-node/register ./**/setMintPermission.test.ts",
+ "testSetPublicAccessMode": "mocha --timeout 9999999 -r ts-node/register ./**/setPublicAccessMode.test.ts",
"testCreditFeesToTreasury": "mocha --timeout 9999999 -r ts-node/register ./**/creditFeesToTreasury.test.ts",
"testContractSponsoring": "mocha --timeout 9999999 -r ts-node/register ./**/contractSponsoring.test.ts",
"testEnableContractSponsoring": "mocha --timeout 9999999 -r ts-node/register ./**/enableContractSponsoring.test.ts",
@@ -71,7 +72,6 @@
"testSetContractSponsoringRateLimit": "mocha --timeout 9999999 -r ts-node/register ./**/setContractSponsoringRateLimit.test.ts",
"testSetOffchainSchema": "mocha --timeout 9999999 -r ts-node/register ./**/setOffchainSchema.test.ts",
"testOverflow": "mocha --timeout 9999999 -r ts-node/register ./**/overflow.test.ts",
- "testSetVariableMetadataSponsoringRateLimit": "mocha --timeout 9999999 -r ts-node/register ./**/setVariableMetadataSponsoringRateLimit.test.ts",
"testInflation": "mocha --timeout 9999999 -r ts-node/register ./**/inflation.test.ts",
"testScheduler": "mocha --timeout 9999999 -r ts-node/register ./**/scheduler.test.ts",
"testSchedulingEVM": "mocha --timeout 9999999 -r ts-node/register ./**/eth/scheduling.test.ts",
tests/src/util/playgrounds/index.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/index.ts
+++ b/tests/src/util/playgrounds/index.ts
@@ -2,6 +2,7 @@
// SPDX-License-Identifier: Apache-2.0
import {IKeyringPair} from '@polkadot/types/types';
+import {Context} from 'mocha';
import config from '../../config';
import '../../interfaces/augment-api-events';
import {DevUniqueHelper, SilentLogger, SilentConsole} from './unique.dev';
@@ -24,3 +25,39 @@
silentConsole.disable();
}
};
+
+export enum Pallets {
+ Inflation = 'inflation',
+ RmrkCore = 'rmrkcore',
+ RmrkEquip = 'rmrkequip',
+ ReFungible = 'refungible',
+ Fungible = 'fungible',
+ NFT = 'nonfungible',
+ Scheduler = 'scheduler',
+}
+
+export function requirePalletsOrSkip(test: Context, helper: DevUniqueHelper, requiredPallets: string[]) {
+ const missingPallets = helper.fetchMissingPalletNames(requiredPallets);
+
+ if (missingPallets.length > 0) {
+ const skipMsg = `\tSkipping test '${test.test?.title}'.\n\tThe following pallets are missing:\n\t- ${missingPallets.join('\n\t- ')}`;
+ console.warn('\x1b[38:5:208m%s\x1b[0m', skipMsg);
+ test.skip();
+ }
+}
+
+export async function itSub(name: string, cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => IKeyringPair }) => any, opts: { only?: boolean, skip?: boolean, requiredPallets?: string[] } = {}) {
+ (opts.only ? it.only :
+ opts.skip ? it.skip : it)(name, async function () {
+ await usingPlaygrounds(async (helper, privateKey) => {
+ if (opts.requiredPallets) {
+ requirePalletsOrSkip(this, helper, opts.requiredPallets);
+ }
+
+ await cb({helper, privateKey});
+ });
+ });
+}
+itSub.only = (name: string, cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => IKeyringPair }) => any) => itSub(name, cb, {only: true});
+itSub.skip = (name: string, cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => IKeyringPair }) => any) => itSub(name, cb, {skip: true});
+itSub.ifWithPallets = (name: string, required: string[], cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => IKeyringPair }) => any) => itSub(name, cb, {requiredPallets: required});
tests/src/util/playgrounds/types.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/types.ts
+++ b/tests/src/util/playgrounds/types.ts
@@ -102,9 +102,9 @@
}
export interface ICollectionCreationOptions {
- name: string | number[];
- description: string | number[];
- tokenPrefix: string | number[];
+ name?: string | number[];
+ description?: string | number[];
+ tokenPrefix?: string | number[];
mode?: {
nft?: null;
refungible?: null;
tests/src/util/playgrounds/unique.dev.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/unique.dev.ts
+++ b/tests/src/util/playgrounds/unique.dev.ts
@@ -118,14 +118,15 @@
*/
createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {
let nonce = await this.helper.chain.getNonce(donor.address);
+ const ss58Format = this.helper.chain.getChainProperties().ss58Format;
const tokenNominal = this.helper.balance.getOneTokenNominal();
const transactions = [];
const accounts: IKeyringPair[] = [];
for (const balance of balances) {
- const recepient = this.helper.util.fromSeed(mnemonicGenerate());
- accounts.push(recepient);
+ const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);
+ accounts.push(recipient);
if (balance !== 0n) {
- const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, balance * tokenNominal]);
+ const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);
transactions.push(this.helper.signTransaction(donor, tx, 'account generation', {nonce}));
nonce++;
}
tests/src/util/playgrounds/unique.tsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};202122const nesting = {23 toChecksumAddress(address: string): string {24 if (typeof address === 'undefined') return '';2526 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2728 address = address.toLowerCase().replace(/^0x/i,'');29 const addressHash = keccakAsHex(address).replace(/^0x/i,'');30 const checksumAddress = ['0x'];3132 for (let i = 0; i < address.length; i++) {33 // If ith character is 8 to f then make it uppercase34 if (parseInt(addressHash[i], 16) > 7) {35 checksumAddress.push(address[i].toUpperCase());36 } else {37 checksumAddress.push(address[i]);38 }39 }40 return checksumAddress.join('');41 },42 tokenIdToAddress(collectionId: number, tokenId: number) {43 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);44 },45};4647class UniqueUtil {48 static transactionStatus = {49 NOT_READY: 'NotReady',50 FAIL: 'Fail',51 SUCCESS: 'Success',52 };5354 static chainLogType = {55 EXTRINSIC: 'extrinsic',56 RPC: 'rpc',57 };5859 static getNestingTokenAddress(collectionId: number, tokenId: number) {60 return nesting.tokenIdToAddress(collectionId, tokenId);61 }6263 static getDefaultLogger(): ILogger {64 return {65 log(msg: any, level = 'INFO') {66 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));67 },68 level: {69 ERROR: 'ERROR',70 WARNING: 'WARNING',71 INFO: 'INFO',72 },73 };74 }7576 static vec2str(arr: string[] | number[]) {77 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');78 }7980 static str2vec(string: string) {81 if (typeof string !== 'string') return string;82 return Array.from(string).map(x => x.charCodeAt(0));83 }8485 static fromSeed(seed: string, ss58Format = 42) {86 const keyring = new Keyring({type: 'sr25519', ss58Format});87 return keyring.addFromUri(seed);88 }8990 static normalizeSubstrateAddress(address: string, ss58Format = 42) {91 return encodeAddress(decodeAddress(address), ss58Format);92 }9394 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult) {95 if (creationResult.status !== this.transactionStatus.SUCCESS) {96 throw Error('Unable to create collection!');97 }9899 let collectionId = null;100 creationResult.result.events.forEach(({event: {data, method, section}}) => {101 if ((section === 'common') && (method === 'CollectionCreated')) {102 collectionId = parseInt(data[0].toString(), 10);103 }104 });105106 if (collectionId === null) {107 throw Error('No CollectionCreated event was found!');108 }109110 return collectionId;111 }112113 static extractTokensFromCreationResult(creationResult: ITransactionResult) {114 if (creationResult.status !== this.transactionStatus.SUCCESS) {115 throw Error('Unable to create tokens!');116 }117 let success = false;118 const tokens = [] as any;119 creationResult.result.events.forEach(({event: {data, method, section}}) => {120 if (method === 'ExtrinsicSuccess') {121 success = true;122 } else if ((section === 'common') && (method === 'ItemCreated')) {123 tokens.push({124 collectionId: parseInt(data[0].toString(), 10),125 tokenId: parseInt(data[1].toString(), 10),126 owner: data[2].toJSON(),127 });128 }129 });130 return {success, tokens};131 }132133 static extractTokensFromBurnResult(burnResult: ITransactionResult) {134 if (burnResult.status !== this.transactionStatus.SUCCESS) {135 throw Error('Unable to burn tokens!');136 }137 let success = false;138 const tokens = [] as any;139 burnResult.result.events.forEach(({event: {data, method, section}}) => {140 if (method === 'ExtrinsicSuccess') {141 success = true;142 } else if ((section === 'common') && (method === 'ItemDestroyed')) {143 tokens.push({144 collectionId: parseInt(data[0].toString(), 10),145 tokenId: parseInt(data[1].toString(), 10),146 owner: data[2].toJSON(),147 });148 }149 });150 return {success, tokens};151 }152153 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string) {154 let eventId = null;155 events.forEach(({event: {data, method, section}}) => {156 if ((section === expectedSection) && (method === expectedMethod)) {157 eventId = parseInt(data[0].toString(), 10);158 }159 });160161 if (eventId === null) {162 throw Error(`No ${expectedMethod} event was found!`);163 }164 return eventId === collectionId;165 }166167 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {168 const normalizeAddress = (address: string | ICrossAccountId) => {169 if(typeof address === 'string') return address;170 const obj = {} as any;171 Object.keys(address).forEach(k => {172 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];173 });174 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};175 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};176 return address;177 };178 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;179 events.forEach(({event: {data, method, section}}) => {180 if ((section === 'common') && (method === 'Transfer')) {181 const hData = (data as any).toJSON();182 transfer = {183 collectionId: hData[0],184 tokenId: hData[1],185 from: normalizeAddress(hData[2]),186 to: normalizeAddress(hData[3]),187 amount: BigInt(hData[4]),188 };189 }190 });191 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);193 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);194 isSuccess = isSuccess && amount === transfer.amount;195 return isSuccess;196 }197}198199200class ChainHelperBase {201 transactionStatus = UniqueUtil.transactionStatus;202 chainLogType = UniqueUtil.chainLogType;203 util: typeof UniqueUtil;204 logger: ILogger;205 api: ApiPromise | null;206 forcedNetwork: TUniqueNetworks | null;207 network: TUniqueNetworks | null;208 chainLog: IUniqueHelperLog[];209210 constructor(logger?: ILogger) {211 this.util = UniqueUtil;212 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();213 this.logger = logger;214 this.api = null;215 this.forcedNetwork = null;216 this.network = null;217 this.chainLog = [];218 }219220 clearChainLog(): void {221 this.chainLog = [];222 }223224 forceNetwork(value: TUniqueNetworks): void {225 this.forcedNetwork = value;226 }227228 async connect(wsEndpoint: string, listeners?: IApiListeners) {229 if (this.api !== null) throw Error('Already connected');230 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);231 this.api = api;232 this.network = network;233 }234235 async disconnect() {236 if (this.api === null) return;237 await this.api.disconnect();238 this.api = null;239 this.network = null;240 }241242 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {243 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;244 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;245 return 'opal';246 }247248 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {249 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});250 await api.isReady;251252 const network = await this.detectNetwork(api);253254 await api.disconnect();255256 return network;257 }258259 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 260 api: ApiPromise; 261 network: TUniqueNetworks; 262 }> {263 if(typeof network === 'undefined' || network === null) network = 'opal';264 const supportedRPC = {265 opal: {266 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,267 },268 quartz: {269 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,270 },271 unique: {272 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,273 },274 };275 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);276 const rpc = supportedRPC[network];277278 // TODO: investigate how to replace rpc in runtime279 // api._rpcCore.addUserInterfaces(rpc);280281 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});282283 await api.isReadyOrError;284285 if (typeof listeners === 'undefined') listeners = {};286 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {287 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;288 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);289 }290291 return {api, network};292 }293294 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {295 const {events, status} = data;296 if (status.isReady) {297 return this.transactionStatus.NOT_READY;298 }299 if (status.isBroadcast) {300 return this.transactionStatus.NOT_READY;301 }302 if (status.isInBlock || status.isFinalized) {303 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');304 if (errors.length > 0) {305 return this.transactionStatus.FAIL;306 }307 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {308 return this.transactionStatus.SUCCESS;309 }310 }311312 return this.transactionStatus.FAIL;313 }314315 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {316 const sign = (callback: any) => {317 if(options !== null) return transaction.signAndSend(sender, options, callback);318 return transaction.signAndSend(sender, callback);319 };320 // eslint-disable-next-line no-async-promise-executor321 return new Promise(async (resolve, reject) => {322 try {323 const unsub = await sign((result: any) => {324 const status = this.getTransactionStatus(result);325326 if (status === this.transactionStatus.SUCCESS) {327 this.logger.log(`${label} successful`);328 unsub();329 resolve({result, status});330 } else if (status === this.transactionStatus.FAIL) {331 let moduleError = null;332333 if (result.hasOwnProperty('dispatchError')) {334 const dispatchError = result['dispatchError'];335336 if (dispatchError && dispatchError.isModule) {337 const modErr = dispatchError.asModule;338 const errorMeta = dispatchError.registry.findMetaError(modErr);339340 moduleError = `${errorMeta.section}.${errorMeta.name}`;341 }342 else {343 this.logger.log(result, this.logger.level.ERROR);344 }345 }346347 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);348 unsub();349 reject({status, moduleError, result});350 }351 });352 } catch (e) {353 this.logger.log(e, this.logger.level.ERROR);354 reject(e);355 }356 });357 }358359 constructApiCall(apiCall: string, params: any[]) {360 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);361 let call = this.api as any;362 for(const part of apiCall.slice(4).split('.')) {363 call = call[part];364 }365 return call(...params);366 }367368 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false/*, failureMessage='expected success'*/) {369 if(this.api === null) throw Error('API not initialized');370 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);371372 const startTime = (new Date()).getTime();373 let result: ITransactionResult;374 let events = [];375 try {376 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;377 events = result.result.events.map((x: any) => x.toHuman());378 }379 catch(e) {380 if(!(e as object).hasOwnProperty('status')) throw e;381 result = e as ITransactionResult;382 }383384 const endTime = (new Date()).getTime();385386 const log = {387 executedAt: endTime,388 executionTime: endTime - startTime,389 type: this.chainLogType.EXTRINSIC,390 status: result.status,391 call: extrinsic,392 signer: this.getSignerAddress(sender),393 params,394 } as IUniqueHelperLog;395396 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;397 if(events.length > 0) log.events = events;398399 this.chainLog.push(log);400401 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);402 return result;403 }404405 async callRpc(rpc: string, params?: any[]) {406 if(typeof params === 'undefined') params = [];407 if(this.api === null) throw Error('API not initialized');408 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);409410 const startTime = (new Date()).getTime();411 let result;412 let error = null;413 const log = {414 type: this.chainLogType.RPC,415 call: rpc,416 params,417 } as IUniqueHelperLog;418419 try {420 result = await this.constructApiCall(rpc, params);421 }422 catch(e) {423 error = e;424 }425426 const endTime = (new Date()).getTime();427428 log.executedAt = endTime;429 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';430 log.executionTime = endTime - startTime;431432 this.chainLog.push(log);433434 if(error !== null) throw error;435436 return result;437 }438439 getSignerAddress(signer: IKeyringPair | string): string {440 if(typeof signer === 'string') return signer;441 return signer.address;442 }443}444445446class HelperGroup {447 helper: UniqueHelper;448449 constructor(uniqueHelper: UniqueHelper) {450 this.helper = uniqueHelper;451 }452}453454455class CollectionGroup extends HelperGroup {456 /**457 * Get number of blocks when sponsored transaction is available.458 *459 * @param collectionId ID of collection460 * @param tokenId ID of token461 * @param addressObj address for which the sponsorship is checked462 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});463 * @returns number of blocks or null if sponsorship hasn't been set464 */465 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {466 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();467 }468469 /**470 * Get the number of created collections.471 * 472 * @returns number of created collections473 */474 async getTotalCount(): Promise<number> {475 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();476 }477478 /**479 * Get information about the collection with additional data, including the number of tokens it contains, its administrators, the normalized address of the collection's owner, and decoded name and description.480 * 481 * @param collectionId ID of collection482 * @example await getData(2)483 * @returns collection information object484 */485 async getData(collectionId: number): Promise<{486 id: number;487 name: string;488 description: string;489 tokensCount: number;490 admins: ICrossAccountId[];491 normalizedOwner: TSubstrateAccount;492 raw: any493 } | null> {494 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);495 const humanCollection = collection.toHuman(), collectionData = {496 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],497 raw: humanCollection,498 } as any, jsonCollection = collection.toJSON();499 if (humanCollection === null) return null;500 collectionData.raw.limits = jsonCollection.limits;501 collectionData.raw.permissions = jsonCollection.permissions;502 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);503 for (const key of ['name', 'description']) {504 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);505 }506507 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) : 0;508 collectionData.admins = await this.getAdmins(collectionId);509510 return collectionData;511 }512513 /**514 * Get the normalized addresses of the collection's administrators.515 * 516 * @param collectionId ID of collection517 * @example await getAdmins(1)518 * @returns array of administrators519 */520 async getAdmins(collectionId: number): Promise<ICrossAccountId[]> {521 const normalized = [];522 for(const admin of (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman()) {523 if(admin.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(admin.Substrate)});524 else normalized.push(admin);525 }526 return normalized;527 }528529 /**530 * Get the normalized addresses added to the collection allow-list.531 * @param collectionId ID of collection532 * @example await getAllowList(1)533 * @returns array of allow-listed addresses534 */535 async getAllowList(collectionId: number): Promise<ICrossAccountId[]> {536 const normalized = [];537 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();538 for (const address of allowListed) {539 if (address.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(address.Substrate)});540 else normalized.push(address);541 }542 return normalized;543 }544545 /**546 * Get the effective limits of the collection instead of null for default values547 * 548 * @param collectionId ID of collection549 * @example await getEffectiveLimits(2)550 * @returns object of collection limits551 */552 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {553 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();554 }555556 /**557 * Burns the collection if the signer has sufficient permissions and collection is empty.558 * 559 * @param signer keyring of signer560 * @param collectionId ID of collection561 * @example await helper.collection.burn(aliceKeyring, 3);562 * @returns ```true``` if extrinsic success, otherwise ```false```563 */564 async burn(signer: TSigner, collectionId: number): Promise<boolean> {565 const result = await this.helper.executeExtrinsic(566 signer,567 'api.tx.unique.destroyCollection', [collectionId],568 true,569 );570571 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');572 }573574 /**575 * Sets the sponsor for the collection (Requires the Substrate address).576 * 577 * @param signer keyring of signer578 * @param collectionId ID of collection579 * @param sponsorAddress Sponsor substrate address580 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")581 * @returns ```true``` if extrinsic success, otherwise ```false```582 */583 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {584 const result = await this.helper.executeExtrinsic(585 signer,586 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],587 true,588 );589590 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');591 }592593 /**594 * Confirms consent to sponsor the collection on behalf of the signer.595 * 596 * @param signer keyring of signer597 * @param collectionId ID of collection598 * @example confirmSponsorship(aliceKeyring, 10)599 * @returns ```true``` if extrinsic success, otherwise ```false```600 */601 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {602 const result = await this.helper.executeExtrinsic(603 signer,604 'api.tx.unique.confirmSponsorship', [collectionId],605 true,606 );607608 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');609 }610611 /**612 * Sets the limits of the collection. At least one limit must be specified for a correct call.613 * 614 * @param signer keyring of signer615 * @param collectionId ID of collection616 * @param limits collection limits object617 * @example618 * await setLimits(619 * aliceKeyring,620 * 10,621 * {622 * sponsorTransferTimeout: 0,623 * ownerCanDestroy: false624 * }625 * )626 * @returns ```true``` if extrinsic success, otherwise ```false```627 */628 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {629 const result = await this.helper.executeExtrinsic(630 signer,631 'api.tx.unique.setCollectionLimits', [collectionId, limits],632 true,633 );634635 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');636 }637638 /**639 * Changes the owner of the collection to the new Substrate address.640 * 641 * @param signer keyring of signer642 * @param collectionId ID of collection643 * @param ownerAddress substrate address of new owner644 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")645 * @returns ```true``` if extrinsic success, otherwise ```false```646 */647 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {648 const result = await this.helper.executeExtrinsic(649 signer,650 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],651 true,652 );653654 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');655 }656657 /**658 * Adds a collection administrator. 659 * 660 * @param signer keyring of signer661 * @param collectionId ID of collection662 * @param adminAddressObj Administrator address (substrate or ethereum)663 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})664 * @returns ```true``` if extrinsic success, otherwise ```false```665 */666 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {667 const result = await this.helper.executeExtrinsic(668 signer,669 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],670 true,671 );672673 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');674 }675676 /**677 * Removes a collection administrator.678 * 679 * @param signer keyring of signer680 * @param collectionId ID of collection681 * @param adminAddressObj Administrator address (substrate or ethereum)682 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})683 * @returns ```true``` if extrinsic success, otherwise ```false```684 */685 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {686 const result = await this.helper.executeExtrinsic(687 signer,688 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],689 true,690 );691692 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');693 }694695 /**696 * Adds an address to allow list 697 * @param signer keyring of signer698 * @param collectionId ID of collection699 * @param addressObj address to add to the allow list700 * @returns ```true``` if extrinsic success, otherwise ```false```701 */702 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {703 const result = await this.helper.executeExtrinsic(704 signer,705 'api.tx.unique.addToAllowList', [collectionId, addressObj],706 true,707 );708709 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');710 }711712 /**713 * Removes an address from allow list 714 * 715 * @param signer keyring of signer716 * @param collectionId ID of collection717 * @param addressObj address to remove from the allow list718 * @returns ```true``` if extrinsic success, otherwise ```false```719 */720 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {721 const result = await this.helper.executeExtrinsic(722 signer,723 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],724 true,725 );726727 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');728 }729730 /**731 * Sets onchain permissions for selected collection.732 * 733 * @param signer keyring of signer734 * @param collectionId ID of collection735 * @param permissions collection permissions object736 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});737 * @returns ```true``` if extrinsic success, otherwise ```false```738 */739 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {740 const result = await this.helper.executeExtrinsic(741 signer,742 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],743 true,744 );745746 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');747 }748749 /**750 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.751 * 752 * @param signer keyring of signer753 * @param collectionId ID of collection754 * @param permissions nesting permissions object755 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});756 * @returns ```true``` if extrinsic success, otherwise ```false```757 */758 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {759 return await this.setPermissions(signer, collectionId, {nesting: permissions});760 }761762 /**763 * Disables nesting for selected collection.764 * 765 * @param signer keyring of signer766 * @param collectionId ID of collection767 * @example disableNesting(aliceKeyring, 10);768 * @returns ```true``` if extrinsic success, otherwise ```false```769 */770 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {771 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});772 }773774 /**775 * Sets onchain properties to the collection.776 * 777 * @param signer keyring of signer778 * @param collectionId ID of collection779 * @param properties array of property objects780 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);781 * @returns ```true``` if extrinsic success, otherwise ```false```782 */783 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {784 const result = await this.helper.executeExtrinsic(785 signer,786 'api.tx.unique.setCollectionProperties', [collectionId, properties],787 true,788 );789790 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');791 }792793 /**794 * Deletes onchain properties from the collection.795 * 796 * @param signer keyring of signer797 * @param collectionId ID of collection798 * @param propertyKeys array of property keys to delete799 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);800 * @returns ```true``` if extrinsic success, otherwise ```false```801 */802 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {803 const result = await this.helper.executeExtrinsic(804 signer,805 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],806 true,807 );808809 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');810 }811812 /**813 * Changes the owner of the token.814 * 815 * @param signer keyring of signer816 * @param collectionId ID of collection817 * @param tokenId ID of token818 * @param addressObj address of a new owner819 * @param amount amount of tokens to be transfered. For NFT must be set to 1n820 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})821 * @returns true if the token success, otherwise false822 */823 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {824 const result = await this.helper.executeExtrinsic(825 signer,826 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],827 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,828 );829830 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);831 }832833 /**834 * 835 * Change ownership of a token(s) on behalf of the owner. 836 * 837 * @param signer keyring of signer838 * @param collectionId ID of collection839 * @param tokenId ID of token840 * @param fromAddressObj address on behalf of which the token will be sent841 * @param toAddressObj new token owner842 * @param amount amount of tokens to be transfered. For NFT must be set to 1n843 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})844 * @returns true if the token success, otherwise false845 */846 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {847 const result = await this.helper.executeExtrinsic(848 signer,849 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],850 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,851 );852 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);853 }854855 /**856 * 857 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.858 * 859 * @param signer keyring of signer860 * @param collectionId ID of collection861 * @param tokenId ID of token862 * @param amount amount of tokens to be burned. For NFT must be set to 1n863 * @example burnToken(aliceKeyring, 10, 5);864 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```865 */866 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<{867 success: boolean,868 token: number | null869 }> {870 const burnResult = await this.helper.executeExtrinsic(871 signer,872 'api.tx.unique.burnItem', [collectionId, tokenId, amount],873 true, // `Unable to burn token for ${label}`,874 );875 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);876 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');877 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};878 }879880 /**881 * Destroys a concrete instance of NFT on behalf of the owner882 * 883 * @param signer keyring of signer884 * @param collectionId ID of collection885 * @param fromAddressObj address on behalf of which the token will be burnt886 * @param tokenId ID of token887 * @param amount amount of tokens to be burned. For NFT must be set to 1n888 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})889 * @returns ```true``` if extrinsic success, otherwise ```false```890 */891 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, amount=1n): Promise<boolean> {892 const burnResult = await this.helper.executeExtrinsic(893 signer,894 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],895 true, // `Unable to burn token from for ${label}`,896 );897 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);898 return burnedTokens.success && burnedTokens.tokens.length > 0;899 }900901 /**902 * Set, change, or remove approved address to transfer the ownership of the NFT.903 * 904 * @param signer keyring of signer905 * @param collectionId ID of collection906 * @param tokenId ID of token907 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens908 * @param amount amount of token to be approved. For NFT must be set to 1n909 * @returns ```true``` if extrinsic success, otherwise ```false```910 */911 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {912 const approveResult = await this.helper.executeExtrinsic(913 signer, 914 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],915 true, // `Unable to approve token for ${label}`,916 );917918 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');919 }920921 /**922 * Get the amount of token pieces approved to transfer or burn. Normally 0.923 * 924 * @param collectionId ID of collection925 * @param tokenId ID of token926 * @param toAccountObj address which is approved to use token pieces927 * @param fromAccountObj address which may have allowed the use of its owned tokens928 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})929 * @returns number of approved to transfer pieces930 */931 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {932 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();933 }934935 /**936 * Get the last created token ID in a collection937 * 938 * @param collectionId ID of collection939 * @example getLastTokenId(10);940 * @returns id of the last created token941 */942 async getLastTokenId(collectionId: number): Promise<number> {943 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();944 }945946 /**947 * Check if token exists948 * 949 * @param collectionId ID of collection950 * @param tokenId ID of token951 * @example isTokenExists(10, 20);952 * @returns true if the token exists, otherwise false953 */954 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {955 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();956 }957}958959class NFTnRFT extends CollectionGroup {960 /**961 * Get tokens owned by account962 * 963 * @param collectionId ID of collection964 * @param addressObj tokens owner965 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})966 * @returns array of token ids owned by account967 */968 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {969 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();970 }971972 /**973 * Get token data974 * 975 * @param collectionId ID of collection976 * @param tokenId ID of token977 * @param propertyKeys optionally filter the token properties to only these keys978 * @param blockHashAt optionally query the data at some block with this hash979 * @example getToken(10, 5);980 * @returns human readable token data 981 */982 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{983 properties: IProperty[];984 owner: ICrossAccountId;985 normalizedOwner: ICrossAccountId;986 }| null> {987 let tokenData;988 if(typeof blockHashAt === 'undefined') {989 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);990 }991 else {992 if(propertyKeys.length == 0) {993 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();994 if(!collection) return null;995 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);996 }997 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);998 }999 tokenData = tokenData.toHuman();1000 if (tokenData === null || tokenData.owner === null) return null;1001 const owner = {} as any;1002 for (const key of Object.keys(tokenData.owner)) {1003 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1004 }1005 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1006 return tokenData;1007 }10081009 /**1010 * Set permissions to change token properties1011 * 1012 * @param signer keyring of signer1013 * @param collectionId ID of collection1014 * @param permissions permissions to change a property by the collection owner or admin1015 * @example setTokenPropertyPermissions(1016 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1017 * )1018 * @returns true if extrinsic success otherwise false1019 */1020 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1021 const result = await this.helper.executeExtrinsic(1022 signer,1023 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1024 true,1025 );10261027 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1028 }10291030 /**1031 * Set token properties1032 * 1033 * @param signer keyring of signer1034 * @param collectionId ID of collection1035 * @param tokenId ID of token1036 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1037 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1038 * @returns ```true``` if extrinsic success, otherwise ```false```1039 */1040 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1041 const result = await this.helper.executeExtrinsic(1042 signer,1043 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1044 true,1045 );10461047 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1048 }10491050 /**1051 * Delete the provided properties of a token1052 * @param signer keyring of signer1053 * @param collectionId ID of collection1054 * @param tokenId ID of token1055 * @param propertyKeys property keys to be deleted 1056 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1057 * @returns ```true``` if extrinsic success, otherwise ```false```1058 */1059 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1060 const result = await this.helper.executeExtrinsic(1061 signer,1062 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1063 true,1064 );10651066 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1067 }10681069 /**1070 * Mint new collection1071 * 1072 * @param signer keyring of signer1073 * @param collectionOptions basic collection options and properties 1074 * @param mode NFT or RFT type of a collection1075 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1076 * @returns object of the created collection1077 */1078 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueCollectionBase> {1079 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1080 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1081 for (const key of ['name', 'description', 'tokenPrefix']) {1082 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);1083 }1084 const creationResult = await this.helper.executeExtrinsic(1085 signer,1086 'api.tx.unique.createCollectionEx', [collectionOptions],1087 true, // errorLabel,1088 );1089 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1090 }10911092 getCollectionObject(_collectionId: number): any {1093 return null;1094 }10951096 getTokenObject(_collectionId: number, _tokenId: number): any {1097 return null;1098 }1099}110011011102class NFTGroup extends NFTnRFT {1103 /**1104 * Get collection object1105 * @param collectionId ID of collection1106 * @example getCollectionObject(2);1107 * @returns instance of UniqueNFTCollection1108 */1109 getCollectionObject(collectionId: number): UniqueNFTCollection {1110 return new UniqueNFTCollection(collectionId, this.helper);1111 }11121113 /**1114 * Get token object1115 * @param collectionId ID of collection1116 * @param tokenId ID of token1117 * @example getTokenObject(10, 5);1118 * @returns instance of UniqueNFTToken1119 */1120 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1121 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1122 }11231124 /**1125 * Get token's owner1126 * @param collectionId ID of collection1127 * @param tokenId ID of token1128 * @param blockHashAt optionally query the data at the block with this hash1129 * @example getTokenOwner(10, 5);1130 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1131 */1132 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1133 let owner;1134 if (typeof blockHashAt === 'undefined') {1135 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1136 } else {1137 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1138 }1139 return crossAccountIdFromLower(owner.toJSON());1140 }11411142 /**1143 * Is token approved to transfer1144 * @param collectionId ID of collection1145 * @param tokenId ID of token1146 * @param toAccountObj address to be approved1147 * @returns ```true``` if extrinsic success, otherwise ```false```1148 */1149 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1150 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1151 }11521153 /**1154 * Changes the owner of the token.1155 * 1156 * @param signer keyring of signer1157 * @param collectionId ID of collection1158 * @param tokenId ID of token1159 * @param addressObj address of a new owner1160 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1161 * @returns ```true``` if extrinsic success, otherwise ```false```1162 */1163 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1164 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1165 }11661167 /**1168 * 1169 * Change ownership of a NFT on behalf of the owner. 1170 * 1171 * @param signer keyring of signer1172 * @param collectionId ID of collection1173 * @param tokenId ID of token1174 * @param fromAddressObj address on behalf of which the token will be sent1175 * @param toAddressObj new token owner1176 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1177 * @returns ```true``` if extrinsic success, otherwise ```false```1178 */1179 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1180 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1181 }11821183 /**1184 * Recursively find the address that owns the token1185 * @param collectionId ID of collection1186 * @param tokenId ID of token1187 * @param blockHashAt 1188 * @example getTokenTopmostOwner(10, 5);1189 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1190 */1191 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1192 let owner;1193 if (typeof blockHashAt === 'undefined') {1194 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1195 } else {1196 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1197 }11981199 if (owner === null) return null;12001201 owner = owner.toHuman();12021203 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1204 }12051206 /**1207 * Get tokens nested in the provided token1208 * @param collectionId ID of collection1209 * @param tokenId ID of token1210 * @param blockHashAt optionally query the data at the block with this hash1211 * @example getTokenChildren(10, 5);1212 * @returns tokens whose depth of nesting is <= 5 1213 */1214 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1215 let children;1216 if(typeof blockHashAt === 'undefined') {1217 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1218 } else {1219 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1220 }12211222 return children.toJSON().map((x: any) => {1223 return {collectionId: x.collection, tokenId: x.token};1224 });1225 }12261227 /**1228 * Nest one token into another1229 * @param signer keyring of signer1230 * @param tokenObj token to be nested1231 * @param rootTokenObj token to be parent1232 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1233 * @returns ```true``` if extrinsic success, otherwise ```false```1234 */1235 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1236 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1237 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1238 if(!result) {1239 throw Error('Unable to nest token!');1240 }1241 return result;1242 }12431244 /**1245 * Remove token from nested state1246 * @param signer keyring of signer1247 * @param tokenObj token to unnest1248 * @param rootTokenObj parent of a token1249 * @param toAddressObj address of a new token owner 1250 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1251 * @returns ```true``` if extrinsic success, otherwise ```false```1252 */1253 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1254 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1255 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1256 if(!result) {1257 throw Error('Unable to unnest token!');1258 }1259 return result;1260 }12611262 /**1263 * Mint new collection1264 * @param signer keyring of signer1265 * @param collectionOptions Collection options1266 * @example 1267 * mintCollection(aliceKeyring, {1268 * name: 'New',1269 * description: 'New collection',1270 * tokenPrefix: 'NEW',1271 * })1272 * @returns object of the created collection1273 */1274 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueNFTCollection> {1275 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1276 }12771278 /**1279 * Mint new token1280 * @param signer keyring of signer1281 * @param data token data1282 * @returns created token object1283 */1284 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFTToken> {1285 const creationResult = await this.helper.executeExtrinsic(1286 signer,1287 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1288 nft: {1289 properties: data.properties,1290 },1291 }],1292 true,1293 );1294 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1295 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1296 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1297 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1298 }12991300 /**1301 * Mint multiple NFT tokens1302 * @param signer keyring of signer1303 * @param collectionId ID of collection1304 * @param tokens array of tokens with owner and properties1305 * @example 1306 * mintMultipleTokens(aliceKeyring, 10, [{1307 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1308 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1309 * },{1310 * owner: {Ethereum: "0x9F0583DbB855d..."},1311 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1312 * }]);1313 * @returns ```true``` if extrinsic success, otherwise ```false```1314 */1315 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1316 const creationResult = await this.helper.executeExtrinsic(1317 signer,1318 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1319 true,1320 );1321 const collection = this.getCollectionObject(collectionId);1322 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1323 }13241325 /**1326 * Mint multiple NFT tokens with one owner1327 * @param signer keyring of signer1328 * @param collectionId ID of collection1329 * @param owner tokens owner1330 * @param tokens array of tokens with owner and properties1331 * @example1332 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1333 * properties: [{1334 * key: "gender",1335 * value: "female",1336 * },{1337 * key: "age",1338 * value: "33",1339 * }],1340 * }]);1341 * @returns array of newly created tokens1342 */1343 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1344 const rawTokens = [];1345 for (const token of tokens) {1346 const raw = {NFT: {properties: token.properties}};1347 rawTokens.push(raw);1348 }1349 const creationResult = await this.helper.executeExtrinsic(1350 signer,1351 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1352 true,1353 );1354 const collection = this.getCollectionObject(collectionId);1355 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1356 }13571358 /**1359 * Destroys a concrete instance of NFT.1360 * @param signer keyring of signer1361 * @param collectionId ID of collection1362 * @param tokenId ID of token1363 * @example burnToken(aliceKeyring, 10, 5);1364 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1365 */1366 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number): Promise<{ success: boolean; token: number | null; }> {1367 return await super.burnToken(signer, collectionId, tokenId, 1n);1368 }13691370 /**1371 * Set, change, or remove approved address to transfer the ownership of the NFT.1372 * 1373 * @param signer keyring of signer1374 * @param collectionId ID of collection1375 * @param tokenId ID of token1376 * @param toAddressObj address to approve1377 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1378 * @returns ```true``` if extrinsic success, otherwise ```false```1379 */1380 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1381 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1382 }1383}138413851386class RFTGroup extends NFTnRFT {1387 /**1388 * Get collection object1389 * @param collectionId ID of collection1390 * @example getCollectionObject(2);1391 * @returns instance of UniqueRFTCollection1392 */1393 getCollectionObject(collectionId: number): UniqueRFTCollection {1394 return new UniqueRFTCollection(collectionId, this.helper);1395 }13961397 /**1398 * Get token object1399 * @param collectionId ID of collection1400 * @param tokenId ID of token1401 * @example getTokenObject(10, 5);1402 * @returns instance of UniqueNFTToken1403 */1404 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1405 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1406 }14071408 /**1409 * Get top 10 token owners with the largest number of pieces 1410 * @param collectionId ID of collection1411 * @param tokenId ID of token1412 * @example getTokenTop10Owners(10, 5);1413 * @returns array of top 10 owners1414 */1415 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1416 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1417 }14181419 /**1420 * Get number of pieces owned by address1421 * @param collectionId ID of collection1422 * @param tokenId ID of token1423 * @param addressObj address token owner1424 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1425 * @returns number of pieces ownerd by address1426 */1427 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1428 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1429 }14301431 /**1432 * Transfer pieces of token to another address1433 * @param signer keyring of signer1434 * @param collectionId ID of collection1435 * @param tokenId ID of token1436 * @param addressObj address of a new owner1437 * @param amount number of pieces to be transfered1438 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1439 * @returns ```true``` if extrinsic success, otherwise ```false```1440 */1441 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1442 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1443 }14441445 /**1446 * Change ownership of some pieces of RFT on behalf of the owner. 1447 * @param signer keyring of signer1448 * @param collectionId ID of collection1449 * @param tokenId ID of token1450 * @param fromAddressObj address on behalf of which the token will be sent1451 * @param toAddressObj new token owner1452 * @param amount number of pieces to be transfered1453 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1454 * @returns ```true``` if extrinsic success, otherwise ```false```1455 */1456 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1457 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1458 }14591460 /**1461 * Mint new collection1462 * @param signer keyring of signer1463 * @param collectionOptions Collection options1464 * @example1465 * mintCollection(aliceKeyring, {1466 * name: 'New',1467 * description: 'New collection',1468 * tokenPrefix: 'NEW',1469 * })1470 * @returns object of the created collection1471 */1472 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueRFTCollection> {1473 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1474 }14751476 /**1477 * Mint new token1478 * @param signer keyring of signer1479 * @param data token data1480 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1481 * @returns created token object1482 */1483 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFTToken> {1484 const creationResult = await this.helper.executeExtrinsic(1485 signer,1486 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1487 refungible: {1488 pieces: data.pieces,1489 properties: data.properties,1490 },1491 }],1492 true,1493 );1494 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1495 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1496 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1497 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1498 }14991500 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1501 throw Error('Not implemented');1502 const creationResult = await this.helper.executeExtrinsic(1503 signer,1504 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1505 true, // `Unable to mint RFT tokens for ${label}`,1506 );1507 const collection = this.getCollectionObject(collectionId);1508 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1509 }15101511 /**1512 * Mint multiple RFT tokens with one owner1513 * @param signer keyring of signer1514 * @param collectionId ID of collection1515 * @param owner tokens owner1516 * @param tokens array of tokens with properties and pieces1517 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1518 * @returns array of newly created RFT tokens1519 */1520 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1521 const rawTokens = [];1522 for (const token of tokens) {1523 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1524 rawTokens.push(raw);1525 }1526 const creationResult = await this.helper.executeExtrinsic(1527 signer,1528 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1529 true,1530 );1531 const collection = this.getCollectionObject(collectionId);1532 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1533 }15341535 /**1536 * Destroys a concrete instance of RFT.1537 * @param signer keyring of signer1538 * @param collectionId ID of collection1539 * @param tokenId ID of token1540 * @param amount number of pieces to be burnt1541 * @example burnToken(aliceKeyring, 10, 5);1542 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1543 */1544 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<{ success: boolean; token: number | null; }> {1545 return await super.burnToken(signer, collectionId, tokenId, amount);1546 }15471548 /**1549 * Set, change, or remove approved address to transfer the ownership of the RFT.1550 * 1551 * @param signer keyring of signer1552 * @param collectionId ID of collection1553 * @param tokenId ID of token1554 * @param toAddressObj address to approve1555 * @param amount number of pieces to be approved1556 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1557 * @returns true if the token success, otherwise false1558 */1559 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1560 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1561 }15621563 /**1564 * Get total number of pieces1565 * @param collectionId ID of collection1566 * @param tokenId ID of token1567 * @example getTokenTotalPieces(10, 5);1568 * @returns number of pieces1569 */1570 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1571 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1572 }15731574 /**1575 * Change number of token pieces. Signer must be the owner of all token pieces.1576 * @param signer keyring of signer1577 * @param collectionId ID of collection1578 * @param tokenId ID of token1579 * @param amount new number of pieces1580 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1581 * @returns true if the repartion was success, otherwise false1582 */1583 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1584 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1585 const repartitionResult = await this.helper.executeExtrinsic(1586 signer,1587 'api.tx.unique.repartition', [collectionId, tokenId, amount],1588 true,1589 );1590 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1591 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1592 }1593}159415951596class FTGroup extends CollectionGroup {1597 /**1598 * Get collection object1599 * @param collectionId ID of collection1600 * @example getCollectionObject(2);1601 * @returns instance of UniqueFTCollection1602 */1603 getCollectionObject(collectionId: number): UniqueFTCollection {1604 return new UniqueFTCollection(collectionId, this.helper);1605 }16061607 /**1608 * Mint new fungible collection1609 * @param signer keyring of signer1610 * @param collectionOptions Collection options1611 * @param decimalPoints number of token decimals 1612 * @example1613 * mintCollection(aliceKeyring, {1614 * name: 'New',1615 * description: 'New collection',1616 * tokenPrefix: 'NEW',1617 * }, 18)1618 * @returns newly created fungible collection1619 */1620 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0): Promise<UniqueFTCollection> {1621 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1622 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1623 collectionOptions.mode = {fungible: decimalPoints};1624 for (const key of ['name', 'description', 'tokenPrefix']) {1625 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);1626 }1627 const creationResult = await this.helper.executeExtrinsic(1628 signer,1629 'api.tx.unique.createCollectionEx', [collectionOptions],1630 true,1631 );1632 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1633 }16341635 /**1636 * Mint tokens1637 * @param signer keyring of signer1638 * @param collectionId ID of collection1639 * @param owner address owner of new tokens1640 * @param amount amount of tokens to be meanted1641 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1642 * @returns ```true``` if extrinsic success, otherwise ```false``` 1643 */1644 async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint): Promise<boolean> {1645 const creationResult = await this.helper.executeExtrinsic(1646 signer,1647 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1648 fungible: {1649 value: amount,1650 },1651 }],1652 true, // `Unable to mint fungible tokens for ${label}`,1653 );1654 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1655 }16561657 /**1658 * Mint multiple Fungible tokens with one owner1659 * @param signer keyring of signer1660 * @param collectionId ID of collection1661 * @param owner tokens owner1662 * @param tokens array of tokens with properties and pieces1663 * @returns ```true``` if extrinsic success, otherwise ```false``` 1664 */1665 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[]): Promise<boolean> {1666 const rawTokens = [];1667 for (const token of tokens) {1668 const raw = {Fungible: {Value: token.value}};1669 rawTokens.push(raw);1670 }1671 const creationResult = await this.helper.executeExtrinsic(1672 signer,1673 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1674 true,1675 );1676 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1677 }16781679 /**1680 * Get the top 10 owners with the largest balance for the Fungible collection 1681 * @param collectionId ID of collection1682 * @example getTop10Owners(10);1683 * @returns array of ```ICrossAccountId```1684 */1685 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1686 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1687 }16881689 /**1690 * Get account balance1691 * @param collectionId ID of collection1692 * @param addressObj address of owner1693 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1694 * @returns amount of fungible tokens owned by address1695 */1696 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1697 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1698 }16991700 /**1701 * Transfer tokens to address1702 * @param signer keyring of signer1703 * @param collectionId ID of collection1704 * @param toAddressObj address recipient1705 * @param amount amount of tokens to be sent1706 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1707 * @returns ```true``` if extrinsic success, otherwise ```false``` 1708 */1709 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1710 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1711 }17121713 /**1714 * Transfer some tokens on behalf of the owner.1715 * @param signer keyring of signer1716 * @param collectionId ID of collection1717 * @param fromAddressObj address on behalf of which tokens will be sent1718 * @param toAddressObj address where token to be sent1719 * @param amount number of tokens to be sent1720 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1721 * @returns ```true``` if extrinsic success, otherwise ```false``` 1722 */1723 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1724 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1725 }17261727 /**1728 * Destroy some amount of tokens1729 * @param signer keyring of signer1730 * @param collectionId ID of collection1731 * @param amount amount of tokens to be destroyed1732 * @example burnTokens(aliceKeyring, 10, 1000n);1733 * @returns ```true``` if extrinsic success, otherwise ```false``` 1734 */1735 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1736 return (await super.burnToken(signer, collectionId, 0, amount)).success;1737 }17381739 /**1740 * Burn some tokens on behalf of the owner.1741 * @param signer keyring of signer1742 * @param collectionId ID of collection1743 * @param fromAddressObj address on behalf of which tokens will be burnt1744 * @param amount amount of tokens to be burnt1745 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1746 * @returns ```true``` if extrinsic success, otherwise ```false``` 1747 */1748 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1749 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, amount);1750 }17511752 /**1753 * Get total collection supply1754 * @param collectionId 1755 * @returns 1756 */1757 async getTotalPieces(collectionId: number): Promise<bigint> {1758 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1759 }17601761 /**1762 * Set, change, or remove approved address to transfer tokens.1763 * 1764 * @param signer keyring of signer1765 * @param collectionId ID of collection1766 * @param toAddressObj address to be approved1767 * @param amount amount of tokens to be approved1768 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1769 * @returns ```true``` if extrinsic success, otherwise ```false``` 1770 */1771 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1772 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1773 }17741775 /**1776 * Get amount of fungible tokens approved to transfer1777 * @param collectionId ID of collection1778 * @param fromAddressObj owner of tokens1779 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1780 * @returns number of tokens approved for the transfer1781 */1782 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1783 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1784 }1785}178617871788class ChainGroup extends HelperGroup {1789 /**1790 * Get system properties of a chain1791 * @example getChainProperties();1792 * @returns ss58Format, token decimals, and token symbol1793 */1794 getChainProperties(): IChainProperties {1795 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1796 return {1797 ss58Format: properties.ss58Format.toJSON(),1798 tokenDecimals: properties.tokenDecimals.toJSON(),1799 tokenSymbol: properties.tokenSymbol.toJSON(),1800 };1801 }18021803 /**1804 * Get chain header1805 * @example getLatestBlockNumber();1806 * @returns the number of the last block1807 */1808 async getLatestBlockNumber(): Promise<number> {1809 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1810 }18111812 /**1813 * Get block hash by block number1814 * @param blockNumber number of block1815 * @example getBlockHashByNumber(12345);1816 * @returns hash of a block1817 */1818 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1819 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1820 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1821 return blockHash;1822 }18231824 /**1825 * Get account nonce1826 * @param address substrate address1827 * @example getNonce("5GrwvaEF5zXb26Fz...");1828 * @returns number, account's nonce1829 */1830 async getNonce(address: TSubstrateAccount): Promise<number> {1831 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1832 }1833}183418351836class BalanceGroup extends HelperGroup {1837 /**1838 * Representation of the native token in the smallest unit1839 * @example getOneTokenNominal()1840 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1841 */1842 getOneTokenNominal(): bigint {1843 const chainProperties = this.helper.chain.getChainProperties();1844 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1845 }18461847 /**1848 * Get substrate address balance1849 * @param address substrate address1850 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1851 * @returns amount of tokens on address1852 */1853 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1854 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1855 }18561857 /**1858 * Get ethereum address balance1859 * @param address ethereum address1860 * @example getEthereum("0x9F0583DbB855d...")1861 * @returns amount of tokens on address1862 */1863 async getEthereum(address: TEthereumAccount): Promise<bigint> {1864 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1865 }18661867 /**1868 * Transfer tokens to substrate address1869 * @param signer keyring of signer1870 * @param address substrate address of a recipient1871 * @param amount amount of tokens to be transfered1872 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1873 * @returns ```true``` if extrinsic success, otherwise ```false```1874 */1875 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1876 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}`*/);18771878 let transfer = {from: null, to: null, amount: 0n} as any;1879 result.result.events.forEach(({event: {data, method, section}}) => {1880 if ((section === 'balances') && (method === 'Transfer')) {1881 transfer = {1882 from: this.helper.address.normalizeSubstrate(data[0]),1883 to: this.helper.address.normalizeSubstrate(data[1]),1884 amount: BigInt(data[2]),1885 };1886 }1887 });1888 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1889 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1890 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1891 return isSuccess;1892 }1893}189418951896class AddressGroup extends HelperGroup {1897 /**1898 * Normalizes the address to the specified ss58 format, by default ```42```.1899 * @param address substrate address1900 * @param ss58Format format for address conversion, by default ```42```1901 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1902 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1903 */1904 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1905 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1906 }19071908 /**1909 * Get address in the connected chain format1910 * @param address substrate address1911 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1912 * @returns address in chain format1913 */1914 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1915 const info = this.helper.chain.getChainProperties();1916 return encodeAddress(decodeAddress(address), info.ss58Format);1917 }19181919 /**1920 * Get substrate mirror of an ethereum address1921 * @param ethAddress ethereum address1922 * @param toChainFormat false for normalized account1923 * @example ethToSubstrate('0x9F0583DbB855d...')1924 * @returns substrate mirror of a provided ethereum address1925 */1926 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1927 if(!toChainFormat) return evmToAddress(ethAddress);1928 const info = this.helper.chain.getChainProperties();1929 return evmToAddress(ethAddress, info.ss58Format);1930 }19311932 /**1933 * Get ethereum mirror of a substrate address1934 * @param subAddress substrate account1935 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1936 * @returns ethereum mirror of a provided substrate address1937 */1938 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1939 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1940 }1941}194219431944export class UniqueHelper extends ChainHelperBase {1945 chain: ChainGroup;1946 balance: BalanceGroup;1947 address: AddressGroup;1948 collection: CollectionGroup;1949 nft: NFTGroup;1950 rft: RFTGroup;1951 ft: FTGroup;19521953 constructor(logger?: ILogger) {1954 super(logger);1955 this.chain = new ChainGroup(this);1956 this.balance = new BalanceGroup(this);1957 this.address = new AddressGroup(this);1958 this.collection = new CollectionGroup(this);1959 this.nft = new NFTGroup(this);1960 this.rft = new RFTGroup(this);1961 this.ft = new FTGroup(this);1962 } 1963}196419651966class UniqueCollectionBase {1967 helper: UniqueHelper;1968 collectionId: number;19691970 constructor(collectionId: number, uniqueHelper: UniqueHelper) {1971 this.collectionId = collectionId;1972 this.helper = uniqueHelper;1973 }19741975 async getData() {1976 return await this.helper.collection.getData(this.collectionId);1977 }19781979 async getLastTokenId() {1980 return await this.helper.collection.getLastTokenId(this.collectionId);1981 }19821983 async isTokenExists(tokenId: number) {1984 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);1985 }19861987 async getAdmins() {1988 return await this.helper.collection.getAdmins(this.collectionId);1989 }19901991 async getAllowList() {1992 return await this.helper.collection.getAllowList(this.collectionId);1993 }19941995 async getEffectiveLimits() {1996 return await this.helper.collection.getEffectiveLimits(this.collectionId);1997 }19981999 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2000 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2001 }20022003 async confirmSponsorship(signer: TSigner) {2004 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2005 }20062007 async setLimits(signer: TSigner, limits: ICollectionLimits) {2008 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2009 }20102011 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2012 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2013 }20142015 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2016 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2017 }20182019 async enableAllowList(signer: TSigner, value = true/*: 'Normal' | 'AllowList' = 'AllowList'*/) {2020 return await this.setPermissions(signer, value ? {access: 'AllowList', mintMode: true} : {access: 'Normal'});2021 }20222023 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2024 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2025 }20262027 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2028 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2029 }20302031 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2032 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2033 }20342035 async setProperties(signer: TSigner, properties: IProperty[]) {2036 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2037 }20382039 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2040 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2041 }20422043 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2044 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2045 }20462047 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2048 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2049 }20502051 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2052 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2053 }20542055 async disableNesting(signer: TSigner) {2056 return await this.helper.collection.disableNesting(signer, this.collectionId);2057 }20582059 async burn(signer: TSigner) {2060 return await this.helper.collection.burn(signer, this.collectionId);2061 }2062}206320642065class UniqueNFTCollection extends UniqueCollectionBase {2066 getTokenObject(tokenId: number) {2067 return new UniqueNFTToken(tokenId, this);2068 }20692070 async getTokensByAddress(addressObj: ICrossAccountId) {2071 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2072 }20732074 async getToken(tokenId: number, blockHashAt?: string) {2075 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2076 }20772078 async getTokenOwner(tokenId: number, blockHashAt?: string) {2079 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2080 }20812082 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2083 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2084 }20852086 async getTokenChildren(tokenId: number, blockHashAt?: string) {2087 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2088 }20892090 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2091 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2092 }20932094 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2095 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2096 }20972098 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2099 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2100 }21012102 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2103 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2104 }21052106 async mintToken(signer: TSigner, owner: ICrossAccountId, properties?: IProperty[]) {2107 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2108 }21092110 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2111 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2112 }21132114 async burnToken(signer: TSigner, tokenId: number) {2115 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2116 }21172118 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2119 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2120 }21212122 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2123 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2124 }21252126 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2127 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2128 }21292130 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2131 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2132 }21332134 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2135 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2136 }2137}213821392140class UniqueRFTCollection extends UniqueCollectionBase {2141 getTokenObject(tokenId: number) {2142 return new UniqueRFTToken(tokenId, this);2143 }21442145 async getTokensByAddress(addressObj: ICrossAccountId) {2146 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2147 }21482149 async getTop10TokenOwners(tokenId: number) {2150 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2151 }21522153 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2154 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2155 }21562157 async getTokenTotalPieces(tokenId: number) {2158 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2159 }21602161 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2162 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2163 }21642165 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2166 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2167 }21682169 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2170 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2171 }21722173 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2174 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2175 }21762177 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2178 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2179 }21802181 async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[]) {2182 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2183 }21842185 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]) {2186 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2187 }21882189 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2190 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2191 }21922193 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2194 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2195 }21962197 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2198 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2199 }22002201 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2202 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2203 }2204}220522062207class UniqueFTCollection extends UniqueCollectionBase {2208 async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint) {2209 return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount);2210 }22112212 async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[]) {2213 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens);2214 }22152216 async getBalance(addressObj: ICrossAccountId) {2217 return await this.helper.ft.getBalance(this.collectionId, addressObj);2218 }22192220 async getTop10Owners() {2221 return await this.helper.ft.getTop10Owners(this.collectionId);2222 }22232224 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2225 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2226 }22272228 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2229 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2230 }22312232 async burnTokens(signer: TSigner, amount=1n) {2233 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2234 }22352236 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2237 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2238 }22392240 async getTotalPieces() {2241 return await this.helper.ft.getTotalPieces(this.collectionId);2242 }22432244 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2245 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2246 }22472248 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2249 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2250 }2251}225222532254class UniqueTokenBase implements IToken {2255 collection: UniqueNFTCollection | UniqueRFTCollection;2256 collectionId: number;2257 tokenId: number;22582259 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2260 this.collection = collection;2261 this.collectionId = collection.collectionId;2262 this.tokenId = tokenId;2263 }22642265 async getNextSponsored(addressObj: ICrossAccountId) {2266 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2267 }22682269 async setProperties(signer: TSigner, properties: IProperty[]) {2270 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2271 }22722273 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2274 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2275 }2276}227722782279class UniqueNFTToken extends UniqueTokenBase {2280 collection: UniqueNFTCollection;22812282 constructor(tokenId: number, collection: UniqueNFTCollection) {2283 super(tokenId, collection);2284 this.collection = collection;2285 }22862287 async getData(blockHashAt?: string) {2288 return await this.collection.getToken(this.tokenId, blockHashAt);2289 }22902291 async getOwner(blockHashAt?: string) {2292 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2293 }22942295 async getTopmostOwner(blockHashAt?: string) {2296 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2297 }22982299 async getChildren(blockHashAt?: string) {2300 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2301 }23022303 async nest(signer: TSigner, toTokenObj: IToken) {2304 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2305 }23062307 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2308 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2309 }23102311 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2312 return await this.collection.transferToken(signer, this.tokenId, addressObj);2313 }23142315 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2316 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2317 }23182319 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2320 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2321 }23222323 async isApproved(toAddressObj: ICrossAccountId) {2324 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2325 }23262327 async burn(signer: TSigner) {2328 return await this.collection.burnToken(signer, this.tokenId);2329 }2330}23312332class UniqueRFTToken extends UniqueTokenBase {2333 collection: UniqueRFTCollection;23342335 constructor(tokenId: number, collection: UniqueRFTCollection) {2336 super(tokenId, collection);2337 this.collection = collection;2338 }23392340 async getTop10Owners() {2341 return await this.collection.getTop10TokenOwners(this.tokenId);2342 }23432344 async getBalance(addressObj: ICrossAccountId) {2345 return await this.collection.getTokenBalance(this.tokenId, addressObj);2346 }23472348 async getTotalPieces() {2349 return await this.collection.getTokenTotalPieces(this.tokenId);2350 }23512352 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2353 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2354 }23552356 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2357 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2358 }23592360 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2361 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2362 }23632364 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2365 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2366 }23672368 async repartition(signer: TSigner, amount: bigint) {2369 return await this.collection.repartitionToken(signer, this.tokenId, amount);2370 }23712372 async burn(signer: TSigner, amount=1n) {2373 return await this.collection.burnToken(signer, this.tokenId, amount);2374 }2375}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314export const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};2021const nesting = {22 toChecksumAddress(address: string): string {23 if (typeof address === 'undefined') return '';2425 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2627 address = address.toLowerCase().replace(/^0x/i,'');28 const addressHash = keccakAsHex(address).replace(/^0x/i,'');29 const checksumAddress = ['0x'];3031 for (let i = 0; i < address.length; i++) {32 // If ith character is 8 to f then make it uppercase33 if (parseInt(addressHash[i], 16) > 7) {34 checksumAddress.push(address[i].toUpperCase());35 } else {36 checksumAddress.push(address[i]);37 }38 }39 return checksumAddress.join('');40 },41 tokenIdToAddress(collectionId: number, tokenId: number) {42 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);43 },44};4546class UniqueUtil {47 static transactionStatus = {48 NOT_READY: 'NotReady',49 FAIL: 'Fail',50 SUCCESS: 'Success',51 };5253 static chainLogType = {54 EXTRINSIC: 'extrinsic',55 RPC: 'rpc',56 };5758 static getNestingTokenAddress(collectionId: number, tokenId: number) {59 return nesting.tokenIdToAddress(collectionId, tokenId);60 }6162 static getDefaultLogger(): ILogger {63 return {64 log(msg: any, level = 'INFO') {65 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));66 },67 level: {68 ERROR: 'ERROR',69 WARNING: 'WARNING',70 INFO: 'INFO',71 },72 };73 }7475 static vec2str(arr: string[] | number[]) {76 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');77 }7879 static str2vec(string: string) {80 if (typeof string !== 'string') return string;81 return Array.from(string).map(x => x.charCodeAt(0));82 }8384 static fromSeed(seed: string, ss58Format = 42) {85 const keyring = new Keyring({type: 'sr25519', ss58Format});86 return keyring.addFromUri(seed);87 }8889 static normalizeSubstrateAddress(address: string, ss58Format = 42) {90 return encodeAddress(decodeAddress(address), ss58Format);91 }9293 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult) {94 if (creationResult.status !== this.transactionStatus.SUCCESS) {95 throw Error('Unable to create collection!');96 }9798 let collectionId = null;99 creationResult.result.events.forEach(({event: {data, method, section}}) => {100 if ((section === 'common') && (method === 'CollectionCreated')) {101 collectionId = parseInt(data[0].toString(), 10);102 }103 });104105 if (collectionId === null) {106 throw Error('No CollectionCreated event was found!');107 }108109 return collectionId;110 }111112 static extractTokensFromCreationResult(creationResult: ITransactionResult) {113 if (creationResult.status !== this.transactionStatus.SUCCESS) {114 throw Error('Unable to create tokens!');115 }116 let success = false;117 const tokens = [] as any;118 creationResult.result.events.forEach(({event: {data, method, section}}) => {119 if (method === 'ExtrinsicSuccess') {120 success = true;121 } else if ((section === 'common') && (method === 'ItemCreated')) {122 tokens.push({123 collectionId: parseInt(data[0].toString(), 10),124 tokenId: parseInt(data[1].toString(), 10),125 owner: data[2].toJSON(),126 });127 }128 });129 return {success, tokens};130 }131132 static extractTokensFromBurnResult(burnResult: ITransactionResult) {133 if (burnResult.status !== this.transactionStatus.SUCCESS) {134 throw Error('Unable to burn tokens!');135 }136 let success = false;137 const tokens = [] as any;138 burnResult.result.events.forEach(({event: {data, method, section}}) => {139 if (method === 'ExtrinsicSuccess') {140 success = true;141 } else if ((section === 'common') && (method === 'ItemDestroyed')) {142 tokens.push({143 collectionId: parseInt(data[0].toString(), 10),144 tokenId: parseInt(data[1].toString(), 10),145 owner: data[2].toJSON(),146 });147 }148 });149 return {success, tokens};150 }151152 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string) {153 let eventId = null;154 events.forEach(({event: {data, method, section}}) => {155 if ((section === expectedSection) && (method === expectedMethod)) {156 eventId = parseInt(data[0].toString(), 10);157 }158 });159160 if (eventId === null) {161 throw Error(`No ${expectedMethod} event was found!`);162 }163 return eventId === collectionId;164 }165166 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {167 const normalizeAddress = (address: string | ICrossAccountId) => {168 if(typeof address === 'string') return address;169 const obj = {} as any;170 Object.keys(address).forEach(k => {171 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];172 });173 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};174 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};175 return address;176 };177 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;178 events.forEach(({event: {data, method, section}}) => {179 if ((section === 'common') && (method === 'Transfer')) {180 const hData = (data as any).toJSON();181 transfer = {182 collectionId: hData[0],183 tokenId: hData[1],184 from: normalizeAddress(hData[2]),185 to: normalizeAddress(hData[3]),186 amount: BigInt(hData[4]),187 };188 }189 });190 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;191 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);193 isSuccess = isSuccess && amount === transfer.amount;194 return isSuccess;195 }196}197198199class ChainHelperBase {200 transactionStatus = UniqueUtil.transactionStatus;201 chainLogType = UniqueUtil.chainLogType;202 util: typeof UniqueUtil;203 logger: ILogger;204 api: ApiPromise | null;205 forcedNetwork: TUniqueNetworks | null;206 network: TUniqueNetworks | null;207 chainLog: IUniqueHelperLog[];208209 constructor(logger?: ILogger) {210 this.util = UniqueUtil;211 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();212 this.logger = logger;213 this.api = null;214 this.forcedNetwork = null;215 this.network = null;216 this.chainLog = [];217 }218219 clearChainLog(): void {220 this.chainLog = [];221 }222223 forceNetwork(value: TUniqueNetworks): void {224 this.forcedNetwork = value;225 }226227 async connect(wsEndpoint: string, listeners?: IApiListeners) {228 if (this.api !== null) throw Error('Already connected');229 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);230 this.api = api;231 this.network = network;232 }233234 async disconnect() {235 if (this.api === null) return;236 await this.api.disconnect();237 this.api = null;238 this.network = null;239 }240241 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {242 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;243 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;244 return 'opal';245 }246247 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {248 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});249 await api.isReady;250251 const network = await this.detectNetwork(api);252253 await api.disconnect();254255 return network;256 }257258 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 259 api: ApiPromise; 260 network: TUniqueNetworks; 261 }> {262 if(typeof network === 'undefined' || network === null) network = 'opal';263 const supportedRPC = {264 opal: {265 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,266 },267 quartz: {268 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,269 },270 unique: {271 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,272 },273 };274 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);275 const rpc = supportedRPC[network];276277 // TODO: investigate how to replace rpc in runtime278 // api._rpcCore.addUserInterfaces(rpc);279280 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});281282 await api.isReadyOrError;283284 if (typeof listeners === 'undefined') listeners = {};285 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {286 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;287 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);288 }289290 return {api, network};291 }292293 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {294 const {events, status} = data;295 if (status.isReady) {296 return this.transactionStatus.NOT_READY;297 }298 if (status.isBroadcast) {299 return this.transactionStatus.NOT_READY;300 }301 if (status.isInBlock || status.isFinalized) {302 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');303 if (errors.length > 0) {304 return this.transactionStatus.FAIL;305 }306 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {307 return this.transactionStatus.SUCCESS;308 }309 }310311 return this.transactionStatus.FAIL;312 }313314 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {315 const sign = (callback: any) => {316 if(options !== null) return transaction.signAndSend(sender, options, callback);317 return transaction.signAndSend(sender, callback);318 };319 // eslint-disable-next-line no-async-promise-executor320 return new Promise(async (resolve, reject) => {321 try {322 const unsub = await sign((result: any) => {323 const status = this.getTransactionStatus(result);324325 if (status === this.transactionStatus.SUCCESS) {326 this.logger.log(`${label} successful`);327 unsub();328 resolve({result, status});329 } else if (status === this.transactionStatus.FAIL) {330 let moduleError = null;331332 if (result.hasOwnProperty('dispatchError')) {333 const dispatchError = result['dispatchError'];334335 if (dispatchError && dispatchError.isModule) {336 const modErr = dispatchError.asModule;337 const errorMeta = dispatchError.registry.findMetaError(modErr);338339 moduleError = `${errorMeta.section}.${errorMeta.name}`;340 }341 else {342 this.logger.log(result, this.logger.level.ERROR);343 }344 }345346 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);347 unsub();348 reject({status, moduleError, result});349 }350 });351 } catch (e) {352 this.logger.log(e, this.logger.level.ERROR);353 reject(e);354 }355 });356 }357358 constructApiCall(apiCall: string, params: any[]) {359 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);360 let call = this.api as any;361 for(const part of apiCall.slice(4).split('.')) {362 call = call[part];363 }364 return call(...params);365 }366367 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false/*, failureMessage='expected success'*/) {368 if(this.api === null) throw Error('API not initialized');369 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);370371 const startTime = (new Date()).getTime();372 let result: ITransactionResult;373 let events = [];374 try {375 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;376 events = result.result.events.map((x: any) => x.toHuman());377 }378 catch(e) {379 if(!(e as object).hasOwnProperty('status')) throw e;380 result = e as ITransactionResult;381 }382383 const endTime = (new Date()).getTime();384385 const log = {386 executedAt: endTime,387 executionTime: endTime - startTime,388 type: this.chainLogType.EXTRINSIC,389 status: result.status,390 call: extrinsic,391 signer: this.getSignerAddress(sender),392 params,393 } as IUniqueHelperLog;394395 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;396 if(events.length > 0) log.events = events;397398 this.chainLog.push(log);399400 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);401 return result;402 }403404 async callRpc(rpc: string, params?: any[]) {405 if(typeof params === 'undefined') params = [];406 if(this.api === null) throw Error('API not initialized');407 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);408409 const startTime = (new Date()).getTime();410 let result;411 let error = null;412 const log = {413 type: this.chainLogType.RPC,414 call: rpc,415 params,416 } as IUniqueHelperLog;417418 try {419 result = await this.constructApiCall(rpc, params);420 }421 catch(e) {422 error = e;423 }424425 const endTime = (new Date()).getTime();426427 log.executedAt = endTime;428 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';429 log.executionTime = endTime - startTime;430431 this.chainLog.push(log);432433 if(error !== null) throw error;434435 return result;436 }437438 getSignerAddress(signer: IKeyringPair | string): string {439 if(typeof signer === 'string') return signer;440 return signer.address;441 }442443 fetchAllPalletNames(): string[] {444 if(this.api === null) throw Error('API not initialized');445 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());446 }447 448 fetchMissingPalletNames(requiredPallets: string[]): string[] {449 const palletNames = this.fetchAllPalletNames();450 return requiredPallets.filter(p => !palletNames.includes(p));451 }452}453454455class HelperGroup {456 helper: UniqueHelper;457458 constructor(uniqueHelper: UniqueHelper) {459 this.helper = uniqueHelper;460 }461}462463464class CollectionGroup extends HelperGroup {465 /**466 * Get number of blocks when sponsored transaction is available.467 *468 * @param collectionId ID of collection469 * @param tokenId ID of token470 * @param addressObj address for which the sponsorship is checked471 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});472 * @returns number of blocks or null if sponsorship hasn't been set473 */474 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {475 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();476 }477478 /**479 * Get the number of created collections.480 * 481 * @returns number of created collections482 */483 async getTotalCount(): Promise<number> {484 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();485 }486487 /**488 * Get information about the collection with additional data, 489 * including the number of tokens it contains, its administrators, 490 * the normalized address of the collection's owner, and decoded name and description.491 * 492 * @param collectionId ID of collection493 * @example await getData(2)494 * @returns collection information object495 */496 async getData(collectionId: number): Promise<{497 id: number;498 name: string;499 description: string;500 tokensCount: number;501 admins: ICrossAccountId[];502 normalizedOwner: TSubstrateAccount;503 raw: any504 } | null> {505 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);506 const humanCollection = collection.toHuman(), collectionData = {507 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],508 raw: humanCollection,509 } as any, jsonCollection = collection.toJSON();510 if (humanCollection === null) return null;511 collectionData.raw.limits = jsonCollection.limits;512 collectionData.raw.permissions = jsonCollection.permissions;513 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);514 for (const key of ['name', 'description']) {515 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);516 }517518 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) 519 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) 520 : 0;521 collectionData.admins = await this.getAdmins(collectionId);522523 return collectionData;524 }525526 /**527 * Get the addresses of the collection's administrators, optionally normalized.528 * 529 * @param collectionId ID of collection530 * @param normalize whether to normalize the addresses to the default ss58 format531 * @example await getAdmins(1)532 * @returns array of administrators533 */534 async getAdmins(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {535 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();536537 return normalize538 ? admins.map((address: any) => {539 return address.Substrate540 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}541 : address;542 }) 543 : admins;544 }545546 /**547 * Get the addresses added to the collection allow-list, optionally normalized.548 * @param collectionId ID of collection549 * @param normalize whether to normalize the addresses to the default ss58 format550 * @example await getAllowList(1)551 * @returns array of allow-listed addresses552 */553 async getAllowList(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {554 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();555 return normalize556 ? allowListed.map((address: any) => {557 return address.Substrate558 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}559 : address;560 }) 561 : allowListed;562 }563564 /**565 * Get the effective limits of the collection instead of null for default values566 * 567 * @param collectionId ID of collection568 * @example await getEffectiveLimits(2)569 * @returns object of collection limits570 */571 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {572 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();573 }574575 /**576 * Burns the collection if the signer has sufficient permissions and collection is empty.577 * 578 * @param signer keyring of signer579 * @param collectionId ID of collection580 * @example await helper.collection.burn(aliceKeyring, 3);581 * @returns ```true``` if extrinsic success, otherwise ```false```582 */583 async burn(signer: TSigner, collectionId: number): Promise<boolean> {584 const result = await this.helper.executeExtrinsic(585 signer,586 'api.tx.unique.destroyCollection', [collectionId],587 true,588 );589590 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');591 }592593 /**594 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.595 * 596 * @param signer keyring of signer597 * @param collectionId ID of collection598 * @param sponsorAddress Sponsor substrate address599 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")600 * @returns ```true``` if extrinsic success, otherwise ```false```601 */602 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {603 const result = await this.helper.executeExtrinsic(604 signer,605 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],606 true,607 );608609 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');610 }611612 /**613 * Confirms consent to sponsor the collection on behalf of the signer.614 * 615 * @param signer keyring of signer616 * @param collectionId ID of collection617 * @example confirmSponsorship(aliceKeyring, 10)618 * @returns ```true``` if extrinsic success, otherwise ```false```619 */620 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {621 const result = await this.helper.executeExtrinsic(622 signer,623 'api.tx.unique.confirmSponsorship', [collectionId],624 true,625 );626627 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');628 }629630 /**631 * Removes the sponsor of a collection, regardless if it consented or not.632 * 633 * @param signer keyring of signer634 * @param collectionId ID of collection635 * @example removeSponsor(aliceKeyring, 10)636 * @returns ```true``` if extrinsic success, otherwise ```false```637 */638 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {639 const result = await this.helper.executeExtrinsic(640 signer,641 'api.tx.unique.removeCollectionSponsor', [collectionId],642 true,643 );644645 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');646 }647648 /**649 * Sets the limits of the collection. At least one limit must be specified for a correct call.650 * 651 * @param signer keyring of signer652 * @param collectionId ID of collection653 * @param limits collection limits object654 * @example655 * await setLimits(656 * aliceKeyring,657 * 10,658 * {659 * sponsorTransferTimeout: 0,660 * ownerCanDestroy: false661 * }662 * )663 * @returns ```true``` if extrinsic success, otherwise ```false```664 */665 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {666 const result = await this.helper.executeExtrinsic(667 signer,668 'api.tx.unique.setCollectionLimits', [collectionId, limits],669 true,670 );671672 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');673 }674675 /**676 * Changes the owner of the collection to the new Substrate address.677 * 678 * @param signer keyring of signer679 * @param collectionId ID of collection680 * @param ownerAddress substrate address of new owner681 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")682 * @returns ```true``` if extrinsic success, otherwise ```false```683 */684 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {685 const result = await this.helper.executeExtrinsic(686 signer,687 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],688 true,689 );690691 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');692 }693694 /**695 * Adds a collection administrator. 696 * 697 * @param signer keyring of signer698 * @param collectionId ID of collection699 * @param adminAddressObj Administrator address (substrate or ethereum)700 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})701 * @returns ```true``` if extrinsic success, otherwise ```false```702 */703 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {704 const result = await this.helper.executeExtrinsic(705 signer,706 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],707 true,708 );709710 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');711 }712713 /**714 * Removes a collection administrator.715 * 716 * @param signer keyring of signer717 * @param collectionId ID of collection718 * @param adminAddressObj Administrator address (substrate or ethereum)719 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})720 * @returns ```true``` if extrinsic success, otherwise ```false```721 */722 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {723 const result = await this.helper.executeExtrinsic(724 signer,725 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],726 true,727 );728729 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');730 }731732 /**733 * Adds an address to allow list 734 * @param signer keyring of signer735 * @param collectionId ID of collection736 * @param addressObj address to add to the allow list737 * @returns ```true``` if extrinsic success, otherwise ```false```738 */739 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {740 const result = await this.helper.executeExtrinsic(741 signer,742 'api.tx.unique.addToAllowList', [collectionId, addressObj],743 true,744 );745746 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');747 }748749 /**750 * Removes an address from allow list 751 * 752 * @param signer keyring of signer753 * @param collectionId ID of collection754 * @param addressObj address to remove from the allow list755 * @returns ```true``` if extrinsic success, otherwise ```false```756 */757 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {758 const result = await this.helper.executeExtrinsic(759 signer,760 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],761 true,762 );763764 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');765 }766767 /**768 * Sets onchain permissions for selected collection.769 * 770 * @param signer keyring of signer771 * @param collectionId ID of collection772 * @param permissions collection permissions object773 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});774 * @returns ```true``` if extrinsic success, otherwise ```false```775 */776 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {777 const result = await this.helper.executeExtrinsic(778 signer,779 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],780 true,781 );782783 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');784 }785786 /**787 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.788 * 789 * @param signer keyring of signer790 * @param collectionId ID of collection791 * @param permissions nesting permissions object792 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});793 * @returns ```true``` if extrinsic success, otherwise ```false```794 */795 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {796 return await this.setPermissions(signer, collectionId, {nesting: permissions});797 }798799 /**800 * Disables nesting for selected collection.801 * 802 * @param signer keyring of signer803 * @param collectionId ID of collection804 * @example disableNesting(aliceKeyring, 10);805 * @returns ```true``` if extrinsic success, otherwise ```false```806 */807 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {808 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});809 }810811 /**812 * Sets onchain properties to the collection.813 * 814 * @param signer keyring of signer815 * @param collectionId ID of collection816 * @param properties array of property objects817 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);818 * @returns ```true``` if extrinsic success, otherwise ```false```819 */820 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {821 const result = await this.helper.executeExtrinsic(822 signer,823 'api.tx.unique.setCollectionProperties', [collectionId, properties],824 true,825 );826827 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');828 }829830 /**831 * Deletes onchain properties from the collection.832 * 833 * @param signer keyring of signer834 * @param collectionId ID of collection835 * @param propertyKeys array of property keys to delete836 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);837 * @returns ```true``` if extrinsic success, otherwise ```false```838 */839 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {840 const result = await this.helper.executeExtrinsic(841 signer,842 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],843 true,844 );845846 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');847 }848849 /**850 * Changes the owner of the token.851 * 852 * @param signer keyring of signer853 * @param collectionId ID of collection854 * @param tokenId ID of token855 * @param addressObj address of a new owner856 * @param amount amount of tokens to be transfered. For NFT must be set to 1n857 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})858 * @returns true if the token success, otherwise false859 */860 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {861 const result = await this.helper.executeExtrinsic(862 signer,863 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],864 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,865 );866867 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);868 }869870 /**871 * 872 * Change ownership of a token(s) on behalf of the owner. 873 * 874 * @param signer keyring of signer875 * @param collectionId ID of collection876 * @param tokenId ID of token877 * @param fromAddressObj address on behalf of which the token will be sent878 * @param toAddressObj new token owner879 * @param amount amount of tokens to be transfered. For NFT must be set to 1n880 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})881 * @returns true if the token success, otherwise false882 */883 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {884 const result = await this.helper.executeExtrinsic(885 signer,886 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],887 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,888 );889 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);890 }891892 /**893 * 894 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.895 * 896 * @param signer keyring of signer897 * @param collectionId ID of collection898 * @param tokenId ID of token899 * @param amount amount of tokens to be burned. For NFT must be set to 1n900 * @example burnToken(aliceKeyring, 10, 5);901 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```902 */903 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<{904 success: boolean,905 token: number | null906 }> {907 const burnResult = await this.helper.executeExtrinsic(908 signer,909 'api.tx.unique.burnItem', [collectionId, tokenId, amount],910 true, // `Unable to burn token for ${label}`,911 );912 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);913 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');914 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};915 }916917 /**918 * Destroys a concrete instance of NFT on behalf of the owner919 * 920 * @param signer keyring of signer921 * @param collectionId ID of collection922 * @param fromAddressObj address on behalf of which the token will be burnt923 * @param tokenId ID of token924 * @param amount amount of tokens to be burned. For NFT must be set to 1n925 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})926 * @returns ```true``` if extrinsic success, otherwise ```false```927 */928 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, amount=1n): Promise<boolean> {929 const burnResult = await this.helper.executeExtrinsic(930 signer,931 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],932 true, // `Unable to burn token from for ${label}`,933 );934 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);935 return burnedTokens.success && burnedTokens.tokens.length > 0;936 }937938 /**939 * Set, change, or remove approved address to transfer the ownership of the NFT.940 * 941 * @param signer keyring of signer942 * @param collectionId ID of collection943 * @param tokenId ID of token944 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens945 * @param amount amount of token to be approved. For NFT must be set to 1n946 * @returns ```true``` if extrinsic success, otherwise ```false```947 */948 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {949 const approveResult = await this.helper.executeExtrinsic(950 signer, 951 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],952 true, // `Unable to approve token for ${label}`,953 );954955 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');956 }957958 /**959 * Get the amount of token pieces approved to transfer or burn. Normally 0.960 * 961 * @param collectionId ID of collection962 * @param tokenId ID of token963 * @param toAccountObj address which is approved to use token pieces964 * @param fromAccountObj address which may have allowed the use of its owned tokens965 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})966 * @returns number of approved to transfer pieces967 */968 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {969 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();970 }971972 /**973 * Get the last created token ID in a collection974 * 975 * @param collectionId ID of collection976 * @example getLastTokenId(10);977 * @returns id of the last created token978 */979 async getLastTokenId(collectionId: number): Promise<number> {980 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();981 }982983 /**984 * Check if token exists985 * 986 * @param collectionId ID of collection987 * @param tokenId ID of token988 * @example isTokenExists(10, 20);989 * @returns true if the token exists, otherwise false990 */991 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {992 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();993 }994}995996class NFTnRFT extends CollectionGroup {997 /**998 * Get tokens owned by account999 * 1000 * @param collectionId ID of collection1001 * @param addressObj tokens owner1002 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1003 * @returns array of token ids owned by account1004 */1005 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1006 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1007 }10081009 /**1010 * Get token data1011 * 1012 * @param collectionId ID of collection1013 * @param tokenId ID of token1014 * @param propertyKeys optionally filter the token properties to only these keys1015 * @param blockHashAt optionally query the data at some block with this hash1016 * @example getToken(10, 5);1017 * @returns human readable token data 1018 */1019 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1020 properties: IProperty[];1021 owner: ICrossAccountId;1022 normalizedOwner: ICrossAccountId;1023 }| null> {1024 let tokenData;1025 if(typeof blockHashAt === 'undefined') {1026 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1027 }1028 else {1029 if(propertyKeys.length == 0) {1030 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1031 if(!collection) return null;1032 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1033 }1034 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1035 }1036 tokenData = tokenData.toHuman();1037 if (tokenData === null || tokenData.owner === null) return null;1038 const owner = {} as any;1039 for (const key of Object.keys(tokenData.owner)) {1040 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1041 }1042 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1043 return tokenData;1044 }10451046 /**1047 * Set permissions to change token properties1048 * 1049 * @param signer keyring of signer1050 * @param collectionId ID of collection1051 * @param permissions permissions to change a property by the collection owner or admin1052 * @example setTokenPropertyPermissions(1053 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1054 * )1055 * @returns true if extrinsic success otherwise false1056 */1057 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1058 const result = await this.helper.executeExtrinsic(1059 signer,1060 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1061 true,1062 );10631064 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1065 }10661067 /**1068 * Set token properties1069 * 1070 * @param signer keyring of signer1071 * @param collectionId ID of collection1072 * @param tokenId ID of token1073 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1074 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1075 * @returns ```true``` if extrinsic success, otherwise ```false```1076 */1077 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1078 const result = await this.helper.executeExtrinsic(1079 signer,1080 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1081 true,1082 );10831084 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1085 }10861087 /**1088 * Delete the provided properties of a token1089 * @param signer keyring of signer1090 * @param collectionId ID of collection1091 * @param tokenId ID of token1092 * @param propertyKeys property keys to be deleted 1093 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1094 * @returns ```true``` if extrinsic success, otherwise ```false```1095 */1096 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1097 const result = await this.helper.executeExtrinsic(1098 signer,1099 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1100 true,1101 );11021103 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1104 }11051106 /**1107 * Mint new collection1108 * 1109 * @param signer keyring of signer1110 * @param collectionOptions basic collection options and properties 1111 * @param mode NFT or RFT type of a collection1112 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1113 * @returns object of the created collection1114 */1115 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueCollectionBase> {1116 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1117 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1118 for (const key of ['name', 'description', 'tokenPrefix']) {1119 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1120 }1121 const creationResult = await this.helper.executeExtrinsic(1122 signer,1123 'api.tx.unique.createCollectionEx', [collectionOptions],1124 true, // errorLabel,1125 );1126 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1127 }11281129 getCollectionObject(_collectionId: number): any {1130 return null;1131 }11321133 getTokenObject(_collectionId: number, _tokenId: number): any {1134 return null;1135 }1136}113711381139class NFTGroup extends NFTnRFT {1140 /**1141 * Get collection object1142 * @param collectionId ID of collection1143 * @example getCollectionObject(2);1144 * @returns instance of UniqueNFTCollection1145 */1146 getCollectionObject(collectionId: number): UniqueNFTCollection {1147 return new UniqueNFTCollection(collectionId, this.helper);1148 }11491150 /**1151 * Get token object1152 * @param collectionId ID of collection1153 * @param tokenId ID of token1154 * @example getTokenObject(10, 5);1155 * @returns instance of UniqueNFTToken1156 */1157 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1158 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1159 }11601161 /**1162 * Get token's owner1163 * @param collectionId ID of collection1164 * @param tokenId ID of token1165 * @param blockHashAt optionally query the data at the block with this hash1166 * @example getTokenOwner(10, 5);1167 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1168 */1169 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1170 let owner;1171 if (typeof blockHashAt === 'undefined') {1172 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1173 } else {1174 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1175 }1176 return crossAccountIdFromLower(owner.toJSON());1177 }11781179 /**1180 * Is token approved to transfer1181 * @param collectionId ID of collection1182 * @param tokenId ID of token1183 * @param toAccountObj address to be approved1184 * @returns ```true``` if extrinsic success, otherwise ```false```1185 */1186 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1187 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1188 }11891190 /**1191 * Changes the owner of the token.1192 * 1193 * @param signer keyring of signer1194 * @param collectionId ID of collection1195 * @param tokenId ID of token1196 * @param addressObj address of a new owner1197 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1198 * @returns ```true``` if extrinsic success, otherwise ```false```1199 */1200 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1201 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1202 }12031204 /**1205 * 1206 * Change ownership of a NFT on behalf of the owner. 1207 * 1208 * @param signer keyring of signer1209 * @param collectionId ID of collection1210 * @param tokenId ID of token1211 * @param fromAddressObj address on behalf of which the token will be sent1212 * @param toAddressObj new token owner1213 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1214 * @returns ```true``` if extrinsic success, otherwise ```false```1215 */1216 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1217 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1218 }12191220 /**1221 * Recursively find the address that owns the token1222 * @param collectionId ID of collection1223 * @param tokenId ID of token1224 * @param blockHashAt 1225 * @example getTokenTopmostOwner(10, 5);1226 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1227 */1228 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1229 let owner;1230 if (typeof blockHashAt === 'undefined') {1231 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1232 } else {1233 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1234 }12351236 if (owner === null) return null;12371238 owner = owner.toHuman();12391240 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1241 }12421243 /**1244 * Get tokens nested in the provided token1245 * @param collectionId ID of collection1246 * @param tokenId ID of token1247 * @param blockHashAt optionally query the data at the block with this hash1248 * @example getTokenChildren(10, 5);1249 * @returns tokens whose depth of nesting is <= 5 1250 */1251 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1252 let children;1253 if(typeof blockHashAt === 'undefined') {1254 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1255 } else {1256 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1257 }12581259 return children.toJSON().map((x: any) => {1260 return {collectionId: x.collection, tokenId: x.token};1261 });1262 }12631264 /**1265 * Nest one token into another1266 * @param signer keyring of signer1267 * @param tokenObj token to be nested1268 * @param rootTokenObj token to be parent1269 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1270 * @returns ```true``` if extrinsic success, otherwise ```false```1271 */1272 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1273 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1274 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1275 if(!result) {1276 throw Error('Unable to nest token!');1277 }1278 return result;1279 }12801281 /**1282 * Remove token from nested state1283 * @param signer keyring of signer1284 * @param tokenObj token to unnest1285 * @param rootTokenObj parent of a token1286 * @param toAddressObj address of a new token owner 1287 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1288 * @returns ```true``` if extrinsic success, otherwise ```false```1289 */1290 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1291 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1292 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1293 if(!result) {1294 throw Error('Unable to unnest token!');1295 }1296 return result;1297 }12981299 /**1300 * Mint new collection1301 * @param signer keyring of signer1302 * @param collectionOptions Collection options1303 * @example 1304 * mintCollection(aliceKeyring, {1305 * name: 'New',1306 * description: 'New collection',1307 * tokenPrefix: 'NEW',1308 * })1309 * @returns object of the created collection1310 */1311 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueNFTCollection> {1312 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1313 }13141315 /**1316 * Mint new token1317 * @param signer keyring of signer1318 * @param data token data1319 * @returns created token object1320 */1321 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFTToken> {1322 const creationResult = await this.helper.executeExtrinsic(1323 signer,1324 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1325 nft: {1326 properties: data.properties,1327 },1328 }],1329 true,1330 );1331 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1332 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1333 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1334 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1335 }13361337 /**1338 * Mint multiple NFT tokens1339 * @param signer keyring of signer1340 * @param collectionId ID of collection1341 * @param tokens array of tokens with owner and properties1342 * @example 1343 * mintMultipleTokens(aliceKeyring, 10, [{1344 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1345 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1346 * },{1347 * owner: {Ethereum: "0x9F0583DbB855d..."},1348 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1349 * }]);1350 * @returns ```true``` if extrinsic success, otherwise ```false```1351 */1352 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1353 const creationResult = await this.helper.executeExtrinsic(1354 signer,1355 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1356 true,1357 );1358 const collection = this.getCollectionObject(collectionId);1359 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1360 }13611362 /**1363 * Mint multiple NFT tokens with one owner1364 * @param signer keyring of signer1365 * @param collectionId ID of collection1366 * @param owner tokens owner1367 * @param tokens array of tokens with owner and properties1368 * @example1369 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1370 * properties: [{1371 * key: "gender",1372 * value: "female",1373 * },{1374 * key: "age",1375 * value: "33",1376 * }],1377 * }]);1378 * @returns array of newly created tokens1379 */1380 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1381 const rawTokens = [];1382 for (const token of tokens) {1383 const raw = {NFT: {properties: token.properties}};1384 rawTokens.push(raw);1385 }1386 const creationResult = await this.helper.executeExtrinsic(1387 signer,1388 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1389 true,1390 );1391 const collection = this.getCollectionObject(collectionId);1392 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1393 }13941395 /**1396 * Destroys a concrete instance of NFT.1397 * @param signer keyring of signer1398 * @param collectionId ID of collection1399 * @param tokenId ID of token1400 * @example burnToken(aliceKeyring, 10, 5);1401 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1402 */1403 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number): Promise<{ success: boolean; token: number | null; }> {1404 return await super.burnToken(signer, collectionId, tokenId, 1n);1405 }14061407 /**1408 * Set, change, or remove approved address to transfer the ownership of the NFT.1409 * 1410 * @param signer keyring of signer1411 * @param collectionId ID of collection1412 * @param tokenId ID of token1413 * @param toAddressObj address to approve1414 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1415 * @returns ```true``` if extrinsic success, otherwise ```false```1416 */1417 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1418 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1419 }1420}142114221423class RFTGroup extends NFTnRFT {1424 /**1425 * Get collection object1426 * @param collectionId ID of collection1427 * @example getCollectionObject(2);1428 * @returns instance of UniqueRFTCollection1429 */1430 getCollectionObject(collectionId: number): UniqueRFTCollection {1431 return new UniqueRFTCollection(collectionId, this.helper);1432 }14331434 /**1435 * Get token object1436 * @param collectionId ID of collection1437 * @param tokenId ID of token1438 * @example getTokenObject(10, 5);1439 * @returns instance of UniqueNFTToken1440 */1441 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1442 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1443 }14441445 /**1446 * Get top 10 token owners with the largest number of pieces 1447 * @param collectionId ID of collection1448 * @param tokenId ID of token1449 * @example getTokenTop10Owners(10, 5);1450 * @returns array of top 10 owners1451 */1452 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1453 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1454 }14551456 /**1457 * Get number of pieces owned by address1458 * @param collectionId ID of collection1459 * @param tokenId ID of token1460 * @param addressObj address token owner1461 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1462 * @returns number of pieces ownerd by address1463 */1464 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1465 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1466 }14671468 /**1469 * Transfer pieces of token to another address1470 * @param signer keyring of signer1471 * @param collectionId ID of collection1472 * @param tokenId ID of token1473 * @param addressObj address of a new owner1474 * @param amount number of pieces to be transfered1475 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1476 * @returns ```true``` if extrinsic success, otherwise ```false```1477 */1478 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1479 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1480 }14811482 /**1483 * Change ownership of some pieces of RFT on behalf of the owner. 1484 * @param signer keyring of signer1485 * @param collectionId ID of collection1486 * @param tokenId ID of token1487 * @param fromAddressObj address on behalf of which the token will be sent1488 * @param toAddressObj new token owner1489 * @param amount number of pieces to be transfered1490 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1491 * @returns ```true``` if extrinsic success, otherwise ```false```1492 */1493 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1494 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1495 }14961497 /**1498 * Mint new collection1499 * @param signer keyring of signer1500 * @param collectionOptions Collection options1501 * @example1502 * mintCollection(aliceKeyring, {1503 * name: 'New',1504 * description: 'New collection',1505 * tokenPrefix: 'NEW',1506 * })1507 * @returns object of the created collection1508 */1509 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueRFTCollection> {1510 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1511 }15121513 /**1514 * Mint new token1515 * @param signer keyring of signer1516 * @param data token data1517 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1518 * @returns created token object1519 */1520 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFTToken> {1521 const creationResult = await this.helper.executeExtrinsic(1522 signer,1523 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1524 refungible: {1525 pieces: data.pieces,1526 properties: data.properties,1527 },1528 }],1529 true,1530 );1531 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1532 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1533 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1534 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1535 }15361537 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1538 throw Error('Not implemented');1539 const creationResult = await this.helper.executeExtrinsic(1540 signer,1541 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1542 true, // `Unable to mint RFT tokens for ${label}`,1543 );1544 const collection = this.getCollectionObject(collectionId);1545 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1546 }15471548 /**1549 * Mint multiple RFT tokens with one owner1550 * @param signer keyring of signer1551 * @param collectionId ID of collection1552 * @param owner tokens owner1553 * @param tokens array of tokens with properties and pieces1554 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1555 * @returns array of newly created RFT tokens1556 */1557 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1558 const rawTokens = [];1559 for (const token of tokens) {1560 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1561 rawTokens.push(raw);1562 }1563 const creationResult = await this.helper.executeExtrinsic(1564 signer,1565 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1566 true,1567 );1568 const collection = this.getCollectionObject(collectionId);1569 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1570 }15711572 /**1573 * Destroys a concrete instance of RFT.1574 * @param signer keyring of signer1575 * @param collectionId ID of collection1576 * @param tokenId ID of token1577 * @param amount number of pieces to be burnt1578 * @example burnToken(aliceKeyring, 10, 5);1579 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1580 */1581 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<{ success: boolean; token: number | null; }> {1582 return await super.burnToken(signer, collectionId, tokenId, amount);1583 }15841585 /**1586 * Set, change, or remove approved address to transfer the ownership of the RFT.1587 * 1588 * @param signer keyring of signer1589 * @param collectionId ID of collection1590 * @param tokenId ID of token1591 * @param toAddressObj address to approve1592 * @param amount number of pieces to be approved1593 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1594 * @returns true if the token success, otherwise false1595 */1596 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1597 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1598 }15991600 /**1601 * Get total number of pieces1602 * @param collectionId ID of collection1603 * @param tokenId ID of token1604 * @example getTokenTotalPieces(10, 5);1605 * @returns number of pieces1606 */1607 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1608 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1609 }16101611 /**1612 * Change number of token pieces. Signer must be the owner of all token pieces.1613 * @param signer keyring of signer1614 * @param collectionId ID of collection1615 * @param tokenId ID of token1616 * @param amount new number of pieces1617 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1618 * @returns true if the repartion was success, otherwise false1619 */1620 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1621 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1622 const repartitionResult = await this.helper.executeExtrinsic(1623 signer,1624 'api.tx.unique.repartition', [collectionId, tokenId, amount],1625 true,1626 );1627 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1628 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1629 }1630}163116321633class FTGroup extends CollectionGroup {1634 /**1635 * Get collection object1636 * @param collectionId ID of collection1637 * @example getCollectionObject(2);1638 * @returns instance of UniqueFTCollection1639 */1640 getCollectionObject(collectionId: number): UniqueFTCollection {1641 return new UniqueFTCollection(collectionId, this.helper);1642 }16431644 /**1645 * Mint new fungible collection1646 * @param signer keyring of signer1647 * @param collectionOptions Collection options1648 * @param decimalPoints number of token decimals 1649 * @example1650 * mintCollection(aliceKeyring, {1651 * name: 'New',1652 * description: 'New collection',1653 * tokenPrefix: 'NEW',1654 * }, 18)1655 * @returns newly created fungible collection1656 */1657 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0): Promise<UniqueFTCollection> {1658 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1659 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1660 collectionOptions.mode = {fungible: decimalPoints};1661 for (const key of ['name', 'description', 'tokenPrefix']) {1662 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1663 }1664 const creationResult = await this.helper.executeExtrinsic(1665 signer,1666 'api.tx.unique.createCollectionEx', [collectionOptions],1667 true,1668 );1669 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1670 }16711672 /**1673 * Mint tokens1674 * @param signer keyring of signer1675 * @param collectionId ID of collection1676 * @param owner address owner of new tokens1677 * @param amount amount of tokens to be meanted1678 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1679 * @returns ```true``` if extrinsic success, otherwise ```false``` 1680 */1681 async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint): Promise<boolean> {1682 const creationResult = await this.helper.executeExtrinsic(1683 signer,1684 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1685 fungible: {1686 value: amount,1687 },1688 }],1689 true, // `Unable to mint fungible tokens for ${label}`,1690 );1691 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1692 }16931694 /**1695 * Mint multiple Fungible tokens with one owner1696 * @param signer keyring of signer1697 * @param collectionId ID of collection1698 * @param owner tokens owner1699 * @param tokens array of tokens with properties and pieces1700 * @returns ```true``` if extrinsic success, otherwise ```false``` 1701 */1702 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[]): Promise<boolean> {1703 const rawTokens = [];1704 for (const token of tokens) {1705 const raw = {Fungible: {Value: token.value}};1706 rawTokens.push(raw);1707 }1708 const creationResult = await this.helper.executeExtrinsic(1709 signer,1710 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1711 true,1712 );1713 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1714 }17151716 /**1717 * Get the top 10 owners with the largest balance for the Fungible collection 1718 * @param collectionId ID of collection1719 * @example getTop10Owners(10);1720 * @returns array of ```ICrossAccountId```1721 */1722 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1723 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1724 }17251726 /**1727 * Get account balance1728 * @param collectionId ID of collection1729 * @param addressObj address of owner1730 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1731 * @returns amount of fungible tokens owned by address1732 */1733 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1734 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1735 }17361737 /**1738 * Transfer tokens to address1739 * @param signer keyring of signer1740 * @param collectionId ID of collection1741 * @param toAddressObj address recipient1742 * @param amount amount of tokens to be sent1743 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1744 * @returns ```true``` if extrinsic success, otherwise ```false``` 1745 */1746 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1747 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1748 }17491750 /**1751 * Transfer some tokens on behalf of the owner.1752 * @param signer keyring of signer1753 * @param collectionId ID of collection1754 * @param fromAddressObj address on behalf of which tokens will be sent1755 * @param toAddressObj address where token to be sent1756 * @param amount number of tokens to be sent1757 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1758 * @returns ```true``` if extrinsic success, otherwise ```false``` 1759 */1760 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1761 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1762 }17631764 /**1765 * Destroy some amount of tokens1766 * @param signer keyring of signer1767 * @param collectionId ID of collection1768 * @param amount amount of tokens to be destroyed1769 * @example burnTokens(aliceKeyring, 10, 1000n);1770 * @returns ```true``` if extrinsic success, otherwise ```false``` 1771 */1772 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1773 return (await super.burnToken(signer, collectionId, 0, amount)).success;1774 }17751776 /**1777 * Burn some tokens on behalf of the owner.1778 * @param signer keyring of signer1779 * @param collectionId ID of collection1780 * @param fromAddressObj address on behalf of which tokens will be burnt1781 * @param amount amount of tokens to be burnt1782 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1783 * @returns ```true``` if extrinsic success, otherwise ```false``` 1784 */1785 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1786 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, amount);1787 }17881789 /**1790 * Get total collection supply1791 * @param collectionId 1792 * @returns 1793 */1794 async getTotalPieces(collectionId: number): Promise<bigint> {1795 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1796 }17971798 /**1799 * Set, change, or remove approved address to transfer tokens.1800 * 1801 * @param signer keyring of signer1802 * @param collectionId ID of collection1803 * @param toAddressObj address to be approved1804 * @param amount amount of tokens to be approved1805 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1806 * @returns ```true``` if extrinsic success, otherwise ```false``` 1807 */1808 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1809 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1810 }18111812 /**1813 * Get amount of fungible tokens approved to transfer1814 * @param collectionId ID of collection1815 * @param fromAddressObj owner of tokens1816 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1817 * @returns number of tokens approved for the transfer1818 */1819 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1820 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1821 }1822}182318241825class ChainGroup extends HelperGroup {1826 /**1827 * Get system properties of a chain1828 * @example getChainProperties();1829 * @returns ss58Format, token decimals, and token symbol1830 */1831 getChainProperties(): IChainProperties {1832 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1833 return {1834 ss58Format: properties.ss58Format.toJSON(),1835 tokenDecimals: properties.tokenDecimals.toJSON(),1836 tokenSymbol: properties.tokenSymbol.toJSON(),1837 };1838 }18391840 /**1841 * Get chain header1842 * @example getLatestBlockNumber();1843 * @returns the number of the last block1844 */1845 async getLatestBlockNumber(): Promise<number> {1846 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1847 }18481849 /**1850 * Get block hash by block number1851 * @param blockNumber number of block1852 * @example getBlockHashByNumber(12345);1853 * @returns hash of a block1854 */1855 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1856 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1857 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1858 return blockHash;1859 }18601861 /**1862 * Get account nonce1863 * @param address substrate address1864 * @example getNonce("5GrwvaEF5zXb26Fz...");1865 * @returns number, account's nonce1866 */1867 async getNonce(address: TSubstrateAccount): Promise<number> {1868 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1869 }1870}187118721873class BalanceGroup extends HelperGroup {1874 /**1875 * Representation of the native token in the smallest unit1876 * @example getOneTokenNominal()1877 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1878 */1879 getOneTokenNominal(): bigint {1880 const chainProperties = this.helper.chain.getChainProperties();1881 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1882 }18831884 /**1885 * Get substrate address balance1886 * @param address substrate address1887 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1888 * @returns amount of tokens on address1889 */1890 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1891 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1892 }18931894 /**1895 * Get ethereum address balance1896 * @param address ethereum address1897 * @example getEthereum("0x9F0583DbB855d...")1898 * @returns amount of tokens on address1899 */1900 async getEthereum(address: TEthereumAccount): Promise<bigint> {1901 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1902 }19031904 /**1905 * Transfer tokens to substrate address1906 * @param signer keyring of signer1907 * @param address substrate address of a recipient1908 * @param amount amount of tokens to be transfered1909 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1910 * @returns ```true``` if extrinsic success, otherwise ```false```1911 */1912 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1913 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}`*/);19141915 let transfer = {from: null, to: null, amount: 0n} as any;1916 result.result.events.forEach(({event: {data, method, section}}) => {1917 if ((section === 'balances') && (method === 'Transfer')) {1918 transfer = {1919 from: this.helper.address.normalizeSubstrate(data[0]),1920 to: this.helper.address.normalizeSubstrate(data[1]),1921 amount: BigInt(data[2]),1922 };1923 }1924 });1925 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1926 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1927 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1928 return isSuccess;1929 }1930}193119321933class AddressGroup extends HelperGroup {1934 /**1935 * Normalizes the address to the specified ss58 format, by default ```42```.1936 * @param address substrate address1937 * @param ss58Format format for address conversion, by default ```42```1938 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1939 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1940 */1941 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1942 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1943 }19441945 /**1946 * Get address in the connected chain format1947 * @param address substrate address1948 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1949 * @returns address in chain format1950 */1951 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1952 const info = this.helper.chain.getChainProperties();1953 return encodeAddress(decodeAddress(address), info.ss58Format);1954 }19551956 /**1957 * Get substrate mirror of an ethereum address1958 * @param ethAddress ethereum address1959 * @param toChainFormat false for normalized account1960 * @example ethToSubstrate('0x9F0583DbB855d...')1961 * @returns substrate mirror of a provided ethereum address1962 */1963 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1964 if(!toChainFormat) return evmToAddress(ethAddress);1965 const info = this.helper.chain.getChainProperties();1966 return evmToAddress(ethAddress, info.ss58Format);1967 }19681969 /**1970 * Get ethereum mirror of a substrate address1971 * @param subAddress substrate account1972 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1973 * @returns ethereum mirror of a provided substrate address1974 */1975 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1976 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1977 }1978}197919801981export class UniqueHelper extends ChainHelperBase {1982 chain: ChainGroup;1983 balance: BalanceGroup;1984 address: AddressGroup;1985 collection: CollectionGroup;1986 nft: NFTGroup;1987 rft: RFTGroup;1988 ft: FTGroup;19891990 constructor(logger?: ILogger) {1991 super(logger);1992 this.chain = new ChainGroup(this);1993 this.balance = new BalanceGroup(this);1994 this.address = new AddressGroup(this);1995 this.collection = new CollectionGroup(this);1996 this.nft = new NFTGroup(this);1997 this.rft = new RFTGroup(this);1998 this.ft = new FTGroup(this);1999 } 2000}200120022003class UniqueCollectionBase {2004 helper: UniqueHelper;2005 collectionId: number;20062007 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2008 this.collectionId = collectionId;2009 this.helper = uniqueHelper;2010 }20112012 async getData() {2013 return await this.helper.collection.getData(this.collectionId);2014 }20152016 async getLastTokenId() {2017 return await this.helper.collection.getLastTokenId(this.collectionId);2018 }20192020 async isTokenExists(tokenId: number) {2021 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2022 }20232024 async getAdmins() {2025 return await this.helper.collection.getAdmins(this.collectionId);2026 }20272028 async getAllowList() {2029 return await this.helper.collection.getAllowList(this.collectionId);2030 }20312032 async getEffectiveLimits() {2033 return await this.helper.collection.getEffectiveLimits(this.collectionId);2034 }20352036 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2037 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2038 }20392040 async confirmSponsorship(signer: TSigner) {2041 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2042 }20432044 async removeSponsor(signer: TSigner) {2045 return await this.helper.collection.removeSponsor(signer, this.collectionId);2046 }20472048 async setLimits(signer: TSigner, limits: ICollectionLimits) {2049 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2050 }20512052 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2053 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2054 }20552056 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2057 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2058 }20592060 async enableCertainPermissions(signer: TSigner, accessMode: 'AllowList' | 'Normal' | undefined = 'AllowList', mintMode: boolean | undefined = true) {2061 return await this.setPermissions(signer, {access: accessMode, mintMode: mintMode});2062 }20632064 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2065 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2066 }20672068 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2069 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2070 }20712072 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2073 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2074 }20752076 async setProperties(signer: TSigner, properties: IProperty[]) {2077 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2078 }20792080 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2081 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2082 }20832084 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2085 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2086 }20872088 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2089 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2090 }20912092 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2093 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2094 }20952096 async disableNesting(signer: TSigner) {2097 return await this.helper.collection.disableNesting(signer, this.collectionId);2098 }20992100 async burn(signer: TSigner) {2101 return await this.helper.collection.burn(signer, this.collectionId);2102 }2103}210421052106class UniqueNFTCollection extends UniqueCollectionBase {2107 getTokenObject(tokenId: number) {2108 return new UniqueNFTToken(tokenId, this);2109 }21102111 async getTokensByAddress(addressObj: ICrossAccountId) {2112 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2113 }21142115 async getToken(tokenId: number, blockHashAt?: string) {2116 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2117 }21182119 async getTokenOwner(tokenId: number, blockHashAt?: string) {2120 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2121 }21222123 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2124 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2125 }21262127 async getTokenChildren(tokenId: number, blockHashAt?: string) {2128 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2129 }21302131 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2132 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2133 }21342135 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2136 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2137 }21382139 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2140 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2141 }21422143 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2144 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2145 }21462147 async mintToken(signer: TSigner, owner: ICrossAccountId, properties?: IProperty[]) {2148 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2149 }21502151 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2152 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2153 }21542155 async burnToken(signer: TSigner, tokenId: number) {2156 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2157 }21582159 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2160 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2161 }21622163 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2164 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2165 }21662167 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2168 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2169 }21702171 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2172 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2173 }21742175 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2176 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2177 }2178}217921802181class UniqueRFTCollection extends UniqueCollectionBase {2182 getTokenObject(tokenId: number) {2183 return new UniqueRFTToken(tokenId, this);2184 }21852186 async getTokensByAddress(addressObj: ICrossAccountId) {2187 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2188 }21892190 async getTop10TokenOwners(tokenId: number) {2191 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2192 }21932194 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2195 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2196 }21972198 async getTokenTotalPieces(tokenId: number) {2199 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2200 }22012202 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2203 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2204 }22052206 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2207 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2208 }22092210 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2211 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2212 }22132214 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2215 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2216 }22172218 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2219 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2220 }22212222 async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[]) {2223 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2224 }22252226 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]) {2227 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2228 }22292230 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2231 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2232 }22332234 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2235 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2236 }22372238 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2239 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2240 }22412242 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2243 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2244 }2245}224622472248class UniqueFTCollection extends UniqueCollectionBase {2249 async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint) {2250 return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount);2251 }22522253 async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[]) {2254 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens);2255 }22562257 async getBalance(addressObj: ICrossAccountId) {2258 return await this.helper.ft.getBalance(this.collectionId, addressObj);2259 }22602261 async getTop10Owners() {2262 return await this.helper.ft.getTop10Owners(this.collectionId);2263 }22642265 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2266 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2267 }22682269 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2270 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2271 }22722273 async burnTokens(signer: TSigner, amount=1n) {2274 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2275 }22762277 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2278 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2279 }22802281 async getTotalPieces() {2282 return await this.helper.ft.getTotalPieces(this.collectionId);2283 }22842285 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2286 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2287 }22882289 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2290 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2291 }2292}229322942295class UniqueTokenBase implements IToken {2296 collection: UniqueNFTCollection | UniqueRFTCollection;2297 collectionId: number;2298 tokenId: number;22992300 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2301 this.collection = collection;2302 this.collectionId = collection.collectionId;2303 this.tokenId = tokenId;2304 }23052306 async getNextSponsored(addressObj: ICrossAccountId) {2307 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2308 }23092310 async setProperties(signer: TSigner, properties: IProperty[]) {2311 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2312 }23132314 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2315 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2316 }2317}231823192320class UniqueNFTToken extends UniqueTokenBase {2321 collection: UniqueNFTCollection;23222323 constructor(tokenId: number, collection: UniqueNFTCollection) {2324 super(tokenId, collection);2325 this.collection = collection;2326 }23272328 async getData(blockHashAt?: string) {2329 return await this.collection.getToken(this.tokenId, blockHashAt);2330 }23312332 async getOwner(blockHashAt?: string) {2333 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2334 }23352336 async getTopmostOwner(blockHashAt?: string) {2337 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2338 }23392340 async getChildren(blockHashAt?: string) {2341 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2342 }23432344 async nest(signer: TSigner, toTokenObj: IToken) {2345 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2346 }23472348 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2349 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2350 }23512352 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2353 return await this.collection.transferToken(signer, this.tokenId, addressObj);2354 }23552356 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2357 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2358 }23592360 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2361 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2362 }23632364 async isApproved(toAddressObj: ICrossAccountId) {2365 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2366 }23672368 async burn(signer: TSigner) {2369 return await this.collection.burnToken(signer, this.tokenId);2370 }2371}23722373class UniqueRFTToken extends UniqueTokenBase {2374 collection: UniqueRFTCollection;23752376 constructor(tokenId: number, collection: UniqueRFTCollection) {2377 super(tokenId, collection);2378 this.collection = collection;2379 }23802381 async getTop10Owners() {2382 return await this.collection.getTop10TokenOwners(this.tokenId);2383 }23842385 async getBalance(addressObj: ICrossAccountId) {2386 return await this.collection.getTokenBalance(this.tokenId, addressObj);2387 }23882389 async getTotalPieces() {2390 return await this.collection.getTokenTotalPieces(this.tokenId);2391 }23922393 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2394 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2395 }23962397 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2398 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2399 }24002401 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2402 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2403 }24042405 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2406 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2407 }24082409 async repartition(signer: TSigner, amount: bigint) {2410 return await this.collection.repartitionToken(signer, this.tokenId, amount);2411 }24122413 async burn(signer: TSigner, amount=1n) {2414 return await this.collection.burnToken(signer, this.tokenId, amount);2415 }2416}