git.delta.rocks / unique-network / refs/commits / e1ae4a6cdf40

difftreelog

add collection allow-list methods to playgrounds

Max Andreev2022-08-24parent: #15ab591.patch.diff
in: master

1 file changed

modifiedtests/src/util/playgrounds/unique.tsdiffbeforeafterboth
before · tests/src/util/playgrounds/unique.ts
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15  const address = {} as ICrossAccountId;16  if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17  if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18  return address;19};202122const nesting = {23  toChecksumAddress(address: string): string {24    if (typeof address === 'undefined') return '';2526    if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2728    address = address.toLowerCase().replace(/^0x/i,'');29    const addressHash = keccakAsHex(address).replace(/^0x/i,'');30    const checksumAddress = ['0x'];3132    for (let i = 0; i < address.length; i++) {33      // If ith character is 8 to f then make it uppercase34      if (parseInt(addressHash[i], 16) > 7) {35        checksumAddress.push(address[i].toUpperCase());36      } else {37        checksumAddress.push(address[i]);38      }39    }40    return checksumAddress.join('');41  },42  tokenIdToAddress(collectionId: number, tokenId: number) {43    return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8, '0')}${tokenId.toString(16).padStart(8, '0')}`);44  },45};4647class UniqueUtil {48  static transactionStatus = {49    NOT_READY: 'NotReady',50    FAIL: 'Fail',51    SUCCESS: 'Success',52  };5354  static chainLogType = {55    EXTRINSIC: 'extrinsic',56    RPC: 'rpc',57  };5859  static getNestingTokenAddress(collectionId: number, tokenId: number) {60    return nesting.tokenIdToAddress(collectionId, tokenId);61  }6263  static getDefaultLogger(): ILogger {64    return {65      log(msg: any, level = 'INFO') {66        console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));67      },68      level: {69        ERROR: 'ERROR',70        WARNING: 'WARNING',71        INFO: 'INFO',72      },73    };74  }7576  static vec2str(arr: string[] | number[]) {77    return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');78  }7980  static str2vec(string: string) {81    if (typeof string !== 'string') return string;82    return Array.from(string).map(x => x.charCodeAt(0));83  }8485  static fromSeed(seed: string, ss58Format = 42) {86    const keyring = new Keyring({type: 'sr25519', ss58Format});87    return keyring.addFromUri(seed);88  }8990  static normalizeSubstrateAddress(address: string, ss58Format = 42) {91    return encodeAddress(decodeAddress(address), ss58Format);92  }9394  static extractCollectionIdFromCreationResult(creationResult: ITransactionResult, label = 'new collection') {95    if (creationResult.status !== this.transactionStatus.SUCCESS) {96      throw Error(`Unable to create collection for ${label}`);97    }9899    let collectionId = null;100    creationResult.result.events.forEach(({event: {data, method, section}}) => {101      if ((section === 'common') && (method === 'CollectionCreated')) {102        collectionId = parseInt(data[0].toString(), 10);103      }104    });105106    if (collectionId === null) {107      throw Error(`No CollectionCreated event for ${label}`);108    }109110    return collectionId;111  }112113  static extractTokensFromCreationResult(creationResult: ITransactionResult, label = 'new tokens') {114    if (creationResult.status !== this.transactionStatus.SUCCESS) {115      throw Error(`Unable to create tokens for ${label}`);116    }117    let success = false;118    const tokens = [] as any;119    creationResult.result.events.forEach(({event: {data, method, section}}) => {120      if (method === 'ExtrinsicSuccess') {121        success = true;122      } else if ((section === 'common') && (method === 'ItemCreated')) {123        tokens.push({124          collectionId: parseInt(data[0].toString(), 10),125          tokenId: parseInt(data[1].toString(), 10),126          owner: data[2].toJSON(),127        });128      }129    });130    return {success, tokens};131  }132133  static extractTokensFromBurnResult(burnResult: ITransactionResult, label = 'burned tokens') {134    if (burnResult.status !== this.transactionStatus.SUCCESS) {135      throw Error(`Unable to burn tokens for ${label}`);136    }137    let success = false;138    const tokens = [] as any;139    burnResult.result.events.forEach(({event: {data, method, section}}) => {140      if (method === 'ExtrinsicSuccess') {141        success = true;142      } else if ((section === 'common') && (method === 'ItemDestroyed')) {143        tokens.push({144          collectionId: parseInt(data[0].toString(), 10),145          tokenId: parseInt(data[1].toString(), 10),146          owner: data[2].toJSON(),147        });148      }149    });150    return {success, tokens};151  }152153  static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string, label?: string) {154    let eventId = null;155    events.forEach(({event: {data, method, section}}) => {156      if ((section === expectedSection) && (method === expectedMethod)) {157        eventId = parseInt(data[0].toString(), 10);158      }159    });160161    if (eventId === null) {162      throw Error(`No ${expectedMethod} event for ${label}`);163    }164    return eventId === collectionId;165  }166167  static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {168    const normalizeAddress = (address: string | ICrossAccountId) => {169      if(typeof address === 'string') return address;170      const obj = {} as any;171      Object.keys(address).forEach(k => {172        obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];173      });174      if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};175      if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};176      return address;177    };178    let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;179    events.forEach(({event: {data, method, section}}) => {180      if ((section === 'common') && (method === 'Transfer')) {181        const hData = (data as any).toJSON();182        transfer = {183          collectionId: hData[0],184          tokenId: hData[1],185          from: normalizeAddress(hData[2]),186          to: normalizeAddress(hData[3]),187          amount: BigInt(hData[4]),188        };189      }190    });191    let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;192    isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);193    isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);194    isSuccess = isSuccess && amount === transfer.amount;195    return isSuccess;196  }197}198199200class ChainHelperBase {201  transactionStatus = UniqueUtil.transactionStatus;202  chainLogType = UniqueUtil.chainLogType;203  util: typeof UniqueUtil;204  logger: ILogger;205  api: ApiPromise | null;206  forcedNetwork: TUniqueNetworks | null;207  network: TUniqueNetworks | null;208  chainLog: IUniqueHelperLog[];209210  constructor(logger?: ILogger) {211    this.util = UniqueUtil;212    if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();213    this.logger = logger;214    this.api = null;215    this.forcedNetwork = null;216    this.network = null;217    this.chainLog = [];218  }219220  clearChainLog(): void {221    this.chainLog = [];222  }223224  forceNetwork(value: TUniqueNetworks): void {225    this.forcedNetwork = value;226  }227228  async connect(wsEndpoint: string, listeners?: IApiListeners) {229    if (this.api !== null) throw Error('Already connected');230    const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);231    this.api = api;232    this.network = network;233  }234235  async disconnect() {236    if (this.api === null) return;237    await this.api.disconnect();238    this.api = null;239    this.network = null;240  }241242  static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {243    const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;244    if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;245    return 'opal';246  }247248  static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {249    const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});250    await api.isReady;251252    const network = await this.detectNetwork(api);253254    await api.disconnect();255256    return network;257  }258259  static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 260    api: ApiPromise; 261    network: TUniqueNetworks; 262  }> {263    if(typeof network === 'undefined' || network === null) network = 'opal';264    const supportedRPC = {265      opal: {266        unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,267      },268      quartz: {269        unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,270      },271      unique: {272        unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,273      },274    };275    if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);276    const rpc = supportedRPC[network];277278    // TODO: investigate how to replace rpc in runtime279    // api._rpcCore.addUserInterfaces(rpc);280281    const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});282283    await api.isReadyOrError;284285    if (typeof listeners === 'undefined') listeners = {};286    for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {287      if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;288      api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);289    }290291    return {api, network};292  }293294  getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {295    const {events, status} = data;296    if (status.isReady) {297      return this.transactionStatus.NOT_READY;298    }299    if (status.isBroadcast) {300      return this.transactionStatus.NOT_READY;301    }302    if (status.isInBlock || status.isFinalized) {303      const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');304      if (errors.length > 0) {305        return this.transactionStatus.FAIL;306      }307      if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {308        return this.transactionStatus.SUCCESS;309      }310    }311312    return this.transactionStatus.FAIL;313  }314315  signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {316    const sign = (callback: any) => {317      if(options !== null) return transaction.signAndSend(sender, options, callback);318      return transaction.signAndSend(sender, callback);319    };320    return new Promise(async (resolve, reject) => {321      try {322        const unsub = await sign((result: any) => {323          const status = this.getTransactionStatus(result);324325          if (status === this.transactionStatus.SUCCESS) {326            this.logger.log(`${label} successful`);327            unsub();328            resolve({result, status});329          } else if (status === this.transactionStatus.FAIL) {330            let moduleError = null;331332            if (result.hasOwnProperty('dispatchError')) {333              const dispatchError = result['dispatchError'];334335              if (dispatchError && dispatchError.isModule) {336                const modErr = dispatchError.asModule;337                const errorMeta = dispatchError.registry.findMetaError(modErr);338339                moduleError = `${errorMeta.section}.${errorMeta.name}`;340              }341              else {342                this.logger.log(result, this.logger.level.ERROR);343              }344            }345346            this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);347            unsub();348            reject({status, moduleError, result});349          }350        });351      } catch (e) {352        this.logger.log(e, this.logger.level.ERROR);353        reject(e);354      }355    });356  }357358  constructApiCall(apiCall: string, params: any[]) {359    if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);360    let call = this.api as any;361    for(const part of apiCall.slice(4).split('.')) {362      call = call[part];363    }364    return call(...params);365  }366367  async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false, failureMessage='expected success') {368    if(this.api === null) throw Error('API not initialized');369    if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);370371    const startTime = (new Date()).getTime();372    let result: ITransactionResult;373    let events = [];374    try {375      result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;376      events = result.result.events.map((x: any) => x.toHuman());377    }378    catch(e) {379      if(!(e as object).hasOwnProperty('status')) throw e;380      result = e as ITransactionResult;381    }382383    const endTime = (new Date()).getTime();384385    const log = {386      executedAt: endTime,387      executionTime: endTime - startTime,388      type: this.chainLogType.EXTRINSIC,389      status: result.status,390      call: extrinsic,391      params,392    } as IUniqueHelperLog;393394    if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;395    if(events.length > 0) log.events = events;396397    this.chainLog.push(log);398399    if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(failureMessage);400    return result;401  }402403  async callRpc(rpc: string, params?: any[]) {404    if(typeof params === 'undefined') params = [];405    if(this.api === null) throw Error('API not initialized');406    if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);407408    const startTime = (new Date()).getTime();409    let result;410    let error = null;411    const log = {412      type: this.chainLogType.RPC,413      call: rpc,414      params,415    } as IUniqueHelperLog;416417    try {418      result = await this.constructApiCall(rpc, params);419    }420    catch(e) {421      error = e;422    }423424    const endTime = (new Date()).getTime();425426    log.executedAt = endTime;427    log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';428    log.executionTime = endTime - startTime;429430    this.chainLog.push(log);431432    if(error !== null) throw error;433434    return result;435  }436437  getSignerAddress(signer: IKeyringPair | string): string {438    if(typeof signer === 'string') return signer;439    return signer.address;440  }441}442443444class HelperGroup {445  helper: UniqueHelper;446447  constructor(uniqueHelper: UniqueHelper) {448    this.helper = uniqueHelper;449  }450}451452453class CollectionGroup extends HelperGroup {454  /**455 * Get number of blocks when sponsored transaction is available.456 *457 * @param collectionId ID of collection458 * @param tokenId ID of token459 * @param addressObj address for which the sponsorship is checked460 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});461 * @returns number of blocks or null if sponsorship hasn't been set462 */463  async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {464    return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();465  }466467  /**468   * Get the number of created collections.469   * 470   * @returns number of created collections471   */472  async getTotalCount(): Promise<number> {473    return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();474  }475476  /**477   * Get information about the collection with additional data, including the number of tokens it contains, its administrators, the normalized address of the collection's owner, and decoded name and description.478   * 479   * @param collectionId ID of collection480   * @example await getData(2)481   * @returns collection information object482   */483  async getData(collectionId: number): Promise<{484    id: number;485    name: string;486    description: string;487    tokensCount: number;488    admins: ICrossAccountId[];489    normalizedOwner: TSubstrateAccount;490    raw: any491  } | null> {492    const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);493    const humanCollection = collection.toHuman(), collectionData = {494      id: collectionId, name: null, description: null, tokensCount: 0, admins: [],495      raw: humanCollection,496    } as any, jsonCollection = collection.toJSON();497    if (humanCollection === null) return null;498    collectionData.raw.limits = jsonCollection.limits;499    collectionData.raw.permissions = jsonCollection.permissions;500    collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);501    for (const key of ['name', 'description']) {502      collectionData[key] = this.helper.util.vec2str(humanCollection[key]);503    }504505    collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) : 0;506    collectionData.admins = await this.getAdmins(collectionId);507508    return collectionData;509  }510511  /**512   * Get the normalized addresses of the collection's administrators.513   * 514   * @param collectionId ID of collection515   * @example await getAdmins(1)516   * @returns array of administrators517   */518  async getAdmins(collectionId: number): Promise<ICrossAccountId[]> {519    const normalized = [];520    for(const admin of (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman()) {521      if(admin.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(admin.Substrate)});522      else normalized.push(admin);523    }524    return normalized;525  }526527  /**528   * Get the effective limits of the collection instead of null for default values529   * 530   * @param collectionId ID of collection531   * @example await getEffectiveLimits(2)532   * @returns object of collection limits533   */534  async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {535    return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();536  }537538  /**539   * Burns the collection if the signer has sufficient permissions and collection is empty.540   * 541   * @param signer keyring of signer542   * @param collectionId ID of collection543   * @param label extra label for log544   * @example await helper.collection.burn(aliceKeyring, 3);545   * @returns ```true``` if extrinsic success, otherwise ```false```546   */547  async burn(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {548    if(typeof label === 'undefined') label = `collection #${collectionId}`;549    const result = await this.helper.executeExtrinsic(550      signer,551      'api.tx.unique.destroyCollection', [collectionId],552      true, `Unable to burn collection for ${label}`,553    );554555    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed', label);556  }557558  /**559   * Sets the sponsor for the collection (Requires the Substrate address).560   * 561   * @param signer keyring of signer562   * @param collectionId ID of collection563   * @param sponsorAddress Sponsor substrate address564   * @param label extra label for log565   * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")566   * @returns ```true``` if extrinsic success, otherwise ```false```567   */568  async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount, label?: string): Promise<boolean> {569    if(typeof label === 'undefined') label = `collection #${collectionId}`;570    const result = await this.helper.executeExtrinsic(571      signer,572      'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],573      true, `Unable to set collection sponsor for ${label}`,574    );575576    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet', label);577  }578579  /**580   * Confirms consent to sponsor the collection on behalf of the signer.581   * 582   * @param signer keyring of signer583   * @param collectionId ID of collection584   * @param label extra label for log585   * @example confirmSponsorship(aliceKeyring, 10)586   * @returns ```true``` if extrinsic success, otherwise ```false```587   */588  async confirmSponsorship(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {589    if(typeof label === 'undefined') label = `collection #${collectionId}`;590    const result = await this.helper.executeExtrinsic(591      signer,592      'api.tx.unique.confirmSponsorship', [collectionId],593      true, `Unable to confirm collection sponsorship for ${label}`,594    );595596    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed', label);597  }598599  /**600   * Sets the limits of the collection. At least one limit must be specified for a correct call.601   * 602   * @param signer keyring of signer603   * @param collectionId ID of collection604   * @param limits collection limits object605   * @param label extra label for log606   * @example607   * await setLimits(608   *   aliceKeyring,609   *   10,610   *   {611   *     sponsorTransferTimeout: 0,612   *     ownerCanDestroy: false613   *   }614   * )615   * @returns ```true``` if extrinsic success, otherwise ```false```616   */617  async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits, label?: string): Promise<boolean> {618    if(typeof label === 'undefined') label = `collection #${collectionId}`;619    const result = await this.helper.executeExtrinsic(620      signer,621      'api.tx.unique.setCollectionLimits', [collectionId, limits],622      true, `Unable to set collection limits for ${label}`,623    );624625    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet', label);626  }627628  /**629   * Changes the owner of the collection to the new Substrate address.630   * 631   * @param signer keyring of signer632   * @param collectionId ID of collection633   * @param ownerAddress substrate address of new owner634   * @param label extra label for log635   * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")636   * @returns ```true``` if extrinsic success, otherwise ```false```637   */638  async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount, label?: string): Promise<boolean> {639    if(typeof label === 'undefined') label = `collection #${collectionId}`;640    const result = await this.helper.executeExtrinsic(641      signer,642      'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],643      true, `Unable to change collection owner for ${label}`,644    );645646    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged', label);647  }648649  /**650   * Adds a collection administrator. 651   * 652   * @param signer keyring of signer653   * @param collectionId ID of collection654   * @param adminAddressObj Administrator address (substrate or ethereum)655   * @param label extra label for log656   * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})657   * @returns ```true``` if extrinsic success, otherwise ```false```658   */659  async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {660    if(typeof label === 'undefined') label = `collection #${collectionId}`;661    const result = await this.helper.executeExtrinsic(662      signer,663      'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],664      true, `Unable to add collection admin for ${label}`,665    );666667    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded', label);668  }669670  /**671   * Removes a collection administrator.672   * 673   * @param signer keyring of signer674   * @param collectionId ID of collection675   * @param adminAddressObj Administrator address (substrate or ethereum)676   * @param label extra label for log677   * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})678   * @returns ```true``` if extrinsic success, otherwise ```false```679   */680  async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {681    if(typeof label === 'undefined') label = `collection #${collectionId}`;682    const result = await this.helper.executeExtrinsic(683      signer,684      'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],685      true, `Unable to remove collection admin for ${label}`,686    );687688    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved', label);689  }690691  /**692   * Sets onchain permissions for selected collection.693   * 694   * @param signer keyring of signer695   * @param collectionId ID of collection696   * @param permissions collection permissions object697   * @param label extra label for log698   * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});699   * @returns ```true``` if extrinsic success, otherwise ```false```700   */701  async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions, label?: string): Promise<boolean> {702    if(typeof label === 'undefined') label = `collection #${collectionId}`;703    const result = await this.helper.executeExtrinsic(704      signer,705      'api.tx.unique.setCollectionPermissions', [collectionId, permissions],706      true, `Unable to set collection permissions for ${label}`,707    );708709    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet', label);710  }711712  /**713   * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.714   * 715   * @param signer keyring of signer716   * @param collectionId ID of collection717   * @param permissions nesting permissions object718   * @param label extra label for log719   * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});720   * @returns ```true``` if extrinsic success, otherwise ```false```721   */722  async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions, label?: string): Promise<boolean> {723    return await this.setPermissions(signer, collectionId, {nesting: permissions}, label);724  }725726  /**727   * Disables nesting for selected collection.728   * 729   * @param signer keyring of signer730   * @param collectionId ID of collection731   * @param label extra label for log732   * @example disableNesting(aliceKeyring, 10);733   * @returns ```true``` if extrinsic success, otherwise ```false```734   */735  async disableNesting(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {736    return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}}, label);737  }738739  /**740   * Sets onchain properties to the collection.741   * 742   * @param signer keyring of signer743   * @param collectionId ID of collection744   * @param properties array of property objects745   * @param label extra label for log746   * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);747   * @returns ```true``` if extrinsic success, otherwise ```false```748   */749  async setProperties(signer: TSigner, collectionId: number, properties: IProperty[], label?: string): Promise<boolean> {750    if(typeof label === 'undefined') label = `collection #${collectionId}`;751    const result = await this.helper.executeExtrinsic(752      signer,753      'api.tx.unique.setCollectionProperties', [collectionId, properties],754      true, `Unable to set collection properties for ${label}`,755    );756757    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet', label);758  }759760  /**761   * Deletes onchain properties from the collection.762   * 763   * @param signer keyring of signer764   * @param collectionId ID of collection765   * @param propertyKeys array of property keys to delete766   * @param label767   * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);768   * @returns ```true``` if extrinsic success, otherwise ```false```769   */770  async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[], label?: string): Promise<boolean> {771    if(typeof label === 'undefined') label = `collection #${collectionId}`;772    const result = await this.helper.executeExtrinsic(773      signer,774      'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],775      true, `Unable to delete collection properties for ${label}`,776    );777778    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted', label);779  }780781  /**782   * Changes the owner of the token.783   * 784   * @param signer keyring of signer785   * @param collectionId ID of collection786   * @param tokenId ID of token787   * @param addressObj address of a new owner788   * @param amount amount of tokens to be transfered. For NFT must be set to 1n789   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})790   * @returns true if the token success, otherwise false791   */792  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {793    const result = await this.helper.executeExtrinsic(794      signer,795      'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],796      true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,797    );798799    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);800  }801802  /**803   * 804   * Change ownership of a token(s) on behalf of the owner. 805   * 806   * @param signer keyring of signer807   * @param collectionId ID of collection808   * @param tokenId ID of token809   * @param fromAddressObj address on behalf of which the token will be sent810   * @param toAddressObj new token owner811   * @param amount amount of tokens to be transfered. For NFT must be set to 1n812   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})813   * @returns true if the token success, otherwise false814   */815  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {816    const result = await this.helper.executeExtrinsic(817      signer,818      'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],819      true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,820    );821    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);822  }823824  /**825   * 826   * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.827   * 828   * @param signer keyring of signer829   * @param collectionId ID of collection830   * @param tokenId ID of token831   * @param label 832   * @param amount amount of tokens to be burned. For NFT must be set to 1n833   * @example burnToken(aliceKeyring, 10, 5);834   * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```835   */836  async burnToken(signer: TSigner, collectionId: number, tokenId: number, label?: string, amount=1n): Promise<{837    success: boolean,838    token: number | null839  }> {840    if(typeof label === 'undefined') label = `collection #${collectionId}`;841    const burnResult = await this.helper.executeExtrinsic(842      signer,843      'api.tx.unique.burnItem', [collectionId, tokenId, amount],844      true, `Unable to burn token for ${label}`,845    );846    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);847    if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');848    return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};849  }850851  /**852   * Destroys a concrete instance of NFT on behalf of the owner853   * 854   * @param signer keyring of signer855   * @param collectionId ID of collection856   * @param fromAddressObj address on behalf of which the token will be burnt857   * @param tokenId ID of token858   * @param label 859   * @param amount amount of tokens to be burned. For NFT must be set to 1n860   * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})861   * @returns ```true``` if extrinsic success, otherwise ```false```862   */863  async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, label?: string, amount=1n): Promise<boolean> {864    if(typeof label === 'undefined') label = `collection #${collectionId}`;865    const burnResult = await this.helper.executeExtrinsic(866      signer,867      'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],868      true, `Unable to burn token from for ${label}`,869    );870    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);871    return burnedTokens.success && burnedTokens.tokens.length > 0;872  }873874  /**875   * Set, change, or remove approved address to transfer the ownership of the NFT.876   * 877   * @param signer keyring of signer878   * @param collectionId ID of collection879   * @param tokenId ID of token880   * @param toAddressObj 881   * @param label 882   * @param amount amount of token to be approved. For NFT must be set to 1n883   * @returns ```true``` if extrinsic success, otherwise ```false```884   */885  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=1n) {886    if(typeof label === 'undefined') label = `collection #${collectionId}`;887    const approveResult = await this.helper.executeExtrinsic(888      signer, 889      'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],890      true, `Unable to approve token for ${label}`,891    );892893    return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved', label);894  }895896  /**897   * Get the amount of token pieces approved to transfer898   * @param collectionId ID of collection899   * @param tokenId ID of token900   * @param toAccountObj 901   * @param fromAccountObj902   * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})903   * @returns number of approved to transfer pieces904   */905  async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {906    return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();907  }908909  /**910   * Get the last created token id911   * @param collectionId ID of collection912   * @example getLastTokenId(10);913   * @returns id of the last created token914   */915  async getLastTokenId(collectionId: number): Promise<number> {916    return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();917  }918919  /**920   * Check if token exists921   * @param collectionId ID of collection922   * @param tokenId ID of token923   * @example isTokenExists(10, 20);924   * @returns true if the token exists, otherwise false925   */926  async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {927    return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();928  }929}930931class NFTnRFT extends CollectionGroup {932  /**933   * Get tokens owned by account934   * 935   * @param collectionId ID of collection936   * @param addressObj tokens owner937   * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})938   * @returns array of token ids owned by account939   */940  async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {941    return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();942  }943944  /**945   * Get token data946   * @param collectionId ID of collection947   * @param tokenId ID of token948   * @param blockHashAt 949   * @param propertyKeys950   * @example getToken(10, 5);951   * @returns human readable token data 952   */953  async getToken(collectionId: number, tokenId: number, blockHashAt?: string, propertyKeys?: string[]): Promise<{954    properties: IProperty[];955    owner: ICrossAccountId;956    normalizedOwner: ICrossAccountId;957  }| null> {958    let tokenData;959    if(typeof blockHashAt === 'undefined') {960      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);961    }962    else {963      if(typeof propertyKeys === 'undefined') {964        const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();965        if(!collection) return null;966        propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);967      }968      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);969    }970    tokenData = tokenData.toHuman();971    if (tokenData === null || tokenData.owner === null) return null;972    const owner = {} as any;973    for (const key of Object.keys(tokenData.owner)) {974      owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];975    }976    tokenData.normalizedOwner = crossAccountIdFromLower(owner);977    return tokenData;978  }979980  /**981   * Set permissions to change token properties982   * @param signer keyring of signer983   * @param collectionId ID of collection984   * @param permissions permissions to change a property by the collection owner or admin985   * @param label 986   * @example setTokenPropertyPermissions(987   *   aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]988   * )989   * @returns true if extrinsic success otherwise false990   */991  async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[], label?: string): Promise<boolean> {992    if(typeof label === 'undefined') label = `collection #${collectionId}`;993    const result = await this.helper.executeExtrinsic(994      signer,995      'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],996      true, `Unable to set token property permissions for ${label}`,997    );998999    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet', label);1000  }10011002  /**1003   * Set token properties1004   * @param signer keyring of signer1005   * @param collectionId ID of collection1006   * @param tokenId ID of token1007   * @param properties 1008   * @param label 1009   * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1010   * @returns ```true``` if extrinsic success, otherwise ```false```1011   */1012  async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[], label?: string): Promise<boolean> {1013    if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1014    const result = await this.helper.executeExtrinsic(1015      signer,1016      'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1017      true, `Unable to set token properties for ${label}`,1018    );10191020    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet', label);1021  }10221023  /**1024   * Delete the provided properties of a token1025   * @param signer keyring of signer1026   * @param collectionId ID of collection1027   * @param tokenId ID of token1028   * @param propertyKeys property keys to be deleted 1029   * @param label 1030   * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1031   * @returns ```true``` if extrinsic success, otherwise ```false```1032   */1033  async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[], label?: string): Promise<boolean> {1034    if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1035    const result = await this.helper.executeExtrinsic(1036      signer,1037      'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1038      true, `Unable to delete token properties for ${label}`,1039    );10401041    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted', label);1042  }10431044  /**1045   * Mint new collection1046   * @param signer keyring of signer1047   * @param collectionOptions basic collection options and properties 1048   * @param mode NFT or RFT type of a collection1049   * @param errorLabel 1050   * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1051   * @returns object of the created collection1052   */1053  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT', errorLabel = 'Unable to mint collection'): Promise<UniqueCollectionBase> {1054    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1055    collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1056    for (const key of ['name', 'description', 'tokenPrefix']) {1057      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);1058    }1059    const creationResult = await this.helper.executeExtrinsic(1060      signer,1061      'api.tx.unique.createCollectionEx', [collectionOptions],1062      true, errorLabel,1063    );1064    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1065  }10661067  getCollectionObject(collectionId: number): any {1068    return null;1069  }10701071  getTokenObject(collectionId: number, tokenId: number): any {1072    return null;1073  }1074}107510761077class NFTGroup extends NFTnRFT {1078  /**1079   * Get collection object1080   * @param collectionId ID of collection1081   * @example getCollectionObject(2);1082   * @returns instance of UniqueNFTCollection1083   */1084  getCollectionObject(collectionId: number): UniqueNFTCollection {1085    return new UniqueNFTCollection(collectionId, this.helper);1086  }10871088  /**1089   * Get token object1090   * @param collectionId ID of collection1091   * @param tokenId ID of token1092   * @example getTokenObject(10, 5);1093   * @returns instance of UniqueNFTToken1094   */1095  getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1096    return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1097  }10981099  /**1100   * Get token's owner1101   * @param collectionId ID of collection1102   * @param tokenId ID of token1103   * @param blockHashAt 1104   * @example getTokenOwner(10, 5);1105   * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1106   */1107  async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1108    let owner;1109    if (typeof blockHashAt === 'undefined') {1110      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1111    } else {1112      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1113    }1114    return crossAccountIdFromLower(owner.toJSON());1115  }11161117  /**1118   * Is token approved to transfer1119   * @param collectionId ID of collection1120   * @param tokenId ID of token1121   * @param toAccountObj address to be approved1122   * @returns ```true``` if extrinsic success, otherwise ```false```1123   */1124  async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1125    return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1126  }11271128  /**1129   * Changes the owner of the token.1130   * 1131   * @param signer keyring of signer1132   * @param collectionId ID of collection1133   * @param tokenId ID of token1134   * @param addressObj address of a new owner1135   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1136   * @returns ```true``` if extrinsic success, otherwise ```false```1137   */1138  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1139    return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1140  }11411142  /**1143   * 1144   * Change ownership of a NFT on behalf of the owner. 1145   * 1146   * @param signer keyring of signer1147   * @param collectionId ID of collection1148   * @param tokenId ID of token1149   * @param fromAddressObj address on behalf of which the token will be sent1150   * @param toAddressObj new token owner1151   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1152   * @returns ```true``` if extrinsic success, otherwise ```false```1153   */1154  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1155    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1156  }11571158  /**1159   * Recursively find the address that owns the token1160   * @param collectionId ID of collection1161   * @param tokenId ID of token1162   * @param blockHashAt 1163   * @example getTokenTopmostOwner(10, 5);1164   * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1165   */1166  async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1167    let owner;1168    if (typeof blockHashAt === 'undefined') {1169      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1170    } else {1171      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1172    }11731174    if (owner === null) return null;11751176    owner = owner.toHuman();11771178    return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1179  }11801181  /**1182   * Get tokens nested in the provided token1183   * @param collectionId ID of collection1184   * @param tokenId ID of token1185   * @param blockHashAt 1186   * @example getTokenChildren(10, 5);1187   * @returns tokens whose depth of nesting is <= 5 1188   */1189  async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1190    let children;1191    if(typeof blockHashAt === 'undefined') {1192      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1193    } else {1194      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1195    }11961197    return children.toJSON().map((x: any) => {1198      return {collectionId: x.collection, tokenId: x.token};1199    });1200  }12011202  /**1203   * Nest one token into another1204   * @param signer keyring of signer1205   * @param tokenObj token to be nested1206   * @param rootTokenObj token to be parent1207   * @param label 1208   * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1209   * @returns ```true``` if extrinsic success, otherwise ```false```1210   */1211  async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, label='nest token'): Promise<boolean> {1212    const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1213    const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1214    if(!result) {1215      throw Error(`Unable to nest token for ${label}`);1216    }1217    return result;1218  }12191220  /**1221   * Remove token from nested state1222   * @param signer keyring of signer1223   * @param tokenObj token to unnest1224   * @param rootTokenObj parent of a token1225   * @param toAddressObj address of a new token owner 1226   * @param label 1227   * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1228   * @returns ```true``` if extrinsic success, otherwise ```false```1229   */1230  async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId, label='unnest token'): Promise<boolean> {1231    const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1232    const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1233    if(!result) {1234      throw Error(`Unable to unnest token for ${label}`);1235    }1236    return result;1237  }12381239  /**1240   * Mint new collection1241   * @param signer keyring of signer1242   * @param collectionOptions Collection options1243   * @param label 1244   * @example 1245   * mintCollection(aliceKeyring, {1246   *   name: 'New',1247   *   description: 'New collection',1248   *   tokenPrefix: 'NEW',1249   * })1250   * @returns object of the created collection1251   */1252  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueNFTCollection> {1253    return await super.mintCollection(signer, collectionOptions, 'NFT', `Unable to mint NFT collection for ${label}`) as UniqueNFTCollection;1254  }12551256  /**1257   * Mint new token1258   * @param signer keyring of signer1259   * @param data token data1260   * @param label 1261   * @returns created token object1262   */1263  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }, label?: string): Promise<UniqueNFTToken> {1264    if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1265    const creationResult = await this.helper.executeExtrinsic(1266      signer,1267      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1268        nft: {1269          properties: data.properties,1270        },1271      }],1272      true, `Unable to mint NFT token for ${label}`,1273    );1274    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1275    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1276    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1277    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1278  }12791280  /**1281   * Mint multiple NFT tokens1282   * @param signer keyring of signer1283   * @param collectionId ID of collection1284   * @param tokens array of tokens with owner and properties1285   * @param label 1286   * @example 1287   * mintMultipleTokens(aliceKeyring, 10, [{1288   *     owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1289   *     properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1290   *   },{1291   *     owner: {Ethereum: "0x9F0583DbB855d..."},1292   *     properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1293   * }]);1294   * @returns ```true``` if extrinsic success, otherwise ```false```1295   */1296  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1297    if(typeof label === 'undefined') label = `collection #${collectionId}`;1298    const creationResult = await this.helper.executeExtrinsic(1299      signer,1300      'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1301      true, `Unable to mint NFT tokens for ${label}`,1302    );1303    const collection = this.getCollectionObject(collectionId);1304    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1305  }13061307  /**1308   * Mint multiple NFT tokens with one owner1309   * @param signer keyring of signer1310   * @param collectionId ID of collection1311   * @param owner tokens owner1312   * @param tokens array of tokens with owner and properties1313   * @param label 1314   * @example1315   * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1316   *   properties: [{1317   *   key: "gender",1318   *   value: "female",1319   *  },{1320   *   key: "age",1321   *   value: "33",1322   *  }],1323   * }]);1324   * @returns array of newly created tokens1325   */1326  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1327    if(typeof label === 'undefined') label = `collection #${collectionId}`;1328    const rawTokens = [];1329    for (const token of tokens) {1330      const raw = {NFT: {properties: token.properties}};1331      rawTokens.push(raw);1332    }1333    const creationResult = await this.helper.executeExtrinsic(1334      signer,1335      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1336      true, `Unable to mint NFT tokens for ${label}`,1337    );1338    const collection = this.getCollectionObject(collectionId);1339    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1340  }13411342  /**1343   * Destroys a concrete instance of NFT.1344   * @param signer keyring of signer1345   * @param collectionId ID of collection1346   * @param tokenId ID of token1347   * @param label 1348   * @example burnToken(aliceKeyring, 10, 5);1349   * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1350   */1351  async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string): Promise<{ success: boolean; token: number | null; }> {1352    return await super.burnToken(signer, collectionId, tokenId, label, 1n);1353  }13541355  /**1356   * Set, change, or remove approved address to transfer the ownership of the NFT.1357   * 1358   * @param signer keyring of signer1359   * @param collectionId ID of collection1360   * @param tokenId ID of token1361   * @param toAddressObj address to approve1362   * @param label 1363   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1364   * @returns ```true``` if extrinsic success, otherwise ```false```1365   */1366  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {1367    return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, 1n);1368  }1369}137013711372class RFTGroup extends NFTnRFT {1373  /**1374   * Get collection object1375   * @param collectionId ID of collection1376   * @example getCollectionObject(2);1377   * @returns instance of UniqueRFTCollection1378   */1379  getCollectionObject(collectionId: number): UniqueRFTCollection {1380    return new UniqueRFTCollection(collectionId, this.helper);1381  }13821383  /**1384   * Get token object1385   * @param collectionId ID of collection1386   * @param tokenId ID of token1387   * @example getTokenObject(10, 5);1388   * @returns instance of UniqueNFTToken1389   */1390  getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1391    return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1392  }13931394  /**1395   * Get top 10 token owners with the largest number of pieces 1396   * @param collectionId ID of collection1397   * @param tokenId ID of token1398   * @example getTokenTop10Owners(10, 5);1399   * @returns array of top 10 owners1400   */1401  async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1402    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1403  }14041405  /**1406   * Get number of pieces owned by address1407   * @param collectionId ID of collection1408   * @param tokenId ID of token1409   * @param addressObj address token owner1410   * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1411   * @returns number of pieces ownerd by address1412   */1413  async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1414    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1415  }14161417  /**1418   * Transfer pieces of token to another address1419   * @param signer keyring of signer1420   * @param collectionId ID of collection1421   * @param tokenId ID of token1422   * @param addressObj address of a new owner1423   * @param amount number of pieces to be transfered1424   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1425   * @returns ```true``` if extrinsic success, otherwise ```false```1426   */1427  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=100n): Promise<boolean> {1428    return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1429  }14301431  /**1432   * Change ownership of some pieces of RFT on behalf of the owner. 1433   * @param signer keyring of signer1434   * @param collectionId ID of collection1435   * @param tokenId ID of token1436   * @param fromAddressObj address on behalf of which the token will be sent1437   * @param toAddressObj new token owner1438   * @param amount number of pieces to be transfered1439   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1440   * @returns ```true``` if extrinsic success, otherwise ```false```1441   */1442  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n): Promise<boolean> {1443    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1444  }14451446  /**1447   * Mint new collection1448   * @param signer keyring of signer1449   * @param collectionOptions Collection options1450   * @param label 1451   * @example1452   * mintCollection(aliceKeyring, {1453   *   name: 'New',1454   *   description: 'New collection',1455   *   tokenPrefix: 'NEW',1456   * })1457   * @returns object of the created collection1458   */1459  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueRFTCollection> {1460    return await super.mintCollection(signer, collectionOptions, 'RFT', `Unable to mint RFT collection for ${label}`) as UniqueRFTCollection;1461  }14621463  /**1464   * Mint new token1465   * @param signer keyring of signer1466   * @param data token data1467   * @param label 1468   * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1469   * @returns created token object1470   */1471  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }, label?: string): Promise<UniqueRFTToken> {1472    if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1473    const creationResult = await this.helper.executeExtrinsic(1474      signer,1475      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1476        refungible: {1477          pieces: data.pieces,1478          properties: data.properties,1479        },1480      }],1481      true, `Unable to mint RFT token for ${label}`,1482    );1483    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1484    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1485    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1486    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1487  }14881489  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1490    throw Error('Not implemented');1491    if(typeof label === 'undefined') label = `collection #${collectionId}`;1492    const creationResult = await this.helper.executeExtrinsic(1493      signer,1494      'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1495      true, `Unable to mint RFT tokens for ${label}`,1496    );1497    const collection = this.getCollectionObject(collectionId);1498    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1499  }15001501  /**1502   * Mint multiple RFT tokens with one owner1503   * @param signer keyring of signer1504   * @param collectionId ID of collection1505   * @param owner tokens owner1506   * @param tokens array of tokens with properties and pieces1507   * @param label 1508   * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1509   * @returns array of newly created RFT tokens1510   */1511  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1512    if(typeof label === 'undefined') label = `collection #${collectionId}`;1513    const rawTokens = [];1514    for (const token of tokens) {1515      const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1516      rawTokens.push(raw);1517    }1518    const creationResult = await this.helper.executeExtrinsic(1519      signer,1520      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1521      true, `Unable to mint RFT tokens for ${label}`,1522    );1523    const collection = this.getCollectionObject(collectionId);1524    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1525  }15261527  /**1528   * Destroys a concrete instance of RFT.1529   * @param signer keyring of signer1530   * @param collectionId ID of collection1531   * @param tokenId ID of token1532   * @param label 1533   * @param amount number of pieces to be burnt1534   * @example burnToken(aliceKeyring, 10, 5);1535   * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1536   */1537  async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string, amount=100n): Promise<{ success: boolean; token: number | null; }> {1538    return await super.burnToken(signer, collectionId, tokenId, label, amount);1539  }15401541  /**1542   * Set, change, or remove approved address to transfer the ownership of the RFT.1543   * 1544   * @param signer keyring of signer1545   * @param collectionId ID of collection1546   * @param tokenId ID of token1547   * @param toAddressObj address to approve1548   * @param label 1549   * @param amount number of pieces to be approved1550   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1551   * @returns true if the token success, otherwise false1552   */1553  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=100n) {1554    return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, amount);1555  }15561557  /**1558   * Get total number of pieces1559   * @param collectionId ID of collection1560   * @param tokenId ID of token1561   * @example getTokenTotalPieces(10, 5);1562   * @returns number of pieces1563   */1564  async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1565    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1566  }15671568  /**1569   * Change number of token pieces. Signer must be the owner of all token pieces.1570   * @param signer keyring of signer1571   * @param collectionId ID of collection1572   * @param tokenId ID of token1573   * @param amount new number of pieces1574   * @param label 1575   * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1576   * @returns true if the repartion was success, otherwise false1577   */1578  async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint, label?: string): Promise<boolean> {1579    if(typeof label === 'undefined') label = `collection #${collectionId}`;1580    const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1581    const repartitionResult = await this.helper.executeExtrinsic(1582      signer,1583      'api.tx.unique.repartition', [collectionId, tokenId, amount],1584      true, `Unable to repartition RFT token for ${label}`,1585    );1586    if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated', label);1587    return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed', label);1588  }1589}159015911592class FTGroup extends CollectionGroup {1593  /**1594   * Get collection object1595   * @param collectionId ID of collection1596   * @example getCollectionObject(2);1597   * @returns instance of UniqueFTCollection1598   */1599  getCollectionObject(collectionId: number): UniqueFTCollection {1600    return new UniqueFTCollection(collectionId, this.helper);1601  }16021603  /**1604   * Mint new fungible collection1605   * @param signer keyring of signer1606   * @param collectionOptions Collection options1607   * @param decimalPoints number of token decimals 1608   * @param errorLabel 1609   * @example1610   * mintCollection(aliceKeyring, {1611   *   name: 'New',1612   *   description: 'New collection',1613   *   tokenPrefix: 'NEW',1614   * }, 18)1615   * @returns newly created fungible collection1616   */1617  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0, errorLabel = 'Unable to mint collection'): Promise<UniqueFTCollection> {1618    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1619    if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1620    collectionOptions.mode = {fungible: decimalPoints};1621    for (const key of ['name', 'description', 'tokenPrefix']) {1622      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);1623    }1624    const creationResult = await this.helper.executeExtrinsic(1625      signer,1626      'api.tx.unique.createCollectionEx', [collectionOptions],1627      true, errorLabel,1628    );1629    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1630  }16311632  /**1633   * Mint tokens1634   * @param signer keyring of signer1635   * @param collectionId ID of collection1636   * @param owner address owner of new tokens1637   * @param amount amount of tokens to be meanted1638   * @param label 1639   * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1640   * @returns ```true``` if extrinsic success, otherwise ```false``` 1641   */1642  async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint, label?: string): Promise<boolean> {1643    if(typeof label === 'undefined') label = `collection #${collectionId}`;1644    const creationResult = await this.helper.executeExtrinsic(1645      signer,1646      'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1647        fungible: {1648          value: amount,1649        },1650      }],1651      true, `Unable to mint fungible tokens for ${label}`,1652    );1653    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1654  }16551656  /**1657   * Mint multiple Fungible tokens with one owner1658   * @param signer keyring of signer1659   * @param collectionId ID of collection1660   * @param owner tokens owner1661   * @param tokens array of tokens with properties and pieces1662   * @param label 1663   * @returns ```true``` if extrinsic success, otherwise ```false``` 1664   */1665  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string): Promise<boolean> {1666    if(typeof label === 'undefined') label = `collection #${collectionId}`;1667    const rawTokens = [];1668    for (const token of tokens) {1669      const raw = {Fungible: {Value: token.value}};1670      rawTokens.push(raw);1671    }1672    const creationResult = await this.helper.executeExtrinsic(1673      signer,1674      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1675      true, `Unable to mint RFT tokens for ${label}`,1676    );1677    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1678  }16791680  /**1681   * Get the top 10 owners with the largest balance for the Fungible collection 1682   * @param collectionId ID of collection1683   * @example getTop10Owners(10);1684   * @returns array of ```ICrossAccountId```1685   */1686  async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1687    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1688  }16891690  /**1691   * Get account balance1692   * @param collectionId ID of collection1693   * @param addressObj address of owner1694   * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1695   * @returns amount of fungible tokens owned by address1696   */1697  async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1698    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1699  }17001701  /**1702   * Transfer tokens to address1703   * @param signer keyring of signer1704   * @param collectionId ID of collection1705   * @param toAddressObj address recepient1706   * @param amount amount of tokens to be sent1707   * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1708   * @returns ```true``` if extrinsic success, otherwise ```false``` 1709   */1710  async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount: bigint) {1711    return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1712  }17131714  /**1715   * Transfer some tokens on behalf of the owner.1716   * @param signer keyring of signer1717   * @param collectionId ID of collection1718   * @param fromAddressObj address on behalf of which tokens will be sent1719   * @param toAddressObj address where token to be sent1720   * @param amount number of tokens to be sent1721   * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1722   * @returns ```true``` if extrinsic success, otherwise ```false``` 1723   */1724  async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {1725    return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1726  }17271728  /**1729   * Destroy some amount of tokens1730   * @param signer keyring of signer1731   * @param collectionId ID of collection1732   * @param amount amount of tokens to be destroyed1733   * @param label 1734   * @example burnTokens(aliceKeyring, 10, 1000n);1735   * @returns ```true``` if extrinsic success, otherwise ```false``` 1736   */1737  async burnTokens(signer: IKeyringPair, collectionId: number, amount=100n, label?: string): Promise<boolean> {1738    return (await super.burnToken(signer, collectionId, 0, label, amount)).success;1739  }17401741  /**1742   * Burn some tokens on behalf of the owner.1743   * @param signer keyring of signer1744   * @param collectionId ID of collection1745   * @param fromAddressObj address on behalf of which tokens will be burnt1746   * @param amount amount of tokens to be burnt1747   * @param label 1748   * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1749   * @returns ```true``` if extrinsic success, otherwise ```false``` 1750   */1751  async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=100n, label?: string): Promise<boolean> {1752    return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, label, amount);1753  }17541755  /**1756   * Get total collection supply1757   * @param collectionId 1758   * @returns 1759   */1760  async getTotalPieces(collectionId: number): Promise<bigint> {1761    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1762  }17631764  /**1765   * Set, change, or remove approved address to transfer tokens.1766   * 1767   * @param signer keyring of signer1768   * @param collectionId ID of collection1769   * @param toAddressObj address to be approved1770   * @param amount amount of tokens to be approved1771   * @param label 1772   * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1773   * @returns ```true``` if extrinsic success, otherwise ```false``` 1774   */1775  async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {1776    return super.approveToken(signer, collectionId, 0, toAddressObj, label, amount);1777  }17781779  /**1780   * Get amount of fungible tokens approved to transfer1781   * @param collectionId ID of collection1782   * @param fromAddressObj owner of tokens1783   * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1784   * @returns number of tokens approved for the transfer1785   */1786  async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1787    return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1788  }1789}179017911792class ChainGroup extends HelperGroup {1793  /**1794   * Get system properties of a chain1795   * @example getChainProperties();1796   * @returns ss58Format, token decimals, and token symbol1797   */1798  getChainProperties(): IChainProperties {1799    const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1800    return {1801      ss58Format: properties.ss58Format.toJSON(),1802      tokenDecimals: properties.tokenDecimals.toJSON(),1803      tokenSymbol: properties.tokenSymbol.toJSON(),1804    };1805  }18061807  /**1808   * Get chain header1809   * @example getLatestBlockNumber();1810   * @returns the number of the last block1811   */1812  async getLatestBlockNumber(): Promise<number> {1813    return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1814  }18151816  /**1817   * Get block hash by block number1818   * @param blockNumber number of block1819   * @example getBlockHashByNumber(12345);1820   * @returns hash of a block1821   */1822  async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1823    const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1824    if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1825    return blockHash;1826  }18271828  /**1829   * Get account nonce1830   * @param address substrate address1831   * @example getNonce("5GrwvaEF5zXb26Fz...");1832   * @returns number, account's nonce1833   */1834  async getNonce(address: TSubstrateAccount): Promise<number> {1835    return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1836  }1837}183818391840class BalanceGroup extends HelperGroup {1841  /**1842   * Representation of the native token in the smallest unit1843   * @example getOneTokenNominal()1844   * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1845   */1846  getOneTokenNominal(): bigint {1847    const chainProperties = this.helper.chain.getChainProperties();1848    return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1849  }18501851  /**1852   * Get substrate address balance1853   * @param address substrate address1854   * @example getSubstrate("5GrwvaEF5zXb26Fz...")1855   * @returns amount of tokens on address1856   */1857  async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1858    return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1859  }18601861  /**1862   * Get ethereum address balance1863   * @param address ethereum address1864   * @example getEthereum("0x9F0583DbB855d...")1865   * @returns amount of tokens on address1866   */1867  async getEthereum(address: TEthereumAccount): Promise<bigint> {1868    return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1869  }18701871  /**1872   * Transfer tokens to substrate address1873   * @param signer keyring of signer1874   * @param address substrate address of a recepient1875   * @param amount amount of tokens to be transfered1876   * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1877   * @returns ```true``` if extrinsic success, otherwise ```false```1878   */1879  async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1880    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}`);18811882    let transfer = {from: null, to: null, amount: 0n} as any;1883    result.result.events.forEach(({event: {data, method, section}}) => {1884      if ((section === 'balances') && (method === 'Transfer')) {1885        transfer = {1886          from: this.helper.address.normalizeSubstrate(data[0]),1887          to: this.helper.address.normalizeSubstrate(data[1]),1888          amount: BigInt(data[2]),1889        };1890      }1891    });1892    let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1893    isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1894    isSuccess = isSuccess && BigInt(amount) === transfer.amount;1895    return isSuccess;1896  }1897}189818991900class AddressGroup extends HelperGroup {1901  /**1902   * Normalizes the address to the specified ss58 format, by default ```42```.1903   * @param address substrate address1904   * @param ss58Format format for address conversion, by default ```42```1905   * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1906   * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1907   */1908  normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1909    return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1910  }19111912  /**1913   * Get address in the connected chain format1914   * @param address substrate address1915   * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1916   * @returns address in chain format1917   */1918  async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1919    const info = this.helper.chain.getChainProperties();1920    return encodeAddress(decodeAddress(address), info.ss58Format);1921  }19221923  /**1924   * Get substrate mirror of an ethereum address1925   * @param ethAddress ethereum address1926   * @param toChainFormat false for normalized account1927   * @example ethToSubstrate('0x9F0583DbB855d...')1928   * @returns substrate mirror of a provided ethereum address1929   */1930  async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1931    if(!toChainFormat) return evmToAddress(ethAddress);1932    const info = this.helper.chain.getChainProperties();1933    return evmToAddress(ethAddress, info.ss58Format);1934  }19351936  /**1937   * Get ethereum mirror of a substrate address1938   * @param subAddress substrate account1939   * @example substrateToEth("5DnSF6RRjwteE3BrC...")1940   * @returns ethereum mirror of a provided substrate address1941   */1942  substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1943    return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1944  }1945}194619471948export class UniqueHelper extends ChainHelperBase {1949  chain: ChainGroup;1950  balance: BalanceGroup;1951  address: AddressGroup;1952  collection: CollectionGroup;1953  nft: NFTGroup;1954  rft: RFTGroup;1955  ft: FTGroup;19561957  constructor(logger?: ILogger) {1958    super(logger);1959    this.chain = new ChainGroup(this);1960    this.balance = new BalanceGroup(this);1961    this.address = new AddressGroup(this);1962    this.collection = new CollectionGroup(this);1963    this.nft = new NFTGroup(this);1964    this.rft = new RFTGroup(this);1965    this.ft = new FTGroup(this);1966  }  1967}196819691970class UniqueCollectionBase {1971  helper: UniqueHelper;1972  collectionId: number;19731974  constructor(collectionId: number, uniqueHelper: UniqueHelper) {1975    this.collectionId = collectionId;1976    this.helper = uniqueHelper;1977  }19781979  async getData() {1980    return await this.helper.collection.getData(this.collectionId);1981  }19821983  async getLastTokenId() {1984    return await this.helper.collection.getLastTokenId(this.collectionId);1985  }19861987  async isTokenExists(tokenId: number) {1988    return await this.helper.collection.isTokenExists(this.collectionId, tokenId);1989  }19901991  async getAdmins() {1992    return await this.helper.collection.getAdmins(this.collectionId);1993  }19941995  async getEffectiveLimits() {1996    return await this.helper.collection.getEffectiveLimits(this.collectionId);1997  }19981999  async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount, label?: string) {2000    return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress, label);2001  }20022003  async confirmSponsorship(signer: TSigner, label?: string) {2004    return await this.helper.collection.confirmSponsorship(signer, this.collectionId, label);2005  }20062007  async setLimits(signer: TSigner, limits: ICollectionLimits, label?: string) {2008    return await this.helper.collection.setLimits(signer, this.collectionId, limits, label);2009  }20102011  async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount, label?: string) {2012    return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress, label);2013  }20142015  async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2016    return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj, label);2017  }20182019  async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2020    return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj, label);2021  }20222023  async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2024    return await this.helper.collection.setProperties(signer, this.collectionId, properties, label);2025  }20262027  async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2028    return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys, label);2029  }20302031  async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2032    return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2033  }20342035  async setPermissions(signer: TSigner, permissions: ICollectionPermissions, label?: string) {2036    return await this.helper.collection.setPermissions(signer, this.collectionId, permissions, label);2037  }20382039  async enableNesting(signer: TSigner, permissions: INestingPermissions, label?: string) {2040    return await this.helper.collection.enableNesting(signer, this.collectionId, permissions, label);2041  }20422043  async disableNesting(signer: TSigner, label?: string) {2044    return await this.helper.collection.disableNesting(signer, this.collectionId, label);2045  }20462047  async burn(signer: TSigner, label?: string) {2048    return await this.helper.collection.burn(signer, this.collectionId, label);2049  }2050}205120522053class UniqueNFTCollection extends UniqueCollectionBase {2054  getTokenObject(tokenId: number) {2055    return new UniqueNFTToken(tokenId, this);2056  }20572058  async getTokensByAddress(addressObj: ICrossAccountId) {2059    return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2060  }20612062  async getToken(tokenId: number, blockHashAt?: string) {2063    return await this.helper.nft.getToken(this.collectionId, tokenId, blockHashAt);2064  }20652066  async getTokenOwner(tokenId: number, blockHashAt?: string) {2067    return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2068  }20692070  async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2071    return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2072  }20732074  async getTokenChildren(tokenId: number, blockHashAt?: string) {2075    return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2076  }20772078  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2079    return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2080  }20812082  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2083    return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2084  }20852086  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {2087    return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label);2088  }20892090  async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2091    return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2092  }20932094  async mintToken(signer: TSigner, owner: ICrossAccountId, properties?: IProperty[], label?: string) {2095    return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties}, label);2096  }20972098  async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string) {2099    return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens, label);2100  }21012102  async burnToken(signer: TSigner, tokenId: number, label?: string) {2103    return await this.helper.nft.burnToken(signer, this.collectionId, tokenId, label);2104  }21052106  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2107    return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2108  }21092110  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2111    return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2112  }21132114  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2115    return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2116  }21172118  async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken, label?: string) {2119    return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj, label);2120  }21212122  async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2123    return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj, label);2124  }2125}212621272128class UniqueRFTCollection extends UniqueCollectionBase {2129  getTokenObject(tokenId: number) {2130    return new UniqueRFTToken(tokenId, this);2131  }21322133  async getTokensByAddress(addressObj: ICrossAccountId) {2134    return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2135  }21362137  async getTop10TokenOwners(tokenId: number) {2138    return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2139  }21402141  async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2142    return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2143  }21442145  async getTokenTotalPieces(tokenId: number) {2146    return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2147  }21482149  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=100n) {2150    return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2151  }21522153  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2154    return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2155  }21562157  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2158    return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label, amount);2159  }21602161  async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2162    return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2163  }21642165  async repartitionToken(signer: TSigner, tokenId: number, amount: bigint, label?: string) {2166    return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount, label);2167  }21682169  async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[], label?: string) {2170    return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties}, label);2171  }21722173  async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string) {2174    return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens, label);2175  }21762177  async burnToken(signer: TSigner, tokenId: number, amount=100n, label?: string) {2178    return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, label, amount);2179  }21802181  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2182    return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2183  }21842185  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2186    return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2187  }21882189  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2190    return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2191  }2192}219321942195class UniqueFTCollection extends UniqueCollectionBase {2196  async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint, label?: string) {2197    return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount, label);2198  }21992200  async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string) {2201    return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens, label);2202  }22032204  async getBalance(addressObj: ICrossAccountId) {2205    return await this.helper.ft.getBalance(this.collectionId, addressObj);2206  }22072208  async getTop10Owners() {2209    return await this.helper.ft.getTop10Owners(this.collectionId);2210  }22112212  async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount: bigint) {2213    return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2214  }22152216  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {2217    return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2218  }22192220  async burnTokens(signer: TSigner, amount: bigint, label?: string) {2221    return await this.helper.ft.burnTokens(signer, this.collectionId, amount, label);2222  }22232224  async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount: bigint, label?: string) {2225    return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount, label);2226  }22272228  async getTotalPieces() {2229    return await this.helper.ft.getTotalPieces(this.collectionId);2230  }22312232  async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2233    return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount, label);2234  }22352236  async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2237    return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2238  }2239}224022412242class UniqueTokenBase implements IToken {2243  collection: UniqueNFTCollection | UniqueRFTCollection;2244  collectionId: number;2245  tokenId: number;22462247  constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2248    this.collection = collection;2249    this.collectionId = collection.collectionId;2250    this.tokenId = tokenId;2251  }22522253  async getNextSponsored(addressObj: ICrossAccountId) {2254    return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2255  }22562257  async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2258    return await this.collection.setTokenProperties(signer, this.tokenId, properties, label);2259  }22602261  async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2262    return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys, label);2263  }2264}226522662267class UniqueNFTToken extends UniqueTokenBase {2268  collection: UniqueNFTCollection;22692270  constructor(tokenId: number, collection: UniqueNFTCollection) {2271    super(tokenId, collection);2272    this.collection = collection;2273  }22742275  async getData(blockHashAt?: string) {2276    return await this.collection.getToken(this.tokenId, blockHashAt);2277  }22782279  async getOwner(blockHashAt?: string) {2280    return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2281  }22822283  async getTopmostOwner(blockHashAt?: string) {2284    return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2285  }22862287  async getChildren(blockHashAt?: string) {2288    return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2289  }22902291  async nest(signer: TSigner, toTokenObj: IToken, label?: string) {2292    return await this.collection.nestToken(signer, this.tokenId, toTokenObj, label);2293  }22942295  async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2296    return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj, label);2297  }22982299  async transfer(signer: TSigner, addressObj: ICrossAccountId) {2300    return await this.collection.transferToken(signer, this.tokenId, addressObj);2301  }23022303  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2304    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2305  }23062307  async approve(signer: TSigner, toAddressObj: ICrossAccountId, label?: string) {2308    return await this.collection.approveToken(signer, this.tokenId, toAddressObj, label);2309  }23102311  async isApproved(toAddressObj: ICrossAccountId) {2312    return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2313  }23142315  async burn(signer: TSigner, label?: string) {2316    return await this.collection.burnToken(signer, this.tokenId, label);2317  }2318}23192320class UniqueRFTToken extends UniqueTokenBase {2321  collection: UniqueRFTCollection;23222323  constructor(tokenId: number, collection: UniqueRFTCollection) {2324    super(tokenId, collection);2325    this.collection = collection;2326  }23272328  async getTop10Owners() {2329    return await this.collection.getTop10TokenOwners(this.tokenId);2330  }23312332  async getBalance(addressObj: ICrossAccountId) {2333    return await this.collection.getTokenBalance(this.tokenId, addressObj);2334  }23352336  async getTotalPieces() {2337    return await this.collection.getTokenTotalPieces(this.tokenId);2338  }23392340  async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=100n) {2341    return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2342  }23432344  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2345    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2346  }23472348  async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2349    return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount, label);2350  }23512352  async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2353    return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2354  }23552356  async repartition(signer: TSigner, amount: bigint, label?: string) {2357    return await this.collection.repartitionToken(signer, this.tokenId, amount, label);2358  }23592360  async burn(signer: TSigner, amount=100n, label?: string) {2361    return await this.collection.burnToken(signer, this.tokenId, amount, label);2362  }2363}
after · tests/src/util/playgrounds/unique.ts
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15  const address = {} as ICrossAccountId;16  if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17  if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18  return address;19};202122const nesting = {23  toChecksumAddress(address: string): string {24    if (typeof address === 'undefined') return '';2526    if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2728    address = address.toLowerCase().replace(/^0x/i,'');29    const addressHash = keccakAsHex(address).replace(/^0x/i,'');30    const checksumAddress = ['0x'];3132    for (let i = 0; i < address.length; i++) {33      // If ith character is 8 to f then make it uppercase34      if (parseInt(addressHash[i], 16) > 7) {35        checksumAddress.push(address[i].toUpperCase());36      } else {37        checksumAddress.push(address[i]);38      }39    }40    return checksumAddress.join('');41  },42  tokenIdToAddress(collectionId: number, tokenId: number) {43    return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8, '0')}${tokenId.toString(16).padStart(8, '0')}`);44  },45};4647class UniqueUtil {48  static transactionStatus = {49    NOT_READY: 'NotReady',50    FAIL: 'Fail',51    SUCCESS: 'Success',52  };5354  static chainLogType = {55    EXTRINSIC: 'extrinsic',56    RPC: 'rpc',57  };5859  static getNestingTokenAddress(collectionId: number, tokenId: number) {60    return nesting.tokenIdToAddress(collectionId, tokenId);61  }6263  static getDefaultLogger(): ILogger {64    return {65      log(msg: any, level = 'INFO') {66        console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));67      },68      level: {69        ERROR: 'ERROR',70        WARNING: 'WARNING',71        INFO: 'INFO',72      },73    };74  }7576  static vec2str(arr: string[] | number[]) {77    return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');78  }7980  static str2vec(string: string) {81    if (typeof string !== 'string') return string;82    return Array.from(string).map(x => x.charCodeAt(0));83  }8485  static fromSeed(seed: string, ss58Format = 42) {86    const keyring = new Keyring({type: 'sr25519', ss58Format});87    return keyring.addFromUri(seed);88  }8990  static normalizeSubstrateAddress(address: string, ss58Format = 42) {91    return encodeAddress(decodeAddress(address), ss58Format);92  }9394  static extractCollectionIdFromCreationResult(creationResult: ITransactionResult, label = 'new collection') {95    if (creationResult.status !== this.transactionStatus.SUCCESS) {96      throw Error(`Unable to create collection for ${label}`);97    }9899    let collectionId = null;100    creationResult.result.events.forEach(({event: {data, method, section}}) => {101      if ((section === 'common') && (method === 'CollectionCreated')) {102        collectionId = parseInt(data[0].toString(), 10);103      }104    });105106    if (collectionId === null) {107      throw Error(`No CollectionCreated event for ${label}`);108    }109110    return collectionId;111  }112113  static extractTokensFromCreationResult(creationResult: ITransactionResult, label = 'new tokens') {114    if (creationResult.status !== this.transactionStatus.SUCCESS) {115      throw Error(`Unable to create tokens for ${label}`);116    }117    let success = false;118    const tokens = [] as any;119    creationResult.result.events.forEach(({event: {data, method, section}}) => {120      if (method === 'ExtrinsicSuccess') {121        success = true;122      } else if ((section === 'common') && (method === 'ItemCreated')) {123        tokens.push({124          collectionId: parseInt(data[0].toString(), 10),125          tokenId: parseInt(data[1].toString(), 10),126          owner: data[2].toJSON(),127        });128      }129    });130    return {success, tokens};131  }132133  static extractTokensFromBurnResult(burnResult: ITransactionResult, label = 'burned tokens') {134    if (burnResult.status !== this.transactionStatus.SUCCESS) {135      throw Error(`Unable to burn tokens for ${label}`);136    }137    let success = false;138    const tokens = [] as any;139    burnResult.result.events.forEach(({event: {data, method, section}}) => {140      if (method === 'ExtrinsicSuccess') {141        success = true;142      } else if ((section === 'common') && (method === 'ItemDestroyed')) {143        tokens.push({144          collectionId: parseInt(data[0].toString(), 10),145          tokenId: parseInt(data[1].toString(), 10),146          owner: data[2].toJSON(),147        });148      }149    });150    return {success, tokens};151  }152153  static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string, label?: string) {154    let eventId = null;155    events.forEach(({event: {data, method, section}}) => {156      if ((section === expectedSection) && (method === expectedMethod)) {157        eventId = parseInt(data[0].toString(), 10);158      }159    });160161    if (eventId === null) {162      throw Error(`No ${expectedMethod} event for ${label}`);163    }164    return eventId === collectionId;165  }166167  static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {168    const normalizeAddress = (address: string | ICrossAccountId) => {169      if(typeof address === 'string') return address;170      const obj = {} as any;171      Object.keys(address).forEach(k => {172        obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];173      });174      if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};175      if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};176      return address;177    };178    let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;179    events.forEach(({event: {data, method, section}}) => {180      if ((section === 'common') && (method === 'Transfer')) {181        const hData = (data as any).toJSON();182        transfer = {183          collectionId: hData[0],184          tokenId: hData[1],185          from: normalizeAddress(hData[2]),186          to: normalizeAddress(hData[3]),187          amount: BigInt(hData[4]),188        };189      }190    });191    let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;192    isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);193    isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);194    isSuccess = isSuccess && amount === transfer.amount;195    return isSuccess;196  }197}198199200class ChainHelperBase {201  transactionStatus = UniqueUtil.transactionStatus;202  chainLogType = UniqueUtil.chainLogType;203  util: typeof UniqueUtil;204  logger: ILogger;205  api: ApiPromise | null;206  forcedNetwork: TUniqueNetworks | null;207  network: TUniqueNetworks | null;208  chainLog: IUniqueHelperLog[];209210  constructor(logger?: ILogger) {211    this.util = UniqueUtil;212    if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();213    this.logger = logger;214    this.api = null;215    this.forcedNetwork = null;216    this.network = null;217    this.chainLog = [];218  }219220  clearChainLog(): void {221    this.chainLog = [];222  }223224  forceNetwork(value: TUniqueNetworks): void {225    this.forcedNetwork = value;226  }227228  async connect(wsEndpoint: string, listeners?: IApiListeners) {229    if (this.api !== null) throw Error('Already connected');230    const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);231    this.api = api;232    this.network = network;233  }234235  async disconnect() {236    if (this.api === null) return;237    await this.api.disconnect();238    this.api = null;239    this.network = null;240  }241242  static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {243    const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;244    if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;245    return 'opal';246  }247248  static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {249    const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});250    await api.isReady;251252    const network = await this.detectNetwork(api);253254    await api.disconnect();255256    return network;257  }258259  static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 260    api: ApiPromise; 261    network: TUniqueNetworks; 262  }> {263    if(typeof network === 'undefined' || network === null) network = 'opal';264    const supportedRPC = {265      opal: {266        unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,267      },268      quartz: {269        unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,270      },271      unique: {272        unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,273      },274    };275    if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);276    const rpc = supportedRPC[network];277278    // TODO: investigate how to replace rpc in runtime279    // api._rpcCore.addUserInterfaces(rpc);280281    const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});282283    await api.isReadyOrError;284285    if (typeof listeners === 'undefined') listeners = {};286    for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {287      if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;288      api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);289    }290291    return {api, network};292  }293294  getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {295    const {events, status} = data;296    if (status.isReady) {297      return this.transactionStatus.NOT_READY;298    }299    if (status.isBroadcast) {300      return this.transactionStatus.NOT_READY;301    }302    if (status.isInBlock || status.isFinalized) {303      const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');304      if (errors.length > 0) {305        return this.transactionStatus.FAIL;306      }307      if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {308        return this.transactionStatus.SUCCESS;309      }310    }311312    return this.transactionStatus.FAIL;313  }314315  signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {316    const sign = (callback: any) => {317      if(options !== null) return transaction.signAndSend(sender, options, callback);318      return transaction.signAndSend(sender, callback);319    };320    return new Promise(async (resolve, reject) => {321      try {322        const unsub = await sign((result: any) => {323          const status = this.getTransactionStatus(result);324325          if (status === this.transactionStatus.SUCCESS) {326            this.logger.log(`${label} successful`);327            unsub();328            resolve({result, status});329          } else if (status === this.transactionStatus.FAIL) {330            let moduleError = null;331332            if (result.hasOwnProperty('dispatchError')) {333              const dispatchError = result['dispatchError'];334335              if (dispatchError && dispatchError.isModule) {336                const modErr = dispatchError.asModule;337                const errorMeta = dispatchError.registry.findMetaError(modErr);338339                moduleError = `${errorMeta.section}.${errorMeta.name}`;340              }341              else {342                this.logger.log(result, this.logger.level.ERROR);343              }344            }345346            this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);347            unsub();348            reject({status, moduleError, result});349          }350        });351      } catch (e) {352        this.logger.log(e, this.logger.level.ERROR);353        reject(e);354      }355    });356  }357358  constructApiCall(apiCall: string, params: any[]) {359    if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);360    let call = this.api as any;361    for(const part of apiCall.slice(4).split('.')) {362      call = call[part];363    }364    return call(...params);365  }366367  async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false, failureMessage='expected success') {368    if(this.api === null) throw Error('API not initialized');369    if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);370371    const startTime = (new Date()).getTime();372    let result: ITransactionResult;373    let events = [];374    try {375      result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;376      events = result.result.events.map((x: any) => x.toHuman());377    }378    catch(e) {379      if(!(e as object).hasOwnProperty('status')) throw e;380      result = e as ITransactionResult;381    }382383    const endTime = (new Date()).getTime();384385    const log = {386      executedAt: endTime,387      executionTime: endTime - startTime,388      type: this.chainLogType.EXTRINSIC,389      status: result.status,390      call: extrinsic,391      params,392    } as IUniqueHelperLog;393394    if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;395    if(events.length > 0) log.events = events;396397    this.chainLog.push(log);398399    if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(failureMessage);400    return result;401  }402403  async callRpc(rpc: string, params?: any[]) {404    if(typeof params === 'undefined') params = [];405    if(this.api === null) throw Error('API not initialized');406    if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);407408    const startTime = (new Date()).getTime();409    let result;410    let error = null;411    const log = {412      type: this.chainLogType.RPC,413      call: rpc,414      params,415    } as IUniqueHelperLog;416417    try {418      result = await this.constructApiCall(rpc, params);419    }420    catch(e) {421      error = e;422    }423424    const endTime = (new Date()).getTime();425426    log.executedAt = endTime;427    log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';428    log.executionTime = endTime - startTime;429430    this.chainLog.push(log);431432    if(error !== null) throw error;433434    return result;435  }436437  getSignerAddress(signer: IKeyringPair | string): string {438    if(typeof signer === 'string') return signer;439    return signer.address;440  }441}442443444class HelperGroup {445  helper: UniqueHelper;446447  constructor(uniqueHelper: UniqueHelper) {448    this.helper = uniqueHelper;449  }450}451452453class CollectionGroup extends HelperGroup {454  /**455 * Get number of blocks when sponsored transaction is available.456 *457 * @param collectionId ID of collection458 * @param tokenId ID of token459 * @param addressObj address for which the sponsorship is checked460 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});461 * @returns number of blocks or null if sponsorship hasn't been set462 */463  async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {464    return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();465  }466467  /**468   * Get the number of created collections.469   * 470   * @returns number of created collections471   */472  async getTotalCount(): Promise<number> {473    return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();474  }475476  /**477   * Get information about the collection with additional data, including the number of tokens it contains, its administrators, the normalized address of the collection's owner, and decoded name and description.478   * 479   * @param collectionId ID of collection480   * @example await getData(2)481   * @returns collection information object482   */483  async getData(collectionId: number): Promise<{484    id: number;485    name: string;486    description: string;487    tokensCount: number;488    admins: ICrossAccountId[];489    normalizedOwner: TSubstrateAccount;490    raw: any491  } | null> {492    const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);493    const humanCollection = collection.toHuman(), collectionData = {494      id: collectionId, name: null, description: null, tokensCount: 0, admins: [],495      raw: humanCollection,496    } as any, jsonCollection = collection.toJSON();497    if (humanCollection === null) return null;498    collectionData.raw.limits = jsonCollection.limits;499    collectionData.raw.permissions = jsonCollection.permissions;500    collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);501    for (const key of ['name', 'description']) {502      collectionData[key] = this.helper.util.vec2str(humanCollection[key]);503    }504505    collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) : 0;506    collectionData.admins = await this.getAdmins(collectionId);507508    return collectionData;509  }510511  /**512   * Get the normalized addresses of the collection's administrators.513   * 514   * @param collectionId ID of collection515   * @example await getAdmins(1)516   * @returns array of administrators517   */518  async getAdmins(collectionId: number): Promise<ICrossAccountId[]> {519    const normalized = [];520    for(const admin of (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman()) {521      if(admin.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(admin.Substrate)});522      else normalized.push(admin);523    }524    return normalized;525  }526527  /**528   * Get the normalized addresses added to the collection allow-list.529   * @param collectionId ID of collection530   * @example await getAllowList(1)531   * @returns array of allow-listed addresses532   */533  async getAllowList(collectionId: number): Promise<ICrossAccountId[]> {534    const normalized = [];535    const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();536    for (const address of allowListed) {537      if (address.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(address.Substrate)});538      else normalized.push(address);539    }540    return normalized;541  }542543  /**544   * Get the effective limits of the collection instead of null for default values545   * 546   * @param collectionId ID of collection547   * @example await getEffectiveLimits(2)548   * @returns object of collection limits549   */550  async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {551    return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();552  }553554  /**555   * Burns the collection if the signer has sufficient permissions and collection is empty.556   * 557   * @param signer keyring of signer558   * @param collectionId ID of collection559   * @param label extra label for log560   * @example await helper.collection.burn(aliceKeyring, 3);561   * @returns ```true``` if extrinsic success, otherwise ```false```562   */563  async burn(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {564    if(typeof label === 'undefined') label = `collection #${collectionId}`;565    const result = await this.helper.executeExtrinsic(566      signer,567      'api.tx.unique.destroyCollection', [collectionId],568      true, `Unable to burn collection for ${label}`,569    );570571    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed', label);572  }573574  /**575   * Sets the sponsor for the collection (Requires the Substrate address).576   * 577   * @param signer keyring of signer578   * @param collectionId ID of collection579   * @param sponsorAddress Sponsor substrate address580   * @param label extra label for log581   * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")582   * @returns ```true``` if extrinsic success, otherwise ```false```583   */584  async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount, label?: string): Promise<boolean> {585    if(typeof label === 'undefined') label = `collection #${collectionId}`;586    const result = await this.helper.executeExtrinsic(587      signer,588      'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],589      true, `Unable to set collection sponsor for ${label}`,590    );591592    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet', label);593  }594595  /**596   * Confirms consent to sponsor the collection on behalf of the signer.597   * 598   * @param signer keyring of signer599   * @param collectionId ID of collection600   * @param label extra label for log601   * @example confirmSponsorship(aliceKeyring, 10)602   * @returns ```true``` if extrinsic success, otherwise ```false```603   */604  async confirmSponsorship(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {605    if(typeof label === 'undefined') label = `collection #${collectionId}`;606    const result = await this.helper.executeExtrinsic(607      signer,608      'api.tx.unique.confirmSponsorship', [collectionId],609      true, `Unable to confirm collection sponsorship for ${label}`,610    );611612    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed', label);613  }614615  /**616   * Sets the limits of the collection. At least one limit must be specified for a correct call.617   * 618   * @param signer keyring of signer619   * @param collectionId ID of collection620   * @param limits collection limits object621   * @param label extra label for log622   * @example623   * await setLimits(624   *   aliceKeyring,625   *   10,626   *   {627   *     sponsorTransferTimeout: 0,628   *     ownerCanDestroy: false629   *   }630   * )631   * @returns ```true``` if extrinsic success, otherwise ```false```632   */633  async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits, label?: string): Promise<boolean> {634    if(typeof label === 'undefined') label = `collection #${collectionId}`;635    const result = await this.helper.executeExtrinsic(636      signer,637      'api.tx.unique.setCollectionLimits', [collectionId, limits],638      true, `Unable to set collection limits for ${label}`,639    );640641    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet', label);642  }643644  /**645   * Changes the owner of the collection to the new Substrate address.646   * 647   * @param signer keyring of signer648   * @param collectionId ID of collection649   * @param ownerAddress substrate address of new owner650   * @param label extra label for log651   * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")652   * @returns ```true``` if extrinsic success, otherwise ```false```653   */654  async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount, label?: string): Promise<boolean> {655    if(typeof label === 'undefined') label = `collection #${collectionId}`;656    const result = await this.helper.executeExtrinsic(657      signer,658      'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],659      true, `Unable to change collection owner for ${label}`,660    );661662    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged', label);663  }664665  /**666   * Adds a collection administrator. 667   * 668   * @param signer keyring of signer669   * @param collectionId ID of collection670   * @param adminAddressObj Administrator address (substrate or ethereum)671   * @param label extra label for log672   * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})673   * @returns ```true``` if extrinsic success, otherwise ```false```674   */675  async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {676    if(typeof label === 'undefined') label = `collection #${collectionId}`;677    const result = await this.helper.executeExtrinsic(678      signer,679      'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],680      true, `Unable to add collection admin for ${label}`,681    );682683    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded', label);684  }685686  /**687   * Adds an address to allow list 688   * @param signer keyring of signer689   * @param collectionId ID of collection690   * @param addressObj address to add to the allow list691   * @param label extra label for log692   * @returns ```true``` if extrinsic success, otherwise ```false```693   */694  async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId, label?: string): Promise<boolean> {695    if(typeof label === 'undefined') label = `collection #${collectionId}`;696    const result = await this.helper.executeExtrinsic(697      signer,698      'api.tx.unique.addToAllowList', [collectionId, addressObj],699      true, `Unable to add address to allow list for ${label}`,700    );701702    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');703  }704705  /**706   * Removes a collection administrator.707   * 708   * @param signer keyring of signer709   * @param collectionId ID of collection710   * @param adminAddressObj Administrator address (substrate or ethereum)711   * @param label extra label for log712   * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})713   * @returns ```true``` if extrinsic success, otherwise ```false```714   */715  async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {716    if(typeof label === 'undefined') label = `collection #${collectionId}`;717    const result = await this.helper.executeExtrinsic(718      signer,719      'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],720      true, `Unable to remove collection admin for ${label}`,721    );722723    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved', label);724  }725726  /**727   * Sets onchain permissions for selected collection.728   * 729   * @param signer keyring of signer730   * @param collectionId ID of collection731   * @param permissions collection permissions object732   * @param label extra label for log733   * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});734   * @returns ```true``` if extrinsic success, otherwise ```false```735   */736  async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions, label?: string): Promise<boolean> {737    if(typeof label === 'undefined') label = `collection #${collectionId}`;738    const result = await this.helper.executeExtrinsic(739      signer,740      'api.tx.unique.setCollectionPermissions', [collectionId, permissions],741      true, `Unable to set collection permissions for ${label}`,742    );743744    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet', label);745  }746747  /**748   * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.749   * 750   * @param signer keyring of signer751   * @param collectionId ID of collection752   * @param permissions nesting permissions object753   * @param label extra label for log754   * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});755   * @returns ```true``` if extrinsic success, otherwise ```false```756   */757  async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions, label?: string): Promise<boolean> {758    return await this.setPermissions(signer, collectionId, {nesting: permissions}, label);759  }760761  /**762   * Disables nesting for selected collection.763   * 764   * @param signer keyring of signer765   * @param collectionId ID of collection766   * @param label extra label for log767   * @example disableNesting(aliceKeyring, 10);768   * @returns ```true``` if extrinsic success, otherwise ```false```769   */770  async disableNesting(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {771    return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}}, label);772  }773774  /**775   * Sets onchain properties to the collection.776   * 777   * @param signer keyring of signer778   * @param collectionId ID of collection779   * @param properties array of property objects780   * @param label extra label for log781   * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);782   * @returns ```true``` if extrinsic success, otherwise ```false```783   */784  async setProperties(signer: TSigner, collectionId: number, properties: IProperty[], label?: string): Promise<boolean> {785    if(typeof label === 'undefined') label = `collection #${collectionId}`;786    const result = await this.helper.executeExtrinsic(787      signer,788      'api.tx.unique.setCollectionProperties', [collectionId, properties],789      true, `Unable to set collection properties for ${label}`,790    );791792    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet', label);793  }794795  /**796   * Deletes onchain properties from the collection.797   * 798   * @param signer keyring of signer799   * @param collectionId ID of collection800   * @param propertyKeys array of property keys to delete801   * @param label802   * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);803   * @returns ```true``` if extrinsic success, otherwise ```false```804   */805  async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[], label?: string): Promise<boolean> {806    if(typeof label === 'undefined') label = `collection #${collectionId}`;807    const result = await this.helper.executeExtrinsic(808      signer,809      'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],810      true, `Unable to delete collection properties for ${label}`,811    );812813    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted', label);814  }815816  /**817   * Changes the owner of the token.818   * 819   * @param signer keyring of signer820   * @param collectionId ID of collection821   * @param tokenId ID of token822   * @param addressObj address of a new owner823   * @param amount amount of tokens to be transfered. For NFT must be set to 1n824   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})825   * @returns true if the token success, otherwise false826   */827  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {828    const result = await this.helper.executeExtrinsic(829      signer,830      'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],831      true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,832    );833834    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);835  }836837  /**838   * 839   * Change ownership of a token(s) on behalf of the owner. 840   * 841   * @param signer keyring of signer842   * @param collectionId ID of collection843   * @param tokenId ID of token844   * @param fromAddressObj address on behalf of which the token will be sent845   * @param toAddressObj new token owner846   * @param amount amount of tokens to be transfered. For NFT must be set to 1n847   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})848   * @returns true if the token success, otherwise false849   */850  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {851    const result = await this.helper.executeExtrinsic(852      signer,853      'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],854      true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,855    );856    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);857  }858859  /**860   * 861   * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.862   * 863   * @param signer keyring of signer864   * @param collectionId ID of collection865   * @param tokenId ID of token866   * @param label 867   * @param amount amount of tokens to be burned. For NFT must be set to 1n868   * @example burnToken(aliceKeyring, 10, 5);869   * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```870   */871  async burnToken(signer: TSigner, collectionId: number, tokenId: number, label?: string, amount=1n): Promise<{872    success: boolean,873    token: number | null874  }> {875    if(typeof label === 'undefined') label = `collection #${collectionId}`;876    const burnResult = await this.helper.executeExtrinsic(877      signer,878      'api.tx.unique.burnItem', [collectionId, tokenId, amount],879      true, `Unable to burn token for ${label}`,880    );881    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);882    if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');883    return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};884  }885886  /**887   * Destroys a concrete instance of NFT on behalf of the owner888   * 889   * @param signer keyring of signer890   * @param collectionId ID of collection891   * @param fromAddressObj address on behalf of which the token will be burnt892   * @param tokenId ID of token893   * @param label 894   * @param amount amount of tokens to be burned. For NFT must be set to 1n895   * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})896   * @returns ```true``` if extrinsic success, otherwise ```false```897   */898  async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, label?: string, amount=1n): Promise<boolean> {899    if(typeof label === 'undefined') label = `collection #${collectionId}`;900    const burnResult = await this.helper.executeExtrinsic(901      signer,902      'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],903      true, `Unable to burn token from for ${label}`,904    );905    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);906    return burnedTokens.success && burnedTokens.tokens.length > 0;907  }908909  /**910   * Set, change, or remove approved address to transfer the ownership of the NFT.911   * 912   * @param signer keyring of signer913   * @param collectionId ID of collection914   * @param tokenId ID of token915   * @param toAddressObj 916   * @param label 917   * @param amount amount of token to be approved. For NFT must be set to 1n918   * @returns ```true``` if extrinsic success, otherwise ```false```919   */920  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=1n) {921    if(typeof label === 'undefined') label = `collection #${collectionId}`;922    const approveResult = await this.helper.executeExtrinsic(923      signer, 924      'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],925      true, `Unable to approve token for ${label}`,926    );927928    return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved', label);929  }930931  /**932   * Get the amount of token pieces approved to transfer933   * @param collectionId ID of collection934   * @param tokenId ID of token935   * @param toAccountObj 936   * @param fromAccountObj937   * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})938   * @returns number of approved to transfer pieces939   */940  async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {941    return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();942  }943944  /**945   * Get the last created token id946   * @param collectionId ID of collection947   * @example getLastTokenId(10);948   * @returns id of the last created token949   */950  async getLastTokenId(collectionId: number): Promise<number> {951    return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();952  }953954  /**955   * Check if token exists956   * @param collectionId ID of collection957   * @param tokenId ID of token958   * @example isTokenExists(10, 20);959   * @returns true if the token exists, otherwise false960   */961  async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {962    return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();963  }964}965966class NFTnRFT extends CollectionGroup {967  /**968   * Get tokens owned by account969   * 970   * @param collectionId ID of collection971   * @param addressObj tokens owner972   * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})973   * @returns array of token ids owned by account974   */975  async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {976    return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();977  }978979  /**980   * Get token data981   * @param collectionId ID of collection982   * @param tokenId ID of token983   * @param blockHashAt 984   * @param propertyKeys985   * @example getToken(10, 5);986   * @returns human readable token data 987   */988  async getToken(collectionId: number, tokenId: number, blockHashAt?: string, propertyKeys?: string[]): Promise<{989    properties: IProperty[];990    owner: ICrossAccountId;991    normalizedOwner: ICrossAccountId;992  }| null> {993    let tokenData;994    if(typeof blockHashAt === 'undefined') {995      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);996    }997    else {998      if(typeof propertyKeys === 'undefined') {999        const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1000        if(!collection) return null;1001        propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1002      }1003      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1004    }1005    tokenData = tokenData.toHuman();1006    if (tokenData === null || tokenData.owner === null) return null;1007    const owner = {} as any;1008    for (const key of Object.keys(tokenData.owner)) {1009      owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1010    }1011    tokenData.normalizedOwner = crossAccountIdFromLower(owner);1012    return tokenData;1013  }10141015  /**1016   * Set permissions to change token properties1017   * @param signer keyring of signer1018   * @param collectionId ID of collection1019   * @param permissions permissions to change a property by the collection owner or admin1020   * @param label 1021   * @example setTokenPropertyPermissions(1022   *   aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1023   * )1024   * @returns true if extrinsic success otherwise false1025   */1026  async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[], label?: string): Promise<boolean> {1027    if(typeof label === 'undefined') label = `collection #${collectionId}`;1028    const result = await this.helper.executeExtrinsic(1029      signer,1030      'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1031      true, `Unable to set token property permissions for ${label}`,1032    );10331034    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet', label);1035  }10361037  /**1038   * Set token properties1039   * @param signer keyring of signer1040   * @param collectionId ID of collection1041   * @param tokenId ID of token1042   * @param properties 1043   * @param label 1044   * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1045   * @returns ```true``` if extrinsic success, otherwise ```false```1046   */1047  async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[], label?: string): Promise<boolean> {1048    if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1049    const result = await this.helper.executeExtrinsic(1050      signer,1051      'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1052      true, `Unable to set token properties for ${label}`,1053    );10541055    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet', label);1056  }10571058  /**1059   * Delete the provided properties of a token1060   * @param signer keyring of signer1061   * @param collectionId ID of collection1062   * @param tokenId ID of token1063   * @param propertyKeys property keys to be deleted 1064   * @param label 1065   * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1066   * @returns ```true``` if extrinsic success, otherwise ```false```1067   */1068  async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[], label?: string): Promise<boolean> {1069    if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1070    const result = await this.helper.executeExtrinsic(1071      signer,1072      'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1073      true, `Unable to delete token properties for ${label}`,1074    );10751076    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted', label);1077  }10781079  /**1080   * Mint new collection1081   * @param signer keyring of signer1082   * @param collectionOptions basic collection options and properties 1083   * @param mode NFT or RFT type of a collection1084   * @param errorLabel 1085   * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1086   * @returns object of the created collection1087   */1088  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT', errorLabel = 'Unable to mint collection'): Promise<UniqueCollectionBase> {1089    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1090    collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1091    for (const key of ['name', 'description', 'tokenPrefix']) {1092      if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1093    }1094    const creationResult = await this.helper.executeExtrinsic(1095      signer,1096      'api.tx.unique.createCollectionEx', [collectionOptions],1097      true, errorLabel,1098    );1099    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1100  }11011102  getCollectionObject(collectionId: number): any {1103    return null;1104  }11051106  getTokenObject(collectionId: number, tokenId: number): any {1107    return null;1108  }1109}111011111112class NFTGroup extends NFTnRFT {1113  /**1114   * Get collection object1115   * @param collectionId ID of collection1116   * @example getCollectionObject(2);1117   * @returns instance of UniqueNFTCollection1118   */1119  getCollectionObject(collectionId: number): UniqueNFTCollection {1120    return new UniqueNFTCollection(collectionId, this.helper);1121  }11221123  /**1124   * Get token object1125   * @param collectionId ID of collection1126   * @param tokenId ID of token1127   * @example getTokenObject(10, 5);1128   * @returns instance of UniqueNFTToken1129   */1130  getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1131    return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1132  }11331134  /**1135   * Get token's owner1136   * @param collectionId ID of collection1137   * @param tokenId ID of token1138   * @param blockHashAt 1139   * @example getTokenOwner(10, 5);1140   * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1141   */1142  async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1143    let owner;1144    if (typeof blockHashAt === 'undefined') {1145      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1146    } else {1147      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1148    }1149    return crossAccountIdFromLower(owner.toJSON());1150  }11511152  /**1153   * Is token approved to transfer1154   * @param collectionId ID of collection1155   * @param tokenId ID of token1156   * @param toAccountObj address to be approved1157   * @returns ```true``` if extrinsic success, otherwise ```false```1158   */1159  async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1160    return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1161  }11621163  /**1164   * Changes the owner of the token.1165   * 1166   * @param signer keyring of signer1167   * @param collectionId ID of collection1168   * @param tokenId ID of token1169   * @param addressObj address of a new owner1170   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1171   * @returns ```true``` if extrinsic success, otherwise ```false```1172   */1173  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1174    return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1175  }11761177  /**1178   * 1179   * Change ownership of a NFT on behalf of the owner. 1180   * 1181   * @param signer keyring of signer1182   * @param collectionId ID of collection1183   * @param tokenId ID of token1184   * @param fromAddressObj address on behalf of which the token will be sent1185   * @param toAddressObj new token owner1186   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1187   * @returns ```true``` if extrinsic success, otherwise ```false```1188   */1189  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1190    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1191  }11921193  /**1194   * Recursively find the address that owns the token1195   * @param collectionId ID of collection1196   * @param tokenId ID of token1197   * @param blockHashAt 1198   * @example getTokenTopmostOwner(10, 5);1199   * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1200   */1201  async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1202    let owner;1203    if (typeof blockHashAt === 'undefined') {1204      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1205    } else {1206      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1207    }12081209    if (owner === null) return null;12101211    owner = owner.toHuman();12121213    return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1214  }12151216  /**1217   * Get tokens nested in the provided token1218   * @param collectionId ID of collection1219   * @param tokenId ID of token1220   * @param blockHashAt 1221   * @example getTokenChildren(10, 5);1222   * @returns tokens whose depth of nesting is <= 5 1223   */1224  async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1225    let children;1226    if(typeof blockHashAt === 'undefined') {1227      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1228    } else {1229      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1230    }12311232    return children.toJSON().map((x: any) => {1233      return {collectionId: x.collection, tokenId: x.token};1234    });1235  }12361237  /**1238   * Nest one token into another1239   * @param signer keyring of signer1240   * @param tokenObj token to be nested1241   * @param rootTokenObj token to be parent1242   * @param label 1243   * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1244   * @returns ```true``` if extrinsic success, otherwise ```false```1245   */1246  async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, label='nest token'): Promise<boolean> {1247    const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1248    const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1249    if(!result) {1250      throw Error(`Unable to nest token for ${label}`);1251    }1252    return result;1253  }12541255  /**1256   * Remove token from nested state1257   * @param signer keyring of signer1258   * @param tokenObj token to unnest1259   * @param rootTokenObj parent of a token1260   * @param toAddressObj address of a new token owner 1261   * @param label 1262   * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1263   * @returns ```true``` if extrinsic success, otherwise ```false```1264   */1265  async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId, label='unnest token'): Promise<boolean> {1266    const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1267    const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1268    if(!result) {1269      throw Error(`Unable to unnest token for ${label}`);1270    }1271    return result;1272  }12731274  /**1275   * Mint new collection1276   * @param signer keyring of signer1277   * @param collectionOptions Collection options1278   * @param label 1279   * @example 1280   * mintCollection(aliceKeyring, {1281   *   name: 'New',1282   *   description: 'New collection',1283   *   tokenPrefix: 'NEW',1284   * })1285   * @returns object of the created collection1286   */1287  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueNFTCollection> {1288    return await super.mintCollection(signer, collectionOptions, 'NFT', `Unable to mint NFT collection for ${label}`) as UniqueNFTCollection;1289  }12901291  /**1292   * Mint new token1293   * @param signer keyring of signer1294   * @param data token data1295   * @param label 1296   * @returns created token object1297   */1298  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }, label?: string): Promise<UniqueNFTToken> {1299    if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1300    const creationResult = await this.helper.executeExtrinsic(1301      signer,1302      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1303        nft: {1304          properties: data.properties,1305        },1306      }],1307      true, `Unable to mint NFT token for ${label}`,1308    );1309    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1310    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1311    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1312    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1313  }13141315  /**1316   * Mint multiple NFT tokens1317   * @param signer keyring of signer1318   * @param collectionId ID of collection1319   * @param tokens array of tokens with owner and properties1320   * @param label 1321   * @example 1322   * mintMultipleTokens(aliceKeyring, 10, [{1323   *     owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1324   *     properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1325   *   },{1326   *     owner: {Ethereum: "0x9F0583DbB855d..."},1327   *     properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1328   * }]);1329   * @returns ```true``` if extrinsic success, otherwise ```false```1330   */1331  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1332    if(typeof label === 'undefined') label = `collection #${collectionId}`;1333    const creationResult = await this.helper.executeExtrinsic(1334      signer,1335      'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1336      true, `Unable to mint NFT tokens for ${label}`,1337    );1338    const collection = this.getCollectionObject(collectionId);1339    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1340  }13411342  /**1343   * Mint multiple NFT tokens with one owner1344   * @param signer keyring of signer1345   * @param collectionId ID of collection1346   * @param owner tokens owner1347   * @param tokens array of tokens with owner and properties1348   * @param label 1349   * @example1350   * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1351   *   properties: [{1352   *   key: "gender",1353   *   value: "female",1354   *  },{1355   *   key: "age",1356   *   value: "33",1357   *  }],1358   * }]);1359   * @returns array of newly created tokens1360   */1361  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1362    if(typeof label === 'undefined') label = `collection #${collectionId}`;1363    const rawTokens = [];1364    for (const token of tokens) {1365      const raw = {NFT: {properties: token.properties}};1366      rawTokens.push(raw);1367    }1368    const creationResult = await this.helper.executeExtrinsic(1369      signer,1370      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1371      true, `Unable to mint NFT tokens for ${label}`,1372    );1373    const collection = this.getCollectionObject(collectionId);1374    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1375  }13761377  /**1378   * Destroys a concrete instance of NFT.1379   * @param signer keyring of signer1380   * @param collectionId ID of collection1381   * @param tokenId ID of token1382   * @param label 1383   * @example burnToken(aliceKeyring, 10, 5);1384   * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1385   */1386  async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string): Promise<{ success: boolean; token: number | null; }> {1387    return await super.burnToken(signer, collectionId, tokenId, label, 1n);1388  }13891390  /**1391   * Set, change, or remove approved address to transfer the ownership of the NFT.1392   * 1393   * @param signer keyring of signer1394   * @param collectionId ID of collection1395   * @param tokenId ID of token1396   * @param toAddressObj address to approve1397   * @param label 1398   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1399   * @returns ```true``` if extrinsic success, otherwise ```false```1400   */1401  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {1402    return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, 1n);1403  }1404}140514061407class RFTGroup extends NFTnRFT {1408  /**1409   * Get collection object1410   * @param collectionId ID of collection1411   * @example getCollectionObject(2);1412   * @returns instance of UniqueRFTCollection1413   */1414  getCollectionObject(collectionId: number): UniqueRFTCollection {1415    return new UniqueRFTCollection(collectionId, this.helper);1416  }14171418  /**1419   * Get token object1420   * @param collectionId ID of collection1421   * @param tokenId ID of token1422   * @example getTokenObject(10, 5);1423   * @returns instance of UniqueNFTToken1424   */1425  getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1426    return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1427  }14281429  /**1430   * Get top 10 token owners with the largest number of pieces 1431   * @param collectionId ID of collection1432   * @param tokenId ID of token1433   * @example getTokenTop10Owners(10, 5);1434   * @returns array of top 10 owners1435   */1436  async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1437    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1438  }14391440  /**1441   * Get number of pieces owned by address1442   * @param collectionId ID of collection1443   * @param tokenId ID of token1444   * @param addressObj address token owner1445   * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1446   * @returns number of pieces ownerd by address1447   */1448  async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1449    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1450  }14511452  /**1453   * Transfer pieces of token to another address1454   * @param signer keyring of signer1455   * @param collectionId ID of collection1456   * @param tokenId ID of token1457   * @param addressObj address of a new owner1458   * @param amount number of pieces to be transfered1459   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1460   * @returns ```true``` if extrinsic success, otherwise ```false```1461   */1462  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=100n): Promise<boolean> {1463    return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1464  }14651466  /**1467   * Change ownership of some pieces of RFT on behalf of the owner. 1468   * @param signer keyring of signer1469   * @param collectionId ID of collection1470   * @param tokenId ID of token1471   * @param fromAddressObj address on behalf of which the token will be sent1472   * @param toAddressObj new token owner1473   * @param amount number of pieces to be transfered1474   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1475   * @returns ```true``` if extrinsic success, otherwise ```false```1476   */1477  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n): Promise<boolean> {1478    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1479  }14801481  /**1482   * Mint new collection1483   * @param signer keyring of signer1484   * @param collectionOptions Collection options1485   * @param label 1486   * @example1487   * mintCollection(aliceKeyring, {1488   *   name: 'New',1489   *   description: 'New collection',1490   *   tokenPrefix: 'NEW',1491   * })1492   * @returns object of the created collection1493   */1494  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueRFTCollection> {1495    return await super.mintCollection(signer, collectionOptions, 'RFT', `Unable to mint RFT collection for ${label}`) as UniqueRFTCollection;1496  }14971498  /**1499   * Mint new token1500   * @param signer keyring of signer1501   * @param data token data1502   * @param label 1503   * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1504   * @returns created token object1505   */1506  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }, label?: string): Promise<UniqueRFTToken> {1507    if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1508    const creationResult = await this.helper.executeExtrinsic(1509      signer,1510      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1511        refungible: {1512          pieces: data.pieces,1513          properties: data.properties,1514        },1515      }],1516      true, `Unable to mint RFT token for ${label}`,1517    );1518    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1519    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1520    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1521    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1522  }15231524  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1525    throw Error('Not implemented');1526    if(typeof label === 'undefined') label = `collection #${collectionId}`;1527    const creationResult = await this.helper.executeExtrinsic(1528      signer,1529      'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1530      true, `Unable to mint RFT tokens for ${label}`,1531    );1532    const collection = this.getCollectionObject(collectionId);1533    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1534  }15351536  /**1537   * Mint multiple RFT tokens with one owner1538   * @param signer keyring of signer1539   * @param collectionId ID of collection1540   * @param owner tokens owner1541   * @param tokens array of tokens with properties and pieces1542   * @param label 1543   * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1544   * @returns array of newly created RFT tokens1545   */1546  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1547    if(typeof label === 'undefined') label = `collection #${collectionId}`;1548    const rawTokens = [];1549    for (const token of tokens) {1550      const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1551      rawTokens.push(raw);1552    }1553    const creationResult = await this.helper.executeExtrinsic(1554      signer,1555      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1556      true, `Unable to mint RFT tokens for ${label}`,1557    );1558    const collection = this.getCollectionObject(collectionId);1559    return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1560  }15611562  /**1563   * Destroys a concrete instance of RFT.1564   * @param signer keyring of signer1565   * @param collectionId ID of collection1566   * @param tokenId ID of token1567   * @param label 1568   * @param amount number of pieces to be burnt1569   * @example burnToken(aliceKeyring, 10, 5);1570   * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1571   */1572  async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string, amount=100n): Promise<{ success: boolean; token: number | null; }> {1573    return await super.burnToken(signer, collectionId, tokenId, label, amount);1574  }15751576  /**1577   * Set, change, or remove approved address to transfer the ownership of the RFT.1578   * 1579   * @param signer keyring of signer1580   * @param collectionId ID of collection1581   * @param tokenId ID of token1582   * @param toAddressObj address to approve1583   * @param label 1584   * @param amount number of pieces to be approved1585   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1586   * @returns true if the token success, otherwise false1587   */1588  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=100n) {1589    return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, amount);1590  }15911592  /**1593   * Get total number of pieces1594   * @param collectionId ID of collection1595   * @param tokenId ID of token1596   * @example getTokenTotalPieces(10, 5);1597   * @returns number of pieces1598   */1599  async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1600    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1601  }16021603  /**1604   * Change number of token pieces. Signer must be the owner of all token pieces.1605   * @param signer keyring of signer1606   * @param collectionId ID of collection1607   * @param tokenId ID of token1608   * @param amount new number of pieces1609   * @param label 1610   * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1611   * @returns true if the repartion was success, otherwise false1612   */1613  async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint, label?: string): Promise<boolean> {1614    if(typeof label === 'undefined') label = `collection #${collectionId}`;1615    const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1616    const repartitionResult = await this.helper.executeExtrinsic(1617      signer,1618      'api.tx.unique.repartition', [collectionId, tokenId, amount],1619      true, `Unable to repartition RFT token for ${label}`,1620    );1621    if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated', label);1622    return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed', label);1623  }1624}162516261627class FTGroup extends CollectionGroup {1628  /**1629   * Get collection object1630   * @param collectionId ID of collection1631   * @example getCollectionObject(2);1632   * @returns instance of UniqueFTCollection1633   */1634  getCollectionObject(collectionId: number): UniqueFTCollection {1635    return new UniqueFTCollection(collectionId, this.helper);1636  }16371638  /**1639   * Mint new fungible collection1640   * @param signer keyring of signer1641   * @param collectionOptions Collection options1642   * @param decimalPoints number of token decimals 1643   * @param errorLabel 1644   * @example1645   * mintCollection(aliceKeyring, {1646   *   name: 'New',1647   *   description: 'New collection',1648   *   tokenPrefix: 'NEW',1649   * }, 18)1650   * @returns newly created fungible collection1651   */1652  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0, errorLabel = 'Unable to mint collection'): Promise<UniqueFTCollection> {1653    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1654    if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1655    collectionOptions.mode = {fungible: decimalPoints};1656    for (const key of ['name', 'description', 'tokenPrefix']) {1657      if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1658    }1659    const creationResult = await this.helper.executeExtrinsic(1660      signer,1661      'api.tx.unique.createCollectionEx', [collectionOptions],1662      true, errorLabel,1663    );1664    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1665  }16661667  /**1668   * Mint tokens1669   * @param signer keyring of signer1670   * @param collectionId ID of collection1671   * @param owner address owner of new tokens1672   * @param amount amount of tokens to be meanted1673   * @param label 1674   * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1675   * @returns ```true``` if extrinsic success, otherwise ```false``` 1676   */1677  async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint, label?: string): Promise<boolean> {1678    if(typeof label === 'undefined') label = `collection #${collectionId}`;1679    const creationResult = await this.helper.executeExtrinsic(1680      signer,1681      'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1682        fungible: {1683          value: amount,1684        },1685      }],1686      true, `Unable to mint fungible tokens for ${label}`,1687    );1688    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1689  }16901691  /**1692   * Mint multiple Fungible tokens with one owner1693   * @param signer keyring of signer1694   * @param collectionId ID of collection1695   * @param owner tokens owner1696   * @param tokens array of tokens with properties and pieces1697   * @param label 1698   * @returns ```true``` if extrinsic success, otherwise ```false``` 1699   */1700  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string): Promise<boolean> {1701    if(typeof label === 'undefined') label = `collection #${collectionId}`;1702    const rawTokens = [];1703    for (const token of tokens) {1704      const raw = {Fungible: {Value: token.value}};1705      rawTokens.push(raw);1706    }1707    const creationResult = await this.helper.executeExtrinsic(1708      signer,1709      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1710      true, `Unable to mint RFT tokens for ${label}`,1711    );1712    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1713  }17141715  /**1716   * Get the top 10 owners with the largest balance for the Fungible collection 1717   * @param collectionId ID of collection1718   * @example getTop10Owners(10);1719   * @returns array of ```ICrossAccountId```1720   */1721  async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1722    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1723  }17241725  /**1726   * Get account balance1727   * @param collectionId ID of collection1728   * @param addressObj address of owner1729   * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1730   * @returns amount of fungible tokens owned by address1731   */1732  async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1733    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1734  }17351736  /**1737   * Transfer tokens to address1738   * @param signer keyring of signer1739   * @param collectionId ID of collection1740   * @param toAddressObj address recepient1741   * @param amount amount of tokens to be sent1742   * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1743   * @returns ```true``` if extrinsic success, otherwise ```false``` 1744   */1745  async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount: bigint) {1746    return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1747  }17481749  /**1750   * Transfer some tokens on behalf of the owner.1751   * @param signer keyring of signer1752   * @param collectionId ID of collection1753   * @param fromAddressObj address on behalf of which tokens will be sent1754   * @param toAddressObj address where token to be sent1755   * @param amount number of tokens to be sent1756   * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1757   * @returns ```true``` if extrinsic success, otherwise ```false``` 1758   */1759  async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {1760    return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1761  }17621763  /**1764   * Destroy some amount of tokens1765   * @param signer keyring of signer1766   * @param collectionId ID of collection1767   * @param amount amount of tokens to be destroyed1768   * @param label 1769   * @example burnTokens(aliceKeyring, 10, 1000n);1770   * @returns ```true``` if extrinsic success, otherwise ```false``` 1771   */1772  async burnTokens(signer: IKeyringPair, collectionId: number, amount=100n, label?: string): Promise<boolean> {1773    return (await super.burnToken(signer, collectionId, 0, label, amount)).success;1774  }17751776  /**1777   * Burn some tokens on behalf of the owner.1778   * @param signer keyring of signer1779   * @param collectionId ID of collection1780   * @param fromAddressObj address on behalf of which tokens will be burnt1781   * @param amount amount of tokens to be burnt1782   * @param label 1783   * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1784   * @returns ```true``` if extrinsic success, otherwise ```false``` 1785   */1786  async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=100n, label?: string): Promise<boolean> {1787    return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, label, amount);1788  }17891790  /**1791   * Get total collection supply1792   * @param collectionId 1793   * @returns 1794   */1795  async getTotalPieces(collectionId: number): Promise<bigint> {1796    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1797  }17981799  /**1800   * Set, change, or remove approved address to transfer tokens.1801   * 1802   * @param signer keyring of signer1803   * @param collectionId ID of collection1804   * @param toAddressObj address to be approved1805   * @param amount amount of tokens to be approved1806   * @param label 1807   * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1808   * @returns ```true``` if extrinsic success, otherwise ```false``` 1809   */1810  async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {1811    return super.approveToken(signer, collectionId, 0, toAddressObj, label, amount);1812  }18131814  /**1815   * Get amount of fungible tokens approved to transfer1816   * @param collectionId ID of collection1817   * @param fromAddressObj owner of tokens1818   * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1819   * @returns number of tokens approved for the transfer1820   */1821  async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1822    return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1823  }1824}182518261827class ChainGroup extends HelperGroup {1828  /**1829   * Get system properties of a chain1830   * @example getChainProperties();1831   * @returns ss58Format, token decimals, and token symbol1832   */1833  getChainProperties(): IChainProperties {1834    const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1835    return {1836      ss58Format: properties.ss58Format.toJSON(),1837      tokenDecimals: properties.tokenDecimals.toJSON(),1838      tokenSymbol: properties.tokenSymbol.toJSON(),1839    };1840  }18411842  /**1843   * Get chain header1844   * @example getLatestBlockNumber();1845   * @returns the number of the last block1846   */1847  async getLatestBlockNumber(): Promise<number> {1848    return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1849  }18501851  /**1852   * Get block hash by block number1853   * @param blockNumber number of block1854   * @example getBlockHashByNumber(12345);1855   * @returns hash of a block1856   */1857  async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1858    const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1859    if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1860    return blockHash;1861  }18621863  /**1864   * Get account nonce1865   * @param address substrate address1866   * @example getNonce("5GrwvaEF5zXb26Fz...");1867   * @returns number, account's nonce1868   */1869  async getNonce(address: TSubstrateAccount): Promise<number> {1870    return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1871  }1872}187318741875class BalanceGroup extends HelperGroup {1876  /**1877   * Representation of the native token in the smallest unit1878   * @example getOneTokenNominal()1879   * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1880   */1881  getOneTokenNominal(): bigint {1882    const chainProperties = this.helper.chain.getChainProperties();1883    return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1884  }18851886  /**1887   * Get substrate address balance1888   * @param address substrate address1889   * @example getSubstrate("5GrwvaEF5zXb26Fz...")1890   * @returns amount of tokens on address1891   */1892  async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1893    return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1894  }18951896  /**1897   * Get ethereum address balance1898   * @param address ethereum address1899   * @example getEthereum("0x9F0583DbB855d...")1900   * @returns amount of tokens on address1901   */1902  async getEthereum(address: TEthereumAccount): Promise<bigint> {1903    return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1904  }19051906  /**1907   * Transfer tokens to substrate address1908   * @param signer keyring of signer1909   * @param address substrate address of a recepient1910   * @param amount amount of tokens to be transfered1911   * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1912   * @returns ```true``` if extrinsic success, otherwise ```false```1913   */1914  async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1915    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}`);19161917    let transfer = {from: null, to: null, amount: 0n} as any;1918    result.result.events.forEach(({event: {data, method, section}}) => {1919      if ((section === 'balances') && (method === 'Transfer')) {1920        transfer = {1921          from: this.helper.address.normalizeSubstrate(data[0]),1922          to: this.helper.address.normalizeSubstrate(data[1]),1923          amount: BigInt(data[2]),1924        };1925      }1926    });1927    let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1928    isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1929    isSuccess = isSuccess && BigInt(amount) === transfer.amount;1930    return isSuccess;1931  }1932}193319341935class AddressGroup extends HelperGroup {1936  /**1937   * Normalizes the address to the specified ss58 format, by default ```42```.1938   * @param address substrate address1939   * @param ss58Format format for address conversion, by default ```42```1940   * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1941   * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1942   */1943  normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1944    return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1945  }19461947  /**1948   * Get address in the connected chain format1949   * @param address substrate address1950   * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1951   * @returns address in chain format1952   */1953  async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1954    const info = this.helper.chain.getChainProperties();1955    return encodeAddress(decodeAddress(address), info.ss58Format);1956  }19571958  /**1959   * Get substrate mirror of an ethereum address1960   * @param ethAddress ethereum address1961   * @param toChainFormat false for normalized account1962   * @example ethToSubstrate('0x9F0583DbB855d...')1963   * @returns substrate mirror of a provided ethereum address1964   */1965  async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1966    if(!toChainFormat) return evmToAddress(ethAddress);1967    const info = this.helper.chain.getChainProperties();1968    return evmToAddress(ethAddress, info.ss58Format);1969  }19701971  /**1972   * Get ethereum mirror of a substrate address1973   * @param subAddress substrate account1974   * @example substrateToEth("5DnSF6RRjwteE3BrC...")1975   * @returns ethereum mirror of a provided substrate address1976   */1977  substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1978    return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1979  }1980}198119821983export class UniqueHelper extends ChainHelperBase {1984  chain: ChainGroup;1985  balance: BalanceGroup;1986  address: AddressGroup;1987  collection: CollectionGroup;1988  nft: NFTGroup;1989  rft: RFTGroup;1990  ft: FTGroup;19911992  constructor(logger?: ILogger) {1993    super(logger);1994    this.chain = new ChainGroup(this);1995    this.balance = new BalanceGroup(this);1996    this.address = new AddressGroup(this);1997    this.collection = new CollectionGroup(this);1998    this.nft = new NFTGroup(this);1999    this.rft = new RFTGroup(this);2000    this.ft = new FTGroup(this);2001  }  2002}200320042005class UniqueCollectionBase {2006  helper: UniqueHelper;2007  collectionId: number;20082009  constructor(collectionId: number, uniqueHelper: UniqueHelper) {2010    this.collectionId = collectionId;2011    this.helper = uniqueHelper;2012  }20132014  async getData() {2015    return await this.helper.collection.getData(this.collectionId);2016  }20172018  async getLastTokenId() {2019    return await this.helper.collection.getLastTokenId(this.collectionId);2020  }20212022  async isTokenExists(tokenId: number) {2023    return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2024  }20252026  async getAdmins() {2027    return await this.helper.collection.getAdmins(this.collectionId);2028  }20292030  async getAllowList() {2031    return await this.helper.collection.getAllowList(this.collectionId);2032  }20332034  async getEffectiveLimits() {2035    return await this.helper.collection.getEffectiveLimits(this.collectionId);2036  }20372038  async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount, label?: string) {2039    return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress, label);2040  }20412042  async confirmSponsorship(signer: TSigner, label?: string) {2043    return await this.helper.collection.confirmSponsorship(signer, this.collectionId, label);2044  }20452046  async setLimits(signer: TSigner, limits: ICollectionLimits, label?: string) {2047    return await this.helper.collection.setLimits(signer, this.collectionId, limits, label);2048  }20492050  async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount, label?: string) {2051    return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress, label);2052  }20532054  async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2055    return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj, label);2056  }20572058  async addToAllowList(signer: TSigner, addressObj: ICrossAccountId, label?: string) {2059    return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj, label);2060  }20612062  async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2063    return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj, label);2064  }20652066  async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2067    return await this.helper.collection.setProperties(signer, this.collectionId, properties, label);2068  }20692070  async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2071    return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys, label);2072  }20732074  async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2075    return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2076  }20772078  async setPermissions(signer: TSigner, permissions: ICollectionPermissions, label?: string) {2079    return await this.helper.collection.setPermissions(signer, this.collectionId, permissions, label);2080  }20812082  async enableNesting(signer: TSigner, permissions: INestingPermissions, label?: string) {2083    return await this.helper.collection.enableNesting(signer, this.collectionId, permissions, label);2084  }20852086  async disableNesting(signer: TSigner, label?: string) {2087    return await this.helper.collection.disableNesting(signer, this.collectionId, label);2088  }20892090  async burn(signer: TSigner, label?: string) {2091    return await this.helper.collection.burn(signer, this.collectionId, label);2092  }2093}209420952096class UniqueNFTCollection extends UniqueCollectionBase {2097  getTokenObject(tokenId: number) {2098    return new UniqueNFTToken(tokenId, this);2099  }21002101  async getTokensByAddress(addressObj: ICrossAccountId) {2102    return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2103  }21042105  async getToken(tokenId: number, blockHashAt?: string) {2106    return await this.helper.nft.getToken(this.collectionId, tokenId, blockHashAt);2107  }21082109  async getTokenOwner(tokenId: number, blockHashAt?: string) {2110    return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2111  }21122113  async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2114    return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2115  }21162117  async getTokenChildren(tokenId: number, blockHashAt?: string) {2118    return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2119  }21202121  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2122    return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2123  }21242125  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2126    return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2127  }21282129  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {2130    return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label);2131  }21322133  async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2134    return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2135  }21362137  async mintToken(signer: TSigner, owner: ICrossAccountId, properties?: IProperty[], label?: string) {2138    return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties}, label);2139  }21402141  async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string) {2142    return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens, label);2143  }21442145  async burnToken(signer: TSigner, tokenId: number, label?: string) {2146    return await this.helper.nft.burnToken(signer, this.collectionId, tokenId, label);2147  }21482149  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2150    return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2151  }21522153  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2154    return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2155  }21562157  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2158    return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2159  }21602161  async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken, label?: string) {2162    return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj, label);2163  }21642165  async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2166    return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj, label);2167  }2168}216921702171class UniqueRFTCollection extends UniqueCollectionBase {2172  getTokenObject(tokenId: number) {2173    return new UniqueRFTToken(tokenId, this);2174  }21752176  async getTokensByAddress(addressObj: ICrossAccountId) {2177    return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2178  }21792180  async getTop10TokenOwners(tokenId: number) {2181    return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2182  }21832184  async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2185    return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2186  }21872188  async getTokenTotalPieces(tokenId: number) {2189    return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2190  }21912192  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=100n) {2193    return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2194  }21952196  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2197    return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2198  }21992200  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2201    return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label, amount);2202  }22032204  async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2205    return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2206  }22072208  async repartitionToken(signer: TSigner, tokenId: number, amount: bigint, label?: string) {2209    return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount, label);2210  }22112212  async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[], label?: string) {2213    return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties}, label);2214  }22152216  async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string) {2217    return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens, label);2218  }22192220  async burnToken(signer: TSigner, tokenId: number, amount=100n, label?: string) {2221    return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, label, amount);2222  }22232224  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2225    return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2226  }22272228  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2229    return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2230  }22312232  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2233    return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2234  }2235}223622372238class UniqueFTCollection extends UniqueCollectionBase {2239  async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint, label?: string) {2240    return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount, label);2241  }22422243  async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string) {2244    return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens, label);2245  }22462247  async getBalance(addressObj: ICrossAccountId) {2248    return await this.helper.ft.getBalance(this.collectionId, addressObj);2249  }22502251  async getTop10Owners() {2252    return await this.helper.ft.getTop10Owners(this.collectionId);2253  }22542255  async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount: bigint) {2256    return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2257  }22582259  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {2260    return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2261  }22622263  async burnTokens(signer: TSigner, amount: bigint, label?: string) {2264    return await this.helper.ft.burnTokens(signer, this.collectionId, amount, label);2265  }22662267  async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount: bigint, label?: string) {2268    return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount, label);2269  }22702271  async getTotalPieces() {2272    return await this.helper.ft.getTotalPieces(this.collectionId);2273  }22742275  async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2276    return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount, label);2277  }22782279  async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2280    return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2281  }2282}228322842285class UniqueTokenBase implements IToken {2286  collection: UniqueNFTCollection | UniqueRFTCollection;2287  collectionId: number;2288  tokenId: number;22892290  constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2291    this.collection = collection;2292    this.collectionId = collection.collectionId;2293    this.tokenId = tokenId;2294  }22952296  async getNextSponsored(addressObj: ICrossAccountId) {2297    return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2298  }22992300  async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2301    return await this.collection.setTokenProperties(signer, this.tokenId, properties, label);2302  }23032304  async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2305    return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys, label);2306  }2307}230823092310class UniqueNFTToken extends UniqueTokenBase {2311  collection: UniqueNFTCollection;23122313  constructor(tokenId: number, collection: UniqueNFTCollection) {2314    super(tokenId, collection);2315    this.collection = collection;2316  }23172318  async getData(blockHashAt?: string) {2319    return await this.collection.getToken(this.tokenId, blockHashAt);2320  }23212322  async getOwner(blockHashAt?: string) {2323    return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2324  }23252326  async getTopmostOwner(blockHashAt?: string) {2327    return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2328  }23292330  async getChildren(blockHashAt?: string) {2331    return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2332  }23332334  async nest(signer: TSigner, toTokenObj: IToken, label?: string) {2335    return await this.collection.nestToken(signer, this.tokenId, toTokenObj, label);2336  }23372338  async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2339    return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj, label);2340  }23412342  async transfer(signer: TSigner, addressObj: ICrossAccountId) {2343    return await this.collection.transferToken(signer, this.tokenId, addressObj);2344  }23452346  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2347    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2348  }23492350  async approve(signer: TSigner, toAddressObj: ICrossAccountId, label?: string) {2351    return await this.collection.approveToken(signer, this.tokenId, toAddressObj, label);2352  }23532354  async isApproved(toAddressObj: ICrossAccountId) {2355    return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2356  }23572358  async burn(signer: TSigner, label?: string) {2359    return await this.collection.burnToken(signer, this.tokenId, label);2360  }2361}23622363class UniqueRFTToken extends UniqueTokenBase {2364  collection: UniqueRFTCollection;23652366  constructor(tokenId: number, collection: UniqueRFTCollection) {2367    super(tokenId, collection);2368    this.collection = collection;2369  }23702371  async getTop10Owners() {2372    return await this.collection.getTop10TokenOwners(this.tokenId);2373  }23742375  async getBalance(addressObj: ICrossAccountId) {2376    return await this.collection.getTokenBalance(this.tokenId, addressObj);2377  }23782379  async getTotalPieces() {2380    return await this.collection.getTokenTotalPieces(this.tokenId);2381  }23822383  async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=100n) {2384    return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2385  }23862387  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2388    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2389  }23902391  async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2392    return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount, label);2393  }23942395  async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2396    return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2397  }23982399  async repartition(signer: TSigner, amount: bigint, label?: string) {2400    return await this.collection.repartitionToken(signer, this.tokenId, amount, label);2401  }24022403  async burn(signer: TSigner, amount=100n, label?: string) {2404    return await this.collection.burnToken(signer, this.tokenId, amount, label);2405  }2406}