difftreelog
test(util) replace label with native error message + shift default amounts in functions to 1
in: master
1 file changed
tests/src/util/playgrounds/unique.tsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};202122const nesting = {23 toChecksumAddress(address: string): string {24 if (typeof address === 'undefined') return '';2526 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2728 address = address.toLowerCase().replace(/^0x/i,'');29 const addressHash = keccakAsHex(address).replace(/^0x/i,'');30 const checksumAddress = ['0x'];3132 for (let i = 0; i < address.length; i++) {33 // If ith character is 8 to f then make it uppercase34 if (parseInt(addressHash[i], 16) > 7) {35 checksumAddress.push(address[i].toUpperCase());36 } else {37 checksumAddress.push(address[i]);38 }39 }40 return checksumAddress.join('');41 },42 tokenIdToAddress(collectionId: number, tokenId: number) {43 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);44 },45};4647class UniqueUtil {48 static transactionStatus = {49 NOT_READY: 'NotReady',50 FAIL: 'Fail',51 SUCCESS: 'Success',52 };5354 static chainLogType = {55 EXTRINSIC: 'extrinsic',56 RPC: 'rpc',57 };5859 static getNestingTokenAddress(collectionId: number, tokenId: number) {60 return nesting.tokenIdToAddress(collectionId, tokenId);61 }6263 static getDefaultLogger(): ILogger {64 return {65 log(msg: any, level = 'INFO') {66 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));67 },68 level: {69 ERROR: 'ERROR',70 WARNING: 'WARNING',71 INFO: 'INFO',72 },73 };74 }7576 static vec2str(arr: string[] | number[]) {77 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');78 }7980 static str2vec(string: string) {81 if (typeof string !== 'string') return string;82 return Array.from(string).map(x => x.charCodeAt(0));83 }8485 static fromSeed(seed: string, ss58Format = 42) {86 const keyring = new Keyring({type: 'sr25519', ss58Format});87 return keyring.addFromUri(seed);88 }8990 static normalizeSubstrateAddress(address: string, ss58Format = 42) {91 return encodeAddress(decodeAddress(address), ss58Format);92 }9394 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult, label = 'new collection') {95 if (creationResult.status !== this.transactionStatus.SUCCESS) {96 throw Error(`Unable to create collection for ${label}`);97 }9899 let collectionId = null;100 creationResult.result.events.forEach(({event: {data, method, section}}) => {101 if ((section === 'common') && (method === 'CollectionCreated')) {102 collectionId = parseInt(data[0].toString(), 10);103 }104 });105106 if (collectionId === null) {107 throw Error(`No CollectionCreated event for ${label}`);108 }109110 return collectionId;111 }112113 static extractTokensFromCreationResult(creationResult: ITransactionResult, label = 'new tokens') {114 if (creationResult.status !== this.transactionStatus.SUCCESS) {115 throw Error(`Unable to create tokens for ${label}`);116 }117 let success = false;118 const tokens = [] as any;119 creationResult.result.events.forEach(({event: {data, method, section}}) => {120 if (method === 'ExtrinsicSuccess') {121 success = true;122 } else if ((section === 'common') && (method === 'ItemCreated')) {123 tokens.push({124 collectionId: parseInt(data[0].toString(), 10),125 tokenId: parseInt(data[1].toString(), 10),126 owner: data[2].toJSON(),127 });128 }129 });130 return {success, tokens};131 }132133 static extractTokensFromBurnResult(burnResult: ITransactionResult, label = 'burned tokens') {134 if (burnResult.status !== this.transactionStatus.SUCCESS) {135 throw Error(`Unable to burn tokens for ${label}`);136 }137 let success = false;138 const tokens = [] as any;139 burnResult.result.events.forEach(({event: {data, method, section}}) => {140 if (method === 'ExtrinsicSuccess') {141 success = true;142 } else if ((section === 'common') && (method === 'ItemDestroyed')) {143 tokens.push({144 collectionId: parseInt(data[0].toString(), 10),145 tokenId: parseInt(data[1].toString(), 10),146 owner: data[2].toJSON(),147 });148 }149 });150 return {success, tokens};151 }152153 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string, label?: string) {154 let eventId = null;155 events.forEach(({event: {data, method, section}}) => {156 if ((section === expectedSection) && (method === expectedMethod)) {157 eventId = parseInt(data[0].toString(), 10);158 }159 });160161 if (eventId === null) {162 throw Error(`No ${expectedMethod} event for ${label}`);163 }164 return eventId === collectionId;165 }166167 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {168 const normalizeAddress = (address: string | ICrossAccountId) => {169 if(typeof address === 'string') return address;170 const obj = {} as any;171 Object.keys(address).forEach(k => {172 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];173 });174 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};175 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};176 return address;177 };178 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;179 events.forEach(({event: {data, method, section}}) => {180 if ((section === 'common') && (method === 'Transfer')) {181 const hData = (data as any).toJSON();182 transfer = {183 collectionId: hData[0],184 tokenId: hData[1],185 from: normalizeAddress(hData[2]),186 to: normalizeAddress(hData[3]),187 amount: BigInt(hData[4]),188 };189 }190 });191 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);193 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);194 isSuccess = isSuccess && amount === transfer.amount;195 return isSuccess;196 }197}198199200class ChainHelperBase {201 transactionStatus = UniqueUtil.transactionStatus;202 chainLogType = UniqueUtil.chainLogType;203 util: typeof UniqueUtil;204 logger: ILogger;205 api: ApiPromise | null;206 forcedNetwork: TUniqueNetworks | null;207 network: TUniqueNetworks | null;208 chainLog: IUniqueHelperLog[];209210 constructor(logger?: ILogger) {211 this.util = UniqueUtil;212 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();213 this.logger = logger;214 this.api = null;215 this.forcedNetwork = null;216 this.network = null;217 this.chainLog = [];218 }219220 clearChainLog(): void {221 this.chainLog = [];222 }223224 forceNetwork(value: TUniqueNetworks): void {225 this.forcedNetwork = value;226 }227228 async connect(wsEndpoint: string, listeners?: IApiListeners) {229 if (this.api !== null) throw Error('Already connected');230 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);231 this.api = api;232 this.network = network;233 }234235 async disconnect() {236 if (this.api === null) return;237 await this.api.disconnect();238 this.api = null;239 this.network = null;240 }241242 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {243 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;244 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;245 return 'opal';246 }247248 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {249 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});250 await api.isReady;251252 const network = await this.detectNetwork(api);253254 await api.disconnect();255256 return network;257 }258259 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 260 api: ApiPromise; 261 network: TUniqueNetworks; 262 }> {263 if(typeof network === 'undefined' || network === null) network = 'opal';264 const supportedRPC = {265 opal: {266 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,267 },268 quartz: {269 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,270 },271 unique: {272 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,273 },274 };275 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);276 const rpc = supportedRPC[network];277278 // TODO: investigate how to replace rpc in runtime279 // api._rpcCore.addUserInterfaces(rpc);280281 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});282283 await api.isReadyOrError;284285 if (typeof listeners === 'undefined') listeners = {};286 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {287 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;288 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);289 }290291 return {api, network};292 }293294 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {295 const {events, status} = data;296 if (status.isReady) {297 return this.transactionStatus.NOT_READY;298 }299 if (status.isBroadcast) {300 return this.transactionStatus.NOT_READY;301 }302 if (status.isInBlock || status.isFinalized) {303 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');304 if (errors.length > 0) {305 return this.transactionStatus.FAIL;306 }307 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {308 return this.transactionStatus.SUCCESS;309 }310 }311312 return this.transactionStatus.FAIL;313 }314315 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {316 const sign = (callback: any) => {317 if(options !== null) return transaction.signAndSend(sender, options, callback);318 return transaction.signAndSend(sender, callback);319 };320 return new Promise(async (resolve, reject) => {321 try {322 const unsub = await sign((result: any) => {323 const status = this.getTransactionStatus(result);324325 if (status === this.transactionStatus.SUCCESS) {326 this.logger.log(`${label} successful`);327 unsub();328 resolve({result, status});329 } else if (status === this.transactionStatus.FAIL) {330 let moduleError = null;331332 if (result.hasOwnProperty('dispatchError')) {333 const dispatchError = result['dispatchError'];334335 if (dispatchError && dispatchError.isModule) {336 const modErr = dispatchError.asModule;337 const errorMeta = dispatchError.registry.findMetaError(modErr);338339 moduleError = `${errorMeta.section}.${errorMeta.name}`;340 }341 else {342 this.logger.log(result, this.logger.level.ERROR);343 }344 }345346 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);347 unsub();348 reject({status, moduleError, result});349 }350 });351 } catch (e) {352 this.logger.log(e, this.logger.level.ERROR);353 reject(e);354 }355 });356 }357358 constructApiCall(apiCall: string, params: any[]) {359 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);360 let call = this.api as any;361 for(const part of apiCall.slice(4).split('.')) {362 call = call[part];363 }364 return call(...params);365 }366367 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false, failureMessage='expected success') {368 if(this.api === null) throw Error('API not initialized');369 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);370371 const startTime = (new Date()).getTime();372 let result: ITransactionResult;373 let events = [];374 try {375 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;376 events = result.result.events.map((x: any) => x.toHuman());377 }378 catch(e) {379 if(!(e as object).hasOwnProperty('status')) throw e;380 result = e as ITransactionResult;381 }382383 const endTime = (new Date()).getTime();384385 const log = {386 executedAt: endTime,387 executionTime: endTime - startTime,388 type: this.chainLogType.EXTRINSIC,389 status: result.status,390 call: extrinsic,391 params,392 } as IUniqueHelperLog;393394 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;395 if(events.length > 0) log.events = events;396397 this.chainLog.push(log);398399 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(failureMessage);400 return result;401 }402403 async callRpc(rpc: string, params?: any[]) {404 if(typeof params === 'undefined') params = [];405 if(this.api === null) throw Error('API not initialized');406 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);407408 const startTime = (new Date()).getTime();409 let result;410 let error = null;411 const log = {412 type: this.chainLogType.RPC,413 call: rpc,414 params,415 } as IUniqueHelperLog;416417 try {418 result = await this.constructApiCall(rpc, params);419 }420 catch(e) {421 error = e;422 }423424 const endTime = (new Date()).getTime();425426 log.executedAt = endTime;427 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';428 log.executionTime = endTime - startTime;429430 this.chainLog.push(log);431432 if(error !== null) throw error;433434 return result;435 }436437 getSignerAddress(signer: IKeyringPair | string): string {438 if(typeof signer === 'string') return signer;439 return signer.address;440 }441}442443444class HelperGroup {445 helper: UniqueHelper;446447 constructor(uniqueHelper: UniqueHelper) {448 this.helper = uniqueHelper;449 }450}451452453class CollectionGroup extends HelperGroup {454 /**455 * Get number of blocks when sponsored transaction is available.456 *457 * @param collectionId ID of collection458 * @param tokenId ID of token459 * @param addressObj address for which the sponsorship is checked460 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});461 * @returns number of blocks or null if sponsorship hasn't been set462 */463 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {464 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();465 }466467 /**468 * Get the number of created collections.469 * 470 * @returns number of created collections471 */472 async getTotalCount(): Promise<number> {473 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();474 }475476 /**477 * Get information about the collection with additional data, including the number of tokens it contains, its administrators, the normalized address of the collection's owner, and decoded name and description.478 * 479 * @param collectionId ID of collection480 * @example await getData(2)481 * @returns collection information object482 */483 async getData(collectionId: number): Promise<{484 id: number;485 name: string;486 description: string;487 tokensCount: number;488 admins: ICrossAccountId[];489 normalizedOwner: TSubstrateAccount;490 raw: any491 } | null> {492 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);493 const humanCollection = collection.toHuman(), collectionData = {494 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],495 raw: humanCollection,496 } as any, jsonCollection = collection.toJSON();497 if (humanCollection === null) return null;498 collectionData.raw.limits = jsonCollection.limits;499 collectionData.raw.permissions = jsonCollection.permissions;500 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);501 for (const key of ['name', 'description']) {502 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);503 }504505 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) : 0;506 collectionData.admins = await this.getAdmins(collectionId);507508 return collectionData;509 }510511 /**512 * Get the normalized addresses of the collection's administrators.513 * 514 * @param collectionId ID of collection515 * @example await getAdmins(1)516 * @returns array of administrators517 */518 async getAdmins(collectionId: number): Promise<ICrossAccountId[]> {519 const normalized = [];520 for(const admin of (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman()) {521 if(admin.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(admin.Substrate)});522 else normalized.push(admin);523 }524 return normalized;525 }526527 /**528 * Get the normalized addresses added to the collection allow-list.529 * @param collectionId ID of collection530 * @example await getAllowList(1)531 * @returns array of allow-listed addresses532 */533 async getAllowList(collectionId: number): Promise<ICrossAccountId[]> {534 const normalized = [];535 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();536 for (const address of allowListed) {537 if (address.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(address.Substrate)});538 else normalized.push(address);539 }540 return normalized;541 }542543 /**544 * Get the effective limits of the collection instead of null for default values545 * 546 * @param collectionId ID of collection547 * @example await getEffectiveLimits(2)548 * @returns object of collection limits549 */550 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {551 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();552 }553554 /**555 * Burns the collection if the signer has sufficient permissions and collection is empty.556 * 557 * @param signer keyring of signer558 * @param collectionId ID of collection559 * @param label extra label for log560 * @example await helper.collection.burn(aliceKeyring, 3);561 * @returns ```true``` if extrinsic success, otherwise ```false```562 */563 async burn(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {564 if(typeof label === 'undefined') label = `collection #${collectionId}`;565 const result = await this.helper.executeExtrinsic(566 signer,567 'api.tx.unique.destroyCollection', [collectionId],568 true, `Unable to burn collection for ${label}`,569 );570571 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed', label);572 }573574 /**575 * Sets the sponsor for the collection (Requires the Substrate address).576 * 577 * @param signer keyring of signer578 * @param collectionId ID of collection579 * @param sponsorAddress Sponsor substrate address580 * @param label extra label for log581 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")582 * @returns ```true``` if extrinsic success, otherwise ```false```583 */584 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount, label?: string): Promise<boolean> {585 if(typeof label === 'undefined') label = `collection #${collectionId}`;586 const result = await this.helper.executeExtrinsic(587 signer,588 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],589 true, `Unable to set collection sponsor for ${label}`,590 );591592 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet', label);593 }594595 /**596 * Confirms consent to sponsor the collection on behalf of the signer.597 * 598 * @param signer keyring of signer599 * @param collectionId ID of collection600 * @param label extra label for log601 * @example confirmSponsorship(aliceKeyring, 10)602 * @returns ```true``` if extrinsic success, otherwise ```false```603 */604 async confirmSponsorship(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {605 if(typeof label === 'undefined') label = `collection #${collectionId}`;606 const result = await this.helper.executeExtrinsic(607 signer,608 'api.tx.unique.confirmSponsorship', [collectionId],609 true, `Unable to confirm collection sponsorship for ${label}`,610 );611612 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed', label);613 }614615 /**616 * Sets the limits of the collection. At least one limit must be specified for a correct call.617 * 618 * @param signer keyring of signer619 * @param collectionId ID of collection620 * @param limits collection limits object621 * @param label extra label for log622 * @example623 * await setLimits(624 * aliceKeyring,625 * 10,626 * {627 * sponsorTransferTimeout: 0,628 * ownerCanDestroy: false629 * }630 * )631 * @returns ```true``` if extrinsic success, otherwise ```false```632 */633 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits, label?: string): Promise<boolean> {634 if(typeof label === 'undefined') label = `collection #${collectionId}`;635 const result = await this.helper.executeExtrinsic(636 signer,637 'api.tx.unique.setCollectionLimits', [collectionId, limits],638 true, `Unable to set collection limits for ${label}`,639 );640641 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet', label);642 }643644 /**645 * Changes the owner of the collection to the new Substrate address.646 * 647 * @param signer keyring of signer648 * @param collectionId ID of collection649 * @param ownerAddress substrate address of new owner650 * @param label extra label for log651 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")652 * @returns ```true``` if extrinsic success, otherwise ```false```653 */654 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount, label?: string): Promise<boolean> {655 if(typeof label === 'undefined') label = `collection #${collectionId}`;656 const result = await this.helper.executeExtrinsic(657 signer,658 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],659 true, `Unable to change collection owner for ${label}`,660 );661662 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged', label);663 }664665 /**666 * Adds a collection administrator. 667 * 668 * @param signer keyring of signer669 * @param collectionId ID of collection670 * @param adminAddressObj Administrator address (substrate or ethereum)671 * @param label extra label for log672 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})673 * @returns ```true``` if extrinsic success, otherwise ```false```674 */675 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {676 if(typeof label === 'undefined') label = `collection #${collectionId}`;677 const result = await this.helper.executeExtrinsic(678 signer,679 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],680 true, `Unable to add collection admin for ${label}`,681 );682683 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded', label);684 }685686 /**687 * Adds an address to allow list 688 * @param signer keyring of signer689 * @param collectionId ID of collection690 * @param addressObj address to add to the allow list691 * @param label extra label for log692 * @returns ```true``` if extrinsic success, otherwise ```false```693 */694 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId, label?: string): Promise<boolean> {695 if(typeof label === 'undefined') label = `collection #${collectionId}`;696 const result = await this.helper.executeExtrinsic(697 signer,698 'api.tx.unique.addToAllowList', [collectionId, addressObj],699 true, `Unable to add address to allow list for ${label}`,700 );701702 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');703 }704705 /**706 * Removes a collection administrator.707 * 708 * @param signer keyring of signer709 * @param collectionId ID of collection710 * @param adminAddressObj Administrator address (substrate or ethereum)711 * @param label extra label for log712 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})713 * @returns ```true``` if extrinsic success, otherwise ```false```714 */715 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId, label?: string): Promise<boolean> {716 if(typeof label === 'undefined') label = `collection #${collectionId}`;717 const result = await this.helper.executeExtrinsic(718 signer,719 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],720 true, `Unable to remove collection admin for ${label}`,721 );722723 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved', label);724 }725726 /**727 * Sets onchain permissions for selected collection.728 * 729 * @param signer keyring of signer730 * @param collectionId ID of collection731 * @param permissions collection permissions object732 * @param label extra label for log733 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});734 * @returns ```true``` if extrinsic success, otherwise ```false```735 */736 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions, label?: string): Promise<boolean> {737 if(typeof label === 'undefined') label = `collection #${collectionId}`;738 const result = await this.helper.executeExtrinsic(739 signer,740 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],741 true, `Unable to set collection permissions for ${label}`,742 );743744 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet', label);745 }746747 /**748 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.749 * 750 * @param signer keyring of signer751 * @param collectionId ID of collection752 * @param permissions nesting permissions object753 * @param label extra label for log754 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});755 * @returns ```true``` if extrinsic success, otherwise ```false```756 */757 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions, label?: string): Promise<boolean> {758 return await this.setPermissions(signer, collectionId, {nesting: permissions}, label);759 }760761 /**762 * Disables nesting for selected collection.763 * 764 * @param signer keyring of signer765 * @param collectionId ID of collection766 * @param label extra label for log767 * @example disableNesting(aliceKeyring, 10);768 * @returns ```true``` if extrinsic success, otherwise ```false```769 */770 async disableNesting(signer: TSigner, collectionId: number, label?: string): Promise<boolean> {771 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}}, label);772 }773774 /**775 * Sets onchain properties to the collection.776 * 777 * @param signer keyring of signer778 * @param collectionId ID of collection779 * @param properties array of property objects780 * @param label extra label for log781 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);782 * @returns ```true``` if extrinsic success, otherwise ```false```783 */784 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[], label?: string): Promise<boolean> {785 if(typeof label === 'undefined') label = `collection #${collectionId}`;786 const result = await this.helper.executeExtrinsic(787 signer,788 'api.tx.unique.setCollectionProperties', [collectionId, properties],789 true, `Unable to set collection properties for ${label}`,790 );791792 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet', label);793 }794795 /**796 * Deletes onchain properties from the collection.797 * 798 * @param signer keyring of signer799 * @param collectionId ID of collection800 * @param propertyKeys array of property keys to delete801 * @param label802 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);803 * @returns ```true``` if extrinsic success, otherwise ```false```804 */805 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[], label?: string): Promise<boolean> {806 if(typeof label === 'undefined') label = `collection #${collectionId}`;807 const result = await this.helper.executeExtrinsic(808 signer,809 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],810 true, `Unable to delete collection properties for ${label}`,811 );812813 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted', label);814 }815816 /**817 * Changes the owner of the token.818 * 819 * @param signer keyring of signer820 * @param collectionId ID of collection821 * @param tokenId ID of token822 * @param addressObj address of a new owner823 * @param amount amount of tokens to be transfered. For NFT must be set to 1n824 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})825 * @returns true if the token success, otherwise false826 */827 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {828 const result = await this.helper.executeExtrinsic(829 signer,830 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],831 true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,832 );833834 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);835 }836837 /**838 * 839 * Change ownership of a token(s) on behalf of the owner. 840 * 841 * @param signer keyring of signer842 * @param collectionId ID of collection843 * @param tokenId ID of token844 * @param fromAddressObj address on behalf of which the token will be sent845 * @param toAddressObj new token owner846 * @param amount amount of tokens to be transfered. For NFT must be set to 1n847 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})848 * @returns true if the token success, otherwise false849 */850 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {851 const result = await this.helper.executeExtrinsic(852 signer,853 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],854 true, `Unable to transfer token #${tokenId} from collection #${collectionId}`,855 );856 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);857 }858859 /**860 * 861 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.862 * 863 * @param signer keyring of signer864 * @param collectionId ID of collection865 * @param tokenId ID of token866 * @param label 867 * @param amount amount of tokens to be burned. For NFT must be set to 1n868 * @example burnToken(aliceKeyring, 10, 5);869 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```870 */871 async burnToken(signer: TSigner, collectionId: number, tokenId: number, label?: string, amount=1n): Promise<{872 success: boolean,873 token: number | null874 }> {875 if(typeof label === 'undefined') label = `collection #${collectionId}`;876 const burnResult = await this.helper.executeExtrinsic(877 signer,878 'api.tx.unique.burnItem', [collectionId, tokenId, amount],879 true, `Unable to burn token for ${label}`,880 );881 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);882 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');883 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};884 }885886 /**887 * Destroys a concrete instance of NFT on behalf of the owner888 * 889 * @param signer keyring of signer890 * @param collectionId ID of collection891 * @param fromAddressObj address on behalf of which the token will be burnt892 * @param tokenId ID of token893 * @param label 894 * @param amount amount of tokens to be burned. For NFT must be set to 1n895 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})896 * @returns ```true``` if extrinsic success, otherwise ```false```897 */898 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, label?: string, amount=1n): Promise<boolean> {899 if(typeof label === 'undefined') label = `collection #${collectionId}`;900 const burnResult = await this.helper.executeExtrinsic(901 signer,902 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],903 true, `Unable to burn token from for ${label}`,904 );905 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult, label);906 return burnedTokens.success && burnedTokens.tokens.length > 0;907 }908909 /**910 * Set, change, or remove approved address to transfer the ownership of the NFT.911 * 912 * @param signer keyring of signer913 * @param collectionId ID of collection914 * @param tokenId ID of token915 * @param toAddressObj 916 * @param label 917 * @param amount amount of token to be approved. For NFT must be set to 1n918 * @returns ```true``` if extrinsic success, otherwise ```false```919 */920 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=1n) {921 if(typeof label === 'undefined') label = `collection #${collectionId}`;922 const approveResult = await this.helper.executeExtrinsic(923 signer, 924 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],925 true, `Unable to approve token for ${label}`,926 );927928 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved', label);929 }930931 /**932 * Get the amount of token pieces approved to transfer933 * @param collectionId ID of collection934 * @param tokenId ID of token935 * @param toAccountObj 936 * @param fromAccountObj937 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})938 * @returns number of approved to transfer pieces939 */940 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {941 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();942 }943944 /**945 * Get the last created token id946 * @param collectionId ID of collection947 * @example getLastTokenId(10);948 * @returns id of the last created token949 */950 async getLastTokenId(collectionId: number): Promise<number> {951 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();952 }953954 /**955 * Check if token exists956 * @param collectionId ID of collection957 * @param tokenId ID of token958 * @example isTokenExists(10, 20);959 * @returns true if the token exists, otherwise false960 */961 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {962 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();963 }964}965966class NFTnRFT extends CollectionGroup {967 /**968 * Get tokens owned by account969 * 970 * @param collectionId ID of collection971 * @param addressObj tokens owner972 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})973 * @returns array of token ids owned by account974 */975 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {976 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();977 }978979 /**980 * Get token data981 * @param collectionId ID of collection982 * @param tokenId ID of token983 * @param blockHashAt 984 * @param propertyKeys985 * @example getToken(10, 5);986 * @returns human readable token data 987 */988 async getToken(collectionId: number, tokenId: number, blockHashAt?: string, propertyKeys?: string[]): Promise<{989 properties: IProperty[];990 owner: ICrossAccountId;991 normalizedOwner: ICrossAccountId;992 }| null> {993 let tokenData;994 if(typeof blockHashAt === 'undefined') {995 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);996 }997 else {998 if(typeof propertyKeys === 'undefined') {999 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1000 if(!collection) return null;1001 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1002 }1003 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1004 }1005 tokenData = tokenData.toHuman();1006 if (tokenData === null || tokenData.owner === null) return null;1007 const owner = {} as any;1008 for (const key of Object.keys(tokenData.owner)) {1009 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1010 }1011 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1012 return tokenData;1013 }10141015 /**1016 * Set permissions to change token properties1017 * @param signer keyring of signer1018 * @param collectionId ID of collection1019 * @param permissions permissions to change a property by the collection owner or admin1020 * @param label 1021 * @example setTokenPropertyPermissions(1022 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1023 * )1024 * @returns true if extrinsic success otherwise false1025 */1026 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[], label?: string): Promise<boolean> {1027 if(typeof label === 'undefined') label = `collection #${collectionId}`;1028 const result = await this.helper.executeExtrinsic(1029 signer,1030 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1031 true, `Unable to set token property permissions for ${label}`,1032 );10331034 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet', label);1035 }10361037 /**1038 * Set token properties1039 * @param signer keyring of signer1040 * @param collectionId ID of collection1041 * @param tokenId ID of token1042 * @param properties 1043 * @param label 1044 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1045 * @returns ```true``` if extrinsic success, otherwise ```false```1046 */1047 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[], label?: string): Promise<boolean> {1048 if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1049 const result = await this.helper.executeExtrinsic(1050 signer,1051 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1052 true, `Unable to set token properties for ${label}`,1053 );10541055 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet', label);1056 }10571058 /**1059 * Delete the provided properties of a token1060 * @param signer keyring of signer1061 * @param collectionId ID of collection1062 * @param tokenId ID of token1063 * @param propertyKeys property keys to be deleted 1064 * @param label 1065 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1066 * @returns ```true``` if extrinsic success, otherwise ```false```1067 */1068 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[], label?: string): Promise<boolean> {1069 if(typeof label === 'undefined') label = `token #${tokenId} from collection #${collectionId}`;1070 const result = await this.helper.executeExtrinsic(1071 signer,1072 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1073 true, `Unable to delete token properties for ${label}`,1074 );10751076 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted', label);1077 }10781079 /**1080 * Mint new collection1081 * @param signer keyring of signer1082 * @param collectionOptions basic collection options and properties 1083 * @param mode NFT or RFT type of a collection1084 * @param errorLabel 1085 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1086 * @returns object of the created collection1087 */1088 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT', errorLabel = 'Unable to mint collection'): Promise<UniqueCollectionBase> {1089 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1090 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1091 for (const key of ['name', 'description', 'tokenPrefix']) {1092 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1093 }1094 const creationResult = await this.helper.executeExtrinsic(1095 signer,1096 'api.tx.unique.createCollectionEx', [collectionOptions],1097 true, errorLabel,1098 );1099 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1100 }11011102 getCollectionObject(collectionId: number): any {1103 return null;1104 }11051106 getTokenObject(collectionId: number, tokenId: number): any {1107 return null;1108 }1109}111011111112class NFTGroup extends NFTnRFT {1113 /**1114 * Get collection object1115 * @param collectionId ID of collection1116 * @example getCollectionObject(2);1117 * @returns instance of UniqueNFTCollection1118 */1119 getCollectionObject(collectionId: number): UniqueNFTCollection {1120 return new UniqueNFTCollection(collectionId, this.helper);1121 }11221123 /**1124 * Get token object1125 * @param collectionId ID of collection1126 * @param tokenId ID of token1127 * @example getTokenObject(10, 5);1128 * @returns instance of UniqueNFTToken1129 */1130 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1131 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1132 }11331134 /**1135 * Get token's owner1136 * @param collectionId ID of collection1137 * @param tokenId ID of token1138 * @param blockHashAt 1139 * @example getTokenOwner(10, 5);1140 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1141 */1142 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1143 let owner;1144 if (typeof blockHashAt === 'undefined') {1145 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1146 } else {1147 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1148 }1149 return crossAccountIdFromLower(owner.toJSON());1150 }11511152 /**1153 * Is token approved to transfer1154 * @param collectionId ID of collection1155 * @param tokenId ID of token1156 * @param toAccountObj address to be approved1157 * @returns ```true``` if extrinsic success, otherwise ```false```1158 */1159 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1160 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1161 }11621163 /**1164 * Changes the owner of the token.1165 * 1166 * @param signer keyring of signer1167 * @param collectionId ID of collection1168 * @param tokenId ID of token1169 * @param addressObj address of a new owner1170 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1171 * @returns ```true``` if extrinsic success, otherwise ```false```1172 */1173 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1174 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1175 }11761177 /**1178 * 1179 * Change ownership of a NFT on behalf of the owner. 1180 * 1181 * @param signer keyring of signer1182 * @param collectionId ID of collection1183 * @param tokenId ID of token1184 * @param fromAddressObj address on behalf of which the token will be sent1185 * @param toAddressObj new token owner1186 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1187 * @returns ```true``` if extrinsic success, otherwise ```false```1188 */1189 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1190 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1191 }11921193 /**1194 * Recursively find the address that owns the token1195 * @param collectionId ID of collection1196 * @param tokenId ID of token1197 * @param blockHashAt 1198 * @example getTokenTopmostOwner(10, 5);1199 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1200 */1201 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1202 let owner;1203 if (typeof blockHashAt === 'undefined') {1204 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1205 } else {1206 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1207 }12081209 if (owner === null) return null;12101211 owner = owner.toHuman();12121213 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1214 }12151216 /**1217 * Get tokens nested in the provided token1218 * @param collectionId ID of collection1219 * @param tokenId ID of token1220 * @param blockHashAt 1221 * @example getTokenChildren(10, 5);1222 * @returns tokens whose depth of nesting is <= 5 1223 */1224 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1225 let children;1226 if(typeof blockHashAt === 'undefined') {1227 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1228 } else {1229 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1230 }12311232 return children.toJSON().map((x: any) => {1233 return {collectionId: x.collection, tokenId: x.token};1234 });1235 }12361237 /**1238 * Nest one token into another1239 * @param signer keyring of signer1240 * @param tokenObj token to be nested1241 * @param rootTokenObj token to be parent1242 * @param label 1243 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1244 * @returns ```true``` if extrinsic success, otherwise ```false```1245 */1246 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, label='nest token'): Promise<boolean> {1247 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1248 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1249 if(!result) {1250 throw Error(`Unable to nest token for ${label}`);1251 }1252 return result;1253 }12541255 /**1256 * Remove token from nested state1257 * @param signer keyring of signer1258 * @param tokenObj token to unnest1259 * @param rootTokenObj parent of a token1260 * @param toAddressObj address of a new token owner 1261 * @param label 1262 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1263 * @returns ```true``` if extrinsic success, otherwise ```false```1264 */1265 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId, label='unnest token'): Promise<boolean> {1266 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1267 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1268 if(!result) {1269 throw Error(`Unable to unnest token for ${label}`);1270 }1271 return result;1272 }12731274 /**1275 * Mint new collection1276 * @param signer keyring of signer1277 * @param collectionOptions Collection options1278 * @param label 1279 * @example 1280 * mintCollection(aliceKeyring, {1281 * name: 'New',1282 * description: 'New collection',1283 * tokenPrefix: 'NEW',1284 * })1285 * @returns object of the created collection1286 */1287 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueNFTCollection> {1288 return await super.mintCollection(signer, collectionOptions, 'NFT', `Unable to mint NFT collection for ${label}`) as UniqueNFTCollection;1289 }12901291 /**1292 * Mint new token1293 * @param signer keyring of signer1294 * @param data token data1295 * @param label 1296 * @returns created token object1297 */1298 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }, label?: string): Promise<UniqueNFTToken> {1299 if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1300 const creationResult = await this.helper.executeExtrinsic(1301 signer,1302 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1303 nft: {1304 properties: data.properties,1305 },1306 }],1307 true, `Unable to mint NFT token for ${label}`,1308 );1309 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1310 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1311 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1312 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1313 }13141315 /**1316 * Mint multiple NFT tokens1317 * @param signer keyring of signer1318 * @param collectionId ID of collection1319 * @param tokens array of tokens with owner and properties1320 * @param label 1321 * @example 1322 * mintMultipleTokens(aliceKeyring, 10, [{1323 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1324 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1325 * },{1326 * owner: {Ethereum: "0x9F0583DbB855d..."},1327 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1328 * }]);1329 * @returns ```true``` if extrinsic success, otherwise ```false```1330 */1331 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1332 if(typeof label === 'undefined') label = `collection #${collectionId}`;1333 const creationResult = await this.helper.executeExtrinsic(1334 signer,1335 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1336 true, `Unable to mint NFT tokens for ${label}`,1337 );1338 const collection = this.getCollectionObject(collectionId);1339 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1340 }13411342 /**1343 * Mint multiple NFT tokens with one owner1344 * @param signer keyring of signer1345 * @param collectionId ID of collection1346 * @param owner tokens owner1347 * @param tokens array of tokens with owner and properties1348 * @param label 1349 * @example1350 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1351 * properties: [{1352 * key: "gender",1353 * value: "female",1354 * },{1355 * key: "age",1356 * value: "33",1357 * }],1358 * }]);1359 * @returns array of newly created tokens1360 */1361 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[], label?: string): Promise<UniqueNFTToken[]> {1362 if(typeof label === 'undefined') label = `collection #${collectionId}`;1363 const rawTokens = [];1364 for (const token of tokens) {1365 const raw = {NFT: {properties: token.properties}};1366 rawTokens.push(raw);1367 }1368 const creationResult = await this.helper.executeExtrinsic(1369 signer,1370 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1371 true, `Unable to mint NFT tokens for ${label}`,1372 );1373 const collection = this.getCollectionObject(collectionId);1374 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1375 }13761377 /**1378 * Destroys a concrete instance of NFT.1379 * @param signer keyring of signer1380 * @param collectionId ID of collection1381 * @param tokenId ID of token1382 * @param label 1383 * @example burnToken(aliceKeyring, 10, 5);1384 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1385 */1386 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string): Promise<{ success: boolean; token: number | null; }> {1387 return await super.burnToken(signer, collectionId, tokenId, label, 1n);1388 }13891390 /**1391 * Set, change, or remove approved address to transfer the ownership of the NFT.1392 * 1393 * @param signer keyring of signer1394 * @param collectionId ID of collection1395 * @param tokenId ID of token1396 * @param toAddressObj address to approve1397 * @param label 1398 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1399 * @returns ```true``` if extrinsic success, otherwise ```false```1400 */1401 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {1402 return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, 1n);1403 }1404}140514061407class RFTGroup extends NFTnRFT {1408 /**1409 * Get collection object1410 * @param collectionId ID of collection1411 * @example getCollectionObject(2);1412 * @returns instance of UniqueRFTCollection1413 */1414 getCollectionObject(collectionId: number): UniqueRFTCollection {1415 return new UniqueRFTCollection(collectionId, this.helper);1416 }14171418 /**1419 * Get token object1420 * @param collectionId ID of collection1421 * @param tokenId ID of token1422 * @example getTokenObject(10, 5);1423 * @returns instance of UniqueNFTToken1424 */1425 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1426 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1427 }14281429 /**1430 * Get top 10 token owners with the largest number of pieces 1431 * @param collectionId ID of collection1432 * @param tokenId ID of token1433 * @example getTokenTop10Owners(10, 5);1434 * @returns array of top 10 owners1435 */1436 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1437 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1438 }14391440 /**1441 * Get number of pieces owned by address1442 * @param collectionId ID of collection1443 * @param tokenId ID of token1444 * @param addressObj address token owner1445 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1446 * @returns number of pieces ownerd by address1447 */1448 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1449 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1450 }14511452 /**1453 * Transfer pieces of token to another address1454 * @param signer keyring of signer1455 * @param collectionId ID of collection1456 * @param tokenId ID of token1457 * @param addressObj address of a new owner1458 * @param amount number of pieces to be transfered1459 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1460 * @returns ```true``` if extrinsic success, otherwise ```false```1461 */1462 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=100n): Promise<boolean> {1463 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1464 }14651466 /**1467 * Change ownership of some pieces of RFT on behalf of the owner. 1468 * @param signer keyring of signer1469 * @param collectionId ID of collection1470 * @param tokenId ID of token1471 * @param fromAddressObj address on behalf of which the token will be sent1472 * @param toAddressObj new token owner1473 * @param amount number of pieces to be transfered1474 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1475 * @returns ```true``` if extrinsic success, otherwise ```false```1476 */1477 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n): Promise<boolean> {1478 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1479 }14801481 /**1482 * Mint new collection1483 * @param signer keyring of signer1484 * @param collectionOptions Collection options1485 * @param label 1486 * @example1487 * mintCollection(aliceKeyring, {1488 * name: 'New',1489 * description: 'New collection',1490 * tokenPrefix: 'NEW',1491 * })1492 * @returns object of the created collection1493 */1494 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, label = 'new collection'): Promise<UniqueRFTCollection> {1495 return await super.mintCollection(signer, collectionOptions, 'RFT', `Unable to mint RFT collection for ${label}`) as UniqueRFTCollection;1496 }14971498 /**1499 * Mint new token1500 * @param signer keyring of signer1501 * @param data token data1502 * @param label 1503 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1504 * @returns created token object1505 */1506 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }, label?: string): Promise<UniqueRFTToken> {1507 if(typeof label === 'undefined') label = `collection #${data.collectionId}`;1508 const creationResult = await this.helper.executeExtrinsic(1509 signer,1510 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1511 refungible: {1512 pieces: data.pieces,1513 properties: data.properties,1514 },1515 }],1516 true, `Unable to mint RFT token for ${label}`,1517 );1518 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult, label);1519 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1520 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1521 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1522 }15231524 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1525 throw Error('Not implemented');1526 if(typeof label === 'undefined') label = `collection #${collectionId}`;1527 const creationResult = await this.helper.executeExtrinsic(1528 signer,1529 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1530 true, `Unable to mint RFT tokens for ${label}`,1531 );1532 const collection = this.getCollectionObject(collectionId);1533 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1534 }15351536 /**1537 * Mint multiple RFT tokens with one owner1538 * @param signer keyring of signer1539 * @param collectionId ID of collection1540 * @param owner tokens owner1541 * @param tokens array of tokens with properties and pieces1542 * @param label 1543 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1544 * @returns array of newly created RFT tokens1545 */1546 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[], label?: string): Promise<UniqueRFTToken[]> {1547 if(typeof label === 'undefined') label = `collection #${collectionId}`;1548 const rawTokens = [];1549 for (const token of tokens) {1550 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1551 rawTokens.push(raw);1552 }1553 const creationResult = await this.helper.executeExtrinsic(1554 signer,1555 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1556 true, `Unable to mint RFT tokens for ${label}`,1557 );1558 const collection = this.getCollectionObject(collectionId);1559 return this.helper.util.extractTokensFromCreationResult(creationResult, label).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1560 }15611562 /**1563 * Destroys a concrete instance of RFT.1564 * @param signer keyring of signer1565 * @param collectionId ID of collection1566 * @param tokenId ID of token1567 * @param label 1568 * @param amount number of pieces to be burnt1569 * @example burnToken(aliceKeyring, 10, 5);1570 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1571 */1572 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, label?: string, amount=100n): Promise<{ success: boolean; token: number | null; }> {1573 return await super.burnToken(signer, collectionId, tokenId, label, amount);1574 }15751576 /**1577 * Set, change, or remove approved address to transfer the ownership of the RFT.1578 * 1579 * @param signer keyring of signer1580 * @param collectionId ID of collection1581 * @param tokenId ID of token1582 * @param toAddressObj address to approve1583 * @param label 1584 * @param amount number of pieces to be approved1585 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1586 * @returns true if the token success, otherwise false1587 */1588 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, label?: string, amount=100n) {1589 return super.approveToken(signer, collectionId, tokenId, toAddressObj, label, amount);1590 }15911592 /**1593 * Get total number of pieces1594 * @param collectionId ID of collection1595 * @param tokenId ID of token1596 * @example getTokenTotalPieces(10, 5);1597 * @returns number of pieces1598 */1599 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1600 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1601 }16021603 /**1604 * Change number of token pieces. Signer must be the owner of all token pieces.1605 * @param signer keyring of signer1606 * @param collectionId ID of collection1607 * @param tokenId ID of token1608 * @param amount new number of pieces1609 * @param label 1610 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1611 * @returns true if the repartion was success, otherwise false1612 */1613 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint, label?: string): Promise<boolean> {1614 if(typeof label === 'undefined') label = `collection #${collectionId}`;1615 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1616 const repartitionResult = await this.helper.executeExtrinsic(1617 signer,1618 'api.tx.unique.repartition', [collectionId, tokenId, amount],1619 true, `Unable to repartition RFT token for ${label}`,1620 );1621 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated', label);1622 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed', label);1623 }1624}162516261627class FTGroup extends CollectionGroup {1628 /**1629 * Get collection object1630 * @param collectionId ID of collection1631 * @example getCollectionObject(2);1632 * @returns instance of UniqueFTCollection1633 */1634 getCollectionObject(collectionId: number): UniqueFTCollection {1635 return new UniqueFTCollection(collectionId, this.helper);1636 }16371638 /**1639 * Mint new fungible collection1640 * @param signer keyring of signer1641 * @param collectionOptions Collection options1642 * @param decimalPoints number of token decimals 1643 * @param errorLabel 1644 * @example1645 * mintCollection(aliceKeyring, {1646 * name: 'New',1647 * description: 'New collection',1648 * tokenPrefix: 'NEW',1649 * }, 18)1650 * @returns newly created fungible collection1651 */1652 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0, errorLabel = 'Unable to mint collection'): Promise<UniqueFTCollection> {1653 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1654 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1655 collectionOptions.mode = {fungible: decimalPoints};1656 for (const key of ['name', 'description', 'tokenPrefix']) {1657 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1658 }1659 const creationResult = await this.helper.executeExtrinsic(1660 signer,1661 'api.tx.unique.createCollectionEx', [collectionOptions],1662 true, errorLabel,1663 );1664 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult, errorLabel));1665 }16661667 /**1668 * Mint tokens1669 * @param signer keyring of signer1670 * @param collectionId ID of collection1671 * @param owner address owner of new tokens1672 * @param amount amount of tokens to be meanted1673 * @param label 1674 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1675 * @returns ```true``` if extrinsic success, otherwise ```false``` 1676 */1677 async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint, label?: string): Promise<boolean> {1678 if(typeof label === 'undefined') label = `collection #${collectionId}`;1679 const creationResult = await this.helper.executeExtrinsic(1680 signer,1681 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1682 fungible: {1683 value: amount,1684 },1685 }],1686 true, `Unable to mint fungible tokens for ${label}`,1687 );1688 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1689 }16901691 /**1692 * Mint multiple Fungible tokens with one owner1693 * @param signer keyring of signer1694 * @param collectionId ID of collection1695 * @param owner tokens owner1696 * @param tokens array of tokens with properties and pieces1697 * @param label 1698 * @returns ```true``` if extrinsic success, otherwise ```false``` 1699 */1700 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string): Promise<boolean> {1701 if(typeof label === 'undefined') label = `collection #${collectionId}`;1702 const rawTokens = [];1703 for (const token of tokens) {1704 const raw = {Fungible: {Value: token.value}};1705 rawTokens.push(raw);1706 }1707 const creationResult = await this.helper.executeExtrinsic(1708 signer,1709 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1710 true, `Unable to mint RFT tokens for ${label}`,1711 );1712 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated', label);1713 }17141715 /**1716 * Get the top 10 owners with the largest balance for the Fungible collection 1717 * @param collectionId ID of collection1718 * @example getTop10Owners(10);1719 * @returns array of ```ICrossAccountId```1720 */1721 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1722 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1723 }17241725 /**1726 * Get account balance1727 * @param collectionId ID of collection1728 * @param addressObj address of owner1729 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1730 * @returns amount of fungible tokens owned by address1731 */1732 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1733 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1734 }17351736 /**1737 * Transfer tokens to address1738 * @param signer keyring of signer1739 * @param collectionId ID of collection1740 * @param toAddressObj address recepient1741 * @param amount amount of tokens to be sent1742 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1743 * @returns ```true``` if extrinsic success, otherwise ```false``` 1744 */1745 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount: bigint) {1746 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1747 }17481749 /**1750 * Transfer some tokens on behalf of the owner.1751 * @param signer keyring of signer1752 * @param collectionId ID of collection1753 * @param fromAddressObj address on behalf of which tokens will be sent1754 * @param toAddressObj address where token to be sent1755 * @param amount number of tokens to be sent1756 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1757 * @returns ```true``` if extrinsic success, otherwise ```false``` 1758 */1759 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {1760 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1761 }17621763 /**1764 * Destroy some amount of tokens1765 * @param signer keyring of signer1766 * @param collectionId ID of collection1767 * @param amount amount of tokens to be destroyed1768 * @param label 1769 * @example burnTokens(aliceKeyring, 10, 1000n);1770 * @returns ```true``` if extrinsic success, otherwise ```false``` 1771 */1772 async burnTokens(signer: IKeyringPair, collectionId: number, amount=100n, label?: string): Promise<boolean> {1773 return (await super.burnToken(signer, collectionId, 0, label, amount)).success;1774 }17751776 /**1777 * Burn some tokens on behalf of the owner.1778 * @param signer keyring of signer1779 * @param collectionId ID of collection1780 * @param fromAddressObj address on behalf of which tokens will be burnt1781 * @param amount amount of tokens to be burnt1782 * @param label 1783 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1784 * @returns ```true``` if extrinsic success, otherwise ```false``` 1785 */1786 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=100n, label?: string): Promise<boolean> {1787 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, label, amount);1788 }17891790 /**1791 * Get total collection supply1792 * @param collectionId 1793 * @returns 1794 */1795 async getTotalPieces(collectionId: number): Promise<bigint> {1796 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1797 }17981799 /**1800 * Set, change, or remove approved address to transfer tokens.1801 * 1802 * @param signer keyring of signer1803 * @param collectionId ID of collection1804 * @param toAddressObj address to be approved1805 * @param amount amount of tokens to be approved1806 * @param label 1807 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1808 * @returns ```true``` if extrinsic success, otherwise ```false``` 1809 */1810 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {1811 return super.approveToken(signer, collectionId, 0, toAddressObj, label, amount);1812 }18131814 /**1815 * Get amount of fungible tokens approved to transfer1816 * @param collectionId ID of collection1817 * @param fromAddressObj owner of tokens1818 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1819 * @returns number of tokens approved for the transfer1820 */1821 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1822 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1823 }1824}182518261827class ChainGroup extends HelperGroup {1828 /**1829 * Get system properties of a chain1830 * @example getChainProperties();1831 * @returns ss58Format, token decimals, and token symbol1832 */1833 getChainProperties(): IChainProperties {1834 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1835 return {1836 ss58Format: properties.ss58Format.toJSON(),1837 tokenDecimals: properties.tokenDecimals.toJSON(),1838 tokenSymbol: properties.tokenSymbol.toJSON(),1839 };1840 }18411842 /**1843 * Get chain header1844 * @example getLatestBlockNumber();1845 * @returns the number of the last block1846 */1847 async getLatestBlockNumber(): Promise<number> {1848 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1849 }18501851 /**1852 * Get block hash by block number1853 * @param blockNumber number of block1854 * @example getBlockHashByNumber(12345);1855 * @returns hash of a block1856 */1857 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1858 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1859 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1860 return blockHash;1861 }18621863 /**1864 * Get account nonce1865 * @param address substrate address1866 * @example getNonce("5GrwvaEF5zXb26Fz...");1867 * @returns number, account's nonce1868 */1869 async getNonce(address: TSubstrateAccount): Promise<number> {1870 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1871 }1872}187318741875class BalanceGroup extends HelperGroup {1876 /**1877 * Representation of the native token in the smallest unit1878 * @example getOneTokenNominal()1879 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1880 */1881 getOneTokenNominal(): bigint {1882 const chainProperties = this.helper.chain.getChainProperties();1883 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1884 }18851886 /**1887 * Get substrate address balance1888 * @param address substrate address1889 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1890 * @returns amount of tokens on address1891 */1892 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1893 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1894 }18951896 /**1897 * Get ethereum address balance1898 * @param address ethereum address1899 * @example getEthereum("0x9F0583DbB855d...")1900 * @returns amount of tokens on address1901 */1902 async getEthereum(address: TEthereumAccount): Promise<bigint> {1903 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1904 }19051906 /**1907 * Transfer tokens to substrate address1908 * @param signer keyring of signer1909 * @param address substrate address of a recepient1910 * @param amount amount of tokens to be transfered1911 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1912 * @returns ```true``` if extrinsic success, otherwise ```false```1913 */1914 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1915 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true, `Unable to transfer balance from ${this.helper.getSignerAddress(signer)} to ${address}`);19161917 let transfer = {from: null, to: null, amount: 0n} as any;1918 result.result.events.forEach(({event: {data, method, section}}) => {1919 if ((section === 'balances') && (method === 'Transfer')) {1920 transfer = {1921 from: this.helper.address.normalizeSubstrate(data[0]),1922 to: this.helper.address.normalizeSubstrate(data[1]),1923 amount: BigInt(data[2]),1924 };1925 }1926 });1927 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1928 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1929 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1930 return isSuccess;1931 }1932}193319341935class AddressGroup extends HelperGroup {1936 /**1937 * Normalizes the address to the specified ss58 format, by default ```42```.1938 * @param address substrate address1939 * @param ss58Format format for address conversion, by default ```42```1940 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1941 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1942 */1943 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1944 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1945 }19461947 /**1948 * Get address in the connected chain format1949 * @param address substrate address1950 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1951 * @returns address in chain format1952 */1953 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1954 const info = this.helper.chain.getChainProperties();1955 return encodeAddress(decodeAddress(address), info.ss58Format);1956 }19571958 /**1959 * Get substrate mirror of an ethereum address1960 * @param ethAddress ethereum address1961 * @param toChainFormat false for normalized account1962 * @example ethToSubstrate('0x9F0583DbB855d...')1963 * @returns substrate mirror of a provided ethereum address1964 */1965 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1966 if(!toChainFormat) return evmToAddress(ethAddress);1967 const info = this.helper.chain.getChainProperties();1968 return evmToAddress(ethAddress, info.ss58Format);1969 }19701971 /**1972 * Get ethereum mirror of a substrate address1973 * @param subAddress substrate account1974 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1975 * @returns ethereum mirror of a provided substrate address1976 */1977 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1978 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1979 }1980}198119821983export class UniqueHelper extends ChainHelperBase {1984 chain: ChainGroup;1985 balance: BalanceGroup;1986 address: AddressGroup;1987 collection: CollectionGroup;1988 nft: NFTGroup;1989 rft: RFTGroup;1990 ft: FTGroup;19911992 constructor(logger?: ILogger) {1993 super(logger);1994 this.chain = new ChainGroup(this);1995 this.balance = new BalanceGroup(this);1996 this.address = new AddressGroup(this);1997 this.collection = new CollectionGroup(this);1998 this.nft = new NFTGroup(this);1999 this.rft = new RFTGroup(this);2000 this.ft = new FTGroup(this);2001 } 2002}200320042005class UniqueCollectionBase {2006 helper: UniqueHelper;2007 collectionId: number;20082009 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2010 this.collectionId = collectionId;2011 this.helper = uniqueHelper;2012 }20132014 async getData() {2015 return await this.helper.collection.getData(this.collectionId);2016 }20172018 async getLastTokenId() {2019 return await this.helper.collection.getLastTokenId(this.collectionId);2020 }20212022 async isTokenExists(tokenId: number) {2023 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2024 }20252026 async getAdmins() {2027 return await this.helper.collection.getAdmins(this.collectionId);2028 }20292030 async getAllowList() {2031 return await this.helper.collection.getAllowList(this.collectionId);2032 }20332034 async getEffectiveLimits() {2035 return await this.helper.collection.getEffectiveLimits(this.collectionId);2036 }20372038 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount, label?: string) {2039 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress, label);2040 }20412042 async confirmSponsorship(signer: TSigner, label?: string) {2043 return await this.helper.collection.confirmSponsorship(signer, this.collectionId, label);2044 }20452046 async setLimits(signer: TSigner, limits: ICollectionLimits, label?: string) {2047 return await this.helper.collection.setLimits(signer, this.collectionId, limits, label);2048 }20492050 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount, label?: string) {2051 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress, label);2052 }20532054 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2055 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj, label);2056 }20572058 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId, label?: string) {2059 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj, label);2060 }20612062 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId, label?: string) {2063 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj, label);2064 }20652066 async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2067 return await this.helper.collection.setProperties(signer, this.collectionId, properties, label);2068 }20692070 async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2071 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys, label);2072 }20732074 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2075 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2076 }20772078 async setPermissions(signer: TSigner, permissions: ICollectionPermissions, label?: string) {2079 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions, label);2080 }20812082 async enableNesting(signer: TSigner, permissions: INestingPermissions, label?: string) {2083 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions, label);2084 }20852086 async disableNesting(signer: TSigner, label?: string) {2087 return await this.helper.collection.disableNesting(signer, this.collectionId, label);2088 }20892090 async burn(signer: TSigner, label?: string) {2091 return await this.helper.collection.burn(signer, this.collectionId, label);2092 }2093}209420952096class UniqueNFTCollection extends UniqueCollectionBase {2097 getTokenObject(tokenId: number) {2098 return new UniqueNFTToken(tokenId, this);2099 }21002101 async getTokensByAddress(addressObj: ICrossAccountId) {2102 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2103 }21042105 async getToken(tokenId: number, blockHashAt?: string) {2106 return await this.helper.nft.getToken(this.collectionId, tokenId, blockHashAt);2107 }21082109 async getTokenOwner(tokenId: number, blockHashAt?: string) {2110 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2111 }21122113 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2114 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2115 }21162117 async getTokenChildren(tokenId: number, blockHashAt?: string) {2118 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2119 }21202121 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2122 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2123 }21242125 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2126 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2127 }21282129 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, label?: string) {2130 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label);2131 }21322133 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2134 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2135 }21362137 async mintToken(signer: TSigner, owner: ICrossAccountId, properties?: IProperty[], label?: string) {2138 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties}, label);2139 }21402141 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[], label?: string) {2142 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens, label);2143 }21442145 async burnToken(signer: TSigner, tokenId: number, label?: string) {2146 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId, label);2147 }21482149 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2150 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2151 }21522153 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2154 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2155 }21562157 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2158 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2159 }21602161 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken, label?: string) {2162 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj, label);2163 }21642165 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2166 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj, label);2167 }2168}216921702171class UniqueRFTCollection extends UniqueCollectionBase {2172 getTokenObject(tokenId: number) {2173 return new UniqueRFTToken(tokenId, this);2174 }21752176 async getTokensByAddress(addressObj: ICrossAccountId) {2177 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2178 }21792180 async getTop10TokenOwners(tokenId: number) {2181 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2182 }21832184 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2185 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2186 }21872188 async getTokenTotalPieces(tokenId: number) {2189 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2190 }21912192 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=100n) {2193 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2194 }21952196 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2197 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2198 }21992200 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2201 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, label, amount);2202 }22032204 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2205 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2206 }22072208 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint, label?: string) {2209 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount, label);2210 }22112212 async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[], label?: string) {2213 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties}, label);2214 }22152216 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[], label?: string) {2217 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens, label);2218 }22192220 async burnToken(signer: TSigner, tokenId: number, amount=100n, label?: string) {2221 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, label, amount);2222 }22232224 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[], label?: string) {2225 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties, label);2226 }22272228 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[], label?: string) {2229 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys, label);2230 }22312232 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[], label?: string) {2233 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions, label);2234 }2235}223622372238class UniqueFTCollection extends UniqueCollectionBase {2239 async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint, label?: string) {2240 return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount, label);2241 }22422243 async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[], label?: string) {2244 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens, label);2245 }22462247 async getBalance(addressObj: ICrossAccountId) {2248 return await this.helper.ft.getBalance(this.collectionId, addressObj);2249 }22502251 async getTop10Owners() {2252 return await this.helper.ft.getTop10Owners(this.collectionId);2253 }22542255 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount: bigint) {2256 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2257 }22582259 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount: bigint) {2260 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2261 }22622263 async burnTokens(signer: TSigner, amount: bigint, label?: string) {2264 return await this.helper.ft.burnTokens(signer, this.collectionId, amount, label);2265 }22662267 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount: bigint, label?: string) {2268 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount, label);2269 }22702271 async getTotalPieces() {2272 return await this.helper.ft.getTotalPieces(this.collectionId);2273 }22742275 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2276 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount, label);2277 }22782279 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2280 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2281 }2282}228322842285class UniqueTokenBase implements IToken {2286 collection: UniqueNFTCollection | UniqueRFTCollection;2287 collectionId: number;2288 tokenId: number;22892290 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2291 this.collection = collection;2292 this.collectionId = collection.collectionId;2293 this.tokenId = tokenId;2294 }22952296 async getNextSponsored(addressObj: ICrossAccountId) {2297 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2298 }22992300 async setProperties(signer: TSigner, properties: IProperty[], label?: string) {2301 return await this.collection.setTokenProperties(signer, this.tokenId, properties, label);2302 }23032304 async deleteProperties(signer: TSigner, propertyKeys: string[], label?: string) {2305 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys, label);2306 }2307}230823092310class UniqueNFTToken extends UniqueTokenBase {2311 collection: UniqueNFTCollection;23122313 constructor(tokenId: number, collection: UniqueNFTCollection) {2314 super(tokenId, collection);2315 this.collection = collection;2316 }23172318 async getData(blockHashAt?: string) {2319 return await this.collection.getToken(this.tokenId, blockHashAt);2320 }23212322 async getOwner(blockHashAt?: string) {2323 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2324 }23252326 async getTopmostOwner(blockHashAt?: string) {2327 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2328 }23292330 async getChildren(blockHashAt?: string) {2331 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2332 }23332334 async nest(signer: TSigner, toTokenObj: IToken, label?: string) {2335 return await this.collection.nestToken(signer, this.tokenId, toTokenObj, label);2336 }23372338 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId, label?: string) {2339 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj, label);2340 }23412342 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2343 return await this.collection.transferToken(signer, this.tokenId, addressObj);2344 }23452346 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2347 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2348 }23492350 async approve(signer: TSigner, toAddressObj: ICrossAccountId, label?: string) {2351 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, label);2352 }23532354 async isApproved(toAddressObj: ICrossAccountId) {2355 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2356 }23572358 async burn(signer: TSigner, label?: string) {2359 return await this.collection.burnToken(signer, this.tokenId, label);2360 }2361}23622363class UniqueRFTToken extends UniqueTokenBase {2364 collection: UniqueRFTCollection;23652366 constructor(tokenId: number, collection: UniqueRFTCollection) {2367 super(tokenId, collection);2368 this.collection = collection;2369 }23702371 async getTop10Owners() {2372 return await this.collection.getTop10TokenOwners(this.tokenId);2373 }23742375 async getBalance(addressObj: ICrossAccountId) {2376 return await this.collection.getTokenBalance(this.tokenId, addressObj);2377 }23782379 async getTotalPieces() {2380 return await this.collection.getTokenTotalPieces(this.tokenId);2381 }23822383 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=100n) {2384 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2385 }23862387 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=100n) {2388 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2389 }23902391 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=100n, label?: string) {2392 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount, label);2393 }23942395 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2396 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2397 }23982399 async repartition(signer: TSigner, amount: bigint, label?: string) {2400 return await this.collection.repartitionToken(signer, this.tokenId, amount, label);2401 }24022403 async burn(signer: TSigner, amount=100n, label?: string) {2404 return await this.collection.burnToken(signer, this.tokenId, amount, label);2405 }2406}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IChainEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};202122const nesting = {23 toChecksumAddress(address: string): string {24 if (typeof address === 'undefined') return '';2526 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2728 address = address.toLowerCase().replace(/^0x/i,'');29 const addressHash = keccakAsHex(address).replace(/^0x/i,'');30 const checksumAddress = ['0x'];3132 for (let i = 0; i < address.length; i++) {33 // If ith character is 8 to f then make it uppercase34 if (parseInt(addressHash[i], 16) > 7) {35 checksumAddress.push(address[i].toUpperCase());36 } else {37 checksumAddress.push(address[i]);38 }39 }40 return checksumAddress.join('');41 },42 tokenIdToAddress(collectionId: number, tokenId: number) {43 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);44 },45};4647class UniqueUtil {48 static transactionStatus = {49 NOT_READY: 'NotReady',50 FAIL: 'Fail',51 SUCCESS: 'Success',52 };5354 static chainLogType = {55 EXTRINSIC: 'extrinsic',56 RPC: 'rpc',57 };5859 static getNestingTokenAddress(collectionId: number, tokenId: number) {60 return nesting.tokenIdToAddress(collectionId, tokenId);61 }6263 static getDefaultLogger(): ILogger {64 return {65 log(msg: any, level = 'INFO') {66 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));67 },68 level: {69 ERROR: 'ERROR',70 WARNING: 'WARNING',71 INFO: 'INFO',72 },73 };74 }7576 static vec2str(arr: string[] | number[]) {77 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');78 }7980 static str2vec(string: string) {81 if (typeof string !== 'string') return string;82 return Array.from(string).map(x => x.charCodeAt(0));83 }8485 static fromSeed(seed: string, ss58Format = 42) {86 const keyring = new Keyring({type: 'sr25519', ss58Format});87 return keyring.addFromUri(seed);88 }8990 static normalizeSubstrateAddress(address: string, ss58Format = 42) {91 return encodeAddress(decodeAddress(address), ss58Format);92 }9394 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult) {95 if (creationResult.status !== this.transactionStatus.SUCCESS) {96 throw Error('Unable to create collection!');97 }9899 let collectionId = null;100 creationResult.result.events.forEach(({event: {data, method, section}}) => {101 if ((section === 'common') && (method === 'CollectionCreated')) {102 collectionId = parseInt(data[0].toString(), 10);103 }104 });105106 if (collectionId === null) {107 throw Error('No CollectionCreated event was found!');108 }109110 return collectionId;111 }112113 static extractTokensFromCreationResult(creationResult: ITransactionResult) {114 if (creationResult.status !== this.transactionStatus.SUCCESS) {115 throw Error('Unable to create tokens!');116 }117 let success = false;118 const tokens = [] as any;119 creationResult.result.events.forEach(({event: {data, method, section}}) => {120 if (method === 'ExtrinsicSuccess') {121 success = true;122 } else if ((section === 'common') && (method === 'ItemCreated')) {123 tokens.push({124 collectionId: parseInt(data[0].toString(), 10),125 tokenId: parseInt(data[1].toString(), 10),126 owner: data[2].toJSON(),127 });128 }129 });130 return {success, tokens};131 }132133 static extractTokensFromBurnResult(burnResult: ITransactionResult) {134 if (burnResult.status !== this.transactionStatus.SUCCESS) {135 throw Error('Unable to burn tokens!');136 }137 let success = false;138 const tokens = [] as any;139 burnResult.result.events.forEach(({event: {data, method, section}}) => {140 if (method === 'ExtrinsicSuccess') {141 success = true;142 } else if ((section === 'common') && (method === 'ItemDestroyed')) {143 tokens.push({144 collectionId: parseInt(data[0].toString(), 10),145 tokenId: parseInt(data[1].toString(), 10),146 owner: data[2].toJSON(),147 });148 }149 });150 return {success, tokens};151 }152153 static findCollectionInEvents(events: {event: IChainEvent}[], collectionId: number, expectedSection: string, expectedMethod: string) {154 let eventId = null;155 events.forEach(({event: {data, method, section}}) => {156 if ((section === expectedSection) && (method === expectedMethod)) {157 eventId = parseInt(data[0].toString(), 10);158 }159 });160161 if (eventId === null) {162 throw Error(`No ${expectedMethod} event was found!`);163 }164 return eventId === collectionId;165 }166167 static isTokenTransferSuccess(events: {event: IChainEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {168 const normalizeAddress = (address: string | ICrossAccountId) => {169 if(typeof address === 'string') return address;170 const obj = {} as any;171 Object.keys(address).forEach(k => {172 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];173 });174 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};175 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};176 return address;177 };178 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;179 events.forEach(({event: {data, method, section}}) => {180 if ((section === 'common') && (method === 'Transfer')) {181 const hData = (data as any).toJSON();182 transfer = {183 collectionId: hData[0],184 tokenId: hData[1],185 from: normalizeAddress(hData[2]),186 to: normalizeAddress(hData[3]),187 amount: BigInt(hData[4]),188 };189 }190 });191 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;192 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);193 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);194 isSuccess = isSuccess && amount === transfer.amount;195 return isSuccess;196 }197}198199200class ChainHelperBase {201 transactionStatus = UniqueUtil.transactionStatus;202 chainLogType = UniqueUtil.chainLogType;203 util: typeof UniqueUtil;204 logger: ILogger;205 api: ApiPromise | null;206 forcedNetwork: TUniqueNetworks | null;207 network: TUniqueNetworks | null;208 chainLog: IUniqueHelperLog[];209210 constructor(logger?: ILogger) {211 this.util = UniqueUtil;212 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();213 this.logger = logger;214 this.api = null;215 this.forcedNetwork = null;216 this.network = null;217 this.chainLog = [];218 }219220 clearChainLog(): void {221 this.chainLog = [];222 }223224 forceNetwork(value: TUniqueNetworks): void {225 this.forcedNetwork = value;226 }227228 async connect(wsEndpoint: string, listeners?: IApiListeners) {229 if (this.api !== null) throw Error('Already connected');230 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);231 this.api = api;232 this.network = network;233 }234235 async disconnect() {236 if (this.api === null) return;237 await this.api.disconnect();238 this.api = null;239 this.network = null;240 }241242 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {243 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;244 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;245 return 'opal';246 }247248 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {249 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});250 await api.isReady;251252 const network = await this.detectNetwork(api);253254 await api.disconnect();255256 return network;257 }258259 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{ 260 api: ApiPromise; 261 network: TUniqueNetworks; 262 }> {263 if(typeof network === 'undefined' || network === null) network = 'opal';264 const supportedRPC = {265 opal: {266 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,267 },268 quartz: {269 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,270 },271 unique: {272 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,273 },274 };275 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);276 const rpc = supportedRPC[network];277278 // TODO: investigate how to replace rpc in runtime279 // api._rpcCore.addUserInterfaces(rpc);280281 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});282283 await api.isReadyOrError;284285 if (typeof listeners === 'undefined') listeners = {};286 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {287 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;288 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);289 }290291 return {api, network};292 }293294 getTransactionStatus(data: {events: {event: IChainEvent}[], status: any}) {295 const {events, status} = data;296 if (status.isReady) {297 return this.transactionStatus.NOT_READY;298 }299 if (status.isBroadcast) {300 return this.transactionStatus.NOT_READY;301 }302 if (status.isInBlock || status.isFinalized) {303 const errors = events.filter(e => e.event.data.method === 'ExtrinsicFailed');304 if (errors.length > 0) {305 return this.transactionStatus.FAIL;306 }307 if (events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {308 return this.transactionStatus.SUCCESS;309 }310 }311312 return this.transactionStatus.FAIL;313 }314315 signTransaction(sender: TSigner, transaction: any, label = 'transaction', options: any = null) {316 const sign = (callback: any) => {317 if(options !== null) return transaction.signAndSend(sender, options, callback);318 return transaction.signAndSend(sender, callback);319 };320 return new Promise(async (resolve, reject) => {321 try {322 const unsub = await sign((result: any) => {323 const status = this.getTransactionStatus(result);324325 if (status === this.transactionStatus.SUCCESS) {326 this.logger.log(`${label} successful`);327 unsub();328 resolve({result, status});329 } else if (status === this.transactionStatus.FAIL) {330 let moduleError = null;331332 if (result.hasOwnProperty('dispatchError')) {333 const dispatchError = result['dispatchError'];334335 if (dispatchError && dispatchError.isModule) {336 const modErr = dispatchError.asModule;337 const errorMeta = dispatchError.registry.findMetaError(modErr);338339 moduleError = `${errorMeta.section}.${errorMeta.name}`;340 }341 else {342 this.logger.log(result, this.logger.level.ERROR);343 }344 }345346 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);347 unsub();348 reject({status, moduleError, result});349 }350 });351 } catch (e) {352 this.logger.log(e, this.logger.level.ERROR);353 reject(e);354 }355 });356 }357358 constructApiCall(apiCall: string, params: any[]) {359 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);360 let call = this.api as any;361 for(const part of apiCall.slice(4).split('.')) {362 call = call[part];363 }364 return call(...params);365 }366367 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=false/*, failureMessage='expected success'*/) {368 if(this.api === null) throw Error('API not initialized');369 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);370371 const startTime = (new Date()).getTime();372 let result: ITransactionResult;373 let events = [];374 try {375 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), extrinsic) as ITransactionResult;376 events = result.result.events.map((x: any) => x.toHuman());377 }378 catch(e) {379 if(!(e as object).hasOwnProperty('status')) throw e;380 result = e as ITransactionResult;381 }382383 const endTime = (new Date()).getTime();384385 const log = {386 executedAt: endTime,387 executionTime: endTime - startTime,388 type: this.chainLogType.EXTRINSIC,389 status: result.status,390 call: extrinsic,391 params,392 } as IUniqueHelperLog;393394 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;395 if(events.length > 0) log.events = events;396397 this.chainLog.push(log);398399 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);400 return result;401 }402403 async callRpc(rpc: string, params?: any[]) {404 if(typeof params === 'undefined') params = [];405 if(this.api === null) throw Error('API not initialized');406 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);407408 const startTime = (new Date()).getTime();409 let result;410 let error = null;411 const log = {412 type: this.chainLogType.RPC,413 call: rpc,414 params,415 } as IUniqueHelperLog;416417 try {418 result = await this.constructApiCall(rpc, params);419 }420 catch(e) {421 error = e;422 }423424 const endTime = (new Date()).getTime();425426 log.executedAt = endTime;427 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';428 log.executionTime = endTime - startTime;429430 this.chainLog.push(log);431432 if(error !== null) throw error;433434 return result;435 }436437 getSignerAddress(signer: IKeyringPair | string): string {438 if(typeof signer === 'string') return signer;439 return signer.address;440 }441}442443444class HelperGroup {445 helper: UniqueHelper;446447 constructor(uniqueHelper: UniqueHelper) {448 this.helper = uniqueHelper;449 }450}451452453class CollectionGroup extends HelperGroup {454 /**455 * Get number of blocks when sponsored transaction is available.456 *457 * @param collectionId ID of collection458 * @param tokenId ID of token459 * @param addressObj address for which the sponsorship is checked460 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});461 * @returns number of blocks or null if sponsorship hasn't been set462 */463 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {464 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();465 }466467 /**468 * Get the number of created collections.469 * 470 * @returns number of created collections471 */472 async getTotalCount(): Promise<number> {473 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();474 }475476 /**477 * Get information about the collection with additional data, including the number of tokens it contains, its administrators, the normalized address of the collection's owner, and decoded name and description.478 * 479 * @param collectionId ID of collection480 * @example await getData(2)481 * @returns collection information object482 */483 async getData(collectionId: number): Promise<{484 id: number;485 name: string;486 description: string;487 tokensCount: number;488 admins: ICrossAccountId[];489 normalizedOwner: TSubstrateAccount;490 raw: any491 } | null> {492 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);493 const humanCollection = collection.toHuman(), collectionData = {494 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],495 raw: humanCollection,496 } as any, jsonCollection = collection.toJSON();497 if (humanCollection === null) return null;498 collectionData.raw.limits = jsonCollection.limits;499 collectionData.raw.permissions = jsonCollection.permissions;500 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);501 for (const key of ['name', 'description']) {502 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);503 }504505 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode)) ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId) : 0;506 collectionData.admins = await this.getAdmins(collectionId);507508 return collectionData;509 }510511 /**512 * Get the normalized addresses of the collection's administrators.513 * 514 * @param collectionId ID of collection515 * @example await getAdmins(1)516 * @returns array of administrators517 */518 async getAdmins(collectionId: number): Promise<ICrossAccountId[]> {519 const normalized = [];520 for(const admin of (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman()) {521 if(admin.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(admin.Substrate)});522 else normalized.push(admin);523 }524 return normalized;525 }526527 /**528 * Get the normalized addresses added to the collection allow-list.529 * @param collectionId ID of collection530 * @example await getAllowList(1)531 * @returns array of allow-listed addresses532 */533 async getAllowList(collectionId: number): Promise<ICrossAccountId[]> {534 const normalized = [];535 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();536 for (const address of allowListed) {537 if (address.Substrate) normalized.push({Substrate: this.helper.address.normalizeSubstrate(address.Substrate)});538 else normalized.push(address);539 }540 return normalized;541 }542543 /**544 * Get the effective limits of the collection instead of null for default values545 * 546 * @param collectionId ID of collection547 * @example await getEffectiveLimits(2)548 * @returns object of collection limits549 */550 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {551 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();552 }553554 /**555 * Burns the collection if the signer has sufficient permissions and collection is empty.556 * 557 * @param signer keyring of signer558 * @param collectionId ID of collection559 * @example await helper.collection.burn(aliceKeyring, 3);560 * @returns ```true``` if extrinsic success, otherwise ```false```561 */562 async burn(signer: TSigner, collectionId: number): Promise<boolean> {563 const result = await this.helper.executeExtrinsic(564 signer,565 'api.tx.unique.destroyCollection', [collectionId],566 true,567 );568569 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');570 }571572 /**573 * Sets the sponsor for the collection (Requires the Substrate address).574 * 575 * @param signer keyring of signer576 * @param collectionId ID of collection577 * @param sponsorAddress Sponsor substrate address578 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")579 * @returns ```true``` if extrinsic success, otherwise ```false```580 */581 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {582 const result = await this.helper.executeExtrinsic(583 signer,584 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],585 true,586 );587588 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');589 }590591 /**592 * Confirms consent to sponsor the collection on behalf of the signer.593 * 594 * @param signer keyring of signer595 * @param collectionId ID of collection596 * @example confirmSponsorship(aliceKeyring, 10)597 * @returns ```true``` if extrinsic success, otherwise ```false```598 */599 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {600 const result = await this.helper.executeExtrinsic(601 signer,602 'api.tx.unique.confirmSponsorship', [collectionId],603 true,604 );605606 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');607 }608609 /**610 * Sets the limits of the collection. At least one limit must be specified for a correct call.611 * 612 * @param signer keyring of signer613 * @param collectionId ID of collection614 * @param limits collection limits object615 * @example616 * await setLimits(617 * aliceKeyring,618 * 10,619 * {620 * sponsorTransferTimeout: 0,621 * ownerCanDestroy: false622 * }623 * )624 * @returns ```true``` if extrinsic success, otherwise ```false```625 */626 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {627 const result = await this.helper.executeExtrinsic(628 signer,629 'api.tx.unique.setCollectionLimits', [collectionId, limits],630 true,631 );632633 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');634 }635636 /**637 * Changes the owner of the collection to the new Substrate address.638 * 639 * @param signer keyring of signer640 * @param collectionId ID of collection641 * @param ownerAddress substrate address of new owner642 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")643 * @returns ```true``` if extrinsic success, otherwise ```false```644 */645 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {646 const result = await this.helper.executeExtrinsic(647 signer,648 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],649 true,650 );651652 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');653 }654655 /**656 * Adds a collection administrator. 657 * 658 * @param signer keyring of signer659 * @param collectionId ID of collection660 * @param adminAddressObj Administrator address (substrate or ethereum)661 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})662 * @returns ```true``` if extrinsic success, otherwise ```false```663 */664 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {665 const result = await this.helper.executeExtrinsic(666 signer,667 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],668 true,669 );670671 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');672 }673674 /**675 * Removes a collection administrator.676 * 677 * @param signer keyring of signer678 * @param collectionId ID of collection679 * @param adminAddressObj Administrator address (substrate or ethereum)680 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})681 * @returns ```true``` if extrinsic success, otherwise ```false```682 */683 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {684 const result = await this.helper.executeExtrinsic(685 signer,686 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],687 true,688 );689690 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');691 }692693 /**694 * Adds an address to allow list 695 * @param signer keyring of signer696 * @param collectionId ID of collection697 * @param addressObj address to add to the allow list698 * @returns ```true``` if extrinsic success, otherwise ```false```699 */700 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {701 const result = await this.helper.executeExtrinsic(702 signer,703 'api.tx.unique.addToAllowList', [collectionId, addressObj],704 true,705 );706707 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');708 }709710 /**711 * Removes an address from allow list 712 * 713 * @param signer keyring of signer714 * @param collectionId ID of collection715 * @param addressObj address to remove from the allow list716 * @returns ```true``` if extrinsic success, otherwise ```false```717 */718 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {719 const result = await this.helper.executeExtrinsic(720 signer,721 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],722 true,723 );724725 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');726 }727728 /**729 * Sets onchain permissions for selected collection.730 * 731 * @param signer keyring of signer732 * @param collectionId ID of collection733 * @param permissions collection permissions object734 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});735 * @returns ```true``` if extrinsic success, otherwise ```false```736 */737 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {738 const result = await this.helper.executeExtrinsic(739 signer,740 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],741 true,742 );743744 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');745 }746747 /**748 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.749 * 750 * @param signer keyring of signer751 * @param collectionId ID of collection752 * @param permissions nesting permissions object753 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});754 * @returns ```true``` if extrinsic success, otherwise ```false```755 */756 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {757 return await this.setPermissions(signer, collectionId, {nesting: permissions});758 }759760 /**761 * Disables nesting for selected collection.762 * 763 * @param signer keyring of signer764 * @param collectionId ID of collection765 * @example disableNesting(aliceKeyring, 10);766 * @returns ```true``` if extrinsic success, otherwise ```false```767 */768 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {769 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});770 }771772 /**773 * Sets onchain properties to the collection.774 * 775 * @param signer keyring of signer776 * @param collectionId ID of collection777 * @param properties array of property objects778 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);779 * @returns ```true``` if extrinsic success, otherwise ```false```780 */781 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {782 const result = await this.helper.executeExtrinsic(783 signer,784 'api.tx.unique.setCollectionProperties', [collectionId, properties],785 true,786 );787788 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');789 }790791 /**792 * Deletes onchain properties from the collection.793 * 794 * @param signer keyring of signer795 * @param collectionId ID of collection796 * @param propertyKeys array of property keys to delete797 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);798 * @returns ```true``` if extrinsic success, otherwise ```false```799 */800 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {801 const result = await this.helper.executeExtrinsic(802 signer,803 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],804 true,805 );806807 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');808 }809810 /**811 * Changes the owner of the token.812 * 813 * @param signer keyring of signer814 * @param collectionId ID of collection815 * @param tokenId ID of token816 * @param addressObj address of a new owner817 * @param amount amount of tokens to be transfered. For NFT must be set to 1n818 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})819 * @returns true if the token success, otherwise false820 */821 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {822 const result = await this.helper.executeExtrinsic(823 signer,824 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],825 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,826 );827828 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);829 }830831 /**832 * 833 * Change ownership of a token(s) on behalf of the owner. 834 * 835 * @param signer keyring of signer836 * @param collectionId ID of collection837 * @param tokenId ID of token838 * @param fromAddressObj address on behalf of which the token will be sent839 * @param toAddressObj new token owner840 * @param amount amount of tokens to be transfered. For NFT must be set to 1n841 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})842 * @returns true if the token success, otherwise false843 */844 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {845 const result = await this.helper.executeExtrinsic(846 signer,847 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],848 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,849 );850 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);851 }852853 /**854 * 855 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.856 * 857 * @param signer keyring of signer858 * @param collectionId ID of collection859 * @param tokenId ID of token860 * @param amount amount of tokens to be burned. For NFT must be set to 1n861 * @example burnToken(aliceKeyring, 10, 5);862 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```863 */864 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<{865 success: boolean,866 token: number | null867 }> {868 const burnResult = await this.helper.executeExtrinsic(869 signer,870 'api.tx.unique.burnItem', [collectionId, tokenId, amount],871 true, // `Unable to burn token for ${label}`,872 );873 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);874 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');875 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};876 }877878 /**879 * Destroys a concrete instance of NFT on behalf of the owner880 * 881 * @param signer keyring of signer882 * @param collectionId ID of collection883 * @param fromAddressObj address on behalf of which the token will be burnt884 * @param tokenId ID of token885 * @param amount amount of tokens to be burned. For NFT must be set to 1n886 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})887 * @returns ```true``` if extrinsic success, otherwise ```false```888 */889 async burnTokenFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, tokenId: number, amount=1n): Promise<boolean> {890 const burnResult = await this.helper.executeExtrinsic(891 signer,892 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],893 true, // `Unable to burn token from for ${label}`,894 );895 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);896 return burnedTokens.success && burnedTokens.tokens.length > 0;897 }898899 /**900 * Set, change, or remove approved address to transfer the ownership of the NFT.901 * 902 * @param signer keyring of signer903 * @param collectionId ID of collection904 * @param tokenId ID of token905 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens906 * @param amount amount of token to be approved. For NFT must be set to 1n907 * @returns ```true``` if extrinsic success, otherwise ```false```908 */909 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {910 const approveResult = await this.helper.executeExtrinsic(911 signer, 912 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],913 true, // `Unable to approve token for ${label}`,914 );915916 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');917 }918919 /**920 * Get the amount of token pieces approved to transfer or burn. Normally 0.921 * 922 * @param collectionId ID of collection923 * @param tokenId ID of token924 * @param toAccountObj address which is approved to use token pieces925 * @param fromAccountObj address which may have allowed the use of its owned tokens926 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})927 * @returns number of approved to transfer pieces928 */929 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {930 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();931 }932933 /**934 * Get the last created token ID in a collection935 * 936 * @param collectionId ID of collection937 * @example getLastTokenId(10);938 * @returns id of the last created token939 */940 async getLastTokenId(collectionId: number): Promise<number> {941 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();942 }943944 /**945 * Check if token exists946 * 947 * @param collectionId ID of collection948 * @param tokenId ID of token949 * @example isTokenExists(10, 20);950 * @returns true if the token exists, otherwise false951 */952 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {953 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();954 }955}956957class NFTnRFT extends CollectionGroup {958 /**959 * Get tokens owned by account960 * 961 * @param collectionId ID of collection962 * @param addressObj tokens owner963 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})964 * @returns array of token ids owned by account965 */966 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {967 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();968 }969970 /**971 * Get token data972 * 973 * @param collectionId ID of collection974 * @param tokenId ID of token975 * @param blockHashAt 976 * @param propertyKeys977 * @example getToken(10, 5);978 * @returns human readable token data 979 */980 async getToken(collectionId: number, tokenId: number, blockHashAt?: string, propertyKeys?: string[]): Promise<{981 properties: IProperty[];982 owner: ICrossAccountId;983 normalizedOwner: ICrossAccountId;984 }| null> {985 let tokenData;986 if(typeof blockHashAt === 'undefined') {987 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);988 }989 else {990 if(typeof propertyKeys === 'undefined') {991 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();992 if(!collection) return null;993 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);994 }995 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);996 }997 tokenData = tokenData.toHuman();998 if (tokenData === null || tokenData.owner === null) return null;999 const owner = {} as any;1000 for (const key of Object.keys(tokenData.owner)) {1001 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1002 }1003 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1004 return tokenData;1005 }10061007 /**1008 * Set permissions to change token properties1009 * 1010 * @param signer keyring of signer1011 * @param collectionId ID of collection1012 * @param permissions permissions to change a property by the collection owner or admin1013 * @example setTokenPropertyPermissions(1014 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1015 * )1016 * @returns true if extrinsic success otherwise false1017 */1018 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1019 const result = await this.helper.executeExtrinsic(1020 signer,1021 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1022 true,1023 );10241025 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1026 }10271028 /**1029 * Set token properties1030 * 1031 * @param signer keyring of signer1032 * @param collectionId ID of collection1033 * @param tokenId ID of token1034 * @param properties 1035 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1036 * @returns ```true``` if extrinsic success, otherwise ```false```1037 */1038 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1039 const result = await this.helper.executeExtrinsic(1040 signer,1041 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1042 true,1043 );10441045 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1046 }10471048 /**1049 * Delete the provided properties of a token1050 * @param signer keyring of signer1051 * @param collectionId ID of collection1052 * @param tokenId ID of token1053 * @param propertyKeys property keys to be deleted 1054 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1055 * @returns ```true``` if extrinsic success, otherwise ```false```1056 */1057 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1058 const result = await this.helper.executeExtrinsic(1059 signer,1060 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1061 true,1062 );10631064 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1065 }10661067 /**1068 * Mint new collection1069 * 1070 * @param signer keyring of signer1071 * @param collectionOptions basic collection options and properties 1072 * @param mode NFT or RFT type of a collection1073 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1074 * @returns object of the created collection1075 */1076 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueCollectionBase> {1077 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1078 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1079 for (const key of ['name', 'description', 'tokenPrefix']) {1080 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);1081 }1082 const creationResult = await this.helper.executeExtrinsic(1083 signer,1084 'api.tx.unique.createCollectionEx', [collectionOptions],1085 true, // errorLabel,1086 );1087 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1088 }10891090 getCollectionObject(collectionId: number): any {1091 return null;1092 }10931094 getTokenObject(collectionId: number, tokenId: number): any {1095 return null;1096 }1097}109810991100class NFTGroup extends NFTnRFT {1101 /**1102 * Get collection object1103 * @param collectionId ID of collection1104 * @example getCollectionObject(2);1105 * @returns instance of UniqueNFTCollection1106 */1107 getCollectionObject(collectionId: number): UniqueNFTCollection {1108 return new UniqueNFTCollection(collectionId, this.helper);1109 }11101111 /**1112 * Get token object1113 * @param collectionId ID of collection1114 * @param tokenId ID of token1115 * @example getTokenObject(10, 5);1116 * @returns instance of UniqueNFTToken1117 */1118 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1119 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1120 }11211122 /**1123 * Get token's owner1124 * @param collectionId ID of collection1125 * @param tokenId ID of token1126 * @param blockHashAt 1127 * @example getTokenOwner(10, 5);1128 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1129 */1130 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1131 let owner;1132 if (typeof blockHashAt === 'undefined') {1133 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1134 } else {1135 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1136 }1137 return crossAccountIdFromLower(owner.toJSON());1138 }11391140 /**1141 * Is token approved to transfer1142 * @param collectionId ID of collection1143 * @param tokenId ID of token1144 * @param toAccountObj address to be approved1145 * @returns ```true``` if extrinsic success, otherwise ```false```1146 */1147 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1148 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1149 }11501151 /**1152 * Changes the owner of the token.1153 * 1154 * @param signer keyring of signer1155 * @param collectionId ID of collection1156 * @param tokenId ID of token1157 * @param addressObj address of a new owner1158 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1159 * @returns ```true``` if extrinsic success, otherwise ```false```1160 */1161 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1162 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1163 }11641165 /**1166 * 1167 * Change ownership of a NFT on behalf of the owner. 1168 * 1169 * @param signer keyring of signer1170 * @param collectionId ID of collection1171 * @param tokenId ID of token1172 * @param fromAddressObj address on behalf of which the token will be sent1173 * @param toAddressObj new token owner1174 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1175 * @returns ```true``` if extrinsic success, otherwise ```false```1176 */1177 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1178 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1179 }11801181 /**1182 * Recursively find the address that owns the token1183 * @param collectionId ID of collection1184 * @param tokenId ID of token1185 * @param blockHashAt 1186 * @example getTokenTopmostOwner(10, 5);1187 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1188 */1189 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1190 let owner;1191 if (typeof blockHashAt === 'undefined') {1192 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1193 } else {1194 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1195 }11961197 if (owner === null) return null;11981199 owner = owner.toHuman();12001201 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1202 }12031204 /**1205 * Get tokens nested in the provided token1206 * @param collectionId ID of collection1207 * @param tokenId ID of token1208 * @param blockHashAt 1209 * @example getTokenChildren(10, 5);1210 * @returns tokens whose depth of nesting is <= 5 1211 */1212 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1213 let children;1214 if(typeof blockHashAt === 'undefined') {1215 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1216 } else {1217 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1218 }12191220 return children.toJSON().map((x: any) => {1221 return {collectionId: x.collection, tokenId: x.token};1222 });1223 }12241225 /**1226 * Nest one token into another1227 * @param signer keyring of signer1228 * @param tokenObj token to be nested1229 * @param rootTokenObj token to be parent1230 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1231 * @returns ```true``` if extrinsic success, otherwise ```false```1232 */1233 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1234 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1235 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1236 if(!result) {1237 throw Error('Unable to nest token!');1238 }1239 return result;1240 }12411242 /**1243 * Remove token from nested state1244 * @param signer keyring of signer1245 * @param tokenObj token to unnest1246 * @param rootTokenObj parent of a token1247 * @param toAddressObj address of a new token owner 1248 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1249 * @returns ```true``` if extrinsic success, otherwise ```false```1250 */1251 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1252 const rootTokenAddress = {Ethereum: this.helper.util.getNestingTokenAddress(rootTokenObj.collectionId, rootTokenObj.tokenId)};1253 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1254 if(!result) {1255 throw Error('Unable to unnest token!');1256 }1257 return result;1258 }12591260 /**1261 * Mint new collection1262 * @param signer keyring of signer1263 * @param collectionOptions Collection options1264 * @example 1265 * mintCollection(aliceKeyring, {1266 * name: 'New',1267 * description: 'New collection',1268 * tokenPrefix: 'NEW',1269 * })1270 * @returns object of the created collection1271 */1272 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueNFTCollection> {1273 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1274 }12751276 /**1277 * Mint new token1278 * @param signer keyring of signer1279 * @param data token data1280 * @returns created token object1281 */1282 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFTToken> {1283 const creationResult = await this.helper.executeExtrinsic(1284 signer,1285 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1286 nft: {1287 properties: data.properties,1288 },1289 }],1290 true,1291 );1292 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1293 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1294 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1295 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1296 }12971298 /**1299 * Mint multiple NFT tokens1300 * @param signer keyring of signer1301 * @param collectionId ID of collection1302 * @param tokens array of tokens with owner and properties1303 * @example 1304 * mintMultipleTokens(aliceKeyring, 10, [{1305 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1306 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1307 * },{1308 * owner: {Ethereum: "0x9F0583DbB855d..."},1309 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1310 * }]);1311 * @returns ```true``` if extrinsic success, otherwise ```false```1312 */1313 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1314 const creationResult = await this.helper.executeExtrinsic(1315 signer,1316 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1317 true,1318 );1319 const collection = this.getCollectionObject(collectionId);1320 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1321 }13221323 /**1324 * Mint multiple NFT tokens with one owner1325 * @param signer keyring of signer1326 * @param collectionId ID of collection1327 * @param owner tokens owner1328 * @param tokens array of tokens with owner and properties1329 * @example1330 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1331 * properties: [{1332 * key: "gender",1333 * value: "female",1334 * },{1335 * key: "age",1336 * value: "33",1337 * }],1338 * }]);1339 * @returns array of newly created tokens1340 */1341 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1342 const rawTokens = [];1343 for (const token of tokens) {1344 const raw = {NFT: {properties: token.properties}};1345 rawTokens.push(raw);1346 }1347 const creationResult = await this.helper.executeExtrinsic(1348 signer,1349 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1350 true,1351 );1352 const collection = this.getCollectionObject(collectionId);1353 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1354 }13551356 /**1357 * Destroys a concrete instance of NFT.1358 * @param signer keyring of signer1359 * @param collectionId ID of collection1360 * @param tokenId ID of token1361 * @example burnToken(aliceKeyring, 10, 5);1362 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1363 */1364 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number): Promise<{ success: boolean; token: number | null; }> {1365 return await super.burnToken(signer, collectionId, tokenId, 1n);1366 }13671368 /**1369 * Set, change, or remove approved address to transfer the ownership of the NFT.1370 * 1371 * @param signer keyring of signer1372 * @param collectionId ID of collection1373 * @param tokenId ID of token1374 * @param toAddressObj address to approve1375 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1376 * @returns ```true``` if extrinsic success, otherwise ```false```1377 */1378 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1379 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1380 }1381}138213831384class RFTGroup extends NFTnRFT {1385 /**1386 * Get collection object1387 * @param collectionId ID of collection1388 * @example getCollectionObject(2);1389 * @returns instance of UniqueRFTCollection1390 */1391 getCollectionObject(collectionId: number): UniqueRFTCollection {1392 return new UniqueRFTCollection(collectionId, this.helper);1393 }13941395 /**1396 * Get token object1397 * @param collectionId ID of collection1398 * @param tokenId ID of token1399 * @example getTokenObject(10, 5);1400 * @returns instance of UniqueNFTToken1401 */1402 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1403 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1404 }14051406 /**1407 * Get top 10 token owners with the largest number of pieces 1408 * @param collectionId ID of collection1409 * @param tokenId ID of token1410 * @example getTokenTop10Owners(10, 5);1411 * @returns array of top 10 owners1412 */1413 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1414 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1415 }14161417 /**1418 * Get number of pieces owned by address1419 * @param collectionId ID of collection1420 * @param tokenId ID of token1421 * @param addressObj address token owner1422 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1423 * @returns number of pieces ownerd by address1424 */1425 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1426 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1427 }14281429 /**1430 * Transfer pieces of token to another address1431 * @param signer keyring of signer1432 * @param collectionId ID of collection1433 * @param tokenId ID of token1434 * @param addressObj address of a new owner1435 * @param amount number of pieces to be transfered1436 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1437 * @returns ```true``` if extrinsic success, otherwise ```false```1438 */1439 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1440 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1441 }14421443 /**1444 * Change ownership of some pieces of RFT on behalf of the owner. 1445 * @param signer keyring of signer1446 * @param collectionId ID of collection1447 * @param tokenId ID of token1448 * @param fromAddressObj address on behalf of which the token will be sent1449 * @param toAddressObj new token owner1450 * @param amount number of pieces to be transfered1451 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1452 * @returns ```true``` if extrinsic success, otherwise ```false```1453 */1454 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1455 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1456 }14571458 /**1459 * Mint new collection1460 * @param signer keyring of signer1461 * @param collectionOptions Collection options1462 * @example1463 * mintCollection(aliceKeyring, {1464 * name: 'New',1465 * description: 'New collection',1466 * tokenPrefix: 'NEW',1467 * })1468 * @returns object of the created collection1469 */1470 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions): Promise<UniqueRFTCollection> {1471 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1472 }14731474 /**1475 * Mint new token1476 * @param signer keyring of signer1477 * @param data token data1478 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1479 * @returns created token object1480 */1481 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFTToken> {1482 const creationResult = await this.helper.executeExtrinsic(1483 signer,1484 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1485 refungible: {1486 pieces: data.pieces,1487 properties: data.properties,1488 },1489 }],1490 true,1491 );1492 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1493 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1494 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1495 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1496 }14971498 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1499 throw Error('Not implemented');1500 const creationResult = await this.helper.executeExtrinsic(1501 signer,1502 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1503 true, // `Unable to mint RFT tokens for ${label}`,1504 );1505 const collection = this.getCollectionObject(collectionId);1506 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1507 }15081509 /**1510 * Mint multiple RFT tokens with one owner1511 * @param signer keyring of signer1512 * @param collectionId ID of collection1513 * @param owner tokens owner1514 * @param tokens array of tokens with properties and pieces1515 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1516 * @returns array of newly created RFT tokens1517 */1518 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1519 const rawTokens = [];1520 for (const token of tokens) {1521 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1522 rawTokens.push(raw);1523 }1524 const creationResult = await this.helper.executeExtrinsic(1525 signer,1526 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1527 true,1528 );1529 const collection = this.getCollectionObject(collectionId);1530 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1531 }15321533 /**1534 * Destroys a concrete instance of RFT.1535 * @param signer keyring of signer1536 * @param collectionId ID of collection1537 * @param tokenId ID of token1538 * @param amount number of pieces to be burnt1539 * @example burnToken(aliceKeyring, 10, 5);1540 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```1541 */1542 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<{ success: boolean; token: number | null; }> {1543 return await super.burnToken(signer, collectionId, tokenId, amount);1544 }15451546 /**1547 * Set, change, or remove approved address to transfer the ownership of the RFT.1548 * 1549 * @param signer keyring of signer1550 * @param collectionId ID of collection1551 * @param tokenId ID of token1552 * @param toAddressObj address to approve1553 * @param amount number of pieces to be approved1554 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1555 * @returns true if the token success, otherwise false1556 */1557 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1558 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1559 }15601561 /**1562 * Get total number of pieces1563 * @param collectionId ID of collection1564 * @param tokenId ID of token1565 * @example getTokenTotalPieces(10, 5);1566 * @returns number of pieces1567 */1568 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1569 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1570 }15711572 /**1573 * Change number of token pieces. Signer must be the owner of all token pieces.1574 * @param signer keyring of signer1575 * @param collectionId ID of collection1576 * @param tokenId ID of token1577 * @param amount new number of pieces1578 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1579 * @returns true if the repartion was success, otherwise false1580 */1581 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1582 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1583 const repartitionResult = await this.helper.executeExtrinsic(1584 signer,1585 'api.tx.unique.repartition', [collectionId, tokenId, amount],1586 true,1587 );1588 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1589 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1590 }1591}159215931594class FTGroup extends CollectionGroup {1595 /**1596 * Get collection object1597 * @param collectionId ID of collection1598 * @example getCollectionObject(2);1599 * @returns instance of UniqueFTCollection1600 */1601 getCollectionObject(collectionId: number): UniqueFTCollection {1602 return new UniqueFTCollection(collectionId, this.helper);1603 }16041605 /**1606 * Mint new fungible collection1607 * @param signer keyring of signer1608 * @param collectionOptions Collection options1609 * @param decimalPoints number of token decimals 1610 * @example1611 * mintCollection(aliceKeyring, {1612 * name: 'New',1613 * description: 'New collection',1614 * tokenPrefix: 'NEW',1615 * }, 18)1616 * @returns newly created fungible collection1617 */1618 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, decimalPoints = 0): Promise<UniqueFTCollection> {1619 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1620 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1621 collectionOptions.mode = {fungible: decimalPoints};1622 for (const key of ['name', 'description', 'tokenPrefix']) {1623 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);1624 }1625 const creationResult = await this.helper.executeExtrinsic(1626 signer,1627 'api.tx.unique.createCollectionEx', [collectionOptions],1628 true,1629 );1630 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1631 }16321633 /**1634 * Mint tokens1635 * @param signer keyring of signer1636 * @param collectionId ID of collection1637 * @param owner address owner of new tokens1638 * @param amount amount of tokens to be meanted1639 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1640 * @returns ```true``` if extrinsic success, otherwise ```false``` 1641 */1642 async mintTokens(signer: TSigner, collectionId: number, owner: ICrossAccountId | string, amount: bigint): Promise<boolean> {1643 const creationResult = await this.helper.executeExtrinsic(1644 signer,1645 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1646 fungible: {1647 value: amount,1648 },1649 }],1650 true, // `Unable to mint fungible tokens for ${label}`,1651 );1652 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1653 }16541655 /**1656 * Mint multiple Fungible tokens with one owner1657 * @param signer keyring of signer1658 * @param collectionId ID of collection1659 * @param owner tokens owner1660 * @param tokens array of tokens with properties and pieces1661 * @returns ```true``` if extrinsic success, otherwise ```false``` 1662 */1663 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {value: bigint}[]): Promise<boolean> {1664 const rawTokens = [];1665 for (const token of tokens) {1666 const raw = {Fungible: {Value: token.value}};1667 rawTokens.push(raw);1668 }1669 const creationResult = await this.helper.executeExtrinsic(1670 signer,1671 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1672 true,1673 );1674 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1675 }16761677 /**1678 * Get the top 10 owners with the largest balance for the Fungible collection 1679 * @param collectionId ID of collection1680 * @example getTop10Owners(10);1681 * @returns array of ```ICrossAccountId```1682 */1683 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1684 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1685 }16861687 /**1688 * Get account balance1689 * @param collectionId ID of collection1690 * @param addressObj address of owner1691 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1692 * @returns amount of fungible tokens owned by address1693 */1694 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1695 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1696 }16971698 /**1699 * Transfer tokens to address1700 * @param signer keyring of signer1701 * @param collectionId ID of collection1702 * @param toAddressObj address recepient1703 * @param amount amount of tokens to be sent1704 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1705 * @returns ```true``` if extrinsic success, otherwise ```false``` 1706 */1707 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1708 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1709 }17101711 /**1712 * Transfer some tokens on behalf of the owner.1713 * @param signer keyring of signer1714 * @param collectionId ID of collection1715 * @param fromAddressObj address on behalf of which tokens will be sent1716 * @param toAddressObj address where token to be sent1717 * @param amount number of tokens to be sent1718 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1719 * @returns ```true``` if extrinsic success, otherwise ```false``` 1720 */1721 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1722 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1723 }17241725 /**1726 * Destroy some amount of tokens1727 * @param signer keyring of signer1728 * @param collectionId ID of collection1729 * @param amount amount of tokens to be destroyed1730 * @example burnTokens(aliceKeyring, 10, 1000n);1731 * @returns ```true``` if extrinsic success, otherwise ```false``` 1732 */1733 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1734 return (await super.burnToken(signer, collectionId, 0, amount)).success;1735 }17361737 /**1738 * Burn some tokens on behalf of the owner.1739 * @param signer keyring of signer1740 * @param collectionId ID of collection1741 * @param fromAddressObj address on behalf of which tokens will be burnt1742 * @param amount amount of tokens to be burnt1743 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1744 * @returns ```true``` if extrinsic success, otherwise ```false``` 1745 */1746 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1747 return await super.burnTokenFrom(signer, collectionId, fromAddressObj, 0, amount);1748 }17491750 /**1751 * Get total collection supply1752 * @param collectionId 1753 * @returns 1754 */1755 async getTotalPieces(collectionId: number): Promise<bigint> {1756 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1757 }17581759 /**1760 * Set, change, or remove approved address to transfer tokens.1761 * 1762 * @param signer keyring of signer1763 * @param collectionId ID of collection1764 * @param toAddressObj address to be approved1765 * @param amount amount of tokens to be approved1766 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1767 * @returns ```true``` if extrinsic success, otherwise ```false``` 1768 */1769 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1770 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1771 }17721773 /**1774 * Get amount of fungible tokens approved to transfer1775 * @param collectionId ID of collection1776 * @param fromAddressObj owner of tokens1777 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1778 * @returns number of tokens approved for the transfer1779 */1780 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1781 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1782 }1783}178417851786class ChainGroup extends HelperGroup {1787 /**1788 * Get system properties of a chain1789 * @example getChainProperties();1790 * @returns ss58Format, token decimals, and token symbol1791 */1792 getChainProperties(): IChainProperties {1793 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1794 return {1795 ss58Format: properties.ss58Format.toJSON(),1796 tokenDecimals: properties.tokenDecimals.toJSON(),1797 tokenSymbol: properties.tokenSymbol.toJSON(),1798 };1799 }18001801 /**1802 * Get chain header1803 * @example getLatestBlockNumber();1804 * @returns the number of the last block1805 */1806 async getLatestBlockNumber(): Promise<number> {1807 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1808 }18091810 /**1811 * Get block hash by block number1812 * @param blockNumber number of block1813 * @example getBlockHashByNumber(12345);1814 * @returns hash of a block1815 */1816 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1817 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1818 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1819 return blockHash;1820 }18211822 /**1823 * Get account nonce1824 * @param address substrate address1825 * @example getNonce("5GrwvaEF5zXb26Fz...");1826 * @returns number, account's nonce1827 */1828 async getNonce(address: TSubstrateAccount): Promise<number> {1829 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1830 }1831}183218331834class BalanceGroup extends HelperGroup {1835 /**1836 * Representation of the native token in the smallest unit1837 * @example getOneTokenNominal()1838 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1839 */1840 getOneTokenNominal(): bigint {1841 const chainProperties = this.helper.chain.getChainProperties();1842 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1843 }18441845 /**1846 * Get substrate address balance1847 * @param address substrate address1848 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1849 * @returns amount of tokens on address1850 */1851 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {1852 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();1853 }18541855 /**1856 * Get ethereum address balance1857 * @param address ethereum address1858 * @example getEthereum("0x9F0583DbB855d...")1859 * @returns amount of tokens on address1860 */1861 async getEthereum(address: TEthereumAccount): Promise<bigint> {1862 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();1863 }18641865 /**1866 * Transfer tokens to substrate address1867 * @param signer keyring of signer1868 * @param address substrate address of a recepient1869 * @param amount amount of tokens to be transfered1870 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);1871 * @returns ```true``` if extrinsic success, otherwise ```false```1872 */1873 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {1874 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}`*/);18751876 let transfer = {from: null, to: null, amount: 0n} as any;1877 result.result.events.forEach(({event: {data, method, section}}) => {1878 if ((section === 'balances') && (method === 'Transfer')) {1879 transfer = {1880 from: this.helper.address.normalizeSubstrate(data[0]),1881 to: this.helper.address.normalizeSubstrate(data[1]),1882 amount: BigInt(data[2]),1883 };1884 }1885 });1886 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;1887 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;1888 isSuccess = isSuccess && BigInt(amount) === transfer.amount;1889 return isSuccess;1890 }1891}189218931894class AddressGroup extends HelperGroup {1895 /**1896 * Normalizes the address to the specified ss58 format, by default ```42```.1897 * @param address substrate address1898 * @param ss58Format format for address conversion, by default ```42```1899 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY1900 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation1901 */1902 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {1903 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);1904 }19051906 /**1907 * Get address in the connected chain format1908 * @param address substrate address1909 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network1910 * @returns address in chain format1911 */1912 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {1913 const info = this.helper.chain.getChainProperties();1914 return encodeAddress(decodeAddress(address), info.ss58Format);1915 }19161917 /**1918 * Get substrate mirror of an ethereum address1919 * @param ethAddress ethereum address1920 * @param toChainFormat false for normalized account1921 * @example ethToSubstrate('0x9F0583DbB855d...')1922 * @returns substrate mirror of a provided ethereum address1923 */1924 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {1925 if(!toChainFormat) return evmToAddress(ethAddress);1926 const info = this.helper.chain.getChainProperties();1927 return evmToAddress(ethAddress, info.ss58Format);1928 }19291930 /**1931 * Get ethereum mirror of a substrate address1932 * @param subAddress substrate account1933 * @example substrateToEth("5DnSF6RRjwteE3BrC...")1934 * @returns ethereum mirror of a provided substrate address1935 */1936 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {1937 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));1938 }1939}194019411942export class UniqueHelper extends ChainHelperBase {1943 chain: ChainGroup;1944 balance: BalanceGroup;1945 address: AddressGroup;1946 collection: CollectionGroup;1947 nft: NFTGroup;1948 rft: RFTGroup;1949 ft: FTGroup;19501951 constructor(logger?: ILogger) {1952 super(logger);1953 this.chain = new ChainGroup(this);1954 this.balance = new BalanceGroup(this);1955 this.address = new AddressGroup(this);1956 this.collection = new CollectionGroup(this);1957 this.nft = new NFTGroup(this);1958 this.rft = new RFTGroup(this);1959 this.ft = new FTGroup(this);1960 } 1961}196219631964class UniqueCollectionBase {1965 helper: UniqueHelper;1966 collectionId: number;19671968 constructor(collectionId: number, uniqueHelper: UniqueHelper) {1969 this.collectionId = collectionId;1970 this.helper = uniqueHelper;1971 }19721973 async getData() {1974 return await this.helper.collection.getData(this.collectionId);1975 }19761977 async getLastTokenId() {1978 return await this.helper.collection.getLastTokenId(this.collectionId);1979 }19801981 async isTokenExists(tokenId: number) {1982 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);1983 }19841985 async getAdmins() {1986 return await this.helper.collection.getAdmins(this.collectionId);1987 }19881989 async getAllowList() {1990 return await this.helper.collection.getAllowList(this.collectionId);1991 }19921993 async getEffectiveLimits() {1994 return await this.helper.collection.getEffectiveLimits(this.collectionId);1995 }19961997 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {1998 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);1999 }20002001 async confirmSponsorship(signer: TSigner) {2002 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2003 }20042005 async setLimits(signer: TSigner, limits: ICollectionLimits) {2006 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2007 }20082009 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2010 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2011 }20122013 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2014 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2015 }20162017 async enableAllowList(signer: TSigner, value = true/*: 'Normal' | 'AllowList' = 'AllowList'*/) {2018 return await this.setPermissions(signer, value ? {access: 'AllowList', mintMode: true} : {access: 'Normal'});2019 }20202021 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2022 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2023 }20242025 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2026 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2027 }20282029 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2030 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2031 }20322033 async setProperties(signer: TSigner, properties: IProperty[]) {2034 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2035 }20362037 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2038 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2039 }20402041 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2042 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2043 }20442045 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2046 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2047 }20482049 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2050 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2051 }20522053 async disableNesting(signer: TSigner) {2054 return await this.helper.collection.disableNesting(signer, this.collectionId);2055 }20562057 async burn(signer: TSigner) {2058 return await this.helper.collection.burn(signer, this.collectionId);2059 }2060}206120622063class UniqueNFTCollection extends UniqueCollectionBase {2064 getTokenObject(tokenId: number) {2065 return new UniqueNFTToken(tokenId, this);2066 }20672068 async getTokensByAddress(addressObj: ICrossAccountId) {2069 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2070 }20712072 async getToken(tokenId: number, blockHashAt?: string) {2073 return await this.helper.nft.getToken(this.collectionId, tokenId, blockHashAt);2074 }20752076 async getTokenOwner(tokenId: number, blockHashAt?: string) {2077 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2078 }20792080 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2081 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2082 }20832084 async getTokenChildren(tokenId: number, blockHashAt?: string) {2085 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2086 }20872088 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2089 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2090 }20912092 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2093 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2094 }20952096 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2097 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2098 }20992100 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2101 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2102 }21032104 async mintToken(signer: TSigner, owner: ICrossAccountId, properties?: IProperty[]) {2105 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2106 }21072108 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2109 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2110 }21112112 async burnToken(signer: TSigner, tokenId: number) {2113 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2114 }21152116 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2117 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2118 }21192120 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2121 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2122 }21232124 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2125 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2126 }21272128 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2129 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2130 }21312132 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2133 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2134 }2135}213621372138class UniqueRFTCollection extends UniqueCollectionBase {2139 getTokenObject(tokenId: number) {2140 return new UniqueRFTToken(tokenId, this);2141 }21422143 async getTokensByAddress(addressObj: ICrossAccountId) {2144 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2145 }21462147 async getTop10TokenOwners(tokenId: number) {2148 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2149 }21502151 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2152 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2153 }21542155 async getTokenTotalPieces(tokenId: number) {2156 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2157 }21582159 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2160 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2161 }21622163 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2164 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2165 }21662167 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2168 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2169 }21702171 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2172 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2173 }21742175 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2176 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2177 }21782179 async mintToken(signer: TSigner, owner: ICrossAccountId, pieces=100n, properties?: IProperty[]) {2180 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2181 }21822183 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]) {2184 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2185 }21862187 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2188 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2189 }21902191 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2192 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2193 }21942195 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2196 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2197 }21982199 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2200 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2201 }2202}220322042205class UniqueFTCollection extends UniqueCollectionBase {2206 async mint(signer: TSigner, owner: ICrossAccountId, amount: bigint) {2207 return await this.helper.ft.mintTokens(signer, this.collectionId, owner, amount);2208 }22092210 async mintWithOneOwner(signer: TSigner, owner: ICrossAccountId, tokens: {value: bigint}[]) {2211 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, owner, tokens);2212 }22132214 async getBalance(addressObj: ICrossAccountId) {2215 return await this.helper.ft.getBalance(this.collectionId, addressObj);2216 }22172218 async getTop10Owners() {2219 return await this.helper.ft.getTop10Owners(this.collectionId);2220 }22212222 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2223 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2224 }22252226 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2227 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2228 }22292230 async burnTokens(signer: TSigner, amount=1n) {2231 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2232 }22332234 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2235 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2236 }22372238 async getTotalPieces() {2239 return await this.helper.ft.getTotalPieces(this.collectionId);2240 }22412242 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2243 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2244 }22452246 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2247 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2248 }2249}225022512252class UniqueTokenBase implements IToken {2253 collection: UniqueNFTCollection | UniqueRFTCollection;2254 collectionId: number;2255 tokenId: number;22562257 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2258 this.collection = collection;2259 this.collectionId = collection.collectionId;2260 this.tokenId = tokenId;2261 }22622263 async getNextSponsored(addressObj: ICrossAccountId) {2264 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2265 }22662267 async setProperties(signer: TSigner, properties: IProperty[]) {2268 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2269 }22702271 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2272 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2273 }2274}227522762277class UniqueNFTToken extends UniqueTokenBase {2278 collection: UniqueNFTCollection;22792280 constructor(tokenId: number, collection: UniqueNFTCollection) {2281 super(tokenId, collection);2282 this.collection = collection;2283 }22842285 async getData(blockHashAt?: string) {2286 return await this.collection.getToken(this.tokenId, blockHashAt);2287 }22882289 async getOwner(blockHashAt?: string) {2290 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2291 }22922293 async getTopmostOwner(blockHashAt?: string) {2294 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2295 }22962297 async getChildren(blockHashAt?: string) {2298 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2299 }23002301 async nest(signer: TSigner, toTokenObj: IToken) {2302 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2303 }23042305 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2306 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2307 }23082309 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2310 return await this.collection.transferToken(signer, this.tokenId, addressObj);2311 }23122313 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2314 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2315 }23162317 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2318 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2319 }23202321 async isApproved(toAddressObj: ICrossAccountId) {2322 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2323 }23242325 async burn(signer: TSigner) {2326 return await this.collection.burnToken(signer, this.tokenId);2327 }2328}23292330class UniqueRFTToken extends UniqueTokenBase {2331 collection: UniqueRFTCollection;23322333 constructor(tokenId: number, collection: UniqueRFTCollection) {2334 super(tokenId, collection);2335 this.collection = collection;2336 }23372338 async getTop10Owners() {2339 return await this.collection.getTop10TokenOwners(this.tokenId);2340 }23412342 async getBalance(addressObj: ICrossAccountId) {2343 return await this.collection.getTokenBalance(this.tokenId, addressObj);2344 }23452346 async getTotalPieces() {2347 return await this.collection.getTokenTotalPieces(this.tokenId);2348 }23492350 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2351 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2352 }23532354 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2355 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2356 }23572358 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2359 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2360 }23612362 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2363 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2364 }23652366 async repartition(signer: TSigner, amount: bigint) {2367 return await this.collection.repartitionToken(signer, this.tokenId, amount);2368 }23692370 async burn(signer: TSigner, amount=1n) {2371 return await this.collection.burnToken(signer, this.tokenId, amount);2372 }2373}