`09b9e64d0480`

2 files changed

modifiedtests/src/util/playgrounds/unique.dev.tsdiff before after both

--- a/tests/src/util/playgrounds/unique.dev.ts
+++ b/tests/src/util/playgrounds/unique.dev.ts
@@ -7,10 +7,6 @@
 import * as defs from '../../interfaces/definitions';
 import {IKeyringPair} from '@polkadot/types/types';
 import {ICrossAccountId} from './types';
-import type {EventRecord} from '@polkadot/types/interfaces';
-import {VoidFn} from '@polkadot/api/types';
-import {FrameSystemEventRecord} from '@polkadot/types/lookup';
-
 
 export class SilentLogger {
   log(_msg: any, _level: any): void { }

modifiedtests/src/util/playgrounds/unique.tsdiff before after both

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, SignerOptions} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IStakingInfo, ISchedulerOptions, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';13import {RuntimeDispatchInfo} from '@polkadot/types/interfaces';1415export class CrossAccountId implements ICrossAccountId {16  Substrate?: TSubstrateAccount;17  Ethereum?: TEthereumAccount;1819  constructor(account: ICrossAccountId) {20    if (account.Substrate) this.Substrate = account.Substrate;21    if (account.Ethereum) this.Ethereum = account.Ethereum;22  }2324  static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {25    switch (domain) {26      case 'Substrate': return new CrossAccountId({Substrate: account.address});27      case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();28    }29  }3031  static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {32    return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});33  }3435  static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {36    return encodeAddress(decodeAddress(address), ss58Format);37  }3839  static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {40    return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});41  }42  43  withNormalizedSubstrate(ss58Format = 42): CrossAccountId {44    if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);45    return this;46  }4748  static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {49    return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));50  }5152  toEthereum(): CrossAccountId {53    if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});54    return this;55  }5657  static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {58    return evmToAddress(address, ss58Format);59  }6061  toSubstrate(ss58Format?: number): CrossAccountId {62    if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});63    return this;64  }65  66  toLowerCase(): CrossAccountId {67    if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();68    if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();69    return this;70  }71}7273const nesting = {74  toChecksumAddress(address: string): string {75    if (typeof address === 'undefined') return '';7677    if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);7879    address = address.toLowerCase().replace(/^0x/i,'');80    const addressHash = keccakAsHex(address).replace(/^0x/i,'');81    const checksumAddress = ['0x'];8283    for (let i = 0; i < address.length; i++) {84      // If ith character is 8 to f then make it uppercase85      if (parseInt(addressHash[i], 16) > 7) {86        checksumAddress.push(address[i].toUpperCase());87      } else {88        checksumAddress.push(address[i]);89      }90    }91    return checksumAddress.join('');92  },93  tokenIdToAddress(collectionId: number, tokenId: number) {94    return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8, '0')}${tokenId.toString(16).padStart(8, '0')}`);95  },96};9798class UniqueUtil {99  static transactionStatus = {100    NOT_READY: 'NotReady',101    FAIL: 'Fail',102    SUCCESS: 'Success',103  };104105  static chainLogType = {106    EXTRINSIC: 'extrinsic',107    RPC: 'rpc',108  };109110  static getTokenAccount(token: IToken): CrossAccountId {111    return new CrossAccountId({Ethereum: this.getTokenAddress(token)});112  }113114  static getTokenAddress(token: IToken): string {115    return nesting.tokenIdToAddress(token.collectionId, token.tokenId);116  }117118  static getDefaultLogger(): ILogger {119    return {120      log(msg: any, level = 'INFO') {121        console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));122      },123      level: {124        ERROR: 'ERROR',125        WARNING: 'WARNING',126        INFO: 'INFO',127      },128    };129  }130131  static vec2str(arr: string[] | number[]) {132    return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');133  }134135  static str2vec(string: string) {136    if (typeof string !== 'string') return string;137    return Array.from(string).map(x => x.charCodeAt(0));138  }139140  static fromSeed(seed: string, ss58Format = 42) {141    const keyring = new Keyring({type: 'sr25519', ss58Format});142    return keyring.addFromUri(seed);143  }144145  static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {146    if (creationResult.status !== this.transactionStatus.SUCCESS) {147      throw Error('Unable to create collection!');148    }149150    let collectionId = null;151    creationResult.result.events.forEach(({event: {data, method, section}}) => {152      if ((section === 'common') && (method === 'CollectionCreated')) {153        collectionId = parseInt(data[0].toString(), 10);154      }155    });156157    if (collectionId === null) {158      throw Error('No CollectionCreated event was found!');159    }160161    return collectionId;162  }163164  static extractTokensFromCreationResult(creationResult: ITransactionResult): {165    success: boolean, 166    tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],167  } {168    if (creationResult.status !== this.transactionStatus.SUCCESS) {169      throw Error('Unable to create tokens!');170    }171    let success = false;172    const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];173    creationResult.result.events.forEach(({event: {data, method, section}}) => {174      if (method === 'ExtrinsicSuccess') {175        success = true;176      } else if ((section === 'common') && (method === 'ItemCreated')) {177        tokens.push({178          collectionId: parseInt(data[0].toString(), 10),179          tokenId: parseInt(data[1].toString(), 10),180          owner: data[2].toHuman(),181          amount: data[3].toBigInt(),182        });183      }184    });185    return {success, tokens};186  }187188  static extractTokensFromBurnResult(burnResult: ITransactionResult): {189    success: boolean, 190    tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],191  } {192    if (burnResult.status !== this.transactionStatus.SUCCESS) {193      throw Error('Unable to burn tokens!');194    }195    let success = false;196    const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];197    burnResult.result.events.forEach(({event: {data, method, section}}) => {198      if (method === 'ExtrinsicSuccess') {199        success = true;200      } else if ((section === 'common') && (method === 'ItemDestroyed')) {201        tokens.push({202          collectionId: parseInt(data[0].toString(), 10),203          tokenId: parseInt(data[1].toString(), 10),204          owner: data[2].toHuman(),205          amount: data[3].toBigInt(),206        });207      }208    });209    return {success, tokens};210  }211212  static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {213    let eventId = null;214    events.forEach(({event: {data, method, section}}) => {215      if ((section === expectedSection) && (method === expectedMethod)) {216        eventId = parseInt(data[0].toString(), 10);217      }218    });219220    if (eventId === null) {221      throw Error(`No ${expectedMethod} event was found!`);222    }223    return eventId === collectionId;224  }225226  static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {227    const normalizeAddress = (address: string | ICrossAccountId) => {228      if(typeof address === 'string') return address;229      const obj = {} as any;230      Object.keys(address).forEach(k => {231        obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];232      });233      if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);234      if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();235      return address;236    };237    let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;238    events.forEach(({event: {data, method, section}}) => {239      if ((section === 'common') && (method === 'Transfer')) {240        const hData = (data as any).toJSON();241        transfer = {242          collectionId: hData[0],243          tokenId: hData[1],244          from: normalizeAddress(hData[2]),245          to: normalizeAddress(hData[3]),246          amount: BigInt(hData[4]),247        };248      }249    });250    let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;251    isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);252    isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);253    isSuccess = isSuccess && amount === transfer.amount;254    return isSuccess;255  }256}257258class UniqueEventHelper {259  private static extractIndex(index: any): [number, number] | string {260    if(index.toRawType() === '[u8;2]') return [index[0], index[1]];261    return index.toJSON();262  }263264  private static extractSub(data: any, subTypes: any): {[key: string]: any} {265    let obj: any = {};266    let index = 0;267268    if (data.entries) {269      for(const [key, value] of data.entries()) {270        obj[key] = this.extractData(value, subTypes[index]);271        index++;272      }273    } else obj = data.toJSON();274275    return obj;276  }277  278  private static extractData(data: any, type: any): any {279    if(!type) return data.toHuman();280    if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();281    if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();282    if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);283    return data.toHuman();284  }285286  public static extractEvents(records: ITransactionResult): IEvent[] {287    const parsedEvents: IEvent[] = [];288289    records.result.events.forEach((record) => {290      const {event, phase} = record;291      const types = (event as any).typeDef;292293      const eventData: IEvent = {294        section: event.section.toString(),295        method: event.method.toString(),296        index: this.extractIndex(event.index),297        data: [],298        phase: phase.toJSON(),299      };300301      event.data.forEach((val: any, index: number) => {302        eventData.data.push(this.extractData(val, types[index]));303      });304305      parsedEvents.push(eventData);306    });307308    return parsedEvents;309  }310}311312class ChainHelperBase {313  transactionStatus = UniqueUtil.transactionStatus;314  chainLogType = UniqueUtil.chainLogType;315  util: typeof UniqueUtil;316  eventHelper: typeof UniqueEventHelper;317  logger: ILogger;318  api: ApiPromise | null;319  forcedNetwork: TUniqueNetworks | null;320  network: TUniqueNetworks | null;321  chainLog: IUniqueHelperLog[];322  children: ChainHelperBase[];323324  constructor(logger?: ILogger) {325    this.util = UniqueUtil;326    this.eventHelper = UniqueEventHelper;327    if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();328    this.logger = logger;329    this.api = null;330    this.forcedNetwork = null;331    this.network = null;332    this.chainLog = [];333    this.children = [];334  }335336  getApi(): ApiPromise {337    if(this.api === null) throw Error('API not initialized');338    return this.api;339  }340341  clearChainLog(): void {342    this.chainLog = [];343  }344345  forceNetwork(value: TUniqueNetworks): void {346    this.forcedNetwork = value;347  }348349  async connect(wsEndpoint: string, listeners?: IApiListeners) {350    if (this.api !== null) throw Error('Already connected');351    const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);352    this.api = api;353    this.network = network;354  }355356  async disconnect() {357    for (const child of this.children) {358      child.clearApi();359    }360361    if (this.api === null) return;362    await this.api.disconnect();363    this.clearApi();364  }365366  clearApi() {367    this.api = null;368    this.network = null;369  }370371  static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {372    const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;373    if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;374    return 'opal';375  }376377  static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {378    const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});379    await api.isReady;380381    const network = await this.detectNetwork(api);382383    await api.disconnect();384385    return network;386  }387388  static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{389    api: ApiPromise;390    network: TUniqueNetworks;391  }> {392    if(typeof network === 'undefined' || network === null) network = 'opal';393    const supportedRPC = {394      opal: {395        unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,396      },397      quartz: {398        unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,399      },400      unique: {401        unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,402      },403    };404    if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);405    const rpc = supportedRPC[network];406407    // TODO: investigate how to replace rpc in runtime408    // api._rpcCore.addUserInterfaces(rpc);409410    const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});411412    await api.isReadyOrError;413414    if (typeof listeners === 'undefined') listeners = {};415    for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {416      if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;417      api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);418    }419420    return {api, network};421  }422423  getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {424    const {events, status} = data;425    if (status.isReady) {426      return this.transactionStatus.NOT_READY;427    }428    if (status.isBroadcast) {429      return this.transactionStatus.NOT_READY;430    }431    if (status.isInBlock || status.isFinalized) {432      const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');433      if (errors.length > 0) {434        return this.transactionStatus.FAIL;435      }436      if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {437        return this.transactionStatus.SUCCESS;438      }439    }440441    return this.transactionStatus.FAIL;442  }443444  signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {445    const sign = (callback: any) => {446      if(options !== null) return transaction.signAndSend(sender, options, callback);447      return transaction.signAndSend(sender, callback);448    };449    // eslint-disable-next-line no-async-promise-executor450    return new Promise(async (resolve, reject) => {451      try {452        const unsub = await sign((result: any) => {453          const status = this.getTransactionStatus(result);454455          if (status === this.transactionStatus.SUCCESS) {456            this.logger.log(`${label} successful`);457            unsub();458            resolve({result, status});459          } else if (status === this.transactionStatus.FAIL) {460            let moduleError = null;461462            if (result.hasOwnProperty('dispatchError')) {463              const dispatchError = result['dispatchError'];464465              if (dispatchError) {466                if (dispatchError.isModule) {467                  const modErr = dispatchError.asModule;468                  const errorMeta = dispatchError.registry.findMetaError(modErr);469470                  moduleError = `${errorMeta.section}.${errorMeta.name}`;471                } else {472                  moduleError = dispatchError.toHuman();473                }474              } else {475                this.logger.log(result, this.logger.level.ERROR);476              }477            }478479            this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);480            unsub();481            reject({status, moduleError, result});482          }483        });484      } catch (e) {485        this.logger.log(e, this.logger.level.ERROR);486        reject(e);487      }488    });489  }490491  constructApiCall(apiCall: string, params: any[]) {492    if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);493    let call = this.getApi() as any;494    for(const part of apiCall.slice(4).split('.')) {495      call = call[part];496    }497    return call(...params);498  }499500  async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {501    if(this.api === null) throw Error('API not initialized');502    if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);503504    const startTime = (new Date()).getTime();505    let result: ITransactionResult;506    let events: IEvent[] = [];507    try {508      result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;509      events = this.eventHelper.extractEvents(result);510    }511    catch(e) {512      if(!(e as object).hasOwnProperty('status')) throw e;513      result = e as ITransactionResult;514    }515516    const endTime = (new Date()).getTime();517518    const log = {519      executedAt: endTime,520      executionTime: endTime - startTime,521      type: this.chainLogType.EXTRINSIC,522      status: result.status,523      call: extrinsic,524      signer: this.getSignerAddress(sender),525      params,526    } as IUniqueHelperLog;527528    if(result.status !== this.transactionStatus.SUCCESS) {529      if (result.moduleError) log.moduleError = result.moduleError;530      else if (result.result.dispatchError) log.dispatchError = result.result.dispatchError;531    }532    if(events.length > 0) log.events = events;533534    this.chainLog.push(log);535536    if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {537      if (result.moduleError) throw Error(`${result.moduleError}`);538      else if (result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));539    }540    return result;541  }542543  async callRpc(rpc: string, params?: any[]) {544    if(typeof params === 'undefined') params = [];545    if(this.api === null) throw Error('API not initialized');546    if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);547548    const startTime = (new Date()).getTime();549    let result;550    let error = null;551    const log = {552      type: this.chainLogType.RPC,553      call: rpc,554      params,555    } as IUniqueHelperLog;556557    try {558      result = await this.constructApiCall(rpc, params);559    }560    catch(e) {561      error = e;562    }563564    const endTime = (new Date()).getTime();565566    log.executedAt = endTime;567    log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';568    log.executionTime = endTime - startTime;569570    this.chainLog.push(log);571572    if(error !== null) throw error;573574    return result;575  }576577  getSignerAddress(signer: IKeyringPair | string): string {578    if(typeof signer === 'string') return signer;579    return signer.address;580  }581582  fetchAllPalletNames(): string[] {583    if(this.api === null) throw Error('API not initialized');584    return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());585  }586587  fetchMissingPalletNames(requiredPallets: string[]): string[] {588    const palletNames = this.fetchAllPalletNames();589    return requiredPallets.filter(p => !palletNames.includes(p));590  }591}592593594class HelperGroup {595  helper: UniqueHelper;596597  constructor(uniqueHelper: UniqueHelper) {598    this.helper = uniqueHelper;599  }600}601602603class CollectionGroup extends HelperGroup {604  /**605 * Get number of blocks when sponsored transaction is available.606 *607 * @param collectionId ID of collection608 * @param tokenId ID of token609 * @param addressObj address for which the sponsorship is checked610 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});611 * @returns number of blocks or null if sponsorship hasn't been set612 */613  async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {614    return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();615  }616617  /**618   * Get the number of created collections.619   *620   * @returns number of created collections621   */622  async getTotalCount(): Promise<number> {623    return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();624  }625626  /**627   * Get information about the collection with additional data,628   * including the number of tokens it contains, its administrators,629   * the normalized address of the collection's owner, and decoded name and description.630   *631   * @param collectionId ID of collection632   * @example await getData(2)633   * @returns collection information object634   */635  async getData(collectionId: number): Promise<{636    id: number;637    name: string;638    description: string;639    tokensCount: number;640    admins: CrossAccountId[];641    normalizedOwner: TSubstrateAccount;642    raw: any643  } | null> {644    const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);645    const humanCollection = collection.toHuman(), collectionData = {646      id: collectionId, name: null, description: null, tokensCount: 0, admins: [],647      raw: humanCollection,648    } as any, jsonCollection = collection.toJSON();649    if (humanCollection === null) return null;650    collectionData.raw.limits = jsonCollection.limits;651    collectionData.raw.permissions = jsonCollection.permissions;652    collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);653    for (const key of ['name', 'description']) {654      collectionData[key] = this.helper.util.vec2str(humanCollection[key]);655    }656657    collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))658      ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)659      : 0;660    collectionData.admins = await this.getAdmins(collectionId);661662    return collectionData;663  }664665  /**666   * Get the addresses of the collection's administrators, optionally normalized.667   *668   * @param collectionId ID of collection669   * @param normalize whether to normalize the addresses to the default ss58 format670   * @example await getAdmins(1)671   * @returns array of administrators672   */673  async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {674    const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();675676    return normalize677      ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())678      : admins;679  }680681  /**682   * Get the addresses added to the collection allow-list, optionally normalized.683   * @param collectionId ID of collection684   * @param normalize whether to normalize the addresses to the default ss58 format685   * @example await getAllowList(1)686   * @returns array of allow-listed addresses687   */688  async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {689    const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();690    return normalize691      ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())692      : allowListed;693  }694695  /**696   * Get the effective limits of the collection instead of null for default values697   *698   * @param collectionId ID of collection699   * @example await getEffectiveLimits(2)700   * @returns object of collection limits701   */702  async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {703    return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();704  }705706  /**707   * Burns the collection if the signer has sufficient permissions and collection is empty.708   *709   * @param signer keyring of signer710   * @param collectionId ID of collection711   * @example await helper.collection.burn(aliceKeyring, 3);712   * @returns ```true``` if extrinsic success, otherwise ```false```713   */714  async burn(signer: TSigner, collectionId: number): Promise<boolean> {715    const result = await this.helper.executeExtrinsic(716      signer,717      'api.tx.unique.destroyCollection', [collectionId],718      true,719    );720721    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');722  }723724  /**725   * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.726   *727   * @param signer keyring of signer728   * @param collectionId ID of collection729   * @param sponsorAddress Sponsor substrate address730   * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")731   * @returns ```true``` if extrinsic success, otherwise ```false```732   */733  async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {734    const result = await this.helper.executeExtrinsic(735      signer,736      'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],737      true,738    );739740    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');741  }742743  /**744   * Confirms consent to sponsor the collection on behalf of the signer.745   *746   * @param signer keyring of signer747   * @param collectionId ID of collection748   * @example confirmSponsorship(aliceKeyring, 10)749   * @returns ```true``` if extrinsic success, otherwise ```false```750   */751  async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {752    const result = await this.helper.executeExtrinsic(753      signer,754      'api.tx.unique.confirmSponsorship', [collectionId],755      true,756    );757758    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');759  }760761  /**762   * Removes the sponsor of a collection, regardless if it consented or not.763   *764   * @param signer keyring of signer765   * @param collectionId ID of collection766   * @example removeSponsor(aliceKeyring, 10)767   * @returns ```true``` if extrinsic success, otherwise ```false```768   */769  async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {770    const result = await this.helper.executeExtrinsic(771      signer,772      'api.tx.unique.removeCollectionSponsor', [collectionId],773      true,774    );775776    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');777  }778779  /**780   * Sets the limits of the collection. At least one limit must be specified for a correct call.781   *782   * @param signer keyring of signer783   * @param collectionId ID of collection784   * @param limits collection limits object785   * @example786   * await setLimits(787   *   aliceKeyring,788   *   10,789   *   {790   *     sponsorTransferTimeout: 0,791   *     ownerCanDestroy: false792   *   }793   * )794   * @returns ```true``` if extrinsic success, otherwise ```false```795   */796  async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {797    const result = await this.helper.executeExtrinsic(798      signer,799      'api.tx.unique.setCollectionLimits', [collectionId, limits],800      true,801    );802803    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');804  }805806  /**807   * Changes the owner of the collection to the new Substrate address.808   *809   * @param signer keyring of signer810   * @param collectionId ID of collection811   * @param ownerAddress substrate address of new owner812   * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")813   * @returns ```true``` if extrinsic success, otherwise ```false```814   */815  async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {816    const result = await this.helper.executeExtrinsic(817      signer,818      'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],819      true,820    );821822    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');823  }824825  /**826   * Adds a collection administrator.827   *828   * @param signer keyring of signer829   * @param collectionId ID of collection830   * @param adminAddressObj Administrator address (substrate or ethereum)831   * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})832   * @returns ```true``` if extrinsic success, otherwise ```false```833   */834  async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {835    const result = await this.helper.executeExtrinsic(836      signer,837      'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],838      true,839    );840841    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');842  }843844  /**845   * Removes a collection administrator.846   *847   * @param signer keyring of signer848   * @param collectionId ID of collection849   * @param adminAddressObj Administrator address (substrate or ethereum)850   * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})851   * @returns ```true``` if extrinsic success, otherwise ```false```852   */853  async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {854    const result = await this.helper.executeExtrinsic(855      signer,856      'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],857      true,858    );859860    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');861  }862863  /**864   * Check if user is in allow list.865   * 866   * @param collectionId ID of collection867   * @param user Account to check868   * @example await getAdmins(1)869   * @returns is user in allow list870   */871  async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {872    return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();873  }874875  /**876   * Adds an address to allow list877   * @param signer keyring of signer878   * @param collectionId ID of collection879   * @param addressObj address to add to the allow list880   * @returns ```true``` if extrinsic success, otherwise ```false```881   */882  async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {883    const result = await this.helper.executeExtrinsic(884      signer,885      'api.tx.unique.addToAllowList', [collectionId, addressObj],886      true,887    );888889    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');890  }891892  /**893   * Removes an address from allow list894   *895   * @param signer keyring of signer896   * @param collectionId ID of collection897   * @param addressObj address to remove from the allow list898   * @returns ```true``` if extrinsic success, otherwise ```false```899   */900  async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {901    const result = await this.helper.executeExtrinsic(902      signer,903      'api.tx.unique.removeFromAllowList', [collectionId, addressObj],904      true,905    );906907    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');908  }909910  /**911   * Sets onchain permissions for selected collection.912   *913   * @param signer keyring of signer914   * @param collectionId ID of collection915   * @param permissions collection permissions object916   * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});917   * @returns ```true``` if extrinsic success, otherwise ```false```918   */919  async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {920    const result = await this.helper.executeExtrinsic(921      signer,922      'api.tx.unique.setCollectionPermissions', [collectionId, permissions],923      true,924    );925926    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');927  }928929  /**930   * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.931   *932   * @param signer keyring of signer933   * @param collectionId ID of collection934   * @param permissions nesting permissions object935   * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});936   * @returns ```true``` if extrinsic success, otherwise ```false```937   */938  async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {939    return await this.setPermissions(signer, collectionId, {nesting: permissions});940  }941942  /**943   * Disables nesting for selected collection.944   *945   * @param signer keyring of signer946   * @param collectionId ID of collection947   * @example disableNesting(aliceKeyring, 10);948   * @returns ```true``` if extrinsic success, otherwise ```false```949   */950  async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {951    return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});952  }953954  /**955   * Sets onchain properties to the collection.956   *957   * @param signer keyring of signer958   * @param collectionId ID of collection959   * @param properties array of property objects960   * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);961   * @returns ```true``` if extrinsic success, otherwise ```false```962   */963  async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {964    const result = await this.helper.executeExtrinsic(965      signer,966      'api.tx.unique.setCollectionProperties', [collectionId, properties],967      true,968    );969970    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');971  }972973  /**974   * Get collection properties.975   * 976   * @param collectionId ID of collection977   * @param propertyKeys optionally filter the returned properties to only these keys978   * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);979   * @returns array of key-value pairs980   */981  async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {982    return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();983  }984985  /**986   * Deletes onchain properties from the collection.987   *988   * @param signer keyring of signer989   * @param collectionId ID of collection990   * @param propertyKeys array of property keys to delete991   * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);992   * @returns ```true``` if extrinsic success, otherwise ```false```993   */994  async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {995    const result = await this.helper.executeExtrinsic(996      signer,997      'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],998      true,999    );10001001    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1002  }10031004  /**1005   * Changes the owner of the token.1006   *1007   * @param signer keyring of signer1008   * @param collectionId ID of collection1009   * @param tokenId ID of token1010   * @param addressObj address of a new owner1011   * @param amount amount of tokens to be transfered. For NFT must be set to 1n1012   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1013   * @returns true if the token success, otherwise false1014   */1015  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1016    const result = await this.helper.executeExtrinsic(1017      signer,1018      'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1019      true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1020    );10211022    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1023  }10241025  /**1026   *1027   * Change ownership of a token(s) on behalf of the owner.1028   *1029   * @param signer keyring of signer1030   * @param collectionId ID of collection1031   * @param tokenId ID of token1032   * @param fromAddressObj address on behalf of which the token will be sent1033   * @param toAddressObj new token owner1034   * @param amount amount of tokens to be transfered. For NFT must be set to 1n1035   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1036   * @returns true if the token success, otherwise false1037   */1038  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1039    const result = await this.helper.executeExtrinsic(1040      signer,1041      'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1042      true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1043    );1044    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1045  }10461047  /**1048   *1049   * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1050   *1051   * @param signer keyring of signer1052   * @param collectionId ID of collection1053   * @param tokenId ID of token1054   * @param amount amount of tokens to be burned. For NFT must be set to 1n1055   * @example burnToken(aliceKeyring, 10, 5);1056   * @returns ```true``` if the extrinsic is successful, otherwise ```false```1057   */1058  async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1059    const burnResult = await this.helper.executeExtrinsic(1060      signer,1061      'api.tx.unique.burnItem', [collectionId, tokenId, amount],1062      true, // `Unable to burn token for ${label}`,1063    );1064    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1065    if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1066    return burnedTokens.success;1067  }10681069  /**1070   * Destroys a concrete instance of NFT on behalf of the owner1071   *1072   * @param signer keyring of signer1073   * @param collectionId ID of collection1074   * @param tokenId ID of token1075   * @param fromAddressObj address on behalf of which the token will be burnt1076   * @param amount amount of tokens to be burned. For NFT must be set to 1n1077   * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1078   * @returns ```true``` if extrinsic success, otherwise ```false```1079   */1080  async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1081    const burnResult = await this.helper.executeExtrinsic(1082      signer,1083      'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1084      true, // `Unable to burn token from for ${label}`,1085    );1086    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1087    return burnedTokens.success && burnedTokens.tokens.length > 0;1088  }10891090  /**1091   * Set, change, or remove approved address to transfer the ownership of the NFT.1092   *1093   * @param signer keyring of signer1094   * @param collectionId ID of collection1095   * @param tokenId ID of token1096   * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1097   * @param amount amount of token to be approved. For NFT must be set to 1n1098   * @returns ```true``` if extrinsic success, otherwise ```false```1099   */1100  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1101    const approveResult = await this.helper.executeExtrinsic(1102      signer,1103      'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1104      true, // `Unable to approve token for ${label}`,1105    );11061107    return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1108  }11091110  /**1111   * Get the amount of token pieces approved to transfer or burn. Normally 0.1112   *1113   * @param collectionId ID of collection1114   * @param tokenId ID of token1115   * @param toAccountObj address which is approved to use token pieces1116   * @param fromAccountObj address which may have allowed the use of its owned tokens1117   * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1118   * @returns number of approved to transfer pieces1119   */1120  async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1121    return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1122  }11231124  /**1125   * Get the last created token ID in a collection1126   *1127   * @param collectionId ID of collection1128   * @example getLastTokenId(10);1129   * @returns id of the last created token1130   */1131  async getLastTokenId(collectionId: number): Promise<number> {1132    return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1133  }11341135  /**1136   * Check if token exists1137   *1138   * @param collectionId ID of collection1139   * @param tokenId ID of token1140   * @example doesTokenExist(10, 20);1141   * @returns true if the token exists, otherwise false1142   */1143  async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1144    return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1145  }1146}11471148class NFTnRFT extends CollectionGroup {1149  /**1150   * Get tokens owned by account1151   *1152   * @param collectionId ID of collection1153   * @param addressObj tokens owner1154   * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1155   * @returns array of token ids owned by account1156   */1157  async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1158    return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1159  }11601161  /**1162   * Get token data1163   *1164   * @param collectionId ID of collection1165   * @param tokenId ID of token1166   * @param propertyKeys optionally filter the token properties to only these keys1167   * @param blockHashAt optionally query the data at some block with this hash1168   * @example getToken(10, 5);1169   * @returns human readable token data1170   */1171  async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1172    properties: IProperty[];1173    owner: CrossAccountId;1174    normalizedOwner: CrossAccountId;1175  }| null> {1176    let tokenData;1177    if(typeof blockHashAt === 'undefined') {1178      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1179    }1180    else {1181      if(propertyKeys.length == 0) {1182        const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1183        if(!collection) return null;1184        propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1185      }1186      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1187    }1188    tokenData = tokenData.toHuman();1189    if (tokenData === null || tokenData.owner === null) return null;1190    const owner = {} as any;1191    for (const key of Object.keys(tokenData.owner)) {1192      owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate' 1193        ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key]) 1194        : tokenData.owner[key];1195    }1196    tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1197    return tokenData;1198  }11991200  /**1201   * Set permissions to change token properties1202   *1203   * @param signer keyring of signer1204   * @param collectionId ID of collection1205   * @param permissions permissions to change a property by the collection admin or token owner1206   * @example setTokenPropertyPermissions(1207   *   aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1208   * )1209   * @returns true if extrinsic success otherwise false1210   */1211  async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1212    const result = await this.helper.executeExtrinsic(1213      signer,1214      'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1215      true,1216    );12171218    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1219  }12201221  /**1222   * Get token property permissions.1223   * 1224   * @param collectionId ID of collection1225   * @param propertyKeys optionally filter the returned property permissions to only these keys1226   * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1227   * @returns array of key-permission pairs1228   */1229  async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1230    return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1231  }12321233  /**1234   * Set token properties1235   *1236   * @param signer keyring of signer1237   * @param collectionId ID of collection1238   * @param tokenId ID of token1239   * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1240   * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1241   * @returns ```true``` if extrinsic success, otherwise ```false```1242   */1243  async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1244    const result = await this.helper.executeExtrinsic(1245      signer,1246      'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1247      true,1248    );12491250    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1251  }12521253  /**1254   * Get properties, metadata assigned to a token.1255   * 1256   * @param collectionId ID of collection1257   * @param tokenId ID of token1258   * @param propertyKeys optionally filter the returned properties to only these keys1259   * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1260   * @returns array of key-value pairs1261   */1262  async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1263    return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1264  }12651266  /**1267   * Delete the provided properties of a token1268   * @param signer keyring of signer1269   * @param collectionId ID of collection1270   * @param tokenId ID of token1271   * @param propertyKeys property keys to be deleted1272   * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1273   * @returns ```true``` if extrinsic success, otherwise ```false```1274   */1275  async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1276    const result = await this.helper.executeExtrinsic(1277      signer,1278      'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1279      true,1280    );12811282    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1283  }12841285  /**1286   * Mint new collection1287   *1288   * @param signer keyring of signer1289   * @param collectionOptions basic collection options and properties1290   * @param mode NFT or RFT type of a collection1291   * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1292   * @returns object of the created collection1293   */1294  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1295    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1296    collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1297    for (const key of ['name', 'description', 'tokenPrefix']) {1298      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);1299    }1300    const creationResult = await this.helper.executeExtrinsic(1301      signer,1302      'api.tx.unique.createCollectionEx', [collectionOptions],1303      true, // errorLabel,1304    );1305    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1306  }13071308  getCollectionObject(_collectionId: number): any {1309    return null;1310  }13111312  getTokenObject(_collectionId: number, _tokenId: number): any {1313    return null;1314  }1315}131613171318class NFTGroup extends NFTnRFT {1319  /**1320   * Get collection object1321   * @param collectionId ID of collection1322   * @example getCollectionObject(2);1323   * @returns instance of UniqueNFTCollection1324   */1325  getCollectionObject(collectionId: number): UniqueNFTCollection {1326    return new UniqueNFTCollection(collectionId, this.helper);1327  }13281329  /**1330   * Get token object1331   * @param collectionId ID of collection1332   * @param tokenId ID of token1333   * @example getTokenObject(10, 5);1334   * @returns instance of UniqueNFTToken1335   */1336  getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1337    return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1338  }13391340  /**1341   * Get token's owner1342   * @param collectionId ID of collection1343   * @param tokenId ID of token1344   * @param blockHashAt optionally query the data at the block with this hash1345   * @example getTokenOwner(10, 5);1346   * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1347   */1348  async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1349    let owner;1350    if (typeof blockHashAt === 'undefined') {1351      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1352    } else {1353      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1354    }1355    return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1356  }13571358  /**1359   * Is token approved to transfer1360   * @param collectionId ID of collection1361   * @param tokenId ID of token1362   * @param toAccountObj address to be approved1363   * @returns ```true``` if extrinsic success, otherwise ```false```1364   */1365  async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1366    return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1367  }13681369  /**1370   * Changes the owner of the token.1371   *1372   * @param signer keyring of signer1373   * @param collectionId ID of collection1374   * @param tokenId ID of token1375   * @param addressObj address of a new owner1376   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1377   * @returns ```true``` if extrinsic success, otherwise ```false```1378   */1379  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1380    return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1381  }13821383  /**1384   *1385   * Change ownership of a NFT on behalf of the owner.1386   *1387   * @param signer keyring of signer1388   * @param collectionId ID of collection1389   * @param tokenId ID of token1390   * @param fromAddressObj address on behalf of which the token will be sent1391   * @param toAddressObj new token owner1392   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1393   * @returns ```true``` if extrinsic success, otherwise ```false```1394   */1395  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1396    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1397  }13981399  /**1400   * Recursively find the address that owns the token1401   * @param collectionId ID of collection1402   * @param tokenId ID of token1403   * @param blockHashAt1404   * @example getTokenTopmostOwner(10, 5);1405   * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1406   */1407  async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1408    let owner;1409    if (typeof blockHashAt === 'undefined') {1410      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1411    } else {1412      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1413    }14141415    if (owner === null) return null;14161417    return owner.toHuman();1418  }14191420  /**1421   * Get tokens nested in the provided token1422   * @param collectionId ID of collection1423   * @param tokenId ID of token1424   * @param blockHashAt optionally query the data at the block with this hash1425   * @example getTokenChildren(10, 5);1426   * @returns tokens whose depth of nesting is <= 51427   */1428  async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1429    let children;1430    if(typeof blockHashAt === 'undefined') {1431      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1432    } else {1433      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1434    }14351436    return children.toJSON().map((x: any) => {1437      return {collectionId: x.collection, tokenId: x.token};1438    });1439  }14401441  /**1442   * Nest one token into another1443   * @param signer keyring of signer1444   * @param tokenObj token to be nested1445   * @param rootTokenObj token to be parent1446   * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1447   * @returns ```true``` if extrinsic success, otherwise ```false```1448   */1449  async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1450    const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1451    const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1452    if(!result) {1453      throw Error('Unable to nest token!');1454    }1455    return result;1456  }14571458  /**1459   * Remove token from nested state1460   * @param signer keyring of signer1461   * @param tokenObj token to unnest1462   * @param rootTokenObj parent of a token1463   * @param toAddressObj address of a new token owner1464   * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1465   * @returns ```true``` if extrinsic success, otherwise ```false```1466   */1467  async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1468    const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1469    const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1470    if(!result) {1471      throw Error('Unable to unnest token!');1472    }1473    return result;1474  }14751476  /**1477   * Mint new collection1478   * @param signer keyring of signer1479   * @param collectionOptions Collection options1480   * @example1481   * mintCollection(aliceKeyring, {1482   *   name: 'New',1483   *   description: 'New collection',1484   *   tokenPrefix: 'NEW',1485   * })1486   * @returns object of the created collection1487   */1488  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1489    return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1490  }14911492  /**1493   * Mint new token1494   * @param signer keyring of signer1495   * @param data token data1496   * @returns created token object1497   */1498  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1499    const creationResult = await this.helper.executeExtrinsic(1500      signer,1501      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1502        nft: {1503          properties: data.properties,1504        },1505      }],1506      true,1507    );1508    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1509    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1510    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1511    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1512  }15131514  /**1515   * Mint multiple NFT tokens1516   * @param signer keyring of signer1517   * @param collectionId ID of collection1518   * @param tokens array of tokens with owner and properties1519   * @example1520   * mintMultipleTokens(aliceKeyring, 10, [{1521   *     owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1522   *     properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1523   *   },{1524   *     owner: {Ethereum: "0x9F0583DbB855d..."},1525   *     properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1526   * }]);1527   * @returns ```true``` if extrinsic success, otherwise ```false```1528   */1529  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1530    const creationResult = await this.helper.executeExtrinsic(1531      signer,1532      'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1533      true,1534    );1535    const collection = this.getCollectionObject(collectionId);1536    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1537  }15381539  /**1540   * Mint multiple NFT tokens with one owner1541   * @param signer keyring of signer1542   * @param collectionId ID of collection1543   * @param owner tokens owner1544   * @param tokens array of tokens with owner and properties1545   * @example1546   * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1547   *   properties: [{1548   *   key: "gender",1549   *   value: "female",1550   *  },{1551   *   key: "age",1552   *   value: "33",1553   *  }],1554   * }]);1555   * @returns array of newly created tokens1556   */1557  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1558    const rawTokens = [];1559    for (const token of tokens) {1560      const raw = {NFT: {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   * Set, change, or remove approved address to transfer the ownership of the NFT.1574   *1575   * @param signer keyring of signer1576   * @param collectionId ID of collection1577   * @param tokenId ID of token1578   * @param toAddressObj address to approve1579   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1580   * @returns ```true``` if extrinsic success, otherwise ```false```1581   */1582  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1583    return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1584  }1585}158615871588class RFTGroup extends NFTnRFT {1589  /**1590   * Get collection object1591   * @param collectionId ID of collection1592   * @example getCollectionObject(2);1593   * @returns instance of UniqueRFTCollection1594   */1595  getCollectionObject(collectionId: number): UniqueRFTCollection {1596    return new UniqueRFTCollection(collectionId, this.helper);1597  }15981599  /**1600   * Get token object1601   * @param collectionId ID of collection1602   * @param tokenId ID of token1603   * @example getTokenObject(10, 5);1604   * @returns instance of UniqueNFTToken1605   */1606  getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1607    return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1608  }16091610  /**1611   * Get top 10 token owners with the largest number of pieces1612   * @param collectionId ID of collection1613   * @param tokenId ID of token1614   * @example getTokenTop10Owners(10, 5);1615   * @returns array of top 10 owners1616   */1617  async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1618    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1619  }16201621  /**1622   * Get number of pieces owned by address1623   * @param collectionId ID of collection1624   * @param tokenId ID of token1625   * @param addressObj address token owner1626   * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1627   * @returns number of pieces ownerd by address1628   */1629  async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1630    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1631  }16321633  /**1634   * Transfer pieces of token to another address1635   * @param signer keyring of signer1636   * @param collectionId ID of collection1637   * @param tokenId ID of token1638   * @param addressObj address of a new owner1639   * @param amount number of pieces to be transfered1640   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1641   * @returns ```true``` if extrinsic success, otherwise ```false```1642   */1643  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1644    return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1645  }16461647  /**1648   * Change ownership of some pieces of RFT on behalf of the owner.1649   * @param signer keyring of signer1650   * @param collectionId ID of collection1651   * @param tokenId ID of token1652   * @param fromAddressObj address on behalf of which the token will be sent1653   * @param toAddressObj new token owner1654   * @param amount number of pieces to be transfered1655   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1656   * @returns ```true``` if extrinsic success, otherwise ```false```1657   */1658  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1659    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1660  }16611662  /**1663   * Mint new collection1664   * @param signer keyring of signer1665   * @param collectionOptions Collection options1666   * @example1667   * mintCollection(aliceKeyring, {1668   *   name: 'New',1669   *   description: 'New collection',1670   *   tokenPrefix: 'NEW',1671   * })1672   * @returns object of the created collection1673   */1674  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1675    return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1676  }16771678  /**1679   * Mint new token1680   * @param signer keyring of signer1681   * @param data token data1682   * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1683   * @returns created token object1684   */1685  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1686    const creationResult = await this.helper.executeExtrinsic(1687      signer,1688      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1689        refungible: {1690          pieces: data.pieces,1691          properties: data.properties,1692        },1693      }],1694      true,1695    );1696    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1697    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1698    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1699    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1700  }17011702  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1703    throw Error('Not implemented');1704    const creationResult = await this.helper.executeExtrinsic(1705      signer,1706      'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1707      true, // `Unable to mint RFT tokens for ${label}`,1708    );1709    const collection = this.getCollectionObject(collectionId);1710    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1711  }17121713  /**1714   * Mint multiple RFT tokens with one owner1715   * @param signer keyring of signer1716   * @param collectionId ID of collection1717   * @param owner tokens owner1718   * @param tokens array of tokens with properties and pieces1719   * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1720   * @returns array of newly created RFT tokens1721   */1722  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1723    const rawTokens = [];1724    for (const token of tokens) {1725      const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1726      rawTokens.push(raw);1727    }1728    const creationResult = await this.helper.executeExtrinsic(1729      signer,1730      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1731      true,1732    );1733    const collection = this.getCollectionObject(collectionId);1734    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1735  }17361737  /**1738   * Destroys a concrete instance of RFT.1739   * @param signer keyring of signer1740   * @param collectionId ID of collection1741   * @param tokenId ID of token1742   * @param amount number of pieces to be burnt1743   * @example burnToken(aliceKeyring, 10, 5);1744   * @returns ```true``` if the extrinsic is successful, otherwise ```false```1745   */1746  async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1747    return await super.burnToken(signer, collectionId, tokenId, amount);1748  }17491750  /**1751   * Destroys a concrete instance of RFT on behalf of the owner.1752   * @param signer keyring of signer1753   * @param collectionId ID of collection1754   * @param tokenId ID of token1755   * @param fromAddressObj address on behalf of which the token will be burnt1756   * @param amount number of pieces to be burnt1757   * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1758   * @returns ```true``` if extrinsic success, otherwise ```false```1759   */1760  async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1761    return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1762  }17631764  /**1765   * Set, change, or remove approved address to transfer the ownership of the RFT.1766   *1767   * @param signer keyring of signer1768   * @param collectionId ID of collection1769   * @param tokenId ID of token1770   * @param toAddressObj address to approve1771   * @param amount number of pieces to be approved1772   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1773   * @returns true if the token success, otherwise false1774   */1775  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1776    return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1777  }17781779  /**1780   * Get total number of pieces1781   * @param collectionId ID of collection1782   * @param tokenId ID of token1783   * @example getTokenTotalPieces(10, 5);1784   * @returns number of pieces1785   */1786  async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1787    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1788  }17891790  /**1791   * Change number of token pieces. Signer must be the owner of all token pieces.1792   * @param signer keyring of signer1793   * @param collectionId ID of collection1794   * @param tokenId ID of token1795   * @param amount new number of pieces1796   * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1797   * @returns true if the repartion was success, otherwise false1798   */1799  async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1800    const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1801    const repartitionResult = await this.helper.executeExtrinsic(1802      signer,1803      'api.tx.unique.repartition', [collectionId, tokenId, amount],1804      true,1805    );1806    if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1807    return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1808  }1809}181018111812class FTGroup extends CollectionGroup {1813  /**1814   * Get collection object1815   * @param collectionId ID of collection1816   * @example getCollectionObject(2);1817   * @returns instance of UniqueFTCollection1818   */1819  getCollectionObject(collectionId: number): UniqueFTCollection {1820    return new UniqueFTCollection(collectionId, this.helper);1821  }18221823  /**1824   * Mint new fungible collection1825   * @param signer keyring of signer1826   * @param collectionOptions Collection options1827   * @param decimalPoints number of token decimals1828   * @example1829   * mintCollection(aliceKeyring, {1830   *   name: 'New',1831   *   description: 'New collection',1832   *   tokenPrefix: 'NEW',1833   * }, 18)1834   * @returns newly created fungible collection1835   */1836  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {1837    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1838    if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1839    collectionOptions.mode = {fungible: decimalPoints};1840    for (const key of ['name', 'description', 'tokenPrefix']) {1841      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);1842    }1843    const creationResult = await this.helper.executeExtrinsic(1844      signer,1845      'api.tx.unique.createCollectionEx', [collectionOptions],1846      true,1847    );1848    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1849  }18501851  /**1852   * Mint tokens1853   * @param signer keyring of signer1854   * @param collectionId ID of collection1855   * @param owner address owner of new tokens1856   * @param amount amount of tokens to be meanted1857   * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1858   * @returns ```true``` if extrinsic success, otherwise ```false```1859   */1860  async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1861    const creationResult = await this.helper.executeExtrinsic(1862      signer,1863      'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1864        fungible: {1865          value: amount,1866        },1867      }],1868      true, // `Unable to mint fungible tokens for ${label}`,1869    );1870    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1871  }18721873  /**1874   * Mint multiple Fungible tokens with one owner1875   * @param signer keyring of signer1876   * @param collectionId ID of collection1877   * @param owner tokens owner1878   * @param tokens array of tokens with properties and pieces1879   * @returns ```true``` if extrinsic success, otherwise ```false```1880   */1881  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1882    const rawTokens = [];1883    for (const token of tokens) {1884      const raw = {Fungible: {Value: token.value}};1885      rawTokens.push(raw);1886    }1887    const creationResult = await this.helper.executeExtrinsic(1888      signer,1889      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1890      true,1891    );1892    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1893  }18941895  /**1896   * Get the top 10 owners with the largest balance for the Fungible collection1897   * @param collectionId ID of collection1898   * @example getTop10Owners(10);1899   * @returns array of ```ICrossAccountId```1900   */1901  async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {1902    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1903  }19041905  /**1906   * Get account balance1907   * @param collectionId ID of collection1908   * @param addressObj address of owner1909   * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1910   * @returns amount of fungible tokens owned by address1911   */1912  async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1913    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1914  }19151916  /**1917   * Transfer tokens to address1918   * @param signer keyring of signer1919   * @param collectionId ID of collection1920   * @param toAddressObj address recipient1921   * @param amount amount of tokens to be sent1922   * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1923   * @returns ```true``` if extrinsic success, otherwise ```false```1924   */1925  async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1926    return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1927  }19281929  /**1930   * Transfer some tokens on behalf of the owner.1931   * @param signer keyring of signer1932   * @param collectionId ID of collection1933   * @param fromAddressObj address on behalf of which tokens will be sent1934   * @param toAddressObj address where token to be sent1935   * @param amount number of tokens to be sent1936   * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1937   * @returns ```true``` if extrinsic success, otherwise ```false```1938   */1939  async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1940    return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1941  }19421943  /**1944   * Destroy some amount of tokens1945   * @param signer keyring of signer1946   * @param collectionId ID of collection1947   * @param amount amount of tokens to be destroyed1948   * @example burnTokens(aliceKeyring, 10, 1000n);1949   * @returns ```true``` if extrinsic success, otherwise ```false```1950   */1951  async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1952    return await super.burnToken(signer, collectionId, 0, amount);1953  }19541955  /**1956   * Burn some tokens on behalf of the owner.1957   * @param signer keyring of signer1958   * @param collectionId ID of collection1959   * @param fromAddressObj address on behalf of which tokens will be burnt1960   * @param amount amount of tokens to be burnt1961   * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1962   * @returns ```true``` if extrinsic success, otherwise ```false```1963   */1964  async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1965    return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);1966  }19671968  /**1969   * Get total collection supply1970   * @param collectionId1971   * @returns1972   */1973  async getTotalPieces(collectionId: number): Promise<bigint> {1974    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1975  }19761977  /**1978   * Set, change, or remove approved address to transfer tokens.1979   *1980   * @param signer keyring of signer1981   * @param collectionId ID of collection1982   * @param toAddressObj address to be approved1983   * @param amount amount of tokens to be approved1984   * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1985   * @returns ```true``` if extrinsic success, otherwise ```false```1986   */1987  async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1988    return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1989  }19901991  /**1992   * Get amount of fungible tokens approved to transfer1993   * @param collectionId ID of collection1994   * @param fromAddressObj owner of tokens1995   * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1996   * @returns number of tokens approved for the transfer1997   */1998  async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1999    return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2000  }2001}200220032004class ChainGroup extends HelperGroup {2005  /**2006   * Get system properties of a chain2007   * @example getChainProperties();2008   * @returns ss58Format, token decimals, and token symbol2009   */2010  getChainProperties(): IChainProperties {2011    const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2012    return {2013      ss58Format: properties.ss58Format.toJSON(),2014      tokenDecimals: properties.tokenDecimals.toJSON(),2015      tokenSymbol: properties.tokenSymbol.toJSON(),2016    };2017  }20182019  /**2020   * Get chain header2021   * @example getLatestBlockNumber();2022   * @returns the number of the last block2023   */2024  async getLatestBlockNumber(): Promise<number> {2025    return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2026  }20272028  /**2029   * Get block hash by block number2030   * @param blockNumber number of block2031   * @example getBlockHashByNumber(12345);2032   * @returns hash of a block2033   */2034  async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2035    const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2036    if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2037    return blockHash;2038  }20392040  // TODO add docs2041  async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2042    const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2043    if (!blockHash) return null;2044    return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2045  }20462047  /**2048   * Get account nonce2049   * @param address substrate address2050   * @example getNonce("5GrwvaEF5zXb26Fz...");2051   * @returns number, account's nonce2052   */2053  async getNonce(address: TSubstrateAccount): Promise<number> {2054    return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2055  }2056}205720582059class BalanceGroup extends HelperGroup {2060  getCollectionCreationPrice(): bigint {2061    return 2n * this.helper.balance.getOneTokenNominal();2062  }2063  /**2064   * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2065   * @example getOneTokenNominal()2066   * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2067   */2068  getOneTokenNominal(): bigint {2069    const chainProperties = this.helper.chain.getChainProperties();2070    return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2071  }20722073  /**2074   * Get substrate address balance2075   * @param address substrate address2076   * @example getSubstrate("5GrwvaEF5zXb26Fz...")2077   * @returns amount of tokens on address2078   */2079  async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2080    return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2081  }20822083  /**2084   * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2085   * @param address substrate address2086   * @returns2087   */2088  async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2089    const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2090    return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2091  }20922093  /**2094   * Get ethereum address balance2095   * @param address ethereum address2096   * @example getEthereum("0x9F0583DbB855d...")2097   * @returns amount of tokens on address2098   */2099  async getEthereum(address: TEthereumAccount): Promise<bigint> {2100    return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2101  }21022103  /**2104   * Transfer tokens to substrate address2105   * @param signer keyring of signer2106   * @param address substrate address of a recipient2107   * @param amount amount of tokens to be transfered2108   * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2109   * @returns ```true``` if extrinsic success, otherwise ```false```2110   */2111  async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2112    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}`*/);21132114    let transfer = {from: null, to: null, amount: 0n} as any;2115    result.result.events.forEach(({event: {data, method, section}}) => {2116      if ((section === 'balances') && (method === 'Transfer')) {2117        transfer = {2118          from: this.helper.address.normalizeSubstrate(data[0]),2119          to: this.helper.address.normalizeSubstrate(data[1]),2120          amount: BigInt(data[2]),2121        };2122      }2123    });2124    const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from 2125      && this.helper.address.normalizeSubstrate(address) === transfer.to 2126      && BigInt(amount) === transfer.amount;2127    return isSuccess;2128  }2129}213021312132class AddressGroup extends HelperGroup {2133  /**2134   * Normalizes the address to the specified ss58 format, by default ```42```.2135   * @param address substrate address2136   * @param ss58Format format for address conversion, by default ```42```2137   * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2138   * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2139   */2140  normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2141    return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2142  }21432144  /**2145   * Get address in the connected chain format2146   * @param address substrate address2147   * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2148   * @returns address in chain format2149   */2150  normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2151    return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2152  }21532154  /**2155   * Get substrate mirror of an ethereum address2156   * @param ethAddress ethereum address2157   * @param toChainFormat false for normalized account2158   * @example ethToSubstrate('0x9F0583DbB855d...')2159   * @returns substrate mirror of a provided ethereum address2160   */2161  ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2162    return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2163  }21642165  /**2166   * Get ethereum mirror of a substrate address2167   * @param subAddress substrate account2168   * @example substrateToEth("5DnSF6RRjwteE3BrC...")2169   * @returns ethereum mirror of a provided substrate address2170   */2171  substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2172    return CrossAccountId.translateSubToEth(subAddress);2173  }2174}21752176class StakingGroup extends HelperGroup {2177  /**2178   * Stake tokens for App Promotion2179   * @param signer keyring of signer2180   * @param amountToStake amount of tokens to stake2181   * @param label extra label for log2182   * @returns2183   */2184  async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2185    if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2186    const _stakeResult = await this.helper.executeExtrinsic(2187      signer, 'api.tx.appPromotion.stake',2188      [amountToStake], true,2189    );2190    // TODO extract info from stakeResult2191    return true;2192  }21932194  /**2195   * Unstake tokens for App Promotion2196   * @param signer keyring of signer2197   * @param amountToUnstake amount of tokens to unstake2198   * @param label extra label for log2199   * @returns block number where balances will be unlocked2200   */2201  async unstake(signer: TSigner, label?: string): Promise<number> {2202    if(typeof label === 'undefined') label = `${signer.address}`;2203    const _unstakeResult = await this.helper.executeExtrinsic(2204      signer, 'api.tx.appPromotion.unstake',2205      [], true,2206    );2207    // TODO extract block number fron events2208    return 1;2209  }22102211  /**2212   * Get total staked amount for address2213   * @param address substrate or ethereum address2214   * @returns total staked amount2215   */2216  async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2217    if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2218    return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2219  }22202221  /**2222   * Get total staked per block2223   * @param address substrate or ethereum address2224   * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2225   */2226  async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2227    const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2228    return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2229      return { 2230        block: block.toBigInt(),2231        amount: amount.toBigInt(),2232      };2233    });2234  }22352236  /**2237   * Get total pending unstake amount for address2238   * @param address substrate or ethereum address2239   * @returns total pending unstake amount2240   */2241  async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2242    return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2243  }22442245  /**2246   * Get pending unstake amount per block for address2247   * @param address substrate or ethereum address2248   * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2249   */2250  async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2251    const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2252    const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2253      return {2254        block: block.toBigInt(),2255        amount: amount.toBigInt(),2256      };2257    });2258    return result;2259  }2260}22612262class SchedulerGroup extends HelperGroup {2263  constructor(helper: UniqueHelper) {2264    super(helper);2265  }22662267  async cancelScheduled(signer: TSigner, scheduledId: string) {2268    return this.helper.executeExtrinsic(2269      signer,2270      'api.tx.scheduler.cancelNamed',2271      [scheduledId],2272      true,2273    );2274  }22752276  async changePriority(signer: TSigner, scheduledId: string, priority: number) {2277    return this.helper.executeExtrinsic(2278      signer,2279      'api.tx.scheduler.changeNamedPriority',2280      [scheduledId, priority],2281      true,2282    );2283  }22842285  scheduleAt<T extends UniqueHelper>(2286    scheduledId: string,2287    executionBlockNumber: number,2288    options: ISchedulerOptions = {},2289  ) {2290    return this.schedule<T>('scheduleNamed', scheduledId, executionBlockNumber, options);2291  }22922293  scheduleAfter<T extends UniqueHelper>(2294    scheduledId: string,2295    blocksBeforeExecution: number,2296    options: ISchedulerOptions = {},2297  ) {2298    return this.schedule<T>('scheduleNamedAfter', scheduledId, blocksBeforeExecution, options);2299  }23002301  schedule<T extends UniqueHelper>(2302    scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter',2303    scheduledId: string,2304    blocksNum: number,2305    options: ISchedulerOptions = {},2306  ) {2307    // eslint-disable-next-line @typescript-eslint/naming-convention2308    const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2309    return this.helper.clone(ScheduledHelperType, {2310      scheduleFn,2311      scheduledId,2312      blocksNum,2313      options,2314    }) as T;2315  }2316}23172318export type UniqueHelperConstructor = new(...args: any[]) => UniqueHelper;23192320export class UniqueHelper extends ChainHelperBase {2321  helperBase: any;23222323  chain: ChainGroup;2324  balance: BalanceGroup;2325  address: AddressGroup;2326  collection: CollectionGroup;2327  nft: NFTGroup;2328  rft: RFTGroup;2329  ft: FTGroup;2330  staking: StakingGroup;2331  scheduler: SchedulerGroup;23322333  constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2334    super(logger);23352336    this.helperBase = options.helperBase ?? UniqueHelper;23372338    this.chain = new ChainGroup(this);2339    this.balance = new BalanceGroup(this);2340    this.address = new AddressGroup(this);2341    this.collection = new CollectionGroup(this);2342    this.nft = new NFTGroup(this);2343    this.rft = new RFTGroup(this);2344    this.ft = new FTGroup(this);2345    this.staking = new StakingGroup(this);2346    this.scheduler = new SchedulerGroup(this);2347  }23482349  clone(helperCls: UniqueHelperConstructor, options: {[key: string]: any} = {}) {2350    Object.setPrototypeOf(helperCls.prototype, this);2351    const newHelper = new helperCls(this.logger, options);23522353    newHelper.api = this.api;2354    newHelper.network = this.network;2355    newHelper.forceNetwork = this.forceNetwork;23562357    this.children.push(newHelper);23582359    return newHelper;2360  }23612362  getSudo<T extends UniqueHelper>() {2363    // eslint-disable-next-line @typescript-eslint/naming-convention2364    const SudoHelperType = SudoUniqueHelper(this.helperBase);2365    return this.clone(SudoHelperType) as T;2366  }2367}23682369// eslint-disable-next-line @typescript-eslint/naming-convention2370function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {2371  return class extends Base {2372    scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter';2373    scheduledId: string;2374    blocksNum: number;2375    options: ISchedulerOptions;23762377    constructor(...args: any[]) {2378      const logger = args[0] as ILogger;2379      const options = args[1] as {2380        scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter',2381        scheduledId: string,2382        blocksNum: number,2383        options: ISchedulerOptions2384      };23852386      super(logger);23872388      this.scheduleFn = options.scheduleFn;2389      this.scheduledId = options.scheduledId;2390      this.blocksNum = options.blocksNum;2391      this.options = options.options;2392    }23932394    executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {2395      const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);2396      const extrinsic = 'api.tx.scheduler.' +  this.scheduleFn;23972398      return super.executeExtrinsic(2399        sender,2400        extrinsic,2401        [2402          this.scheduledId,2403          this.blocksNum,2404          this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,2405          this.options.priority ?? null,2406          {Value: scheduledTx},2407        ],2408        expectSuccess,2409      );2410    }2411  };2412}24132414// eslint-disable-next-line @typescript-eslint/naming-convention2415function SudoUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {2416  return class extends Base {2417    constructor(...args: any[]) {2418      super(...args);2419    }24202421    executeExtrinsic (2422      sender: IKeyringPair,2423      extrinsic: string,2424      params: any[],2425      expectSuccess?: boolean,2426    ): Promise<ITransactionResult> {2427      const call = this.constructApiCall(extrinsic, params);24282429      return super.executeExtrinsic(2430        sender,2431        'api.tx.sudo.sudo',2432        [call],2433        expectSuccess,2434      );2435    }2436  };2437}24382439export class UniqueBaseCollection {2440  helper: UniqueHelper;2441  collectionId: number;24422443  constructor(collectionId: number, uniqueHelper: UniqueHelper) {2444    this.collectionId = collectionId;2445    this.helper = uniqueHelper;2446  }24472448  async getData() {2449    return await this.helper.collection.getData(this.collectionId);2450  }24512452  async getLastTokenId() {2453    return await this.helper.collection.getLastTokenId(this.collectionId);2454  }24552456  async doesTokenExist(tokenId: number) {2457    return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);2458  }24592460  async getAdmins() {2461    return await this.helper.collection.getAdmins(this.collectionId);2462  }24632464  async getAllowList() {2465    return await this.helper.collection.getAllowList(this.collectionId);2466  }24672468  async getEffectiveLimits() {2469    return await this.helper.collection.getEffectiveLimits(this.collectionId);2470  }24712472  async getProperties(propertyKeys?: string[] | null) {2473    return await this.helper.collection.getProperties(this.collectionId, propertyKeys);2474  }24752476  async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2477    return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2478  }24792480  async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2481    return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2482  }24832484  async confirmSponsorship(signer: TSigner) {2485    return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2486  }24872488  async removeSponsor(signer: TSigner) {2489    return await this.helper.collection.removeSponsor(signer, this.collectionId);2490  }24912492  async setLimits(signer: TSigner, limits: ICollectionLimits) {2493    return await this.helper.collection.setLimits(signer, this.collectionId, limits);2494  }24952496  async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2497    return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2498  }24992500  async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2501    return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2502  }25032504  async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2505    return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2506  }25072508  async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2509    return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2510  }25112512  async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2513    return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2514  }25152516  async setProperties(signer: TSigner, properties: IProperty[]) {2517    return await this.helper.collection.setProperties(signer, this.collectionId, properties);2518  }25192520  async deleteProperties(signer: TSigner, propertyKeys: string[]) {2521    return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2522  }25232524  async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2525    return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2526  }25272528  async enableNesting(signer: TSigner, permissions: INestingPermissions) {2529    return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2530  }25312532  async disableNesting(signer: TSigner) {2533    return await this.helper.collection.disableNesting(signer, this.collectionId);2534  }25352536  async burn(signer: TSigner) {2537    return await this.helper.collection.burn(signer, this.collectionId);2538  }25392540  scheduleAt<T extends UniqueHelper>(2541    scheduledId: string,2542    executionBlockNumber: number,2543    options: ISchedulerOptions = {},2544  ) {2545    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2546    return new UniqueBaseCollection(this.collectionId, scheduledHelper);2547  }25482549  scheduleAfter<T extends UniqueHelper>(2550    scheduledId: string,2551    blocksBeforeExecution: number,2552    options: ISchedulerOptions = {},2553  ) {2554    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2555    return new UniqueBaseCollection(this.collectionId, scheduledHelper);2556  }25572558  getSudo<T extends UniqueHelper>() {2559    return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());2560  }2561}256225632564export class UniqueNFTCollection extends UniqueBaseCollection {2565  getTokenObject(tokenId: number) {2566    return new UniqueNFToken(tokenId, this);2567  }25682569  async getTokensByAddress(addressObj: ICrossAccountId) {2570    return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2571  }25722573  async getToken(tokenId: number, blockHashAt?: string) {2574    return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2575  }25762577  async getTokenOwner(tokenId: number, blockHashAt?: string) {2578    return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2579  }25802581  async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2582    return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2583  }25842585  async getTokenChildren(tokenId: number, blockHashAt?: string) {2586    return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2587  }25882589  async getPropertyPermissions(propertyKeys: string[] | null = null) {2590    return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);2591  }25922593  async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {2594    return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2595  }25962597  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2598    return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2599  }26002601  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2602    return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2603  }26042605  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2606    return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2607  }26082609  async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2610    return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2611  }26122613  async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2614    return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2615  }26162617  async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2618    return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2619  }26202621  async burnToken(signer: TSigner, tokenId: number) {2622    return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2623  }26242625  async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {2626    return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);2627  }26282629  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2630    return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2631  }26322633  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2634    return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2635  }26362637  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2638    return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2639  }26402641  async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2642    return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2643  }26442645  async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2646    return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2647  }26482649  scheduleAt<T extends UniqueHelper>(2650    scheduledId: string,2651    executionBlockNumber: number,2652    options: ISchedulerOptions = {},2653  ) {2654    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2655    return new UniqueNFTCollection(this.collectionId, scheduledHelper);2656  }26572658  scheduleAfter<T extends UniqueHelper>(2659    scheduledId: string,2660    blocksBeforeExecution: number,2661    options: ISchedulerOptions = {},2662  ) {2663    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2664    return new UniqueNFTCollection(this.collectionId, scheduledHelper);2665  }26662667  getSudo<T extends UniqueHelper>() {2668    return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());2669  }2670}267126722673export class UniqueRFTCollection extends UniqueBaseCollection {2674  getTokenObject(tokenId: number) {2675    return new UniqueRFToken(tokenId, this);2676  }26772678  async getToken(tokenId: number, blockHashAt?: string) {2679    return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);2680  }26812682  async getTokensByAddress(addressObj: ICrossAccountId) {2683    return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2684  }26852686  async getTop10TokenOwners(tokenId: number) {2687    return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2688  }26892690  async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2691    return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2692  }26932694  async getTokenTotalPieces(tokenId: number) {2695    return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2696  }26972698  async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2699    return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2700  }27012702  async getPropertyPermissions(propertyKeys: string[] | null = null) {2703    return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);2704  }27052706  async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {2707    return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2708  }27092710  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2711    return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2712  }27132714  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2715    return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2716  }27172718  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2719    return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2720  }27212722  async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2723    return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2724  }27252726  async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2727    return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2728  }27292730  async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {2731    return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2732  }27332734  async burnToken(signer: TSigner, tokenId: number, amount=1n) {2735    return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2736  }27372738  async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId,  amount=1n) {2739    return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);2740  }27412742  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2743    return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2744  }27452746  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2747    return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2748  }27492750  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2751    return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2752  }27532754  scheduleAt<T extends UniqueHelper>(2755    scheduledId: string,2756    executionBlockNumber: number,2757    options: ISchedulerOptions = {},2758  ) {2759    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2760    return new UniqueRFTCollection(this.collectionId, scheduledHelper);2761  }27622763  scheduleAfter<T extends UniqueHelper>(2764    scheduledId: string,2765    blocksBeforeExecution: number,2766    options: ISchedulerOptions = {},2767  ) {2768    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2769    return new UniqueRFTCollection(this.collectionId, scheduledHelper);2770  }27712772  getSudo<T extends UniqueHelper>() {2773    return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());2774  }2775}277627772778export class UniqueFTCollection extends UniqueBaseCollection {2779  async getBalance(addressObj: ICrossAccountId) {2780    return await this.helper.ft.getBalance(this.collectionId, addressObj);2781  }27822783  async getTotalPieces() {2784    return await this.helper.ft.getTotalPieces(this.collectionId);2785  }27862787  async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2788    return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2789  }27902791  async getTop10Owners() {2792    return await this.helper.ft.getTop10Owners(this.collectionId);2793  }27942795  async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {2796    return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);2797  }27982799  async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {2800    return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);2801  }28022803  async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2804    return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2805  }28062807  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2808    return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2809  }28102811  async burnTokens(signer: TSigner, amount=1n) {2812    return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2813  }28142815  async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2816    return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2817  }28182819  async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2820    return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2821  }28222823  scheduleAt<T extends UniqueHelper>(2824    scheduledId: string,2825    executionBlockNumber: number,2826    options: ISchedulerOptions = {},2827  ) {2828    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2829    return new UniqueFTCollection(this.collectionId, scheduledHelper);2830  }28312832  scheduleAfter<T extends UniqueHelper>(2833    scheduledId: string,2834    blocksBeforeExecution: number,2835    options: ISchedulerOptions = {},2836  ) {2837    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2838    return new UniqueFTCollection(this.collectionId, scheduledHelper);2839  }28402841  getSudo<T extends UniqueHelper>() {2842    return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());2843  }2844}284528462847export class UniqueBaseToken {2848  collection: UniqueNFTCollection | UniqueRFTCollection;2849  collectionId: number;2850  tokenId: number;28512852  constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2853    this.collection = collection;2854    this.collectionId = collection.collectionId;2855    this.tokenId = tokenId;2856  }28572858  async getNextSponsored(addressObj: ICrossAccountId) {2859    return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2860  }28612862  async getProperties(propertyKeys?: string[] | null) {2863    return await this.collection.getTokenProperties(this.tokenId, propertyKeys);2864  }28652866  async setProperties(signer: TSigner, properties: IProperty[]) {2867    return await this.collection.setTokenProperties(signer, this.tokenId, properties);2868  }28692870  async deleteProperties(signer: TSigner, propertyKeys: string[]) {2871    return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2872  }28732874  async doesExist() {2875    return await this.collection.doesTokenExist(this.tokenId);2876  }28772878  nestingAccount() {2879    return this.collection.helper.util.getTokenAccount(this);2880  }28812882  scheduleAt<T extends UniqueHelper>(2883    scheduledId: string,2884    executionBlockNumber: number,2885    options: ISchedulerOptions = {},2886  ) {2887    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);2888    return new UniqueBaseToken(this.tokenId, scheduledCollection);2889  }28902891  scheduleAfter<T extends UniqueHelper>(2892    scheduledId: string,2893    blocksBeforeExecution: number,2894    options: ISchedulerOptions = {},2895  ) {2896    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2897    return new UniqueBaseToken(this.tokenId, scheduledCollection);2898  }28992900  getSudo<T extends UniqueHelper>() {2901    return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());2902  }2903}290429052906export class UniqueNFToken extends UniqueBaseToken {2907  collection: UniqueNFTCollection;29082909  constructor(tokenId: number, collection: UniqueNFTCollection) {2910    super(tokenId, collection);2911    this.collection = collection;2912  }29132914  async getData(blockHashAt?: string) {2915    return await this.collection.getToken(this.tokenId, blockHashAt);2916  }29172918  async getOwner(blockHashAt?: string) {2919    return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2920  }29212922  async getTopmostOwner(blockHashAt?: string) {2923    return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2924  }29252926  async getChildren(blockHashAt?: string) {2927    return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2928  }29292930  async nest(signer: TSigner, toTokenObj: IToken) {2931    return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2932  }29332934  async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2935    return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2936  }29372938  async transfer(signer: TSigner, addressObj: ICrossAccountId) {2939    return await this.collection.transferToken(signer, this.tokenId, addressObj);2940  }29412942  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2943    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2944  }29452946  async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2947    return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2948  }29492950  async isApproved(toAddressObj: ICrossAccountId) {2951    return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2952  }29532954  async burn(signer: TSigner) {2955    return await this.collection.burnToken(signer, this.tokenId);2956  }29572958  async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {2959    return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);2960  }29612962  scheduleAt<T extends UniqueHelper>(2963    scheduledId: string,2964    executionBlockNumber: number,2965    options: ISchedulerOptions = {},2966  ) {2967    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);2968    return new UniqueNFToken(this.tokenId, scheduledCollection);2969  }29702971  scheduleAfter<T extends UniqueHelper>(2972    scheduledId: string,2973    blocksBeforeExecution: number,2974    options: ISchedulerOptions = {},2975  ) {2976    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2977    return new UniqueNFToken(this.tokenId, scheduledCollection);2978  }29792980  getSudo<T extends UniqueHelper>() {2981    return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());2982  }2983}29842985export class UniqueRFToken extends UniqueBaseToken {2986  collection: UniqueRFTCollection;29872988  constructor(tokenId: number, collection: UniqueRFTCollection) {2989    super(tokenId, collection);2990    this.collection = collection;2991  }29922993  async getData(blockHashAt?: string) {2994    return await this.collection.getToken(this.tokenId, blockHashAt);2995  }29962997  async getTop10Owners() {2998    return await this.collection.getTop10TokenOwners(this.tokenId);2999  }30003001  async getBalance(addressObj: ICrossAccountId) {3002    return await this.collection.getTokenBalance(this.tokenId, addressObj);3003  }30043005  async getTotalPieces() {3006    return await this.collection.getTokenTotalPieces(this.tokenId);3007  }30083009  async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {3010    return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);3011  }30123013  async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {3014    return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);3015  }30163017  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3018    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);3019  }30203021  async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3022    return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);3023  }30243025  async repartition(signer: TSigner, amount: bigint) {3026    return await this.collection.repartitionToken(signer, this.tokenId, amount);3027  }30283029  async burn(signer: TSigner, amount=1n) {3030    return await this.collection.burnToken(signer, this.tokenId, amount);3031  }30323033  async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3034    return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);3035  }30363037  scheduleAt<T extends UniqueHelper>(3038    scheduledId: string,3039    executionBlockNumber: number,3040    options: ISchedulerOptions = {},3041  ) {3042    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);3043    return new UniqueRFToken(this.tokenId, scheduledCollection);3044  }30453046  scheduleAfter<T extends UniqueHelper>(3047    scheduledId: string,3048    blocksBeforeExecution: number,3049    options: ISchedulerOptions = {},3050  ) {3051    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);3052    return new UniqueRFToken(this.tokenId, scheduledCollection);3053  }30543055  getSudo<T extends UniqueHelper>() {3056    return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());3057  }3058}

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, SignerOptions} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IStakingInfo, ISchedulerOptions, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314export class CrossAccountId implements ICrossAccountId {15  Substrate?: TSubstrateAccount;16  Ethereum?: TEthereumAccount;1718  constructor(account: ICrossAccountId) {19    if (account.Substrate) this.Substrate = account.Substrate;20    if (account.Ethereum) this.Ethereum = account.Ethereum;21  }2223  static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {24    switch (domain) {25      case 'Substrate': return new CrossAccountId({Substrate: account.address});26      case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();27    }28  }2930  static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {31    return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});32  }3334  static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {35    return encodeAddress(decodeAddress(address), ss58Format);36  }3738  static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {39    return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});40  }41  42  withNormalizedSubstrate(ss58Format = 42): CrossAccountId {43    if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);44    return this;45  }4647  static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {48    return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));49  }5051  toEthereum(): CrossAccountId {52    if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});53    return this;54  }5556  static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {57    return evmToAddress(address, ss58Format);58  }5960  toSubstrate(ss58Format?: number): CrossAccountId {61    if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});62    return this;63  }64  65  toLowerCase(): CrossAccountId {66    if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();67    if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();68    return this;69  }70}7172const nesting = {73  toChecksumAddress(address: string): string {74    if (typeof address === 'undefined') return '';7576    if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);7778    address = address.toLowerCase().replace(/^0x/i,'');79    const addressHash = keccakAsHex(address).replace(/^0x/i,'');80    const checksumAddress = ['0x'];8182    for (let i = 0; i < address.length; i++) {83      // If ith character is 8 to f then make it uppercase84      if (parseInt(addressHash[i], 16) > 7) {85        checksumAddress.push(address[i].toUpperCase());86      } else {87        checksumAddress.push(address[i]);88      }89    }90    return checksumAddress.join('');91  },92  tokenIdToAddress(collectionId: number, tokenId: number) {93    return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8, '0')}${tokenId.toString(16).padStart(8, '0')}`);94  },95};9697class UniqueUtil {98  static transactionStatus = {99    NOT_READY: 'NotReady',100    FAIL: 'Fail',101    SUCCESS: 'Success',102  };103104  static chainLogType = {105    EXTRINSIC: 'extrinsic',106    RPC: 'rpc',107  };108109  static getTokenAccount(token: IToken): CrossAccountId {110    return new CrossAccountId({Ethereum: this.getTokenAddress(token)});111  }112113  static getTokenAddress(token: IToken): string {114    return nesting.tokenIdToAddress(token.collectionId, token.tokenId);115  }116117  static getDefaultLogger(): ILogger {118    return {119      log(msg: any, level = 'INFO') {120        console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));121      },122      level: {123        ERROR: 'ERROR',124        WARNING: 'WARNING',125        INFO: 'INFO',126      },127    };128  }129130  static vec2str(arr: string[] | number[]) {131    return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');132  }133134  static str2vec(string: string) {135    if (typeof string !== 'string') return string;136    return Array.from(string).map(x => x.charCodeAt(0));137  }138139  static fromSeed(seed: string, ss58Format = 42) {140    const keyring = new Keyring({type: 'sr25519', ss58Format});141    return keyring.addFromUri(seed);142  }143144  static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {145    if (creationResult.status !== this.transactionStatus.SUCCESS) {146      throw Error('Unable to create collection!');147    }148149    let collectionId = null;150    creationResult.result.events.forEach(({event: {data, method, section}}) => {151      if ((section === 'common') && (method === 'CollectionCreated')) {152        collectionId = parseInt(data[0].toString(), 10);153      }154    });155156    if (collectionId === null) {157      throw Error('No CollectionCreated event was found!');158    }159160    return collectionId;161  }162163  static extractTokensFromCreationResult(creationResult: ITransactionResult): {164    success: boolean, 165    tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],166  } {167    if (creationResult.status !== this.transactionStatus.SUCCESS) {168      throw Error('Unable to create tokens!');169    }170    let success = false;171    const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];172    creationResult.result.events.forEach(({event: {data, method, section}}) => {173      if (method === 'ExtrinsicSuccess') {174        success = true;175      } else if ((section === 'common') && (method === 'ItemCreated')) {176        tokens.push({177          collectionId: parseInt(data[0].toString(), 10),178          tokenId: parseInt(data[1].toString(), 10),179          owner: data[2].toHuman(),180          amount: data[3].toBigInt(),181        });182      }183    });184    return {success, tokens};185  }186187  static extractTokensFromBurnResult(burnResult: ITransactionResult): {188    success: boolean, 189    tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],190  } {191    if (burnResult.status !== this.transactionStatus.SUCCESS) {192      throw Error('Unable to burn tokens!');193    }194    let success = false;195    const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];196    burnResult.result.events.forEach(({event: {data, method, section}}) => {197      if (method === 'ExtrinsicSuccess') {198        success = true;199      } else if ((section === 'common') && (method === 'ItemDestroyed')) {200        tokens.push({201          collectionId: parseInt(data[0].toString(), 10),202          tokenId: parseInt(data[1].toString(), 10),203          owner: data[2].toHuman(),204          amount: data[3].toBigInt(),205        });206      }207    });208    return {success, tokens};209  }210211  static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {212    let eventId = null;213    events.forEach(({event: {data, method, section}}) => {214      if ((section === expectedSection) && (method === expectedMethod)) {215        eventId = parseInt(data[0].toString(), 10);216      }217    });218219    if (eventId === null) {220      throw Error(`No ${expectedMethod} event was found!`);221    }222    return eventId === collectionId;223  }224225  static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {226    const normalizeAddress = (address: string | ICrossAccountId) => {227      if(typeof address === 'string') return address;228      const obj = {} as any;229      Object.keys(address).forEach(k => {230        obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];231      });232      if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);233      if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();234      return address;235    };236    let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;237    events.forEach(({event: {data, method, section}}) => {238      if ((section === 'common') && (method === 'Transfer')) {239        const hData = (data as any).toJSON();240        transfer = {241          collectionId: hData[0],242          tokenId: hData[1],243          from: normalizeAddress(hData[2]),244          to: normalizeAddress(hData[3]),245          amount: BigInt(hData[4]),246        };247      }248    });249    let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;250    isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);251    isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);252    isSuccess = isSuccess && amount === transfer.amount;253    return isSuccess;254  }255}256257class UniqueEventHelper {258  private static extractIndex(index: any): [number, number] | string {259    if(index.toRawType() === '[u8;2]') return [index[0], index[1]];260    return index.toJSON();261  }262263  private static extractSub(data: any, subTypes: any): {[key: string]: any} {264    let obj: any = {};265    let index = 0;266267    if (data.entries) {268      for(const [key, value] of data.entries()) {269        obj[key] = this.extractData(value, subTypes[index]);270        index++;271      }272    } else obj = data.toJSON();273274    return obj;275  }276  277  private static extractData(data: any, type: any): any {278    if(!type) return data.toHuman();279    if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();280    if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();281    if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);282    return data.toHuman();283  }284285  public static extractEvents(records: ITransactionResult): IEvent[] {286    const parsedEvents: IEvent[] = [];287288    records.result.events.forEach((record) => {289      const {event, phase} = record;290      const types = (event as any).typeDef;291292      const eventData: IEvent = {293        section: event.section.toString(),294        method: event.method.toString(),295        index: this.extractIndex(event.index),296        data: [],297        phase: phase.toJSON(),298      };299300      event.data.forEach((val: any, index: number) => {301        eventData.data.push(this.extractData(val, types[index]));302      });303304      parsedEvents.push(eventData);305    });306307    return parsedEvents;308  }309}310311class ChainHelperBase {312  transactionStatus = UniqueUtil.transactionStatus;313  chainLogType = UniqueUtil.chainLogType;314  util: typeof UniqueUtil;315  eventHelper: typeof UniqueEventHelper;316  logger: ILogger;317  api: ApiPromise | null;318  forcedNetwork: TUniqueNetworks | null;319  network: TUniqueNetworks | null;320  chainLog: IUniqueHelperLog[];321  children: ChainHelperBase[];322323  constructor(logger?: ILogger) {324    this.util = UniqueUtil;325    this.eventHelper = UniqueEventHelper;326    if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();327    this.logger = logger;328    this.api = null;329    this.forcedNetwork = null;330    this.network = null;331    this.chainLog = [];332    this.children = [];333  }334335  getApi(): ApiPromise {336    if(this.api === null) throw Error('API not initialized');337    return this.api;338  }339340  clearChainLog(): void {341    this.chainLog = [];342  }343344  forceNetwork(value: TUniqueNetworks): void {345    this.forcedNetwork = value;346  }347348  async connect(wsEndpoint: string, listeners?: IApiListeners) {349    if (this.api !== null) throw Error('Already connected');350    const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);351    this.api = api;352    this.network = network;353  }354355  async disconnect() {356    for (const child of this.children) {357      child.clearApi();358    }359360    if (this.api === null) return;361    await this.api.disconnect();362    this.clearApi();363  }364365  clearApi() {366    this.api = null;367    this.network = null;368  }369370  static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {371    const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;372    if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;373    return 'opal';374  }375376  static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {377    const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});378    await api.isReady;379380    const network = await this.detectNetwork(api);381382    await api.disconnect();383384    return network;385  }386387  static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{388    api: ApiPromise;389    network: TUniqueNetworks;390  }> {391    if(typeof network === 'undefined' || network === null) network = 'opal';392    const supportedRPC = {393      opal: {394        unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,395      },396      quartz: {397        unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,398      },399      unique: {400        unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,401      },402    };403    if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);404    const rpc = supportedRPC[network];405406    // TODO: investigate how to replace rpc in runtime407    // api._rpcCore.addUserInterfaces(rpc);408409    const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});410411    await api.isReadyOrError;412413    if (typeof listeners === 'undefined') listeners = {};414    for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {415      if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;416      api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);417    }418419    return {api, network};420  }421422  getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {423    const {events, status} = data;424    if (status.isReady) {425      return this.transactionStatus.NOT_READY;426    }427    if (status.isBroadcast) {428      return this.transactionStatus.NOT_READY;429    }430    if (status.isInBlock || status.isFinalized) {431      const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');432      if (errors.length > 0) {433        return this.transactionStatus.FAIL;434      }435      if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {436        return this.transactionStatus.SUCCESS;437      }438    }439440    return this.transactionStatus.FAIL;441  }442443  signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {444    const sign = (callback: any) => {445      if(options !== null) return transaction.signAndSend(sender, options, callback);446      return transaction.signAndSend(sender, callback);447    };448    // eslint-disable-next-line no-async-promise-executor449    return new Promise(async (resolve, reject) => {450      try {451        const unsub = await sign((result: any) => {452          const status = this.getTransactionStatus(result);453454          if (status === this.transactionStatus.SUCCESS) {455            this.logger.log(`${label} successful`);456            unsub();457            resolve({result, status});458          } else if (status === this.transactionStatus.FAIL) {459            let moduleError = null;460461            if (result.hasOwnProperty('dispatchError')) {462              const dispatchError = result['dispatchError'];463464              if (dispatchError) {465                if (dispatchError.isModule) {466                  const modErr = dispatchError.asModule;467                  const errorMeta = dispatchError.registry.findMetaError(modErr);468469                  moduleError = `${errorMeta.section}.${errorMeta.name}`;470                } else {471                  moduleError = dispatchError.toHuman();472                }473              } else {474                this.logger.log(result, this.logger.level.ERROR);475              }476            }477478            this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);479            unsub();480            reject({status, moduleError, result});481          }482        });483      } catch (e) {484        this.logger.log(e, this.logger.level.ERROR);485        reject(e);486      }487    });488  }489490  constructApiCall(apiCall: string, params: any[]) {491    if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);492    let call = this.getApi() as any;493    for(const part of apiCall.slice(4).split('.')) {494      call = call[part];495    }496    return call(...params);497  }498499  async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {500    if(this.api === null) throw Error('API not initialized');501    if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);502503    const startTime = (new Date()).getTime();504    let result: ITransactionResult;505    let events: IEvent[] = [];506    try {507      result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;508      events = this.eventHelper.extractEvents(result);509    }510    catch(e) {511      if(!(e as object).hasOwnProperty('status')) throw e;512      result = e as ITransactionResult;513    }514515    const endTime = (new Date()).getTime();516517    const log = {518      executedAt: endTime,519      executionTime: endTime - startTime,520      type: this.chainLogType.EXTRINSIC,521      status: result.status,522      call: extrinsic,523      signer: this.getSignerAddress(sender),524      params,525    } as IUniqueHelperLog;526527    if(result.status !== this.transactionStatus.SUCCESS) {528      if (result.moduleError) log.moduleError = result.moduleError;529      else if (result.result.dispatchError) log.dispatchError = result.result.dispatchError;530    }531    if(events.length > 0) log.events = events;532533    this.chainLog.push(log);534535    if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {536      if (result.moduleError) throw Error(`${result.moduleError}`);537      else if (result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));538    }539    return result;540  }541542  async callRpc(rpc: string, params?: any[]) {543    if(typeof params === 'undefined') params = [];544    if(this.api === null) throw Error('API not initialized');545    if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);546547    const startTime = (new Date()).getTime();548    let result;549    let error = null;550    const log = {551      type: this.chainLogType.RPC,552      call: rpc,553      params,554    } as IUniqueHelperLog;555556    try {557      result = await this.constructApiCall(rpc, params);558    }559    catch(e) {560      error = e;561    }562563    const endTime = (new Date()).getTime();564565    log.executedAt = endTime;566    log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';567    log.executionTime = endTime - startTime;568569    this.chainLog.push(log);570571    if(error !== null) throw error;572573    return result;574  }575576  getSignerAddress(signer: IKeyringPair | string): string {577    if(typeof signer === 'string') return signer;578    return signer.address;579  }580581  fetchAllPalletNames(): string[] {582    if(this.api === null) throw Error('API not initialized');583    return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());584  }585586  fetchMissingPalletNames(requiredPallets: string[]): string[] {587    const palletNames = this.fetchAllPalletNames();588    return requiredPallets.filter(p => !palletNames.includes(p));589  }590}591592593class HelperGroup {594  helper: UniqueHelper;595596  constructor(uniqueHelper: UniqueHelper) {597    this.helper = uniqueHelper;598  }599}600601602class CollectionGroup extends HelperGroup {603  /**604 * Get number of blocks when sponsored transaction is available.605 *606 * @param collectionId ID of collection607 * @param tokenId ID of token608 * @param addressObj address for which the sponsorship is checked609 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});610 * @returns number of blocks or null if sponsorship hasn't been set611 */612  async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {613    return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();614  }615616  /**617   * Get the number of created collections.618   *619   * @returns number of created collections620   */621  async getTotalCount(): Promise<number> {622    return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();623  }624625  /**626   * Get information about the collection with additional data,627   * including the number of tokens it contains, its administrators,628   * the normalized address of the collection's owner, and decoded name and description.629   *630   * @param collectionId ID of collection631   * @example await getData(2)632   * @returns collection information object633   */634  async getData(collectionId: number): Promise<{635    id: number;636    name: string;637    description: string;638    tokensCount: number;639    admins: CrossAccountId[];640    normalizedOwner: TSubstrateAccount;641    raw: any642  } | null> {643    const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);644    const humanCollection = collection.toHuman(), collectionData = {645      id: collectionId, name: null, description: null, tokensCount: 0, admins: [],646      raw: humanCollection,647    } as any, jsonCollection = collection.toJSON();648    if (humanCollection === null) return null;649    collectionData.raw.limits = jsonCollection.limits;650    collectionData.raw.permissions = jsonCollection.permissions;651    collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);652    for (const key of ['name', 'description']) {653      collectionData[key] = this.helper.util.vec2str(humanCollection[key]);654    }655656    collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))657      ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)658      : 0;659    collectionData.admins = await this.getAdmins(collectionId);660661    return collectionData;662  }663664  /**665   * Get the addresses of the collection's administrators, optionally normalized.666   *667   * @param collectionId ID of collection668   * @param normalize whether to normalize the addresses to the default ss58 format669   * @example await getAdmins(1)670   * @returns array of administrators671   */672  async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {673    const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();674675    return normalize676      ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())677      : admins;678  }679680  /**681   * Get the addresses added to the collection allow-list, optionally normalized.682   * @param collectionId ID of collection683   * @param normalize whether to normalize the addresses to the default ss58 format684   * @example await getAllowList(1)685   * @returns array of allow-listed addresses686   */687  async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {688    const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();689    return normalize690      ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())691      : allowListed;692  }693694  /**695   * Get the effective limits of the collection instead of null for default values696   *697   * @param collectionId ID of collection698   * @example await getEffectiveLimits(2)699   * @returns object of collection limits700   */701  async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {702    return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();703  }704705  /**706   * Burns the collection if the signer has sufficient permissions and collection is empty.707   *708   * @param signer keyring of signer709   * @param collectionId ID of collection710   * @example await helper.collection.burn(aliceKeyring, 3);711   * @returns ```true``` if extrinsic success, otherwise ```false```712   */713  async burn(signer: TSigner, collectionId: number): Promise<boolean> {714    const result = await this.helper.executeExtrinsic(715      signer,716      'api.tx.unique.destroyCollection', [collectionId],717      true,718    );719720    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');721  }722723  /**724   * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.725   *726   * @param signer keyring of signer727   * @param collectionId ID of collection728   * @param sponsorAddress Sponsor substrate address729   * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")730   * @returns ```true``` if extrinsic success, otherwise ```false```731   */732  async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {733    const result = await this.helper.executeExtrinsic(734      signer,735      'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],736      true,737    );738739    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');740  }741742  /**743   * Confirms consent to sponsor the collection on behalf of the signer.744   *745   * @param signer keyring of signer746   * @param collectionId ID of collection747   * @example confirmSponsorship(aliceKeyring, 10)748   * @returns ```true``` if extrinsic success, otherwise ```false```749   */750  async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {751    const result = await this.helper.executeExtrinsic(752      signer,753      'api.tx.unique.confirmSponsorship', [collectionId],754      true,755    );756757    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');758  }759760  /**761   * Removes the sponsor of a collection, regardless if it consented or not.762   *763   * @param signer keyring of signer764   * @param collectionId ID of collection765   * @example removeSponsor(aliceKeyring, 10)766   * @returns ```true``` if extrinsic success, otherwise ```false```767   */768  async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {769    const result = await this.helper.executeExtrinsic(770      signer,771      'api.tx.unique.removeCollectionSponsor', [collectionId],772      true,773    );774775    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');776  }777778  /**779   * Sets the limits of the collection. At least one limit must be specified for a correct call.780   *781   * @param signer keyring of signer782   * @param collectionId ID of collection783   * @param limits collection limits object784   * @example785   * await setLimits(786   *   aliceKeyring,787   *   10,788   *   {789   *     sponsorTransferTimeout: 0,790   *     ownerCanDestroy: false791   *   }792   * )793   * @returns ```true``` if extrinsic success, otherwise ```false```794   */795  async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {796    const result = await this.helper.executeExtrinsic(797      signer,798      'api.tx.unique.setCollectionLimits', [collectionId, limits],799      true,800    );801802    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');803  }804805  /**806   * Changes the owner of the collection to the new Substrate address.807   *808   * @param signer keyring of signer809   * @param collectionId ID of collection810   * @param ownerAddress substrate address of new owner811   * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")812   * @returns ```true``` if extrinsic success, otherwise ```false```813   */814  async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {815    const result = await this.helper.executeExtrinsic(816      signer,817      'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],818      true,819    );820821    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');822  }823824  /**825   * Adds a collection administrator.826   *827   * @param signer keyring of signer828   * @param collectionId ID of collection829   * @param adminAddressObj Administrator address (substrate or ethereum)830   * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})831   * @returns ```true``` if extrinsic success, otherwise ```false```832   */833  async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {834    const result = await this.helper.executeExtrinsic(835      signer,836      'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],837      true,838    );839840    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');841  }842843  /**844   * Removes a collection administrator.845   *846   * @param signer keyring of signer847   * @param collectionId ID of collection848   * @param adminAddressObj Administrator address (substrate or ethereum)849   * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})850   * @returns ```true``` if extrinsic success, otherwise ```false```851   */852  async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {853    const result = await this.helper.executeExtrinsic(854      signer,855      'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],856      true,857    );858859    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');860  }861862  /**863   * Check if user is in allow list.864   * 865   * @param collectionId ID of collection866   * @param user Account to check867   * @example await getAdmins(1)868   * @returns is user in allow list869   */870  async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {871    return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();872  }873874  /**875   * Adds an address to allow list876   * @param signer keyring of signer877   * @param collectionId ID of collection878   * @param addressObj address to add to the allow list879   * @returns ```true``` if extrinsic success, otherwise ```false```880   */881  async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {882    const result = await this.helper.executeExtrinsic(883      signer,884      'api.tx.unique.addToAllowList', [collectionId, addressObj],885      true,886    );887888    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');889  }890891  /**892   * Removes an address from allow list893   *894   * @param signer keyring of signer895   * @param collectionId ID of collection896   * @param addressObj address to remove from the allow list897   * @returns ```true``` if extrinsic success, otherwise ```false```898   */899  async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {900    const result = await this.helper.executeExtrinsic(901      signer,902      'api.tx.unique.removeFromAllowList', [collectionId, addressObj],903      true,904    );905906    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');907  }908909  /**910   * Sets onchain permissions for selected collection.911   *912   * @param signer keyring of signer913   * @param collectionId ID of collection914   * @param permissions collection permissions object915   * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});916   * @returns ```true``` if extrinsic success, otherwise ```false```917   */918  async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {919    const result = await this.helper.executeExtrinsic(920      signer,921      'api.tx.unique.setCollectionPermissions', [collectionId, permissions],922      true,923    );924925    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');926  }927928  /**929   * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.930   *931   * @param signer keyring of signer932   * @param collectionId ID of collection933   * @param permissions nesting permissions object934   * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});935   * @returns ```true``` if extrinsic success, otherwise ```false```936   */937  async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {938    return await this.setPermissions(signer, collectionId, {nesting: permissions});939  }940941  /**942   * Disables nesting for selected collection.943   *944   * @param signer keyring of signer945   * @param collectionId ID of collection946   * @example disableNesting(aliceKeyring, 10);947   * @returns ```true``` if extrinsic success, otherwise ```false```948   */949  async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {950    return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});951  }952953  /**954   * Sets onchain properties to the collection.955   *956   * @param signer keyring of signer957   * @param collectionId ID of collection958   * @param properties array of property objects959   * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);960   * @returns ```true``` if extrinsic success, otherwise ```false```961   */962  async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {963    const result = await this.helper.executeExtrinsic(964      signer,965      'api.tx.unique.setCollectionProperties', [collectionId, properties],966      true,967    );968969    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');970  }971972  /**973   * Get collection properties.974   * 975   * @param collectionId ID of collection976   * @param propertyKeys optionally filter the returned properties to only these keys977   * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);978   * @returns array of key-value pairs979   */980  async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {981    return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();982  }983984  /**985   * Deletes onchain properties from the collection.986   *987   * @param signer keyring of signer988   * @param collectionId ID of collection989   * @param propertyKeys array of property keys to delete990   * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);991   * @returns ```true``` if extrinsic success, otherwise ```false```992   */993  async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {994    const result = await this.helper.executeExtrinsic(995      signer,996      'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],997      true,998    );9991000    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1001  }10021003  /**1004   * Changes the owner of the token.1005   *1006   * @param signer keyring of signer1007   * @param collectionId ID of collection1008   * @param tokenId ID of token1009   * @param addressObj address of a new owner1010   * @param amount amount of tokens to be transfered. For NFT must be set to 1n1011   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1012   * @returns true if the token success, otherwise false1013   */1014  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1015    const result = await this.helper.executeExtrinsic(1016      signer,1017      'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1018      true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1019    );10201021    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1022  }10231024  /**1025   *1026   * Change ownership of a token(s) on behalf of the owner.1027   *1028   * @param signer keyring of signer1029   * @param collectionId ID of collection1030   * @param tokenId ID of token1031   * @param fromAddressObj address on behalf of which the token will be sent1032   * @param toAddressObj new token owner1033   * @param amount amount of tokens to be transfered. For NFT must be set to 1n1034   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1035   * @returns true if the token success, otherwise false1036   */1037  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1038    const result = await this.helper.executeExtrinsic(1039      signer,1040      'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1041      true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1042    );1043    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1044  }10451046  /**1047   *1048   * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1049   *1050   * @param signer keyring of signer1051   * @param collectionId ID of collection1052   * @param tokenId ID of token1053   * @param amount amount of tokens to be burned. For NFT must be set to 1n1054   * @example burnToken(aliceKeyring, 10, 5);1055   * @returns ```true``` if the extrinsic is successful, otherwise ```false```1056   */1057  async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1058    const burnResult = await this.helper.executeExtrinsic(1059      signer,1060      'api.tx.unique.burnItem', [collectionId, tokenId, amount],1061      true, // `Unable to burn token for ${label}`,1062    );1063    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1064    if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1065    return burnedTokens.success;1066  }10671068  /**1069   * Destroys a concrete instance of NFT on behalf of the owner1070   *1071   * @param signer keyring of signer1072   * @param collectionId ID of collection1073   * @param tokenId ID of token1074   * @param fromAddressObj address on behalf of which the token will be burnt1075   * @param amount amount of tokens to be burned. For NFT must be set to 1n1076   * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1077   * @returns ```true``` if extrinsic success, otherwise ```false```1078   */1079  async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1080    const burnResult = await this.helper.executeExtrinsic(1081      signer,1082      'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1083      true, // `Unable to burn token from for ${label}`,1084    );1085    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1086    return burnedTokens.success && burnedTokens.tokens.length > 0;1087  }10881089  /**1090   * Set, change, or remove approved address to transfer the ownership of the NFT.1091   *1092   * @param signer keyring of signer1093   * @param collectionId ID of collection1094   * @param tokenId ID of token1095   * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1096   * @param amount amount of token to be approved. For NFT must be set to 1n1097   * @returns ```true``` if extrinsic success, otherwise ```false```1098   */1099  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1100    const approveResult = await this.helper.executeExtrinsic(1101      signer,1102      'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1103      true, // `Unable to approve token for ${label}`,1104    );11051106    return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1107  }11081109  /**1110   * Get the amount of token pieces approved to transfer or burn. Normally 0.1111   *1112   * @param collectionId ID of collection1113   * @param tokenId ID of token1114   * @param toAccountObj address which is approved to use token pieces1115   * @param fromAccountObj address which may have allowed the use of its owned tokens1116   * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1117   * @returns number of approved to transfer pieces1118   */1119  async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1120    return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1121  }11221123  /**1124   * Get the last created token ID in a collection1125   *1126   * @param collectionId ID of collection1127   * @example getLastTokenId(10);1128   * @returns id of the last created token1129   */1130  async getLastTokenId(collectionId: number): Promise<number> {1131    return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1132  }11331134  /**1135   * Check if token exists1136   *1137   * @param collectionId ID of collection1138   * @param tokenId ID of token1139   * @example doesTokenExist(10, 20);1140   * @returns true if the token exists, otherwise false1141   */1142  async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1143    return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1144  }1145}11461147class NFTnRFT extends CollectionGroup {1148  /**1149   * Get tokens owned by account1150   *1151   * @param collectionId ID of collection1152   * @param addressObj tokens owner1153   * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1154   * @returns array of token ids owned by account1155   */1156  async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1157    return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1158  }11591160  /**1161   * Get token data1162   *1163   * @param collectionId ID of collection1164   * @param tokenId ID of token1165   * @param propertyKeys optionally filter the token properties to only these keys1166   * @param blockHashAt optionally query the data at some block with this hash1167   * @example getToken(10, 5);1168   * @returns human readable token data1169   */1170  async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1171    properties: IProperty[];1172    owner: CrossAccountId;1173    normalizedOwner: CrossAccountId;1174  }| null> {1175    let tokenData;1176    if(typeof blockHashAt === 'undefined') {1177      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1178    }1179    else {1180      if(propertyKeys.length == 0) {1181        const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1182        if(!collection) return null;1183        propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1184      }1185      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1186    }1187    tokenData = tokenData.toHuman();1188    if (tokenData === null || tokenData.owner === null) return null;1189    const owner = {} as any;1190    for (const key of Object.keys(tokenData.owner)) {1191      owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate' 1192        ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key]) 1193        : tokenData.owner[key];1194    }1195    tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1196    return tokenData;1197  }11981199  /**1200   * Set permissions to change token properties1201   *1202   * @param signer keyring of signer1203   * @param collectionId ID of collection1204   * @param permissions permissions to change a property by the collection admin or token owner1205   * @example setTokenPropertyPermissions(1206   *   aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1207   * )1208   * @returns true if extrinsic success otherwise false1209   */1210  async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1211    const result = await this.helper.executeExtrinsic(1212      signer,1213      'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1214      true,1215    );12161217    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1218  }12191220  /**1221   * Get token property permissions.1222   * 1223   * @param collectionId ID of collection1224   * @param propertyKeys optionally filter the returned property permissions to only these keys1225   * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1226   * @returns array of key-permission pairs1227   */1228  async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1229    return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1230  }12311232  /**1233   * Set token properties1234   *1235   * @param signer keyring of signer1236   * @param collectionId ID of collection1237   * @param tokenId ID of token1238   * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1239   * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1240   * @returns ```true``` if extrinsic success, otherwise ```false```1241   */1242  async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1243    const result = await this.helper.executeExtrinsic(1244      signer,1245      'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1246      true,1247    );12481249    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1250  }12511252  /**1253   * Get properties, metadata assigned to a token.1254   * 1255   * @param collectionId ID of collection1256   * @param tokenId ID of token1257   * @param propertyKeys optionally filter the returned properties to only these keys1258   * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1259   * @returns array of key-value pairs1260   */1261  async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1262    return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1263  }12641265  /**1266   * Delete the provided properties of a token1267   * @param signer keyring of signer1268   * @param collectionId ID of collection1269   * @param tokenId ID of token1270   * @param propertyKeys property keys to be deleted1271   * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1272   * @returns ```true``` if extrinsic success, otherwise ```false```1273   */1274  async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1275    const result = await this.helper.executeExtrinsic(1276      signer,1277      'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1278      true,1279    );12801281    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1282  }12831284  /**1285   * Mint new collection1286   *1287   * @param signer keyring of signer1288   * @param collectionOptions basic collection options and properties1289   * @param mode NFT or RFT type of a collection1290   * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1291   * @returns object of the created collection1292   */1293  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1294    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1295    collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1296    for (const key of ['name', 'description', 'tokenPrefix']) {1297      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);1298    }1299    const creationResult = await this.helper.executeExtrinsic(1300      signer,1301      'api.tx.unique.createCollectionEx', [collectionOptions],1302      true, // errorLabel,1303    );1304    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1305  }13061307  getCollectionObject(_collectionId: number): any {1308    return null;1309  }13101311  getTokenObject(_collectionId: number, _tokenId: number): any {1312    return null;1313  }1314}131513161317class NFTGroup extends NFTnRFT {1318  /**1319   * Get collection object1320   * @param collectionId ID of collection1321   * @example getCollectionObject(2);1322   * @returns instance of UniqueNFTCollection1323   */1324  getCollectionObject(collectionId: number): UniqueNFTCollection {1325    return new UniqueNFTCollection(collectionId, this.helper);1326  }13271328  /**1329   * Get token object1330   * @param collectionId ID of collection1331   * @param tokenId ID of token1332   * @example getTokenObject(10, 5);1333   * @returns instance of UniqueNFTToken1334   */1335  getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1336    return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1337  }13381339  /**1340   * Get token's owner1341   * @param collectionId ID of collection1342   * @param tokenId ID of token1343   * @param blockHashAt optionally query the data at the block with this hash1344   * @example getTokenOwner(10, 5);1345   * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1346   */1347  async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1348    let owner;1349    if (typeof blockHashAt === 'undefined') {1350      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1351    } else {1352      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1353    }1354    return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1355  }13561357  /**1358   * Is token approved to transfer1359   * @param collectionId ID of collection1360   * @param tokenId ID of token1361   * @param toAccountObj address to be approved1362   * @returns ```true``` if extrinsic success, otherwise ```false```1363   */1364  async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1365    return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1366  }13671368  /**1369   * Changes the owner of the token.1370   *1371   * @param signer keyring of signer1372   * @param collectionId ID of collection1373   * @param tokenId ID of token1374   * @param addressObj address of a new owner1375   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1376   * @returns ```true``` if extrinsic success, otherwise ```false```1377   */1378  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1379    return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1380  }13811382  /**1383   *1384   * Change ownership of a NFT on behalf of the owner.1385   *1386   * @param signer keyring of signer1387   * @param collectionId ID of collection1388   * @param tokenId ID of token1389   * @param fromAddressObj address on behalf of which the token will be sent1390   * @param toAddressObj new token owner1391   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1392   * @returns ```true``` if extrinsic success, otherwise ```false```1393   */1394  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1395    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1396  }13971398  /**1399   * Recursively find the address that owns the token1400   * @param collectionId ID of collection1401   * @param tokenId ID of token1402   * @param blockHashAt1403   * @example getTokenTopmostOwner(10, 5);1404   * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1405   */1406  async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1407    let owner;1408    if (typeof blockHashAt === 'undefined') {1409      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1410    } else {1411      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1412    }14131414    if (owner === null) return null;14151416    return owner.toHuman();1417  }14181419  /**1420   * Get tokens nested in the provided token1421   * @param collectionId ID of collection1422   * @param tokenId ID of token1423   * @param blockHashAt optionally query the data at the block with this hash1424   * @example getTokenChildren(10, 5);1425   * @returns tokens whose depth of nesting is <= 51426   */1427  async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1428    let children;1429    if(typeof blockHashAt === 'undefined') {1430      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1431    } else {1432      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1433    }14341435    return children.toJSON().map((x: any) => {1436      return {collectionId: x.collection, tokenId: x.token};1437    });1438  }14391440  /**1441   * Nest one token into another1442   * @param signer keyring of signer1443   * @param tokenObj token to be nested1444   * @param rootTokenObj token to be parent1445   * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1446   * @returns ```true``` if extrinsic success, otherwise ```false```1447   */1448  async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1449    const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1450    const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1451    if(!result) {1452      throw Error('Unable to nest token!');1453    }1454    return result;1455  }14561457  /**1458   * Remove token from nested state1459   * @param signer keyring of signer1460   * @param tokenObj token to unnest1461   * @param rootTokenObj parent of a token1462   * @param toAddressObj address of a new token owner1463   * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1464   * @returns ```true``` if extrinsic success, otherwise ```false```1465   */1466  async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1467    const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1468    const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1469    if(!result) {1470      throw Error('Unable to unnest token!');1471    }1472    return result;1473  }14741475  /**1476   * Mint new collection1477   * @param signer keyring of signer1478   * @param collectionOptions Collection options1479   * @example1480   * mintCollection(aliceKeyring, {1481   *   name: 'New',1482   *   description: 'New collection',1483   *   tokenPrefix: 'NEW',1484   * })1485   * @returns object of the created collection1486   */1487  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1488    return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1489  }14901491  /**1492   * Mint new token1493   * @param signer keyring of signer1494   * @param data token data1495   * @returns created token object1496   */1497  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1498    const creationResult = await this.helper.executeExtrinsic(1499      signer,1500      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1501        nft: {1502          properties: data.properties,1503        },1504      }],1505      true,1506    );1507    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1508    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1509    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1510    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1511  }15121513  /**1514   * Mint multiple NFT tokens1515   * @param signer keyring of signer1516   * @param collectionId ID of collection1517   * @param tokens array of tokens with owner and properties1518   * @example1519   * mintMultipleTokens(aliceKeyring, 10, [{1520   *     owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1521   *     properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1522   *   },{1523   *     owner: {Ethereum: "0x9F0583DbB855d..."},1524   *     properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1525   * }]);1526   * @returns ```true``` if extrinsic success, otherwise ```false```1527   */1528  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1529    const creationResult = await this.helper.executeExtrinsic(1530      signer,1531      'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1532      true,1533    );1534    const collection = this.getCollectionObject(collectionId);1535    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1536  }15371538  /**1539   * Mint multiple NFT tokens with one owner1540   * @param signer keyring of signer1541   * @param collectionId ID of collection1542   * @param owner tokens owner1543   * @param tokens array of tokens with owner and properties1544   * @example1545   * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1546   *   properties: [{1547   *   key: "gender",1548   *   value: "female",1549   *  },{1550   *   key: "age",1551   *   value: "33",1552   *  }],1553   * }]);1554   * @returns array of newly created tokens1555   */1556  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1557    const rawTokens = [];1558    for (const token of tokens) {1559      const raw = {NFT: {properties: token.properties}};1560      rawTokens.push(raw);1561    }1562    const creationResult = await this.helper.executeExtrinsic(1563      signer,1564      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1565      true,1566    );1567    const collection = this.getCollectionObject(collectionId);1568    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1569  }15701571  /**1572   * Set, change, or remove approved address to transfer the ownership of the NFT.1573   *1574   * @param signer keyring of signer1575   * @param collectionId ID of collection1576   * @param tokenId ID of token1577   * @param toAddressObj address to approve1578   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1579   * @returns ```true``` if extrinsic success, otherwise ```false```1580   */1581  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1582    return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1583  }1584}158515861587class RFTGroup extends NFTnRFT {1588  /**1589   * Get collection object1590   * @param collectionId ID of collection1591   * @example getCollectionObject(2);1592   * @returns instance of UniqueRFTCollection1593   */1594  getCollectionObject(collectionId: number): UniqueRFTCollection {1595    return new UniqueRFTCollection(collectionId, this.helper);1596  }15971598  /**1599   * Get token object1600   * @param collectionId ID of collection1601   * @param tokenId ID of token1602   * @example getTokenObject(10, 5);1603   * @returns instance of UniqueNFTToken1604   */1605  getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1606    return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1607  }16081609  /**1610   * Get top 10 token owners with the largest number of pieces1611   * @param collectionId ID of collection1612   * @param tokenId ID of token1613   * @example getTokenTop10Owners(10, 5);1614   * @returns array of top 10 owners1615   */1616  async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1617    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1618  }16191620  /**1621   * Get number of pieces owned by address1622   * @param collectionId ID of collection1623   * @param tokenId ID of token1624   * @param addressObj address token owner1625   * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1626   * @returns number of pieces ownerd by address1627   */1628  async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1629    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1630  }16311632  /**1633   * Transfer pieces of token to another address1634   * @param signer keyring of signer1635   * @param collectionId ID of collection1636   * @param tokenId ID of token1637   * @param addressObj address of a new owner1638   * @param amount number of pieces to be transfered1639   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1640   * @returns ```true``` if extrinsic success, otherwise ```false```1641   */1642  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1643    return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1644  }16451646  /**1647   * Change ownership of some pieces of RFT on behalf of the owner.1648   * @param signer keyring of signer1649   * @param collectionId ID of collection1650   * @param tokenId ID of token1651   * @param fromAddressObj address on behalf of which the token will be sent1652   * @param toAddressObj new token owner1653   * @param amount number of pieces to be transfered1654   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1655   * @returns ```true``` if extrinsic success, otherwise ```false```1656   */1657  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1658    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1659  }16601661  /**1662   * Mint new collection1663   * @param signer keyring of signer1664   * @param collectionOptions Collection options1665   * @example1666   * mintCollection(aliceKeyring, {1667   *   name: 'New',1668   *   description: 'New collection',1669   *   tokenPrefix: 'NEW',1670   * })1671   * @returns object of the created collection1672   */1673  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1674    return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1675  }16761677  /**1678   * Mint new token1679   * @param signer keyring of signer1680   * @param data token data1681   * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1682   * @returns created token object1683   */1684  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1685    const creationResult = await this.helper.executeExtrinsic(1686      signer,1687      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1688        refungible: {1689          pieces: data.pieces,1690          properties: data.properties,1691        },1692      }],1693      true,1694    );1695    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1696    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1697    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1698    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1699  }17001701  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1702    throw Error('Not implemented');1703    const creationResult = await this.helper.executeExtrinsic(1704      signer,1705      'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1706      true, // `Unable to mint RFT tokens for ${label}`,1707    );1708    const collection = this.getCollectionObject(collectionId);1709    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1710  }17111712  /**1713   * Mint multiple RFT tokens with one owner1714   * @param signer keyring of signer1715   * @param collectionId ID of collection1716   * @param owner tokens owner1717   * @param tokens array of tokens with properties and pieces1718   * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1719   * @returns array of newly created RFT tokens1720   */1721  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1722    const rawTokens = [];1723    for (const token of tokens) {1724      const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1725      rawTokens.push(raw);1726    }1727    const creationResult = await this.helper.executeExtrinsic(1728      signer,1729      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1730      true,1731    );1732    const collection = this.getCollectionObject(collectionId);1733    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1734  }17351736  /**1737   * Destroys a concrete instance of RFT.1738   * @param signer keyring of signer1739   * @param collectionId ID of collection1740   * @param tokenId ID of token1741   * @param amount number of pieces to be burnt1742   * @example burnToken(aliceKeyring, 10, 5);1743   * @returns ```true``` if the extrinsic is successful, otherwise ```false```1744   */1745  async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1746    return await super.burnToken(signer, collectionId, tokenId, amount);1747  }17481749  /**1750   * Destroys a concrete instance of RFT on behalf of the owner.1751   * @param signer keyring of signer1752   * @param collectionId ID of collection1753   * @param tokenId ID of token1754   * @param fromAddressObj address on behalf of which the token will be burnt1755   * @param amount number of pieces to be burnt1756   * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1757   * @returns ```true``` if extrinsic success, otherwise ```false```1758   */1759  async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1760    return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1761  }17621763  /**1764   * Set, change, or remove approved address to transfer the ownership of the RFT.1765   *1766   * @param signer keyring of signer1767   * @param collectionId ID of collection1768   * @param tokenId ID of token1769   * @param toAddressObj address to approve1770   * @param amount number of pieces to be approved1771   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1772   * @returns true if the token success, otherwise false1773   */1774  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1775    return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1776  }17771778  /**1779   * Get total number of pieces1780   * @param collectionId ID of collection1781   * @param tokenId ID of token1782   * @example getTokenTotalPieces(10, 5);1783   * @returns number of pieces1784   */1785  async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1786    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1787  }17881789  /**1790   * Change number of token pieces. Signer must be the owner of all token pieces.1791   * @param signer keyring of signer1792   * @param collectionId ID of collection1793   * @param tokenId ID of token1794   * @param amount new number of pieces1795   * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1796   * @returns true if the repartion was success, otherwise false1797   */1798  async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1799    const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1800    const repartitionResult = await this.helper.executeExtrinsic(1801      signer,1802      'api.tx.unique.repartition', [collectionId, tokenId, amount],1803      true,1804    );1805    if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1806    return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1807  }1808}180918101811class FTGroup extends CollectionGroup {1812  /**1813   * Get collection object1814   * @param collectionId ID of collection1815   * @example getCollectionObject(2);1816   * @returns instance of UniqueFTCollection1817   */1818  getCollectionObject(collectionId: number): UniqueFTCollection {1819    return new UniqueFTCollection(collectionId, this.helper);1820  }18211822  /**1823   * Mint new fungible collection1824   * @param signer keyring of signer1825   * @param collectionOptions Collection options1826   * @param decimalPoints number of token decimals1827   * @example1828   * mintCollection(aliceKeyring, {1829   *   name: 'New',1830   *   description: 'New collection',1831   *   tokenPrefix: 'NEW',1832   * }, 18)1833   * @returns newly created fungible collection1834   */1835  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {1836    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1837    if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1838    collectionOptions.mode = {fungible: decimalPoints};1839    for (const key of ['name', 'description', 'tokenPrefix']) {1840      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);1841    }1842    const creationResult = await this.helper.executeExtrinsic(1843      signer,1844      'api.tx.unique.createCollectionEx', [collectionOptions],1845      true,1846    );1847    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1848  }18491850  /**1851   * Mint tokens1852   * @param signer keyring of signer1853   * @param collectionId ID of collection1854   * @param owner address owner of new tokens1855   * @param amount amount of tokens to be meanted1856   * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1857   * @returns ```true``` if extrinsic success, otherwise ```false```1858   */1859  async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1860    const creationResult = await this.helper.executeExtrinsic(1861      signer,1862      'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1863        fungible: {1864          value: amount,1865        },1866      }],1867      true, // `Unable to mint fungible tokens for ${label}`,1868    );1869    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1870  }18711872  /**1873   * Mint multiple Fungible tokens with one owner1874   * @param signer keyring of signer1875   * @param collectionId ID of collection1876   * @param owner tokens owner1877   * @param tokens array of tokens with properties and pieces1878   * @returns ```true``` if extrinsic success, otherwise ```false```1879   */1880  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1881    const rawTokens = [];1882    for (const token of tokens) {1883      const raw = {Fungible: {Value: token.value}};1884      rawTokens.push(raw);1885    }1886    const creationResult = await this.helper.executeExtrinsic(1887      signer,1888      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1889      true,1890    );1891    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1892  }18931894  /**1895   * Get the top 10 owners with the largest balance for the Fungible collection1896   * @param collectionId ID of collection1897   * @example getTop10Owners(10);1898   * @returns array of ```ICrossAccountId```1899   */1900  async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {1901    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1902  }19031904  /**1905   * Get account balance1906   * @param collectionId ID of collection1907   * @param addressObj address of owner1908   * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1909   * @returns amount of fungible tokens owned by address1910   */1911  async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1912    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1913  }19141915  /**1916   * Transfer tokens to address1917   * @param signer keyring of signer1918   * @param collectionId ID of collection1919   * @param toAddressObj address recipient1920   * @param amount amount of tokens to be sent1921   * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1922   * @returns ```true``` if extrinsic success, otherwise ```false```1923   */1924  async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1925    return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1926  }19271928  /**1929   * Transfer some tokens on behalf of the owner.1930   * @param signer keyring of signer1931   * @param collectionId ID of collection1932   * @param fromAddressObj address on behalf of which tokens will be sent1933   * @param toAddressObj address where token to be sent1934   * @param amount number of tokens to be sent1935   * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1936   * @returns ```true``` if extrinsic success, otherwise ```false```1937   */1938  async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1939    return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1940  }19411942  /**1943   * Destroy some amount of tokens1944   * @param signer keyring of signer1945   * @param collectionId ID of collection1946   * @param amount amount of tokens to be destroyed1947   * @example burnTokens(aliceKeyring, 10, 1000n);1948   * @returns ```true``` if extrinsic success, otherwise ```false```1949   */1950  async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1951    return await super.burnToken(signer, collectionId, 0, amount);1952  }19531954  /**1955   * Burn some tokens on behalf of the owner.1956   * @param signer keyring of signer1957   * @param collectionId ID of collection1958   * @param fromAddressObj address on behalf of which tokens will be burnt1959   * @param amount amount of tokens to be burnt1960   * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1961   * @returns ```true``` if extrinsic success, otherwise ```false```1962   */1963  async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1964    return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);1965  }19661967  /**1968   * Get total collection supply1969   * @param collectionId1970   * @returns1971   */1972  async getTotalPieces(collectionId: number): Promise<bigint> {1973    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1974  }19751976  /**1977   * Set, change, or remove approved address to transfer tokens.1978   *1979   * @param signer keyring of signer1980   * @param collectionId ID of collection1981   * @param toAddressObj address to be approved1982   * @param amount amount of tokens to be approved1983   * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1984   * @returns ```true``` if extrinsic success, otherwise ```false```1985   */1986  async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1987    return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1988  }19891990  /**1991   * Get amount of fungible tokens approved to transfer1992   * @param collectionId ID of collection1993   * @param fromAddressObj owner of tokens1994   * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1995   * @returns number of tokens approved for the transfer1996   */1997  async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1998    return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1999  }2000}200120022003class ChainGroup extends HelperGroup {2004  /**2005   * Get system properties of a chain2006   * @example getChainProperties();2007   * @returns ss58Format, token decimals, and token symbol2008   */2009  getChainProperties(): IChainProperties {2010    const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2011    return {2012      ss58Format: properties.ss58Format.toJSON(),2013      tokenDecimals: properties.tokenDecimals.toJSON(),2014      tokenSymbol: properties.tokenSymbol.toJSON(),2015    };2016  }20172018  /**2019   * Get chain header2020   * @example getLatestBlockNumber();2021   * @returns the number of the last block2022   */2023  async getLatestBlockNumber(): Promise<number> {2024    return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2025  }20262027  /**2028   * Get block hash by block number2029   * @param blockNumber number of block2030   * @example getBlockHashByNumber(12345);2031   * @returns hash of a block2032   */2033  async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2034    const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2035    if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2036    return blockHash;2037  }20382039  // TODO add docs2040  async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2041    const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2042    if (!blockHash) return null;2043    return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2044  }20452046  /**2047   * Get account nonce2048   * @param address substrate address2049   * @example getNonce("5GrwvaEF5zXb26Fz...");2050   * @returns number, account's nonce2051   */2052  async getNonce(address: TSubstrateAccount): Promise<number> {2053    return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2054  }2055}205620572058class BalanceGroup extends HelperGroup {2059  getCollectionCreationPrice(): bigint {2060    return 2n * this.helper.balance.getOneTokenNominal();2061  }2062  /**2063   * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2064   * @example getOneTokenNominal()2065   * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2066   */2067  getOneTokenNominal(): bigint {2068    const chainProperties = this.helper.chain.getChainProperties();2069    return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2070  }20712072  /**2073   * Get substrate address balance2074   * @param address substrate address2075   * @example getSubstrate("5GrwvaEF5zXb26Fz...")2076   * @returns amount of tokens on address2077   */2078  async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2079    return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2080  }20812082  /**2083   * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2084   * @param address substrate address2085   * @returns2086   */2087  async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2088    const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2089    return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2090  }20912092  /**2093   * Get ethereum address balance2094   * @param address ethereum address2095   * @example getEthereum("0x9F0583DbB855d...")2096   * @returns amount of tokens on address2097   */2098  async getEthereum(address: TEthereumAccount): Promise<bigint> {2099    return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2100  }21012102  /**2103   * Transfer tokens to substrate address2104   * @param signer keyring of signer2105   * @param address substrate address of a recipient2106   * @param amount amount of tokens to be transfered2107   * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2108   * @returns ```true``` if extrinsic success, otherwise ```false```2109   */2110  async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2111    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}`*/);21122113    let transfer = {from: null, to: null, amount: 0n} as any;2114    result.result.events.forEach(({event: {data, method, section}}) => {2115      if ((section === 'balances') && (method === 'Transfer')) {2116        transfer = {2117          from: this.helper.address.normalizeSubstrate(data[0]),2118          to: this.helper.address.normalizeSubstrate(data[1]),2119          amount: BigInt(data[2]),2120        };2121      }2122    });2123    const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from 2124      && this.helper.address.normalizeSubstrate(address) === transfer.to 2125      && BigInt(amount) === transfer.amount;2126    return isSuccess;2127  }2128}212921302131class AddressGroup extends HelperGroup {2132  /**2133   * Normalizes the address to the specified ss58 format, by default ```42```.2134   * @param address substrate address2135   * @param ss58Format format for address conversion, by default ```42```2136   * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2137   * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2138   */2139  normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2140    return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2141  }21422143  /**2144   * Get address in the connected chain format2145   * @param address substrate address2146   * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2147   * @returns address in chain format2148   */2149  normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2150    return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2151  }21522153  /**2154   * Get substrate mirror of an ethereum address2155   * @param ethAddress ethereum address2156   * @param toChainFormat false for normalized account2157   * @example ethToSubstrate('0x9F0583DbB855d...')2158   * @returns substrate mirror of a provided ethereum address2159   */2160  ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2161    return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2162  }21632164  /**2165   * Get ethereum mirror of a substrate address2166   * @param subAddress substrate account2167   * @example substrateToEth("5DnSF6RRjwteE3BrC...")2168   * @returns ethereum mirror of a provided substrate address2169   */2170  substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2171    return CrossAccountId.translateSubToEth(subAddress);2172  }2173}21742175class StakingGroup extends HelperGroup {2176  /**2177   * Stake tokens for App Promotion2178   * @param signer keyring of signer2179   * @param amountToStake amount of tokens to stake2180   * @param label extra label for log2181   * @returns2182   */2183  async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2184    if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2185    const _stakeResult = await this.helper.executeExtrinsic(2186      signer, 'api.tx.appPromotion.stake',2187      [amountToStake], true,2188    );2189    // TODO extract info from stakeResult2190    return true;2191  }21922193  /**2194   * Unstake tokens for App Promotion2195   * @param signer keyring of signer2196   * @param amountToUnstake amount of tokens to unstake2197   * @param label extra label for log2198   * @returns block number where balances will be unlocked2199   */2200  async unstake(signer: TSigner, label?: string): Promise<number> {2201    if(typeof label === 'undefined') label = `${signer.address}`;2202    const _unstakeResult = await this.helper.executeExtrinsic(2203      signer, 'api.tx.appPromotion.unstake',2204      [], true,2205    );2206    // TODO extract block number fron events2207    return 1;2208  }22092210  /**2211   * Get total staked amount for address2212   * @param address substrate or ethereum address2213   * @returns total staked amount2214   */2215  async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2216    if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2217    return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2218  }22192220  /**2221   * Get total staked per block2222   * @param address substrate or ethereum address2223   * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2224   */2225  async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2226    const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2227    return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2228      return { 2229        block: block.toBigInt(),2230        amount: amount.toBigInt(),2231      };2232    });2233  }22342235  /**2236   * Get total pending unstake amount for address2237   * @param address substrate or ethereum address2238   * @returns total pending unstake amount2239   */2240  async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2241    return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2242  }22432244  /**2245   * Get pending unstake amount per block for address2246   * @param address substrate or ethereum address2247   * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2248   */2249  async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2250    const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2251    const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2252      return {2253        block: block.toBigInt(),2254        amount: amount.toBigInt(),2255      };2256    });2257    return result;2258  }2259}22602261class SchedulerGroup extends HelperGroup {2262  constructor(helper: UniqueHelper) {2263    super(helper);2264  }22652266  async cancelScheduled(signer: TSigner, scheduledId: string) {2267    return this.helper.executeExtrinsic(2268      signer,2269      'api.tx.scheduler.cancelNamed',2270      [scheduledId],2271      true,2272    );2273  }22742275  async changePriority(signer: TSigner, scheduledId: string, priority: number) {2276    return this.helper.executeExtrinsic(2277      signer,2278      'api.tx.scheduler.changeNamedPriority',2279      [scheduledId, priority],2280      true,2281    );2282  }22832284  scheduleAt<T extends UniqueHelper>(2285    scheduledId: string,2286    executionBlockNumber: number,2287    options: ISchedulerOptions = {},2288  ) {2289    return this.schedule<T>('scheduleNamed', scheduledId, executionBlockNumber, options);2290  }22912292  scheduleAfter<T extends UniqueHelper>(2293    scheduledId: string,2294    blocksBeforeExecution: number,2295    options: ISchedulerOptions = {},2296  ) {2297    return this.schedule<T>('scheduleNamedAfter', scheduledId, blocksBeforeExecution, options);2298  }22992300  schedule<T extends UniqueHelper>(2301    scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter',2302    scheduledId: string,2303    blocksNum: number,2304    options: ISchedulerOptions = {},2305  ) {2306    // eslint-disable-next-line @typescript-eslint/naming-convention2307    const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2308    return this.helper.clone(ScheduledHelperType, {2309      scheduleFn,2310      scheduledId,2311      blocksNum,2312      options,2313    }) as T;2314  }2315}23162317export type UniqueHelperConstructor = new(...args: any[]) => UniqueHelper;23182319export class UniqueHelper extends ChainHelperBase {2320  helperBase: any;23212322  chain: ChainGroup;2323  balance: BalanceGroup;2324  address: AddressGroup;2325  collection: CollectionGroup;2326  nft: NFTGroup;2327  rft: RFTGroup;2328  ft: FTGroup;2329  staking: StakingGroup;2330  scheduler: SchedulerGroup;23312332  constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2333    super(logger);23342335    this.helperBase = options.helperBase ?? UniqueHelper;23362337    this.chain = new ChainGroup(this);2338    this.balance = new BalanceGroup(this);2339    this.address = new AddressGroup(this);2340    this.collection = new CollectionGroup(this);2341    this.nft = new NFTGroup(this);2342    this.rft = new RFTGroup(this);2343    this.ft = new FTGroup(this);2344    this.staking = new StakingGroup(this);2345    this.scheduler = new SchedulerGroup(this);2346  }23472348  clone(helperCls: UniqueHelperConstructor, options: {[key: string]: any} = {}) {2349    Object.setPrototypeOf(helperCls.prototype, this);2350    const newHelper = new helperCls(this.logger, options);23512352    newHelper.api = this.api;2353    newHelper.network = this.network;2354    newHelper.forceNetwork = this.forceNetwork;23552356    this.children.push(newHelper);23572358    return newHelper;2359  }23602361  getSudo<T extends UniqueHelper>() {2362    // eslint-disable-next-line @typescript-eslint/naming-convention2363    const SudoHelperType = SudoUniqueHelper(this.helperBase);2364    return this.clone(SudoHelperType) as T;2365  }2366}23672368// eslint-disable-next-line @typescript-eslint/naming-convention2369function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {2370  return class extends Base {2371    scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter';2372    scheduledId: string;2373    blocksNum: number;2374    options: ISchedulerOptions;23752376    constructor(...args: any[]) {2377      const logger = args[0] as ILogger;2378      const options = args[1] as {2379        scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter',2380        scheduledId: string,2381        blocksNum: number,2382        options: ISchedulerOptions2383      };23842385      super(logger);23862387      this.scheduleFn = options.scheduleFn;2388      this.scheduledId = options.scheduledId;2389      this.blocksNum = options.blocksNum;2390      this.options = options.options;2391    }23922393    executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {2394      const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);2395      const extrinsic = 'api.tx.scheduler.' +  this.scheduleFn;23962397      return super.executeExtrinsic(2398        sender,2399        extrinsic,2400        [2401          this.scheduledId,2402          this.blocksNum,2403          this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,2404          this.options.priority ?? null,2405          {Value: scheduledTx},2406        ],2407        expectSuccess,2408      );2409    }2410  };2411}24122413// eslint-disable-next-line @typescript-eslint/naming-convention2414function SudoUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {2415  return class extends Base {2416    constructor(...args: any[]) {2417      super(...args);2418    }24192420    executeExtrinsic (2421      sender: IKeyringPair,2422      extrinsic: string,2423      params: any[],2424      expectSuccess?: boolean,2425    ): Promise<ITransactionResult> {2426      const call = this.constructApiCall(extrinsic, params);24272428      return super.executeExtrinsic(2429        sender,2430        'api.tx.sudo.sudo',2431        [call],2432        expectSuccess,2433      );2434    }2435  };2436}24372438export class UniqueBaseCollection {2439  helper: UniqueHelper;2440  collectionId: number;24412442  constructor(collectionId: number, uniqueHelper: UniqueHelper) {2443    this.collectionId = collectionId;2444    this.helper = uniqueHelper;2445  }24462447  async getData() {2448    return await this.helper.collection.getData(this.collectionId);2449  }24502451  async getLastTokenId() {2452    return await this.helper.collection.getLastTokenId(this.collectionId);2453  }24542455  async doesTokenExist(tokenId: number) {2456    return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);2457  }24582459  async getAdmins() {2460    return await this.helper.collection.getAdmins(this.collectionId);2461  }24622463  async getAllowList() {2464    return await this.helper.collection.getAllowList(this.collectionId);2465  }24662467  async getEffectiveLimits() {2468    return await this.helper.collection.getEffectiveLimits(this.collectionId);2469  }24702471  async getProperties(propertyKeys?: string[] | null) {2472    return await this.helper.collection.getProperties(this.collectionId, propertyKeys);2473  }24742475  async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2476    return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2477  }24782479  async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2480    return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2481  }24822483  async confirmSponsorship(signer: TSigner) {2484    return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2485  }24862487  async removeSponsor(signer: TSigner) {2488    return await this.helper.collection.removeSponsor(signer, this.collectionId);2489  }24902491  async setLimits(signer: TSigner, limits: ICollectionLimits) {2492    return await this.helper.collection.setLimits(signer, this.collectionId, limits);2493  }24942495  async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2496    return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2497  }24982499  async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2500    return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2501  }25022503  async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2504    return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2505  }25062507  async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2508    return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2509  }25102511  async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2512    return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2513  }25142515  async setProperties(signer: TSigner, properties: IProperty[]) {2516    return await this.helper.collection.setProperties(signer, this.collectionId, properties);2517  }25182519  async deleteProperties(signer: TSigner, propertyKeys: string[]) {2520    return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2521  }25222523  async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2524    return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2525  }25262527  async enableNesting(signer: TSigner, permissions: INestingPermissions) {2528    return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2529  }25302531  async disableNesting(signer: TSigner) {2532    return await this.helper.collection.disableNesting(signer, this.collectionId);2533  }25342535  async burn(signer: TSigner) {2536    return await this.helper.collection.burn(signer, this.collectionId);2537  }25382539  scheduleAt<T extends UniqueHelper>(2540    scheduledId: string,2541    executionBlockNumber: number,2542    options: ISchedulerOptions = {},2543  ) {2544    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2545    return new UniqueBaseCollection(this.collectionId, scheduledHelper);2546  }25472548  scheduleAfter<T extends UniqueHelper>(2549    scheduledId: string,2550    blocksBeforeExecution: number,2551    options: ISchedulerOptions = {},2552  ) {2553    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2554    return new UniqueBaseCollection(this.collectionId, scheduledHelper);2555  }25562557  getSudo<T extends UniqueHelper>() {2558    return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());2559  }2560}256125622563export class UniqueNFTCollection extends UniqueBaseCollection {2564  getTokenObject(tokenId: number) {2565    return new UniqueNFToken(tokenId, this);2566  }25672568  async getTokensByAddress(addressObj: ICrossAccountId) {2569    return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2570  }25712572  async getToken(tokenId: number, blockHashAt?: string) {2573    return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2574  }25752576  async getTokenOwner(tokenId: number, blockHashAt?: string) {2577    return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2578  }25792580  async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2581    return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2582  }25832584  async getTokenChildren(tokenId: number, blockHashAt?: string) {2585    return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2586  }25872588  async getPropertyPermissions(propertyKeys: string[] | null = null) {2589    return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);2590  }25912592  async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {2593    return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2594  }25952596  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2597    return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2598  }25992600  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2601    return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2602  }26032604  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2605    return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2606  }26072608  async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2609    return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2610  }26112612  async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2613    return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2614  }26152616  async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2617    return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2618  }26192620  async burnToken(signer: TSigner, tokenId: number) {2621    return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2622  }26232624  async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {2625    return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);2626  }26272628  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2629    return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2630  }26312632  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2633    return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2634  }26352636  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2637    return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2638  }26392640  async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2641    return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2642  }26432644  async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2645    return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2646  }26472648  scheduleAt<T extends UniqueHelper>(2649    scheduledId: string,2650    executionBlockNumber: number,2651    options: ISchedulerOptions = {},2652  ) {2653    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2654    return new UniqueNFTCollection(this.collectionId, scheduledHelper);2655  }26562657  scheduleAfter<T extends UniqueHelper>(2658    scheduledId: string,2659    blocksBeforeExecution: number,2660    options: ISchedulerOptions = {},2661  ) {2662    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2663    return new UniqueNFTCollection(this.collectionId, scheduledHelper);2664  }26652666  getSudo<T extends UniqueHelper>() {2667    return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());2668  }2669}267026712672export class UniqueRFTCollection extends UniqueBaseCollection {2673  getTokenObject(tokenId: number) {2674    return new UniqueRFToken(tokenId, this);2675  }26762677  async getToken(tokenId: number, blockHashAt?: string) {2678    return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);2679  }26802681  async getTokensByAddress(addressObj: ICrossAccountId) {2682    return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2683  }26842685  async getTop10TokenOwners(tokenId: number) {2686    return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2687  }26882689  async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2690    return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2691  }26922693  async getTokenTotalPieces(tokenId: number) {2694    return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2695  }26962697  async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2698    return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2699  }27002701  async getPropertyPermissions(propertyKeys: string[] | null = null) {2702    return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);2703  }27042705  async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {2706    return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2707  }27082709  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2710    return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2711  }27122713  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2714    return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2715  }27162717  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2718    return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2719  }27202721  async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2722    return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2723  }27242725  async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2726    return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2727  }27282729  async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {2730    return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2731  }27322733  async burnToken(signer: TSigner, tokenId: number, amount=1n) {2734    return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2735  }27362737  async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId,  amount=1n) {2738    return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);2739  }27402741  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2742    return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2743  }27442745  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2746    return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2747  }27482749  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2750    return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2751  }27522753  scheduleAt<T extends UniqueHelper>(2754    scheduledId: string,2755    executionBlockNumber: number,2756    options: ISchedulerOptions = {},2757  ) {2758    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2759    return new UniqueRFTCollection(this.collectionId, scheduledHelper);2760  }27612762  scheduleAfter<T extends UniqueHelper>(2763    scheduledId: string,2764    blocksBeforeExecution: number,2765    options: ISchedulerOptions = {},2766  ) {2767    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2768    return new UniqueRFTCollection(this.collectionId, scheduledHelper);2769  }27702771  getSudo<T extends UniqueHelper>() {2772    return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());2773  }2774}277527762777export class UniqueFTCollection extends UniqueBaseCollection {2778  async getBalance(addressObj: ICrossAccountId) {2779    return await this.helper.ft.getBalance(this.collectionId, addressObj);2780  }27812782  async getTotalPieces() {2783    return await this.helper.ft.getTotalPieces(this.collectionId);2784  }27852786  async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2787    return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2788  }27892790  async getTop10Owners() {2791    return await this.helper.ft.getTop10Owners(this.collectionId);2792  }27932794  async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {2795    return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);2796  }27972798  async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {2799    return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);2800  }28012802  async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2803    return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2804  }28052806  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2807    return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2808  }28092810  async burnTokens(signer: TSigner, amount=1n) {2811    return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2812  }28132814  async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2815    return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2816  }28172818  async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2819    return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2820  }28212822  scheduleAt<T extends UniqueHelper>(2823    scheduledId: string,2824    executionBlockNumber: number,2825    options: ISchedulerOptions = {},2826  ) {2827    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2828    return new UniqueFTCollection(this.collectionId, scheduledHelper);2829  }28302831  scheduleAfter<T extends UniqueHelper>(2832    scheduledId: string,2833    blocksBeforeExecution: number,2834    options: ISchedulerOptions = {},2835  ) {2836    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2837    return new UniqueFTCollection(this.collectionId, scheduledHelper);2838  }28392840  getSudo<T extends UniqueHelper>() {2841    return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());2842  }2843}284428452846export class UniqueBaseToken {2847  collection: UniqueNFTCollection | UniqueRFTCollection;2848  collectionId: number;2849  tokenId: number;28502851  constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2852    this.collection = collection;2853    this.collectionId = collection.collectionId;2854    this.tokenId = tokenId;2855  }28562857  async getNextSponsored(addressObj: ICrossAccountId) {2858    return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2859  }28602861  async getProperties(propertyKeys?: string[] | null) {2862    return await this.collection.getTokenProperties(this.tokenId, propertyKeys);2863  }28642865  async setProperties(signer: TSigner, properties: IProperty[]) {2866    return await this.collection.setTokenProperties(signer, this.tokenId, properties);2867  }28682869  async deleteProperties(signer: TSigner, propertyKeys: string[]) {2870    return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2871  }28722873  async doesExist() {2874    return await this.collection.doesTokenExist(this.tokenId);2875  }28762877  nestingAccount() {2878    return this.collection.helper.util.getTokenAccount(this);2879  }28802881  scheduleAt<T extends UniqueHelper>(2882    scheduledId: string,2883    executionBlockNumber: number,2884    options: ISchedulerOptions = {},2885  ) {2886    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);2887    return new UniqueBaseToken(this.tokenId, scheduledCollection);2888  }28892890  scheduleAfter<T extends UniqueHelper>(2891    scheduledId: string,2892    blocksBeforeExecution: number,2893    options: ISchedulerOptions = {},2894  ) {2895    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2896    return new UniqueBaseToken(this.tokenId, scheduledCollection);2897  }28982899  getSudo<T extends UniqueHelper>() {2900    return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());2901  }2902}290329042905export class UniqueNFToken extends UniqueBaseToken {2906  collection: UniqueNFTCollection;29072908  constructor(tokenId: number, collection: UniqueNFTCollection) {2909    super(tokenId, collection);2910    this.collection = collection;2911  }29122913  async getData(blockHashAt?: string) {2914    return await this.collection.getToken(this.tokenId, blockHashAt);2915  }29162917  async getOwner(blockHashAt?: string) {2918    return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2919  }29202921  async getTopmostOwner(blockHashAt?: string) {2922    return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2923  }29242925  async getChildren(blockHashAt?: string) {2926    return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2927  }29282929  async nest(signer: TSigner, toTokenObj: IToken) {2930    return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2931  }29322933  async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2934    return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2935  }29362937  async transfer(signer: TSigner, addressObj: ICrossAccountId) {2938    return await this.collection.transferToken(signer, this.tokenId, addressObj);2939  }29402941  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2942    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2943  }29442945  async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2946    return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2947  }29482949  async isApproved(toAddressObj: ICrossAccountId) {2950    return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2951  }29522953  async burn(signer: TSigner) {2954    return await this.collection.burnToken(signer, this.tokenId);2955  }29562957  async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {2958    return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);2959  }29602961  scheduleAt<T extends UniqueHelper>(2962    scheduledId: string,2963    executionBlockNumber: number,2964    options: ISchedulerOptions = {},2965  ) {2966    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);2967    return new UniqueNFToken(this.tokenId, scheduledCollection);2968  }29692970  scheduleAfter<T extends UniqueHelper>(2971    scheduledId: string,2972    blocksBeforeExecution: number,2973    options: ISchedulerOptions = {},2974  ) {2975    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2976    return new UniqueNFToken(this.tokenId, scheduledCollection);2977  }29782979  getSudo<T extends UniqueHelper>() {2980    return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());2981  }2982}29832984export class UniqueRFToken extends UniqueBaseToken {2985  collection: UniqueRFTCollection;29862987  constructor(tokenId: number, collection: UniqueRFTCollection) {2988    super(tokenId, collection);2989    this.collection = collection;2990  }29912992  async getData(blockHashAt?: string) {2993    return await this.collection.getToken(this.tokenId, blockHashAt);2994  }29952996  async getTop10Owners() {2997    return await this.collection.getTop10TokenOwners(this.tokenId);2998  }29993000  async getBalance(addressObj: ICrossAccountId) {3001    return await this.collection.getTokenBalance(this.tokenId, addressObj);3002  }30033004  async getTotalPieces() {3005    return await this.collection.getTokenTotalPieces(this.tokenId);3006  }30073008  async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {3009    return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);3010  }30113012  async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {3013    return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);3014  }30153016  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3017    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);3018  }30193020  async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3021    return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);3022  }30233024  async repartition(signer: TSigner, amount: bigint) {3025    return await this.collection.repartitionToken(signer, this.tokenId, amount);3026  }30273028  async burn(signer: TSigner, amount=1n) {3029    return await this.collection.burnToken(signer, this.tokenId, amount);3030  }30313032  async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3033    return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);3034  }30353036  scheduleAt<T extends UniqueHelper>(3037    scheduledId: string,3038    executionBlockNumber: number,3039    options: ISchedulerOptions = {},3040  ) {3041    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);3042    return new UniqueRFToken(this.tokenId, scheduledCollection);3043  }30443045  scheduleAfter<T extends UniqueHelper>(3046    scheduledId: string,3047    blocksBeforeExecution: number,3048    options: ISchedulerOptions = {},3049  ) {3050    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);3051    return new UniqueRFToken(this.tokenId, scheduledCollection);3052  }30533054  getSudo<T extends UniqueHelper>() {3055    return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());3056  }3057}