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

difftreelog

source

tests/src/util/playgrounds/unique.ts127.5 KiBsourcehistory
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents, SignerOptions} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IStakingInfo, ISchedulerOptions, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, IForeignAssetMetadata, TNetworks, MoonbeamAssetInfo, DemocracyStandardAccountVote, AcalaAssetMetadata} from './types';1314export class CrossAccountId implements ICrossAccountId {15  Substrate?: TSubstrateAccount;16  Ethereum?: TEthereumAccount;1718  constructor(account: ICrossAccountId) {19    if (account.Substrate) this.Substrate = account.Substrate;20    if (account.Ethereum) this.Ethereum = account.Ethereum;21  }2223  static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {24    switch (domain) {25      case 'Substrate': return new CrossAccountId({Substrate: account.address});26      case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();27    }28  }2930  static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {31    return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});32  }3334  static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {35    return encodeAddress(decodeAddress(address), ss58Format);36  }3738  static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {39    return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});40  }41  42  withNormalizedSubstrate(ss58Format = 42): CrossAccountId {43    if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);44    return this;45  }4647  static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {48    return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));49  }5051  toEthereum(): CrossAccountId {52    if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});53    return this;54  }5556  static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {57    return evmToAddress(address, ss58Format);58  }5960  toSubstrate(ss58Format?: number): CrossAccountId {61    if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});62    return this;63  }64  65  toLowerCase(): CrossAccountId {66    if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();67    if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();68    return this;69  }70}7172const nesting = {73  toChecksumAddress(address: string): string {74    if (typeof address === 'undefined') return '';7576    if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);7778    address = address.toLowerCase().replace(/^0x/i,'');79    const addressHash = keccakAsHex(address).replace(/^0x/i,'');80    const checksumAddress = ['0x'];8182    for (let i = 0; i < address.length; i++) {83      // If ith character is 8 to f then make it uppercase84      if (parseInt(addressHash[i], 16) > 7) {85        checksumAddress.push(address[i].toUpperCase());86      } else {87        checksumAddress.push(address[i]);88      }89    }90    return checksumAddress.join('');91  },92  tokenIdToAddress(collectionId: number, tokenId: number) {93    return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8, '0')}${tokenId.toString(16).padStart(8, '0')}`);94  },95};9697class UniqueUtil {98  static transactionStatus = {99    NOT_READY: 'NotReady',100    FAIL: 'Fail',101    SUCCESS: 'Success',102  };103104  static chainLogType = {105    EXTRINSIC: 'extrinsic',106    RPC: 'rpc',107  };108109  static getTokenAccount(token: IToken): CrossAccountId {110    return new CrossAccountId({Ethereum: this.getTokenAddress(token)});111  }112113  static getTokenAddress(token: IToken): string {114    return nesting.tokenIdToAddress(token.collectionId, token.tokenId);115  }116117  static getDefaultLogger(): ILogger {118    return {119      log(msg: any, level = 'INFO') {120        console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));121      },122      level: {123        ERROR: 'ERROR',124        WARNING: 'WARNING',125        INFO: 'INFO',126      },127    };128  }129130  static vec2str(arr: string[] | number[]) {131    return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');132  }133134  static str2vec(string: string) {135    if (typeof string !== 'string') return string;136    return Array.from(string).map(x => x.charCodeAt(0));137  }138139  static fromSeed(seed: string, ss58Format = 42) {140    const keyring = new Keyring({type: 'sr25519', ss58Format});141    return keyring.addFromUri(seed);142  }143144  static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {145    if (creationResult.status !== this.transactionStatus.SUCCESS) {146      throw Error('Unable to create collection!');147    }148149    let collectionId = null;150    creationResult.result.events.forEach(({event: {data, method, section}}) => {151      if ((section === 'common') && (method === 'CollectionCreated')) {152        collectionId = parseInt(data[0].toString(), 10);153      }154    });155156    if (collectionId === null) {157      throw Error('No CollectionCreated event was found!');158    }159160    return collectionId;161  }162163  static extractTokensFromCreationResult(creationResult: ITransactionResult): {164    success: boolean, 165    tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],166  } {167    if (creationResult.status !== this.transactionStatus.SUCCESS) {168      throw Error('Unable to create tokens!');169    }170    let success = false;171    const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];172    creationResult.result.events.forEach(({event: {data, method, section}}) => {173      if (method === 'ExtrinsicSuccess') {174        success = true;175      } else if ((section === 'common') && (method === 'ItemCreated')) {176        tokens.push({177          collectionId: parseInt(data[0].toString(), 10),178          tokenId: parseInt(data[1].toString(), 10),179          owner: data[2].toHuman(),180          amount: data[3].toBigInt(),181        });182      }183    });184    return {success, tokens};185  }186187  static extractTokensFromBurnResult(burnResult: ITransactionResult): {188    success: boolean, 189    tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],190  } {191    if (burnResult.status !== this.transactionStatus.SUCCESS) {192      throw Error('Unable to burn tokens!');193    }194    let success = false;195    const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];196    burnResult.result.events.forEach(({event: {data, method, section}}) => {197      if (method === 'ExtrinsicSuccess') {198        success = true;199      } else if ((section === 'common') && (method === 'ItemDestroyed')) {200        tokens.push({201          collectionId: parseInt(data[0].toString(), 10),202          tokenId: parseInt(data[1].toString(), 10),203          owner: data[2].toHuman(),204          amount: data[3].toBigInt(),205        });206      }207    });208    return {success, tokens};209  }210211  static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {212    let eventId = null;213    events.forEach(({event: {data, method, section}}) => {214      if ((section === expectedSection) && (method === expectedMethod)) {215        eventId = parseInt(data[0].toString(), 10);216      }217    });218219    if (eventId === null) {220      throw Error(`No ${expectedMethod} event was found!`);221    }222    return eventId === collectionId;223  }224225  static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {226    const normalizeAddress = (address: string | ICrossAccountId) => {227      if(typeof address === 'string') return address;228      const obj = {} as any;229      Object.keys(address).forEach(k => {230        obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];231      });232      if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);233      if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();234      return address;235    };236    let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;237    events.forEach(({event: {data, method, section}}) => {238      if ((section === 'common') && (method === 'Transfer')) {239        const hData = (data as any).toJSON();240        transfer = {241          collectionId: hData[0],242          tokenId: hData[1],243          from: normalizeAddress(hData[2]),244          to: normalizeAddress(hData[3]),245          amount: BigInt(hData[4]),246        };247      }248    });249    let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;250    isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);251    isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);252    isSuccess = isSuccess && amount === transfer.amount;253    return isSuccess;254  }255}256257class UniqueEventHelper {258  private static extractIndex(index: any): [number, number] | string {259    if(index.toRawType() === '[u8;2]') return [index[0], index[1]];260    return index.toJSON();261  }262263  private static extractSub(data: any, subTypes: any): {[key: string]: any} {264    let obj: any = {};265    let index = 0;266267    if (data.entries) {268      for(const [key, value] of data.entries()) {269        obj[key] = this.extractData(value, subTypes[index]);270        index++;271      }272    } else obj = data.toJSON();273274    return obj;275  }276  277  private static extractData(data: any, type: any): any {278    if(!type) return data.toHuman();279    if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();280    if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();281    if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);282    return data.toHuman();283  }284285  public static extractEvents(records: ITransactionResult): IEvent[] {286    const parsedEvents: IEvent[] = [];287288    records.result.events.forEach((record) => {289      const {event, phase} = record;290      const types = (event as any).typeDef;291292      const eventData: IEvent = {293        section: event.section.toString(),294        method: event.method.toString(),295        index: this.extractIndex(event.index),296        data: [],297        phase: phase.toJSON(),298      };299300      event.data.forEach((val: any, index: number) => {301        eventData.data.push(this.extractData(val, types[index]));302      });303304      parsedEvents.push(eventData);305    });306307    return parsedEvents;308  }309}310311export class ChainHelperBase {312  helperBase: any;313314  transactionStatus = UniqueUtil.transactionStatus;315  chainLogType = UniqueUtil.chainLogType;316  util: typeof UniqueUtil;317  eventHelper: typeof UniqueEventHelper;318  logger: ILogger;319  api: ApiPromise | null;320  forcedNetwork: TNetworks | null;321  network: TNetworks | null;322  chainLog: IUniqueHelperLog[];323  children: ChainHelperBase[];324  address: AddressGroup;325  chain: ChainGroup;326327  constructor(logger?: ILogger, helperBase?: any) {328    this.helperBase = helperBase;329330    this.util = UniqueUtil;331    this.eventHelper = UniqueEventHelper;332    if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();333    this.logger = logger;334    this.api = null;335    this.forcedNetwork = null;336    this.network = null;337    this.chainLog = [];338    this.children = [];339    this.address = new AddressGroup(this);340    this.chain = new ChainGroup(this);341  }342343  clone(helperCls: ChainHelperBaseConstructor, options: {[key: string]: any} = {}) {344    Object.setPrototypeOf(helperCls.prototype, this);345    const newHelper = new helperCls(this.logger, options);346347    newHelper.api = this.api;348    newHelper.network = this.network;349    newHelper.forceNetwork = this.forceNetwork;350351    this.children.push(newHelper);352353    return newHelper;354  }355356  getApi(): ApiPromise {357    if(this.api === null) throw Error('API not initialized');358    return this.api;359  }360361  clearChainLog(): void {362    this.chainLog = [];363  }364365  forceNetwork(value: TNetworks): void {366    this.forcedNetwork = value;367  }368369  async connect(wsEndpoint: string, listeners?: IApiListeners) {370    if (this.api !== null) throw Error('Already connected');371    const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);372    this.api = api;373    this.network = network;374  }375376  async disconnect() {377    for (const child of this.children) {378      child.clearApi();379    }380381    if (this.api === null) return;382    await this.api.disconnect();383    this.clearApi();384  }385386  clearApi() {387    this.api = null;388    this.network = null;389  }390391  static async detectNetwork(api: ApiPromise): Promise<TNetworks> {392    const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;393    const xcmChains = ['rococo', 'westend', 'westmint', 'acala', 'karura', 'moonbeam', 'moonriver'];394395    if(xcmChains.indexOf(spec.specName) > -1) return spec.specName;396397    if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;398    return 'opal';399  }400401  static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TNetworks> {402    const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});403    await api.isReady;404405    const network = await this.detectNetwork(api);406407    await api.disconnect();408409    return network;410  }411412  static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TNetworks | null): Promise<{413    api: ApiPromise;414    network: TNetworks;415  }> {416    console.log('createConnection network = ', network);417    if(typeof network === 'undefined' || network === null) network = 'opal';418    const supportedRPC = {419      opal: {420        unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,421      },422      quartz: {423        unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,424      },425      unique: {426        unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,427      },428      rococo: {},429      westend: {},430      moonbeam: {},431      moonriver: {},432      acala: {},433      karura: {},434      westmint: {},435    };436    if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);437    const rpc = supportedRPC[network];438439    // TODO: investigate how to replace rpc in runtime440    // api._rpcCore.addUserInterfaces(rpc);441442    const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});443444    await api.isReadyOrError;445446    if (typeof listeners === 'undefined') listeners = {};447    for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {448      if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;449      api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);450    }451452    return {api, network};453  }454455  getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {456    const {events, status} = data;457    if (status.isReady) {458      return this.transactionStatus.NOT_READY;459    }460    if (status.isBroadcast) {461      return this.transactionStatus.NOT_READY;462    }463    if (status.isInBlock || status.isFinalized) {464      const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');465      if (errors.length > 0) {466        return this.transactionStatus.FAIL;467      }468      if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {469        return this.transactionStatus.SUCCESS;470      }471    }472473    return this.transactionStatus.FAIL;474  }475476  signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {477    const sign = (callback: any) => {478      if(options !== null) return transaction.signAndSend(sender, options, callback);479      return transaction.signAndSend(sender, callback);480    };481    // eslint-disable-next-line no-async-promise-executor482    return new Promise(async (resolve, reject) => {483      try {484        const unsub = await sign((result: any) => {485          const status = this.getTransactionStatus(result);486487          if (status === this.transactionStatus.SUCCESS) {488            this.logger.log(`${label} successful`);489            unsub();490            resolve({result, status});491          } else if (status === this.transactionStatus.FAIL) {492            let moduleError = null;493494            if (result.hasOwnProperty('dispatchError')) {495              const dispatchError = result['dispatchError'];496497              if (dispatchError) {498                if (dispatchError.isModule) {499                  const modErr = dispatchError.asModule;500                  const errorMeta = dispatchError.registry.findMetaError(modErr);501502                  moduleError = `${errorMeta.section}.${errorMeta.name}`;503                } else {504                  moduleError = dispatchError.toHuman();505                }506              } else {507                this.logger.log(result, this.logger.level.ERROR);508              }509            }510511            this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);512            unsub();513            reject({status, moduleError, result});514          }515        });516      } catch (e) {517        this.logger.log(e, this.logger.level.ERROR);518        reject(e);519      }520    });521  }522523  constructApiCall(apiCall: string, params: any[]) {524    if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);525    let call = this.getApi() as any;526    for(const part of apiCall.slice(4).split('.')) {527      call = call[part];528    }529    return call(...params);530  }531532  async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {533    if(this.api === null) throw Error('API not initialized');534    if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);535536    const startTime = (new Date()).getTime();537    let result: ITransactionResult;538    let events: IEvent[] = [];539    try {540      result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;541      events = this.eventHelper.extractEvents(result);542    }543    catch(e) {544      if(!(e as object).hasOwnProperty('status')) throw e;545      result = e as ITransactionResult;546    }547548    const endTime = (new Date()).getTime();549550    const log = {551      executedAt: endTime,552      executionTime: endTime - startTime,553      type: this.chainLogType.EXTRINSIC,554      status: result.status,555      call: extrinsic,556      signer: this.getSignerAddress(sender),557      params,558    } as IUniqueHelperLog;559560    if(result.status !== this.transactionStatus.SUCCESS) {561      if (result.moduleError) log.moduleError = result.moduleError;562      else if (result.result.dispatchError) log.dispatchError = result.result.dispatchError;563    }564    if(events.length > 0) log.events = events;565566    this.chainLog.push(log);567568    if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {569      if (result.moduleError) throw Error(`${result.moduleError}`);570      else if (result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));571    }572    return result;573  }574575  async callRpc(rpc: string, params?: any[]) {576    if(typeof params === 'undefined') params = [];577    if(this.api === null) throw Error('API not initialized');578    if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);579580    const startTime = (new Date()).getTime();581    let result;582    let error = null;583    const log = {584      type: this.chainLogType.RPC,585      call: rpc,586      params,587    } as IUniqueHelperLog;588589    try {590      result = await this.constructApiCall(rpc, params);591    }592    catch(e) {593      error = e;594    }595596    const endTime = (new Date()).getTime();597598    log.executedAt = endTime;599    log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';600    log.executionTime = endTime - startTime;601602    this.chainLog.push(log);603604    if(error !== null) throw error;605606    return result;607  }608609  getSignerAddress(signer: IKeyringPair | string): string {610    if(typeof signer === 'string') return signer;611    return signer.address;612  }613614  fetchAllPalletNames(): string[] {615    if(this.api === null) throw Error('API not initialized');616    return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());617  }618619  fetchMissingPalletNames(requiredPallets: string[]): string[] {620    const palletNames = this.fetchAllPalletNames();621    return requiredPallets.filter(p => !palletNames.includes(p));622  }623}624625626class HelperGroup<T extends ChainHelperBase> {627  helper: T;628629  constructor(uniqueHelper: T) {630    this.helper = uniqueHelper;631  }632}633634635class CollectionGroup extends HelperGroup<UniqueHelper> {636  /**637 * Get number of blocks when sponsored transaction is available.638 *639 * @param collectionId ID of collection640 * @param tokenId ID of token641 * @param addressObj address for which the sponsorship is checked642 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});643 * @returns number of blocks or null if sponsorship hasn't been set644 */645  async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {646    return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();647  }648649  /**650   * Get the number of created collections.651   *652   * @returns number of created collections653   */654  async getTotalCount(): Promise<number> {655    return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();656  }657658  /**659   * Get information about the collection with additional data,660   * including the number of tokens it contains, its administrators,661   * the normalized address of the collection's owner, and decoded name and description.662   *663   * @param collectionId ID of collection664   * @example await getData(2)665   * @returns collection information object666   */667  async getData(collectionId: number): Promise<{668    id: number;669    name: string;670    description: string;671    tokensCount: number;672    admins: CrossAccountId[];673    normalizedOwner: TSubstrateAccount;674    raw: any675  } | null> {676    const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);677    const humanCollection = collection.toHuman(), collectionData = {678      id: collectionId, name: null, description: null, tokensCount: 0, admins: [],679      raw: humanCollection,680    } as any, jsonCollection = collection.toJSON();681    if (humanCollection === null) return null;682    collectionData.raw.limits = jsonCollection.limits;683    collectionData.raw.permissions = jsonCollection.permissions;684    collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);685    for (const key of ['name', 'description']) {686      collectionData[key] = this.helper.util.vec2str(humanCollection[key]);687    }688689    collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))690      ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)691      : 0;692    collectionData.admins = await this.getAdmins(collectionId);693694    return collectionData;695  }696697  /**698   * Get the addresses of the collection's administrators, optionally normalized.699   *700   * @param collectionId ID of collection701   * @param normalize whether to normalize the addresses to the default ss58 format702   * @example await getAdmins(1)703   * @returns array of administrators704   */705  async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {706    const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();707708    return normalize709      ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())710      : admins;711  }712713  /**714   * Get the addresses added to the collection allow-list, optionally normalized.715   * @param collectionId ID of collection716   * @param normalize whether to normalize the addresses to the default ss58 format717   * @example await getAllowList(1)718   * @returns array of allow-listed addresses719   */720  async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {721    const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();722    return normalize723      ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())724      : allowListed;725  }726727  /**728   * Get the effective limits of the collection instead of null for default values729   *730   * @param collectionId ID of collection731   * @example await getEffectiveLimits(2)732   * @returns object of collection limits733   */734  async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {735    return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();736  }737738  /**739   * Burns the collection if the signer has sufficient permissions and collection is empty.740   *741   * @param signer keyring of signer742   * @param collectionId ID of collection743   * @example await helper.collection.burn(aliceKeyring, 3);744   * @returns ```true``` if extrinsic success, otherwise ```false```745   */746  async burn(signer: TSigner, collectionId: number): Promise<boolean> {747    const result = await this.helper.executeExtrinsic(748      signer,749      'api.tx.unique.destroyCollection', [collectionId],750      true,751    );752753    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');754  }755756  /**757   * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.758   *759   * @param signer keyring of signer760   * @param collectionId ID of collection761   * @param sponsorAddress Sponsor substrate address762   * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")763   * @returns ```true``` if extrinsic success, otherwise ```false```764   */765  async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {766    const result = await this.helper.executeExtrinsic(767      signer,768      'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],769      true,770    );771772    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');773  }774775  /**776   * Confirms consent to sponsor the collection on behalf of the signer.777   *778   * @param signer keyring of signer779   * @param collectionId ID of collection780   * @example confirmSponsorship(aliceKeyring, 10)781   * @returns ```true``` if extrinsic success, otherwise ```false```782   */783  async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {784    const result = await this.helper.executeExtrinsic(785      signer,786      'api.tx.unique.confirmSponsorship', [collectionId],787      true,788    );789790    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');791  }792793  /**794   * Removes the sponsor of a collection, regardless if it consented or not.795   *796   * @param signer keyring of signer797   * @param collectionId ID of collection798   * @example removeSponsor(aliceKeyring, 10)799   * @returns ```true``` if extrinsic success, otherwise ```false```800   */801  async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {802    const result = await this.helper.executeExtrinsic(803      signer,804      'api.tx.unique.removeCollectionSponsor', [collectionId],805      true,806    );807808    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');809  }810811  /**812   * Sets the limits of the collection. At least one limit must be specified for a correct call.813   *814   * @param signer keyring of signer815   * @param collectionId ID of collection816   * @param limits collection limits object817   * @example818   * await setLimits(819   *   aliceKeyring,820   *   10,821   *   {822   *     sponsorTransferTimeout: 0,823   *     ownerCanDestroy: false824   *   }825   * )826   * @returns ```true``` if extrinsic success, otherwise ```false```827   */828  async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {829    const result = await this.helper.executeExtrinsic(830      signer,831      'api.tx.unique.setCollectionLimits', [collectionId, limits],832      true,833    );834835    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');836  }837838  /**839   * Changes the owner of the collection to the new Substrate address.840   *841   * @param signer keyring of signer842   * @param collectionId ID of collection843   * @param ownerAddress substrate address of new owner844   * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")845   * @returns ```true``` if extrinsic success, otherwise ```false```846   */847  async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {848    const result = await this.helper.executeExtrinsic(849      signer,850      'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],851      true,852    );853854    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');855  }856857  /**858   * Adds a collection administrator.859   *860   * @param signer keyring of signer861   * @param collectionId ID of collection862   * @param adminAddressObj Administrator address (substrate or ethereum)863   * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})864   * @returns ```true``` if extrinsic success, otherwise ```false```865   */866  async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {867    const result = await this.helper.executeExtrinsic(868      signer,869      'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],870      true,871    );872873    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');874  }875876  /**877   * Removes a collection administrator.878   *879   * @param signer keyring of signer880   * @param collectionId ID of collection881   * @param adminAddressObj Administrator address (substrate or ethereum)882   * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})883   * @returns ```true``` if extrinsic success, otherwise ```false```884   */885  async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {886    const result = await this.helper.executeExtrinsic(887      signer,888      'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],889      true,890    );891892    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');893  }894895  /**896   * Check if user is in allow list.897   * 898   * @param collectionId ID of collection899   * @param user Account to check900   * @example await getAdmins(1)901   * @returns is user in allow list902   */903  async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {904    return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();905  }906907  /**908   * Adds an address to allow list909   * @param signer keyring of signer910   * @param collectionId ID of collection911   * @param addressObj address to add to the allow list912   * @returns ```true``` if extrinsic success, otherwise ```false```913   */914  async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {915    const result = await this.helper.executeExtrinsic(916      signer,917      'api.tx.unique.addToAllowList', [collectionId, addressObj],918      true,919    );920921    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');922  }923924  /**925   * Removes an address from allow list926   *927   * @param signer keyring of signer928   * @param collectionId ID of collection929   * @param addressObj address to remove from the allow list930   * @returns ```true``` if extrinsic success, otherwise ```false```931   */932  async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {933    const result = await this.helper.executeExtrinsic(934      signer,935      'api.tx.unique.removeFromAllowList', [collectionId, addressObj],936      true,937    );938939    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');940  }941942  /**943   * Sets onchain permissions for selected collection.944   *945   * @param signer keyring of signer946   * @param collectionId ID of collection947   * @param permissions collection permissions object948   * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});949   * @returns ```true``` if extrinsic success, otherwise ```false```950   */951  async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {952    const result = await this.helper.executeExtrinsic(953      signer,954      'api.tx.unique.setCollectionPermissions', [collectionId, permissions],955      true,956    );957958    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');959  }960961  /**962   * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.963   *964   * @param signer keyring of signer965   * @param collectionId ID of collection966   * @param permissions nesting permissions object967   * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});968   * @returns ```true``` if extrinsic success, otherwise ```false```969   */970  async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {971    return await this.setPermissions(signer, collectionId, {nesting: permissions});972  }973974  /**975   * Disables nesting for selected collection.976   *977   * @param signer keyring of signer978   * @param collectionId ID of collection979   * @example disableNesting(aliceKeyring, 10);980   * @returns ```true``` if extrinsic success, otherwise ```false```981   */982  async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {983    return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});984  }985986  /**987   * Sets onchain properties to the collection.988   *989   * @param signer keyring of signer990   * @param collectionId ID of collection991   * @param properties array of property objects992   * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);993   * @returns ```true``` if extrinsic success, otherwise ```false```994   */995  async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {996    const result = await this.helper.executeExtrinsic(997      signer,998      'api.tx.unique.setCollectionProperties', [collectionId, properties],999      true,1000    );10011002    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');1003  }10041005  /**1006   * Get collection properties.1007   * 1008   * @param collectionId ID of collection1009   * @param propertyKeys optionally filter the returned properties to only these keys1010   * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);1011   * @returns array of key-value pairs1012   */1013  async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1014    return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();1015  }10161017  /**1018   * Deletes onchain properties from the collection.1019   *1020   * @param signer keyring of signer1021   * @param collectionId ID of collection1022   * @param propertyKeys array of property keys to delete1023   * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);1024   * @returns ```true``` if extrinsic success, otherwise ```false```1025   */1026  async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {1027    const result = await this.helper.executeExtrinsic(1028      signer,1029      'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],1030      true,1031    );10321033    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1034  }10351036  /**1037   * Changes the owner of the token.1038   *1039   * @param signer keyring of signer1040   * @param collectionId ID of collection1041   * @param tokenId ID of token1042   * @param addressObj address of a new owner1043   * @param amount amount of tokens to be transfered. For NFT must be set to 1n1044   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1045   * @returns true if the token success, otherwise false1046   */1047  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1048    const result = await this.helper.executeExtrinsic(1049      signer,1050      'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1051      true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1052    );10531054    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1055  }10561057  /**1058   *1059   * Change ownership of a token(s) on behalf of the owner.1060   *1061   * @param signer keyring of signer1062   * @param collectionId ID of collection1063   * @param tokenId ID of token1064   * @param fromAddressObj address on behalf of which the token will be sent1065   * @param toAddressObj new token owner1066   * @param amount amount of tokens to be transfered. For NFT must be set to 1n1067   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1068   * @returns true if the token success, otherwise false1069   */1070  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1071    const result = await this.helper.executeExtrinsic(1072      signer,1073      'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1074      true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1075    );1076    return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1077  }10781079  /**1080   *1081   * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1082   *1083   * @param signer keyring of signer1084   * @param collectionId ID of collection1085   * @param tokenId ID of token1086   * @param amount amount of tokens to be burned. For NFT must be set to 1n1087   * @example burnToken(aliceKeyring, 10, 5);1088   * @returns ```true``` if the extrinsic is successful, otherwise ```false```1089   */1090  async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1091    const burnResult = await this.helper.executeExtrinsic(1092      signer,1093      'api.tx.unique.burnItem', [collectionId, tokenId, amount],1094      true, // `Unable to burn token for ${label}`,1095    );1096    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1097    if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1098    return burnedTokens.success;1099  }11001101  /**1102   * Destroys a concrete instance of NFT on behalf of the owner1103   *1104   * @param signer keyring of signer1105   * @param collectionId ID of collection1106   * @param tokenId ID of token1107   * @param fromAddressObj address on behalf of which the token will be burnt1108   * @param amount amount of tokens to be burned. For NFT must be set to 1n1109   * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1110   * @returns ```true``` if extrinsic success, otherwise ```false```1111   */1112  async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1113    const burnResult = await this.helper.executeExtrinsic(1114      signer,1115      'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1116      true, // `Unable to burn token from for ${label}`,1117    );1118    const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1119    return burnedTokens.success && burnedTokens.tokens.length > 0;1120  }11211122  /**1123   * Set, change, or remove approved address to transfer the ownership of the NFT.1124   *1125   * @param signer keyring of signer1126   * @param collectionId ID of collection1127   * @param tokenId ID of token1128   * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1129   * @param amount amount of token to be approved. For NFT must be set to 1n1130   * @returns ```true``` if extrinsic success, otherwise ```false```1131   */1132  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1133    const approveResult = await this.helper.executeExtrinsic(1134      signer,1135      'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1136      true, // `Unable to approve token for ${label}`,1137    );11381139    return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1140  }11411142  /**1143   * Get the amount of token pieces approved to transfer or burn. Normally 0.1144   *1145   * @param collectionId ID of collection1146   * @param tokenId ID of token1147   * @param toAccountObj address which is approved to use token pieces1148   * @param fromAccountObj address which may have allowed the use of its owned tokens1149   * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1150   * @returns number of approved to transfer pieces1151   */1152  async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1153    return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1154  }11551156  /**1157   * Get the last created token ID in a collection1158   *1159   * @param collectionId ID of collection1160   * @example getLastTokenId(10);1161   * @returns id of the last created token1162   */1163  async getLastTokenId(collectionId: number): Promise<number> {1164    return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1165  }11661167  /**1168   * Check if token exists1169   *1170   * @param collectionId ID of collection1171   * @param tokenId ID of token1172   * @example doesTokenExist(10, 20);1173   * @returns true if the token exists, otherwise false1174   */1175  async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1176    return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1177  }1178}11791180class NFTnRFT extends CollectionGroup {1181  /**1182   * Get tokens owned by account1183   *1184   * @param collectionId ID of collection1185   * @param addressObj tokens owner1186   * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1187   * @returns array of token ids owned by account1188   */1189  async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1190    return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1191  }11921193  /**1194   * Get token data1195   *1196   * @param collectionId ID of collection1197   * @param tokenId ID of token1198   * @param propertyKeys optionally filter the token properties to only these keys1199   * @param blockHashAt optionally query the data at some block with this hash1200   * @example getToken(10, 5);1201   * @returns human readable token data1202   */1203  async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1204    properties: IProperty[];1205    owner: CrossAccountId;1206    normalizedOwner: CrossAccountId;1207  }| null> {1208    let tokenData;1209    if(typeof blockHashAt === 'undefined') {1210      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1211    }1212    else {1213      if(propertyKeys.length == 0) {1214        const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1215        if(!collection) return null;1216        propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1217      }1218      tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1219    }1220    tokenData = tokenData.toHuman();1221    if (tokenData === null || tokenData.owner === null) return null;1222    const owner = {} as any;1223    for (const key of Object.keys(tokenData.owner)) {1224      owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate' 1225        ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key]) 1226        : tokenData.owner[key];1227    }1228    tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1229    return tokenData;1230  }12311232  /**1233   * Set permissions to change token properties1234   *1235   * @param signer keyring of signer1236   * @param collectionId ID of collection1237   * @param permissions permissions to change a property by the collection admin or token owner1238   * @example setTokenPropertyPermissions(1239   *   aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1240   * )1241   * @returns true if extrinsic success otherwise false1242   */1243  async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1244    const result = await this.helper.executeExtrinsic(1245      signer,1246      'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1247      true,1248    );12491250    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1251  }12521253  /**1254   * Get token property permissions.1255   * 1256   * @param collectionId ID of collection1257   * @param propertyKeys optionally filter the returned property permissions to only these keys1258   * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1259   * @returns array of key-permission pairs1260   */1261  async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1262    return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1263  }12641265  /**1266   * Set token properties1267   *1268   * @param signer keyring of signer1269   * @param collectionId ID of collection1270   * @param tokenId ID of token1271   * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1272   * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1273   * @returns ```true``` if extrinsic success, otherwise ```false```1274   */1275  async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1276    const result = await this.helper.executeExtrinsic(1277      signer,1278      'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1279      true,1280    );12811282    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1283  }12841285  /**1286   * Get properties, metadata assigned to a token.1287   * 1288   * @param collectionId ID of collection1289   * @param tokenId ID of token1290   * @param propertyKeys optionally filter the returned properties to only these keys1291   * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1292   * @returns array of key-value pairs1293   */1294  async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1295    return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1296  }12971298  /**1299   * Delete the provided properties of a token1300   * @param signer keyring of signer1301   * @param collectionId ID of collection1302   * @param tokenId ID of token1303   * @param propertyKeys property keys to be deleted1304   * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1305   * @returns ```true``` if extrinsic success, otherwise ```false```1306   */1307  async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1308    const result = await this.helper.executeExtrinsic(1309      signer,1310      'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1311      true,1312    );13131314    return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1315  }13161317  /**1318   * Mint new collection1319   *1320   * @param signer keyring of signer1321   * @param collectionOptions basic collection options and properties1322   * @param mode NFT or RFT type of a collection1323   * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1324   * @returns object of the created collection1325   */1326  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1327    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1328    collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1329    for (const key of ['name', 'description', 'tokenPrefix']) {1330      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);1331    }1332    const creationResult = await this.helper.executeExtrinsic(1333      signer,1334      'api.tx.unique.createCollectionEx', [collectionOptions],1335      true, // errorLabel,1336    );1337    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1338  }13391340  getCollectionObject(_collectionId: number): any {1341    return null;1342  }13431344  getTokenObject(_collectionId: number, _tokenId: number): any {1345    return null;1346  }1347}134813491350class NFTGroup extends NFTnRFT {1351  /**1352   * Get collection object1353   * @param collectionId ID of collection1354   * @example getCollectionObject(2);1355   * @returns instance of UniqueNFTCollection1356   */1357  getCollectionObject(collectionId: number): UniqueNFTCollection {1358    return new UniqueNFTCollection(collectionId, this.helper);1359  }13601361  /**1362   * Get token object1363   * @param collectionId ID of collection1364   * @param tokenId ID of token1365   * @example getTokenObject(10, 5);1366   * @returns instance of UniqueNFTToken1367   */1368  getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1369    return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1370  }13711372  /**1373   * Get token's owner1374   * @param collectionId ID of collection1375   * @param tokenId ID of token1376   * @param blockHashAt optionally query the data at the block with this hash1377   * @example getTokenOwner(10, 5);1378   * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1379   */1380  async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1381    let owner;1382    if (typeof blockHashAt === 'undefined') {1383      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1384    } else {1385      owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1386    }1387    return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1388  }13891390  /**1391   * Is token approved to transfer1392   * @param collectionId ID of collection1393   * @param tokenId ID of token1394   * @param toAccountObj address to be approved1395   * @returns ```true``` if extrinsic success, otherwise ```false```1396   */1397  async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1398    return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1399  }14001401  /**1402   * Changes the owner of the token.1403   *1404   * @param signer keyring of signer1405   * @param collectionId ID of collection1406   * @param tokenId ID of token1407   * @param addressObj address of a new owner1408   * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1409   * @returns ```true``` if extrinsic success, otherwise ```false```1410   */1411  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1412    return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1413  }14141415  /**1416   *1417   * Change ownership of a NFT on behalf of the owner.1418   *1419   * @param signer keyring of signer1420   * @param collectionId ID of collection1421   * @param tokenId ID of token1422   * @param fromAddressObj address on behalf of which the token will be sent1423   * @param toAddressObj new token owner1424   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1425   * @returns ```true``` if extrinsic success, otherwise ```false```1426   */1427  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1428    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1429  }14301431  /**1432   * Recursively find the address that owns the token1433   * @param collectionId ID of collection1434   * @param tokenId ID of token1435   * @param blockHashAt1436   * @example getTokenTopmostOwner(10, 5);1437   * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1438   */1439  async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1440    let owner;1441    if (typeof blockHashAt === 'undefined') {1442      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1443    } else {1444      owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1445    }14461447    if (owner === null) return null;14481449    return owner.toHuman();1450  }14511452  /**1453   * Get tokens nested in the provided token1454   * @param collectionId ID of collection1455   * @param tokenId ID of token1456   * @param blockHashAt optionally query the data at the block with this hash1457   * @example getTokenChildren(10, 5);1458   * @returns tokens whose depth of nesting is <= 51459   */1460  async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1461    let children;1462    if(typeof blockHashAt === 'undefined') {1463      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1464    } else {1465      children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1466    }14671468    return children.toJSON().map((x: any) => {1469      return {collectionId: x.collection, tokenId: x.token};1470    });1471  }14721473  /**1474   * Nest one token into another1475   * @param signer keyring of signer1476   * @param tokenObj token to be nested1477   * @param rootTokenObj token to be parent1478   * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1479   * @returns ```true``` if extrinsic success, otherwise ```false```1480   */1481  async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1482    const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1483    const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1484    if(!result) {1485      throw Error('Unable to nest token!');1486    }1487    return result;1488  }14891490  /**1491   * Remove token from nested state1492   * @param signer keyring of signer1493   * @param tokenObj token to unnest1494   * @param rootTokenObj parent of a token1495   * @param toAddressObj address of a new token owner1496   * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1497   * @returns ```true``` if extrinsic success, otherwise ```false```1498   */1499  async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1500    const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1501    const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1502    if(!result) {1503      throw Error('Unable to unnest token!');1504    }1505    return result;1506  }15071508  /**1509   * Mint new collection1510   * @param signer keyring of signer1511   * @param collectionOptions Collection options1512   * @example1513   * mintCollection(aliceKeyring, {1514   *   name: 'New',1515   *   description: 'New collection',1516   *   tokenPrefix: 'NEW',1517   * })1518   * @returns object of the created collection1519   */1520  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1521    return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1522  }15231524  /**1525   * Mint new token1526   * @param signer keyring of signer1527   * @param data token data1528   * @returns created token object1529   */1530  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1531    const creationResult = await this.helper.executeExtrinsic(1532      signer,1533      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1534        nft: {1535          properties: data.properties,1536        },1537      }],1538      true,1539    );1540    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1541    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1542    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1543    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1544  }15451546  /**1547   * Mint multiple NFT tokens1548   * @param signer keyring of signer1549   * @param collectionId ID of collection1550   * @param tokens array of tokens with owner and properties1551   * @example1552   * mintMultipleTokens(aliceKeyring, 10, [{1553   *     owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1554   *     properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1555   *   },{1556   *     owner: {Ethereum: "0x9F0583DbB855d..."},1557   *     properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1558   * }]);1559   * @returns ```true``` if extrinsic success, otherwise ```false```1560   */1561  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1562    const creationResult = await this.helper.executeExtrinsic(1563      signer,1564      'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1565      true,1566    );1567    const collection = this.getCollectionObject(collectionId);1568    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1569  }15701571  /**1572   * Mint multiple NFT tokens with one owner1573   * @param signer keyring of signer1574   * @param collectionId ID of collection1575   * @param owner tokens owner1576   * @param tokens array of tokens with owner and properties1577   * @example1578   * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1579   *   properties: [{1580   *   key: "gender",1581   *   value: "female",1582   *  },{1583   *   key: "age",1584   *   value: "33",1585   *  }],1586   * }]);1587   * @returns array of newly created tokens1588   */1589  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1590    const rawTokens = [];1591    for (const token of tokens) {1592      const raw = {NFT: {properties: token.properties}};1593      rawTokens.push(raw);1594    }1595    const creationResult = await this.helper.executeExtrinsic(1596      signer,1597      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1598      true,1599    );1600    const collection = this.getCollectionObject(collectionId);1601    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1602  }16031604  /**1605   * Set, change, or remove approved address to transfer the ownership of the NFT.1606   *1607   * @param signer keyring of signer1608   * @param collectionId ID of collection1609   * @param tokenId ID of token1610   * @param toAddressObj address to approve1611   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1612   * @returns ```true``` if extrinsic success, otherwise ```false```1613   */1614  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1615    return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1616  }1617}161816191620class RFTGroup extends NFTnRFT {1621  /**1622   * Get collection object1623   * @param collectionId ID of collection1624   * @example getCollectionObject(2);1625   * @returns instance of UniqueRFTCollection1626   */1627  getCollectionObject(collectionId: number): UniqueRFTCollection {1628    return new UniqueRFTCollection(collectionId, this.helper);1629  }16301631  /**1632   * Get token object1633   * @param collectionId ID of collection1634   * @param tokenId ID of token1635   * @example getTokenObject(10, 5);1636   * @returns instance of UniqueNFTToken1637   */1638  getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1639    return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1640  }16411642  /**1643   * Get top 10 token owners with the largest number of pieces1644   * @param collectionId ID of collection1645   * @param tokenId ID of token1646   * @example getTokenTop10Owners(10, 5);1647   * @returns array of top 10 owners1648   */1649  async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1650    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1651  }16521653  /**1654   * Get number of pieces owned by address1655   * @param collectionId ID of collection1656   * @param tokenId ID of token1657   * @param addressObj address token owner1658   * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1659   * @returns number of pieces ownerd by address1660   */1661  async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1662    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1663  }16641665  /**1666   * Transfer pieces of token to another address1667   * @param signer keyring of signer1668   * @param collectionId ID of collection1669   * @param tokenId ID of token1670   * @param addressObj address of a new owner1671   * @param amount number of pieces to be transfered1672   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1673   * @returns ```true``` if extrinsic success, otherwise ```false```1674   */1675  async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1676    return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1677  }16781679  /**1680   * Change ownership of some pieces of RFT on behalf of the owner.1681   * @param signer keyring of signer1682   * @param collectionId ID of collection1683   * @param tokenId ID of token1684   * @param fromAddressObj address on behalf of which the token will be sent1685   * @param toAddressObj new token owner1686   * @param amount number of pieces to be transfered1687   * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1688   * @returns ```true``` if extrinsic success, otherwise ```false```1689   */1690  async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1691    return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1692  }16931694  /**1695   * Mint new collection1696   * @param signer keyring of signer1697   * @param collectionOptions Collection options1698   * @example1699   * mintCollection(aliceKeyring, {1700   *   name: 'New',1701   *   description: 'New collection',1702   *   tokenPrefix: 'NEW',1703   * })1704   * @returns object of the created collection1705   */1706  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1707    return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1708  }17091710  /**1711   * Mint new token1712   * @param signer keyring of signer1713   * @param data token data1714   * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1715   * @returns created token object1716   */1717  async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1718    const creationResult = await this.helper.executeExtrinsic(1719      signer,1720      'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1721        refungible: {1722          pieces: data.pieces,1723          properties: data.properties,1724        },1725      }],1726      true,1727    );1728    const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1729    if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1730    if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1731    return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1732  }17331734  async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1735    throw Error('Not implemented');1736    const creationResult = await this.helper.executeExtrinsic(1737      signer,1738      'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1739      true, // `Unable to mint RFT tokens for ${label}`,1740    );1741    const collection = this.getCollectionObject(collectionId);1742    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1743  }17441745  /**1746   * Mint multiple RFT tokens with one owner1747   * @param signer keyring of signer1748   * @param collectionId ID of collection1749   * @param owner tokens owner1750   * @param tokens array of tokens with properties and pieces1751   * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1752   * @returns array of newly created RFT tokens1753   */1754  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1755    const rawTokens = [];1756    for (const token of tokens) {1757      const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1758      rawTokens.push(raw);1759    }1760    const creationResult = await this.helper.executeExtrinsic(1761      signer,1762      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1763      true,1764    );1765    const collection = this.getCollectionObject(collectionId);1766    return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1767  }17681769  /**1770   * Destroys a concrete instance of RFT.1771   * @param signer keyring of signer1772   * @param collectionId ID of collection1773   * @param tokenId ID of token1774   * @param amount number of pieces to be burnt1775   * @example burnToken(aliceKeyring, 10, 5);1776   * @returns ```true``` if the extrinsic is successful, otherwise ```false```1777   */1778  async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1779    return await super.burnToken(signer, collectionId, tokenId, amount);1780  }17811782  /**1783   * Destroys a concrete instance of RFT on behalf of the owner.1784   * @param signer keyring of signer1785   * @param collectionId ID of collection1786   * @param tokenId ID of token1787   * @param fromAddressObj address on behalf of which the token will be burnt1788   * @param amount number of pieces to be burnt1789   * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1790   * @returns ```true``` if extrinsic success, otherwise ```false```1791   */1792  async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1793    return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1794  }17951796  /**1797   * Set, change, or remove approved address to transfer the ownership of the RFT.1798   *1799   * @param signer keyring of signer1800   * @param collectionId ID of collection1801   * @param tokenId ID of token1802   * @param toAddressObj address to approve1803   * @param amount number of pieces to be approved1804   * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1805   * @returns true if the token success, otherwise false1806   */1807  async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1808    return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1809  }18101811  /**1812   * Get total number of pieces1813   * @param collectionId ID of collection1814   * @param tokenId ID of token1815   * @example getTokenTotalPieces(10, 5);1816   * @returns number of pieces1817   */1818  async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1819    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1820  }18211822  /**1823   * Change number of token pieces. Signer must be the owner of all token pieces.1824   * @param signer keyring of signer1825   * @param collectionId ID of collection1826   * @param tokenId ID of token1827   * @param amount new number of pieces1828   * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1829   * @returns true if the repartion was success, otherwise false1830   */1831  async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1832    const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1833    const repartitionResult = await this.helper.executeExtrinsic(1834      signer,1835      'api.tx.unique.repartition', [collectionId, tokenId, amount],1836      true,1837    );1838    if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1839    return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1840  }1841}184218431844class FTGroup extends CollectionGroup {1845  /**1846   * Get collection object1847   * @param collectionId ID of collection1848   * @example getCollectionObject(2);1849   * @returns instance of UniqueFTCollection1850   */1851  getCollectionObject(collectionId: number): UniqueFTCollection {1852    return new UniqueFTCollection(collectionId, this.helper);1853  }18541855  /**1856   * Mint new fungible collection1857   * @param signer keyring of signer1858   * @param collectionOptions Collection options1859   * @param decimalPoints number of token decimals1860   * @example1861   * mintCollection(aliceKeyring, {1862   *   name: 'New',1863   *   description: 'New collection',1864   *   tokenPrefix: 'NEW',1865   * }, 18)1866   * @returns newly created fungible collection1867   */1868  async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {1869    collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1870    if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1871    collectionOptions.mode = {fungible: decimalPoints};1872    for (const key of ['name', 'description', 'tokenPrefix']) {1873      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);1874    }1875    const creationResult = await this.helper.executeExtrinsic(1876      signer,1877      'api.tx.unique.createCollectionEx', [collectionOptions],1878      true,1879    );1880    return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1881  }18821883  /**1884   * Mint tokens1885   * @param signer keyring of signer1886   * @param collectionId ID of collection1887   * @param owner address owner of new tokens1888   * @param amount amount of tokens to be meanted1889   * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1890   * @returns ```true``` if extrinsic success, otherwise ```false```1891   */1892  async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1893    const creationResult = await this.helper.executeExtrinsic(1894      signer,1895      'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1896        fungible: {1897          value: amount,1898        },1899      }],1900      true, // `Unable to mint fungible tokens for ${label}`,1901    );1902    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1903  }19041905  /**1906   * Mint multiple Fungible tokens with one owner1907   * @param signer keyring of signer1908   * @param collectionId ID of collection1909   * @param owner tokens owner1910   * @param tokens array of tokens with properties and pieces1911   * @returns ```true``` if extrinsic success, otherwise ```false```1912   */1913  async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1914    const rawTokens = [];1915    for (const token of tokens) {1916      const raw = {Fungible: {Value: token.value}};1917      rawTokens.push(raw);1918    }1919    const creationResult = await this.helper.executeExtrinsic(1920      signer,1921      'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1922      true,1923    );1924    return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1925  }19261927  /**1928   * Get the top 10 owners with the largest balance for the Fungible collection1929   * @param collectionId ID of collection1930   * @example getTop10Owners(10);1931   * @returns array of ```ICrossAccountId```1932   */1933  async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {1934    return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1935  }19361937  /**1938   * Get account balance1939   * @param collectionId ID of collection1940   * @param addressObj address of owner1941   * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1942   * @returns amount of fungible tokens owned by address1943   */1944  async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1945    return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1946  }19471948  /**1949   * Transfer tokens to address1950   * @param signer keyring of signer1951   * @param collectionId ID of collection1952   * @param toAddressObj address recipient1953   * @param amount amount of tokens to be sent1954   * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1955   * @returns ```true``` if extrinsic success, otherwise ```false```1956   */1957  async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1958    return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1959  }19601961  /**1962   * Transfer some tokens on behalf of the owner.1963   * @param signer keyring of signer1964   * @param collectionId ID of collection1965   * @param fromAddressObj address on behalf of which tokens will be sent1966   * @param toAddressObj address where token to be sent1967   * @param amount number of tokens to be sent1968   * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1969   * @returns ```true``` if extrinsic success, otherwise ```false```1970   */1971  async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1972    return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1973  }19741975  /**1976   * Destroy some amount of tokens1977   * @param signer keyring of signer1978   * @param collectionId ID of collection1979   * @param amount amount of tokens to be destroyed1980   * @example burnTokens(aliceKeyring, 10, 1000n);1981   * @returns ```true``` if extrinsic success, otherwise ```false```1982   */1983  async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1984    return await super.burnToken(signer, collectionId, 0, amount);1985  }19861987  /**1988   * Burn some tokens on behalf of the owner.1989   * @param signer keyring of signer1990   * @param collectionId ID of collection1991   * @param fromAddressObj address on behalf of which tokens will be burnt1992   * @param amount amount of tokens to be burnt1993   * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1994   * @returns ```true``` if extrinsic success, otherwise ```false```1995   */1996  async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1997    return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);1998  }19992000  /**2001   * Get total collection supply2002   * @param collectionId2003   * @returns2004   */2005  async getTotalPieces(collectionId: number): Promise<bigint> {2006    return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();2007  }20082009  /**2010   * Set, change, or remove approved address to transfer tokens.2011   *2012   * @param signer keyring of signer2013   * @param collectionId ID of collection2014   * @param toAddressObj address to be approved2015   * @param amount amount of tokens to be approved2016   * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)2017   * @returns ```true``` if extrinsic success, otherwise ```false```2018   */2019  async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2020    return super.approveToken(signer, collectionId, 0, toAddressObj, amount);2021  }20222023  /**2024   * Get amount of fungible tokens approved to transfer2025   * @param collectionId ID of collection2026   * @param fromAddressObj owner of tokens2027   * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner2028   * @returns number of tokens approved for the transfer2029   */2030  async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2031    return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2032  }2033}203420352036class ChainGroup extends HelperGroup<ChainHelperBase> {2037  /**2038   * Get system properties of a chain2039   * @example getChainProperties();2040   * @returns ss58Format, token decimals, and token symbol2041   */2042  getChainProperties(): IChainProperties {2043    const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2044    return {2045      ss58Format: properties.ss58Format.toJSON(),2046      tokenDecimals: properties.tokenDecimals.toJSON(),2047      tokenSymbol: properties.tokenSymbol.toJSON(),2048    };2049  }20502051  /**2052   * Get chain header2053   * @example getLatestBlockNumber();2054   * @returns the number of the last block2055   */2056  async getLatestBlockNumber(): Promise<number> {2057    return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2058  }20592060  /**2061   * Get block hash by block number2062   * @param blockNumber number of block2063   * @example getBlockHashByNumber(12345);2064   * @returns hash of a block2065   */2066  async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2067    const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2068    if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2069    return blockHash;2070  }20712072  // TODO add docs2073  async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2074    const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2075    if (!blockHash) return null;2076    return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2077  }20782079  /**2080   * Get account nonce2081   * @param address substrate address2082   * @example getNonce("5GrwvaEF5zXb26Fz...");2083   * @returns number, account's nonce2084   */2085  async getNonce(address: TSubstrateAccount): Promise<number> {2086    return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2087  }2088}20892090class SubstrateBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2091  /**2092 * Get substrate address balance2093 * @param address substrate address2094 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2095 * @returns amount of tokens on address2096 */2097  async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2098    return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2099  }21002101  /**2102   * Transfer tokens to substrate address2103   * @param signer keyring of signer2104   * @param address substrate address of a recipient2105   * @param amount amount of tokens to be transfered2106   * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2107   * @returns ```true``` if extrinsic success, otherwise ```false```2108   */2109  async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2110    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}`*/);21112112    let transfer = {from: null, to: null, amount: 0n} as any;2113    result.result.events.forEach(({event: {data, method, section}}) => {2114      if ((section === 'balances') && (method === 'Transfer')) {2115        transfer = {2116          from: this.helper.address.normalizeSubstrate(data[0]),2117          to: this.helper.address.normalizeSubstrate(data[1]),2118          amount: BigInt(data[2]),2119        };2120      }2121    });2122    const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from 2123      && this.helper.address.normalizeSubstrate(address) === transfer.to 2124      && BigInt(amount) === transfer.amount;2125    return isSuccess;2126  }21272128  /**2129   * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2130   * @param address substrate address2131   * @returns2132   */2133  async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2134    const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2135    return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2136  }2137}21382139class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2140  /**2141   * Get ethereum address balance2142   * @param address ethereum address2143   * @example getEthereum("0x9F0583DbB855d...")2144   * @returns amount of tokens on address2145   */2146  async getEthereum(address: TEthereumAccount): Promise<bigint> {2147    return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2148  }21492150  /**2151   * Transfer tokens to address2152   * @param signer keyring of signer2153   * @param address Ethereum address of a recipient2154   * @param amount amount of tokens to be transfered2155   * @example transferToEthereum(alithKeyring, "0x9F0583DbB855d...", 100_000_000_000n);2156   * @returns ```true``` if extrinsic success, otherwise ```false```2157   */2158  async transferToEthereum(signer: TSigner, address: TEthereumAccount, amount: bigint | string): Promise<boolean> {2159    const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true);21602161    let transfer = {from: null, to: null, amount: 0n} as any;2162    result.result.events.forEach(({event: {data, method, section}}) => {2163      if ((section === 'balances') && (method === 'Transfer')) {2164        transfer = {2165          from: data[0].toString(),2166          to: data[1].toString(),2167          amount: BigInt(data[2]),2168        };2169      }2170    });2171    const isSuccess = (typeof signer === 'string' ? signer : signer.address) === transfer.from 2172      && address === transfer.to 2173      && BigInt(amount) === transfer.amount;2174    return isSuccess;2175  }2176}21772178class BalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2179  subBalanceGroup: SubstrateBalanceGroup<T>;2180  ethBalanceGroup: EthereumBalanceGroup<T>;21812182  constructor(helper: T) {2183    super(helper);2184    this.subBalanceGroup = new SubstrateBalanceGroup(helper);2185    this.ethBalanceGroup = new EthereumBalanceGroup(helper);2186  }21872188  getCollectionCreationPrice(): bigint {2189    return 2n * this.getOneTokenNominal();2190  }2191  /**2192   * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2193   * @example getOneTokenNominal()2194   * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2195   */2196  getOneTokenNominal(): bigint {2197    const chainProperties = this.helper.chain.getChainProperties();2198    return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2199  }22002201  /**2202   * Get substrate address balance2203   * @param address substrate address2204   * @example getSubstrate("5GrwvaEF5zXb26Fz...")2205   * @returns amount of tokens on address2206   */2207  async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2208    return this.subBalanceGroup.getSubstrate(address);2209  }22102211  /**2212   * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2213   * @param address substrate address2214   * @returns2215   */2216  async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2217    return this.subBalanceGroup.getSubstrateFull(address);2218  }22192220  /**2221   * Get ethereum address balance2222   * @param address ethereum address2223   * @example getEthereum("0x9F0583DbB855d...")2224   * @returns amount of tokens on address2225   */2226  async getEthereum(address: TEthereumAccount): Promise<bigint> {2227    return this.ethBalanceGroup.getEthereum(address);2228  }22292230  /**2231   * Transfer tokens to substrate address2232   * @param signer keyring of signer2233   * @param address substrate address of a recipient2234   * @param amount amount of tokens to be transfered2235   * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2236   * @returns ```true``` if extrinsic success, otherwise ```false```2237   */2238  async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2239    return this.subBalanceGroup.transferToSubstrate(signer, address, amount);2240  }2241}22422243class AddressGroup extends HelperGroup<ChainHelperBase> {2244  /**2245   * Normalizes the address to the specified ss58 format, by default ```42```.2246   * @param address substrate address2247   * @param ss58Format format for address conversion, by default ```42```2248   * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2249   * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2250   */2251  normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2252    return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2253  }22542255  /**2256   * Get address in the connected chain format2257   * @param address substrate address2258   * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2259   * @returns address in chain format2260   */2261  normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2262    return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2263  }22642265  /**2266   * Get substrate mirror of an ethereum address2267   * @param ethAddress ethereum address2268   * @param toChainFormat false for normalized account2269   * @example ethToSubstrate('0x9F0583DbB855d...')2270   * @returns substrate mirror of a provided ethereum address2271   */2272  ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2273    return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2274  }22752276  /**2277   * Get ethereum mirror of a substrate address2278   * @param subAddress substrate account2279   * @example substrateToEth("5DnSF6RRjwteE3BrC...")2280   * @returns ethereum mirror of a provided substrate address2281   */2282  substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2283    return CrossAccountId.translateSubToEth(subAddress);2284  }2285}22862287class StakingGroup extends HelperGroup<UniqueHelper> {2288  /**2289   * Stake tokens for App Promotion2290   * @param signer keyring of signer2291   * @param amountToStake amount of tokens to stake2292   * @param label extra label for log2293   * @returns2294   */2295  async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2296    if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2297    const _stakeResult = await this.helper.executeExtrinsic(2298      signer, 'api.tx.appPromotion.stake',2299      [amountToStake], true,2300    );2301    // TODO extract info from stakeResult2302    return true;2303  }23042305  /**2306   * Unstake tokens for App Promotion2307   * @param signer keyring of signer2308   * @param amountToUnstake amount of tokens to unstake2309   * @param label extra label for log2310   * @returns block number where balances will be unlocked2311   */2312  async unstake(signer: TSigner, label?: string): Promise<number> {2313    if(typeof label === 'undefined') label = `${signer.address}`;2314    const _unstakeResult = await this.helper.executeExtrinsic(2315      signer, 'api.tx.appPromotion.unstake',2316      [], true,2317    );2318    // TODO extract block number fron events2319    return 1;2320  }23212322  /**2323   * Get total staked amount for address2324   * @param address substrate or ethereum address2325   * @returns total staked amount2326   */2327  async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2328    if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2329    return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2330  }23312332  /**2333   * Get total staked per block2334   * @param address substrate or ethereum address2335   * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2336   */2337  async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2338    const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2339    return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2340      return { 2341        block: block.toBigInt(),2342        amount: amount.toBigInt(),2343      };2344    });2345  }23462347  /**2348   * Get total pending unstake amount for address2349   * @param address substrate or ethereum address2350   * @returns total pending unstake amount2351   */2352  async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2353    return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2354  }23552356  /**2357   * Get pending unstake amount per block for address2358   * @param address substrate or ethereum address2359   * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2360   */2361  async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2362    const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2363    const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2364      return {2365        block: block.toBigInt(),2366        amount: amount.toBigInt(),2367      };2368    });2369    return result;2370  }2371}23722373class SchedulerGroup extends HelperGroup<UniqueHelper> {2374  constructor(helper: UniqueHelper) {2375    super(helper);2376  }23772378  async cancelScheduled(signer: TSigner, scheduledId: string) {2379    return this.helper.executeExtrinsic(2380      signer,2381      'api.tx.scheduler.cancelNamed',2382      [scheduledId],2383      true,2384    );2385  }23862387  async changePriority(signer: TSigner, scheduledId: string, priority: number) {2388    return this.helper.executeExtrinsic(2389      signer,2390      'api.tx.scheduler.changeNamedPriority',2391      [scheduledId, priority],2392      true,2393    );2394  }23952396  scheduleAt<T extends UniqueHelper>(2397    scheduledId: string,2398    executionBlockNumber: number,2399    options: ISchedulerOptions = {},2400  ) {2401    return this.schedule<T>('scheduleNamed', scheduledId, executionBlockNumber, options);2402  }24032404  scheduleAfter<T extends UniqueHelper>(2405    scheduledId: string,2406    blocksBeforeExecution: number,2407    options: ISchedulerOptions = {},2408  ) {2409    return this.schedule<T>('scheduleNamedAfter', scheduledId, blocksBeforeExecution, options);2410  }24112412  schedule<T extends UniqueHelper>(2413    scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter',2414    scheduledId: string,2415    blocksNum: number,2416    options: ISchedulerOptions = {},2417  ) {2418    // eslint-disable-next-line @typescript-eslint/naming-convention2419    const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2420    return this.helper.clone(ScheduledHelperType, {2421      scheduleFn,2422      scheduledId,2423      blocksNum,2424      options,2425    }) as T;2426  }2427}24282429class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {2430  async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {2431    await this.helper.executeExtrinsic(2432      signer,2433      'api.tx.foreignAssets.registerForeignAsset',2434      [ownerAddress, location, metadata],2435      true,2436    );2437  }24382439  async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {2440    await this.helper.executeExtrinsic(2441      signer,2442      'api.tx.foreignAssets.updateForeignAsset',2443      [foreignAssetId, location, metadata],2444      true,2445    );2446  }2447}24482449class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {2450  palletName: string;24512452  constructor(helper: T, palletName: string) {2453    super(helper);24542455    this.palletName = palletName;2456  }24572458  async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: number) {2459    await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, {Limited: weightLimit}], true);2460  }2461}24622463class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2464  async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: number) {2465    await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);2466  }24672468  async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: number) {2469    await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);2470  }2471}24722473class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2474  async accounts(address: string, currencyId: any) {2475    const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;2476    return BigInt(free);2477  }2478}24792480class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {2481  async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {2482    await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);2483  }2484}24852486class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {2487  makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {2488    const apiPrefix = 'api.tx.assetManager.';24892490    const registerTx = this.helper.constructApiCall(2491      apiPrefix + 'registerForeignAsset',2492      [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],2493    );24942495    const setUnitsTx = this.helper.constructApiCall(2496      apiPrefix + 'setAssetUnitsPerSecond',2497      [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],2498    );24992500    const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);2501    const encodedProposal = batchCall?.method.toHex() || '';2502    return encodedProposal;2503  }25042505  async assetTypeId(location: any) {2506    return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);2507  }2508}25092510class MoonbeamAssetsGroup extends HelperGroup<MoonbeamHelper> {2511  async account(assetId: string, address: string) {2512    const accountAsset = (2513      await this.helper.callRpc('api.query.assets.account', [assetId, address])2514    ).toJSON()! as any;25152516    if (accountAsset !== null) {2517      return BigInt(accountAsset['balance']);2518    } else {2519      return null;2520    }2521  }2522}25232524class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {2525  async notePreimage(signer: TSigner, encodedProposal: string) {2526    await this.helper.executeExtrinsic(signer, 'api.tx.democracy.notePreimage', [encodedProposal], true);2527  }25282529  externalProposeMajority(proposalHash: string) {2530    return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposalHash]);2531  }25322533  fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {2534    return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);2535  }25362537  async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {2538    await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);2539  }2540}25412542class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {2543  collective: string;25442545  constructor(helper: MoonbeamHelper, collective: string) {2546    super(helper);25472548    this.collective = collective;2549  }25502551  async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {2552    await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);2553  }25542555  async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {2556    await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);2557  }25582559  async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: number, lengthBound: number) {2560    await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);2561  }25622563  async proposalCount() {2564    return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));2565  }2566}25672568export type ChainHelperBaseConstructor = new(...args: any[]) => ChainHelperBase;2569export type UniqueHelperConstructor = new(...args: any[]) => UniqueHelper;25702571export class UniqueHelper extends ChainHelperBase {2572  balance: BalanceGroup<UniqueHelper>;2573  collection: CollectionGroup;2574  nft: NFTGroup;2575  rft: RFTGroup;2576  ft: FTGroup;2577  staking: StakingGroup;2578  scheduler: SchedulerGroup;2579  foreignAssets: ForeignAssetsGroup;2580  xcm: XcmGroup<UniqueHelper>;2581  xTokens: XTokensGroup<UniqueHelper>;2582  tokens: TokensGroup<UniqueHelper>;25832584  constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2585    super(logger, options.helperBase ?? UniqueHelper);25862587    this.balance = new BalanceGroup(this);2588    this.address = new AddressGroup(this);2589    this.collection = new CollectionGroup(this);2590    this.nft = new NFTGroup(this);2591    this.rft = new RFTGroup(this);2592    this.ft = new FTGroup(this);2593    this.staking = new StakingGroup(this);2594    this.scheduler = new SchedulerGroup(this);2595    this.foreignAssets = new ForeignAssetsGroup(this);2596    this.xcm = new XcmGroup(this, 'polkadotXcm');2597    this.xTokens = new XTokensGroup(this);2598    this.tokens = new TokensGroup(this);2599  }26002601  getSudo<T extends UniqueHelper>() {2602    // eslint-disable-next-line @typescript-eslint/naming-convention2603    const SudoHelperType = SudoHelper(this.helperBase);2604    return this.clone(SudoHelperType) as T;2605  }2606}26072608export class XcmChainHelper extends ChainHelperBase {2609  async connect(wsEndpoint: string, _listeners?: any): Promise<void> {2610    const wsProvider = new WsProvider(wsEndpoint);2611    this.api = new ApiPromise({2612      provider: wsProvider,2613    });2614    await this.api.isReadyOrError;2615    this.network = await UniqueHelper.detectNetwork(this.api);2616  }2617}26182619export class RelayHelper extends XcmChainHelper {2620  xcm: XcmGroup<RelayHelper>;26212622  constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2623    super(logger, options.helperBase ?? RelayHelper);26242625    this.xcm = new XcmGroup(this, 'xcmPallet');2626  }2627}26282629export class MoonbeamHelper extends XcmChainHelper {2630  balance: EthereumBalanceGroup<MoonbeamHelper>;2631  assetManager: MoonbeamAssetManagerGroup;2632  assets: MoonbeamAssetsGroup;2633  xTokens: XTokensGroup<MoonbeamHelper>;2634  democracy: MoonbeamDemocracyGroup;2635  collective: {2636    council: MoonbeamCollectiveGroup,2637    techCommittee: MoonbeamCollectiveGroup,2638  };26392640  constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2641    super(logger, options.helperBase ?? MoonbeamHelper);26422643    this.balance = new EthereumBalanceGroup(this);2644    this.assetManager = new MoonbeamAssetManagerGroup(this);2645    this.assets = new MoonbeamAssetsGroup(this);2646    this.xTokens = new XTokensGroup(this);2647    this.democracy = new MoonbeamDemocracyGroup(this);2648    this.collective = {2649      council: new MoonbeamCollectiveGroup(this, 'councilCollective'),2650      techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),2651    };2652  }2653}26542655export class AcalaHelper extends XcmChainHelper {2656  balance: SubstrateBalanceGroup<AcalaHelper>;2657  assetRegistry: AcalaAssetRegistryGroup;2658  xTokens: XTokensGroup<AcalaHelper>;2659  tokens: TokensGroup<AcalaHelper>;26602661  constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2662    super(logger, options.helperBase ?? AcalaHelper);26632664    this.balance = new SubstrateBalanceGroup(this);2665    this.assetRegistry = new AcalaAssetRegistryGroup(this);2666    this.xTokens = new XTokensGroup(this);2667    this.tokens = new TokensGroup(this);2668  }26692670  getSudo<T extends AcalaHelper>() {2671    // eslint-disable-next-line @typescript-eslint/naming-convention2672    const SudoHelperType = SudoHelper(this.helperBase);2673    return this.clone(SudoHelperType) as T;2674  }2675}26762677// eslint-disable-next-line @typescript-eslint/naming-convention2678function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {2679  return class extends Base {2680    scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter';2681    scheduledId: string;2682    blocksNum: number;2683    options: ISchedulerOptions;26842685    constructor(...args: any[]) {2686      const logger = args[0] as ILogger;2687      const options = args[1] as {2688        scheduleFn: 'scheduleNamed' | 'scheduleNamedAfter',2689        scheduledId: string,2690        blocksNum: number,2691        options: ISchedulerOptions2692      };26932694      super(logger);26952696      this.scheduleFn = options.scheduleFn;2697      this.scheduledId = options.scheduledId;2698      this.blocksNum = options.blocksNum;2699      this.options = options.options;2700    }27012702    executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {2703      const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);2704      const extrinsic = 'api.tx.scheduler.' +  this.scheduleFn;27052706      return super.executeExtrinsic(2707        sender,2708        extrinsic,2709        [2710          this.scheduledId,2711          this.blocksNum,2712          this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,2713          this.options.priority ?? null,2714          {Value: scheduledTx},2715        ],2716        expectSuccess,2717      );2718    }2719  };2720}27212722// eslint-disable-next-line @typescript-eslint/naming-convention2723function SudoHelper<T extends ChainHelperBaseConstructor>(Base: T) {2724  return class extends Base {2725    constructor(...args: any[]) {2726      super(...args);2727    }27282729    executeExtrinsic (2730      sender: IKeyringPair,2731      extrinsic: string,2732      params: any[],2733      expectSuccess?: boolean,2734    ): Promise<ITransactionResult> {2735      const call = this.constructApiCall(extrinsic, params);27362737      return super.executeExtrinsic(2738        sender,2739        'api.tx.sudo.sudo',2740        [call],2741        expectSuccess,2742      );2743    }2744  };2745}27462747export class UniqueBaseCollection {2748  helper: UniqueHelper;2749  collectionId: number;27502751  constructor(collectionId: number, uniqueHelper: UniqueHelper) {2752    this.collectionId = collectionId;2753    this.helper = uniqueHelper;2754  }27552756  async getData() {2757    return await this.helper.collection.getData(this.collectionId);2758  }27592760  async getLastTokenId() {2761    return await this.helper.collection.getLastTokenId(this.collectionId);2762  }27632764  async doesTokenExist(tokenId: number) {2765    return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);2766  }27672768  async getAdmins() {2769    return await this.helper.collection.getAdmins(this.collectionId);2770  }27712772  async getAllowList() {2773    return await this.helper.collection.getAllowList(this.collectionId);2774  }27752776  async getEffectiveLimits() {2777    return await this.helper.collection.getEffectiveLimits(this.collectionId);2778  }27792780  async getProperties(propertyKeys?: string[] | null) {2781    return await this.helper.collection.getProperties(this.collectionId, propertyKeys);2782  }27832784  async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2785    return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2786  }27872788  async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2789    return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2790  }27912792  async confirmSponsorship(signer: TSigner) {2793    return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2794  }27952796  async removeSponsor(signer: TSigner) {2797    return await this.helper.collection.removeSponsor(signer, this.collectionId);2798  }27992800  async setLimits(signer: TSigner, limits: ICollectionLimits) {2801    return await this.helper.collection.setLimits(signer, this.collectionId, limits);2802  }28032804  async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2805    return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2806  }28072808  async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2809    return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2810  }28112812  async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2813    return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2814  }28152816  async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2817    return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2818  }28192820  async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2821    return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2822  }28232824  async setProperties(signer: TSigner, properties: IProperty[]) {2825    return await this.helper.collection.setProperties(signer, this.collectionId, properties);2826  }28272828  async deleteProperties(signer: TSigner, propertyKeys: string[]) {2829    return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2830  }28312832  async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2833    return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2834  }28352836  async enableNesting(signer: TSigner, permissions: INestingPermissions) {2837    return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2838  }28392840  async disableNesting(signer: TSigner) {2841    return await this.helper.collection.disableNesting(signer, this.collectionId);2842  }28432844  async burn(signer: TSigner) {2845    return await this.helper.collection.burn(signer, this.collectionId);2846  }28472848  scheduleAt<T extends UniqueHelper>(2849    scheduledId: string,2850    executionBlockNumber: number,2851    options: ISchedulerOptions = {},2852  ) {2853    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2854    return new UniqueBaseCollection(this.collectionId, scheduledHelper);2855  }28562857  scheduleAfter<T extends UniqueHelper>(2858    scheduledId: string,2859    blocksBeforeExecution: number,2860    options: ISchedulerOptions = {},2861  ) {2862    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2863    return new UniqueBaseCollection(this.collectionId, scheduledHelper);2864  }28652866  getSudo<T extends UniqueHelper>() {2867    return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());2868  }2869}287028712872export class UniqueNFTCollection extends UniqueBaseCollection {2873  getTokenObject(tokenId: number) {2874    return new UniqueNFToken(tokenId, this);2875  }28762877  async getTokensByAddress(addressObj: ICrossAccountId) {2878    return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2879  }28802881  async getToken(tokenId: number, blockHashAt?: string) {2882    return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2883  }28842885  async getTokenOwner(tokenId: number, blockHashAt?: string) {2886    return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2887  }28882889  async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2890    return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2891  }28922893  async getTokenChildren(tokenId: number, blockHashAt?: string) {2894    return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2895  }28962897  async getPropertyPermissions(propertyKeys: string[] | null = null) {2898    return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);2899  }29002901  async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {2902    return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2903  }29042905  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2906    return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2907  }29082909  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2910    return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2911  }29122913  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2914    return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2915  }29162917  async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2918    return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2919  }29202921  async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2922    return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2923  }29242925  async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2926    return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2927  }29282929  async burnToken(signer: TSigner, tokenId: number) {2930    return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2931  }29322933  async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {2934    return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);2935  }29362937  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2938    return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2939  }29402941  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2942    return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2943  }29442945  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2946    return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2947  }29482949  async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2950    return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2951  }29522953  async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2954    return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2955  }29562957  scheduleAt<T extends UniqueHelper>(2958    scheduledId: string,2959    executionBlockNumber: number,2960    options: ISchedulerOptions = {},2961  ) {2962    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);2963    return new UniqueNFTCollection(this.collectionId, scheduledHelper);2964  }29652966  scheduleAfter<T extends UniqueHelper>(2967    scheduledId: string,2968    blocksBeforeExecution: number,2969    options: ISchedulerOptions = {},2970  ) {2971    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);2972    return new UniqueNFTCollection(this.collectionId, scheduledHelper);2973  }29742975  getSudo<T extends UniqueHelper>() {2976    return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());2977  }2978}297929802981export class UniqueRFTCollection extends UniqueBaseCollection {2982  getTokenObject(tokenId: number) {2983    return new UniqueRFToken(tokenId, this);2984  }29852986  async getToken(tokenId: number, blockHashAt?: string) {2987    return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);2988  }29892990  async getTokensByAddress(addressObj: ICrossAccountId) {2991    return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2992  }29932994  async getTop10TokenOwners(tokenId: number) {2995    return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2996  }29972998  async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2999    return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);3000  }30013002  async getTokenTotalPieces(tokenId: number) {3003    return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);3004  }30053006  async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3007    return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);3008  }30093010  async getPropertyPermissions(propertyKeys: string[] | null = null) {3011    return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);3012  }30133014  async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3015    return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3016  }30173018  async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {3019    return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);3020  }30213022  async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3023    return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);3024  }30253026  async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {3027    return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);3028  }30293030  async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {3031    return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);3032  }30333034  async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3035    return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});3036  }30373038  async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {3039    return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);3040  }30413042  async burnToken(signer: TSigner, tokenId: number, amount=1n) {3043    return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);3044  }30453046  async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId,  amount=1n) {3047    return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);3048  }30493050  async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3051    return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);3052  }30533054  async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3055    return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3056  }30573058  async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3059    return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3060  }30613062  scheduleAt<T extends UniqueHelper>(3063    scheduledId: string,3064    executionBlockNumber: number,3065    options: ISchedulerOptions = {},3066  ) {3067    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);3068    return new UniqueRFTCollection(this.collectionId, scheduledHelper);3069  }30703071  scheduleAfter<T extends UniqueHelper>(3072    scheduledId: string,3073    blocksBeforeExecution: number,3074    options: ISchedulerOptions = {},3075  ) {3076    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);3077    return new UniqueRFTCollection(this.collectionId, scheduledHelper);3078  }30793080  getSudo<T extends UniqueHelper>() {3081    return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());3082  }3083}308430853086export class UniqueFTCollection extends UniqueBaseCollection {3087  async getBalance(addressObj: ICrossAccountId) {3088    return await this.helper.ft.getBalance(this.collectionId, addressObj);3089  }30903091  async getTotalPieces() {3092    return await this.helper.ft.getTotalPieces(this.collectionId);3093  }30943095  async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3096    return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);3097  }30983099  async getTop10Owners() {3100    return await this.helper.ft.getTop10Owners(this.collectionId);3101  }31023103  async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {3104    return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);3105  }31063107  async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {3108    return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);3109  }31103111  async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3112    return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);3113  }31143115  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3116    return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);3117  }31183119  async burnTokens(signer: TSigner, amount=1n) {3120    return await this.helper.ft.burnTokens(signer, this.collectionId, amount);3121  }31223123  async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3124    return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);3125  }31263127  async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3128    return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);3129  }31303131  scheduleAt<T extends UniqueHelper>(3132    scheduledId: string,3133    executionBlockNumber: number,3134    options: ISchedulerOptions = {},3135  ) {3136    const scheduledHelper = this.helper.scheduler.scheduleAt<T>(scheduledId, executionBlockNumber, options);3137    return new UniqueFTCollection(this.collectionId, scheduledHelper);3138  }31393140  scheduleAfter<T extends UniqueHelper>(3141    scheduledId: string,3142    blocksBeforeExecution: number,3143    options: ISchedulerOptions = {},3144  ) {3145    const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);3146    return new UniqueFTCollection(this.collectionId, scheduledHelper);3147  }31483149  getSudo<T extends UniqueHelper>() {3150    return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());3151  }3152}315331543155export class UniqueBaseToken {3156  collection: UniqueNFTCollection | UniqueRFTCollection;3157  collectionId: number;3158  tokenId: number;31593160  constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {3161    this.collection = collection;3162    this.collectionId = collection.collectionId;3163    this.tokenId = tokenId;3164  }31653166  async getNextSponsored(addressObj: ICrossAccountId) {3167    return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);3168  }31693170  async getProperties(propertyKeys?: string[] | null) {3171    return await this.collection.getTokenProperties(this.tokenId, propertyKeys);3172  }31733174  async setProperties(signer: TSigner, properties: IProperty[]) {3175    return await this.collection.setTokenProperties(signer, this.tokenId, properties);3176  }31773178  async deleteProperties(signer: TSigner, propertyKeys: string[]) {3179    return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);3180  }31813182  async doesExist() {3183    return await this.collection.doesTokenExist(this.tokenId);3184  }31853186  nestingAccount() {3187    return this.collection.helper.util.getTokenAccount(this);3188  }31893190  scheduleAt<T extends UniqueHelper>(3191    scheduledId: string,3192    executionBlockNumber: number,3193    options: ISchedulerOptions = {},3194  ) {3195    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);3196    return new UniqueBaseToken(this.tokenId, scheduledCollection);3197  }31983199  scheduleAfter<T extends UniqueHelper>(3200    scheduledId: string,3201    blocksBeforeExecution: number,3202    options: ISchedulerOptions = {},3203  ) {3204    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);3205    return new UniqueBaseToken(this.tokenId, scheduledCollection);3206  }32073208  getSudo<T extends UniqueHelper>() {3209    return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());3210  }3211}321232133214export class UniqueNFToken extends UniqueBaseToken {3215  collection: UniqueNFTCollection;32163217  constructor(tokenId: number, collection: UniqueNFTCollection) {3218    super(tokenId, collection);3219    this.collection = collection;3220  }32213222  async getData(blockHashAt?: string) {3223    return await this.collection.getToken(this.tokenId, blockHashAt);3224  }32253226  async getOwner(blockHashAt?: string) {3227    return await this.collection.getTokenOwner(this.tokenId, blockHashAt);3228  }32293230  async getTopmostOwner(blockHashAt?: string) {3231    return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);3232  }32333234  async getChildren(blockHashAt?: string) {3235    return await this.collection.getTokenChildren(this.tokenId, blockHashAt);3236  }32373238  async nest(signer: TSigner, toTokenObj: IToken) {3239    return await this.collection.nestToken(signer, this.tokenId, toTokenObj);3240  }32413242  async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3243    return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);3244  }32453246  async transfer(signer: TSigner, addressObj: ICrossAccountId) {3247    return await this.collection.transferToken(signer, this.tokenId, addressObj);3248  }32493250  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3251    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);3252  }32533254  async approve(signer: TSigner, toAddressObj: ICrossAccountId) {3255    return await this.collection.approveToken(signer, this.tokenId, toAddressObj);3256  }32573258  async isApproved(toAddressObj: ICrossAccountId) {3259    return await this.collection.isTokenApproved(this.tokenId, toAddressObj);3260  }32613262  async burn(signer: TSigner) {3263    return await this.collection.burnToken(signer, this.tokenId);3264  }32653266  async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {3267    return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);3268  }32693270  scheduleAt<T extends UniqueHelper>(3271    scheduledId: string,3272    executionBlockNumber: number,3273    options: ISchedulerOptions = {},3274  ) {3275    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);3276    return new UniqueNFToken(this.tokenId, scheduledCollection);3277  }32783279  scheduleAfter<T extends UniqueHelper>(3280    scheduledId: string,3281    blocksBeforeExecution: number,3282    options: ISchedulerOptions = {},3283  ) {3284    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);3285    return new UniqueNFToken(this.tokenId, scheduledCollection);3286  }32873288  getSudo<T extends UniqueHelper>() {3289    return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());3290  }3291}32923293export class UniqueRFToken extends UniqueBaseToken {3294  collection: UniqueRFTCollection;32953296  constructor(tokenId: number, collection: UniqueRFTCollection) {3297    super(tokenId, collection);3298    this.collection = collection;3299  }33003301  async getData(blockHashAt?: string) {3302    return await this.collection.getToken(this.tokenId, blockHashAt);3303  }33043305  async getTop10Owners() {3306    return await this.collection.getTop10TokenOwners(this.tokenId);3307  }33083309  async getBalance(addressObj: ICrossAccountId) {3310    return await this.collection.getTokenBalance(this.tokenId, addressObj);3311  }33123313  async getTotalPieces() {3314    return await this.collection.getTokenTotalPieces(this.tokenId);3315  }33163317  async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {3318    return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);3319  }33203321  async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {3322    return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);3323  }33243325  async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3326    return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);3327  }33283329  async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3330    return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);3331  }33323333  async repartition(signer: TSigner, amount: bigint) {3334    return await this.collection.repartitionToken(signer, this.tokenId, amount);3335  }33363337  async burn(signer: TSigner, amount=1n) {3338    return await this.collection.burnToken(signer, this.tokenId, amount);3339  }33403341  async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3342    return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);3343  }33443345  scheduleAt<T extends UniqueHelper>(3346    scheduledId: string,3347    executionBlockNumber: number,3348    options: ISchedulerOptions = {},3349  ) {3350    const scheduledCollection = this.collection.scheduleAt<T>(scheduledId, executionBlockNumber, options);3351    return new UniqueRFToken(this.tokenId, scheduledCollection);3352  }33533354  scheduleAfter<T extends UniqueHelper>(3355    scheduledId: string,3356    blocksBeforeExecution: number,3357    options: ISchedulerOptions = {},3358  ) {3359    const scheduledCollection = this.collection.scheduleAfter<T>(scheduledId, blocksBeforeExecution, options);3360    return new UniqueRFToken(this.tokenId, scheduledCollection);3361  }33623363  getSudo<T extends UniqueHelper>() {3364    return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());3365  }3366}