difftreelog
tests(util): altrefactorbstrate normalization
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, SignerOptions} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IStakingInfo, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314export const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};2021const nesting = {22 toChecksumAddress(address: string): string {23 if (typeof address === 'undefined') return '';2425 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2627 address = address.toLowerCase().replace(/^0x/i,'');28 const addressHash = keccakAsHex(address).replace(/^0x/i,'');29 const checksumAddress = ['0x'];3031 for (let i = 0; i < address.length; i++) {32 // If ith character is 8 to f then make it uppercase33 if (parseInt(addressHash[i], 16) > 7) {34 checksumAddress.push(address[i].toUpperCase());35 } else {36 checksumAddress.push(address[i]);37 }38 }39 return checksumAddress.join('');40 },41 tokenIdToAddress(collectionId: number, tokenId: number) {42 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);43 },44};4546class UniqueUtil {47 static transactionStatus = {48 NOT_READY: 'NotReady',49 FAIL: 'Fail',50 SUCCESS: 'Success',51 };5253 static chainLogType = {54 EXTRINSIC: 'extrinsic',55 RPC: 'rpc',56 };5758 static getNestingTokenAddress(token: IToken) {59 return {Ethereum: this.getNestingTokenAddressRaw(token).toLowerCase()};60 }6162 static getNestingTokenAddressRaw(token: IToken) {63 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);64 }6566 static getDefaultLogger(): ILogger {67 return {68 log(msg: any, level = 'INFO') {69 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));70 },71 level: {72 ERROR: 'ERROR',73 WARNING: 'WARNING',74 INFO: 'INFO',75 },76 };77 }7879 static vec2str(arr: string[] | number[]) {80 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');81 }8283 static str2vec(string: string) {84 if (typeof string !== 'string') return string;85 return Array.from(string).map(x => x.charCodeAt(0));86 }8788 static fromSeed(seed: string, ss58Format = 42) {89 const keyring = new Keyring({type: 'sr25519', ss58Format});90 return keyring.addFromUri(seed);91 }9293 static normalizeSubstrateAddress(address: string, ss58Format = 42) {94 return encodeAddress(decodeAddress(address), ss58Format);95 }9697 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult) {98 if (creationResult.status !== this.transactionStatus.SUCCESS) {99 throw Error('Unable to create collection!');100 }101102 let collectionId = null;103 creationResult.result.events.forEach(({event: {data, method, section}}) => {104 if ((section === 'common') && (method === 'CollectionCreated')) {105 collectionId = parseInt(data[0].toString(), 10);106 }107 });108109 if (collectionId === null) {110 throw Error('No CollectionCreated event was found!');111 }112113 return collectionId;114 }115116 static extractTokensFromCreationResult(creationResult: ITransactionResult) {117 if (creationResult.status !== this.transactionStatus.SUCCESS) {118 throw Error('Unable to create tokens!');119 }120 let success = false;121 const tokens = [] as any;122 creationResult.result.events.forEach(({event: {data, method, section}}) => {123 if (method === 'ExtrinsicSuccess') {124 success = true;125 } else if ((section === 'common') && (method === 'ItemCreated')) {126 tokens.push({127 collectionId: parseInt(data[0].toString(), 10),128 tokenId: parseInt(data[1].toString(), 10),129 owner: data[2].toJSON(),130 });131 }132 });133 return {success, tokens};134 }135136 static extractTokensFromBurnResult(burnResult: ITransactionResult) {137 if (burnResult.status !== this.transactionStatus.SUCCESS) {138 throw Error('Unable to burn tokens!');139 }140 let success = false;141 const tokens = [] as any;142 burnResult.result.events.forEach(({event: {data, method, section}}) => {143 if (method === 'ExtrinsicSuccess') {144 success = true;145 } else if ((section === 'common') && (method === 'ItemDestroyed')) {146 tokens.push({147 collectionId: parseInt(data[0].toString(), 10),148 tokenId: parseInt(data[1].toString(), 10),149 owner: data[2].toJSON(),150 });151 }152 });153 return {success, tokens};154 }155156 static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string) {157 let eventId = null;158 events.forEach(({event: {data, method, section}}) => {159 if ((section === expectedSection) && (method === expectedMethod)) {160 eventId = parseInt(data[0].toString(), 10);161 }162 });163164 if (eventId === null) {165 throw Error(`No ${expectedMethod} event was found!`);166 }167 return eventId === collectionId;168 }169170 static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {171 const normalizeAddress = (address: string | ICrossAccountId) => {172 if(typeof address === 'string') return address;173 const obj = {} as any;174 Object.keys(address).forEach(k => {175 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];176 });177 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};178 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};179 return address;180 };181 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;182 events.forEach(({event: {data, method, section}}) => {183 if ((section === 'common') && (method === 'Transfer')) {184 const hData = (data as any).toJSON();185 transfer = {186 collectionId: hData[0],187 tokenId: hData[1],188 from: normalizeAddress(hData[2]),189 to: normalizeAddress(hData[3]),190 amount: BigInt(hData[4]),191 };192 }193 });194 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;195 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);196 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);197 isSuccess = isSuccess && amount === transfer.amount;198 return isSuccess;199 }200}201202class UniqueEventHelper {203 private static extractIndex(index: any): [number, number] | string {204 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];205 return index.toJSON();206 }207208 private static extractSub(data: any, subTypes: any): {[key: string]: any} {209 let obj: any = {};210 let index = 0;211212 if (data.entries) {213 for(const [key, value] of data.entries()) {214 obj[key] = this.extractData(value, subTypes[index]);215 index++;216 }217 } else obj = data.toJSON();218219 return obj;220 }221 222 private static extractData(data: any, type: any): any {223 if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();224 if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();225 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);226 return data.toHuman();227 }228229 public static extractEvents(records: ITransactionResult): IEvent[] {230 const parsedEvents: IEvent[] = [];231232 records.result.events.forEach((record) => {233 const {event, phase} = record;234 const types = (event as any).typeDef;235236 const eventData: IEvent = {237 section: event.section.toString(),238 method: event.method.toString(),239 index: this.extractIndex(event.index),240 data: [],241 phase: phase.toJSON(),242 };243244 event.data.forEach((val: any, index: number) => {245 eventData.data.push(this.extractData(val, types[index]));246 });247248 parsedEvents.push(eventData);249 });250251 return parsedEvents;252 }253}254255class ChainHelperBase {256 transactionStatus = UniqueUtil.transactionStatus;257 chainLogType = UniqueUtil.chainLogType;258 util: typeof UniqueUtil;259 eventHelper: typeof UniqueEventHelper;260 logger: ILogger;261 api: ApiPromise | null;262 forcedNetwork: TUniqueNetworks | null;263 network: TUniqueNetworks | null;264 chainLog: IUniqueHelperLog[];265266 constructor(logger?: ILogger) {267 this.util = UniqueUtil;268 this.eventHelper = UniqueEventHelper;269 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();270 this.logger = logger;271 this.api = null;272 this.forcedNetwork = null;273 this.network = null;274 this.chainLog = [];275 }276277 clearChainLog(): void {278 this.chainLog = [];279 }280281 forceNetwork(value: TUniqueNetworks): void {282 this.forcedNetwork = value;283 }284285 async connect(wsEndpoint: string, listeners?: IApiListeners) {286 if (this.api !== null) throw Error('Already connected');287 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);288 this.api = api;289 this.network = network;290 }291292 async disconnect() {293 if (this.api === null) return;294 await this.api.disconnect();295 this.api = null;296 this.network = null;297 }298299 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {300 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;301 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;302 return 'opal';303 }304305 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {306 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});307 await api.isReady;308309 const network = await this.detectNetwork(api);310311 await api.disconnect();312313 return network;314 }315316 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{317 api: ApiPromise;318 network: TUniqueNetworks;319 }> {320 if(typeof network === 'undefined' || network === null) network = 'opal';321 const supportedRPC = {322 opal: {323 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,324 },325 quartz: {326 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,327 },328 unique: {329 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,330 },331 };332 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);333 const rpc = supportedRPC[network];334335 // TODO: investigate how to replace rpc in runtime336 // api._rpcCore.addUserInterfaces(rpc);337338 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});339340 await api.isReadyOrError;341342 if (typeof listeners === 'undefined') listeners = {};343 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {344 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;345 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);346 }347348 return {api, network};349 }350351 getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {352 const {events, status} = data;353 if (status.isReady) {354 return this.transactionStatus.NOT_READY;355 }356 if (status.isBroadcast) {357 return this.transactionStatus.NOT_READY;358 }359 if (status.isInBlock || status.isFinalized) {360 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');361 if (errors.length > 0) {362 return this.transactionStatus.FAIL;363 }364 if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {365 return this.transactionStatus.SUCCESS;366 }367 }368369 return this.transactionStatus.FAIL;370 }371372 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {373 const sign = (callback: any) => {374 if(options !== null) return transaction.signAndSend(sender, options, callback);375 return transaction.signAndSend(sender, callback);376 };377 // eslint-disable-next-line no-async-promise-executor378 return new Promise(async (resolve, reject) => {379 try {380 const unsub = await sign((result: any) => {381 const status = this.getTransactionStatus(result);382383 if (status === this.transactionStatus.SUCCESS) {384 this.logger.log(`${label} successful`);385 unsub();386 resolve({result, status});387 } else if (status === this.transactionStatus.FAIL) {388 let moduleError = null;389390 if (result.hasOwnProperty('dispatchError')) {391 const dispatchError = result['dispatchError'];392393 if (dispatchError) {394 if (dispatchError.isModule) {395 const modErr = dispatchError.asModule;396 const errorMeta = dispatchError.registry.findMetaError(modErr);397398 moduleError = `${errorMeta.section}.${errorMeta.name}`;399 } else {400 moduleError = dispatchError.toHuman();401 }402 } else {403 this.logger.log(result, this.logger.level.ERROR);404 }405 }406407 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);408 unsub();409 reject({status, moduleError, result});410 }411 });412 } catch (e) {413 this.logger.log(e, this.logger.level.ERROR);414 reject(e);415 }416 });417 }418419 constructApiCall(apiCall: string, params: any[]) {420 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);421 let call = this.api as any;422 for(const part of apiCall.slice(4).split('.')) {423 call = call[part];424 }425 return call(...params);426 }427428 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {429 if(this.api === null) throw Error('API not initialized');430 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);431432 const startTime = (new Date()).getTime();433 let result: ITransactionResult;434 let events: IEvent[] = [];435 try {436 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;437 events = this.eventHelper.extractEvents(result);438 }439 catch(e) {440 if(!(e as object).hasOwnProperty('status')) throw e;441 result = e as ITransactionResult;442 }443444 const endTime = (new Date()).getTime();445446 const log = {447 executedAt: endTime,448 executionTime: endTime - startTime,449 type: this.chainLogType.EXTRINSIC,450 status: result.status,451 call: extrinsic,452 signer: this.getSignerAddress(sender),453 params,454 } as IUniqueHelperLog;455456 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;457 if(events.length > 0) log.events = events;458459 this.chainLog.push(log);460461 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);462 return result;463 }464465 async callRpc(rpc: string, params?: any[]) {466 if(typeof params === 'undefined') params = [];467 if(this.api === null) throw Error('API not initialized');468 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);469470 const startTime = (new Date()).getTime();471 let result;472 let error = null;473 const log = {474 type: this.chainLogType.RPC,475 call: rpc,476 params,477 } as IUniqueHelperLog;478479 try {480 result = await this.constructApiCall(rpc, params);481 }482 catch(e) {483 error = e;484 }485486 const endTime = (new Date()).getTime();487488 log.executedAt = endTime;489 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';490 log.executionTime = endTime - startTime;491492 this.chainLog.push(log);493494 if(error !== null) throw error;495496 return result;497 }498499 getSignerAddress(signer: IKeyringPair | string): string {500 if(typeof signer === 'string') return signer;501 return signer.address;502 }503504 fetchAllPalletNames(): string[] {505 if(this.api === null) throw Error('API not initialized');506 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());507 }508509 fetchMissingPalletNames(requiredPallets: string[]): string[] {510 const palletNames = this.fetchAllPalletNames();511 return requiredPallets.filter(p => !palletNames.includes(p));512 }513}514515516class HelperGroup {517 helper: UniqueHelper;518519 constructor(uniqueHelper: UniqueHelper) {520 this.helper = uniqueHelper;521 }522}523524525class CollectionGroup extends HelperGroup {526 /**527 * Get number of blocks when sponsored transaction is available.528 *529 * @param collectionId ID of collection530 * @param tokenId ID of token531 * @param addressObj address for which the sponsorship is checked532 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});533 * @returns number of blocks or null if sponsorship hasn't been set534 */535 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {536 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();537 }538539 /**540 * Get the number of created collections.541 *542 * @returns number of created collections543 */544 async getTotalCount(): Promise<number> {545 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();546 }547548 /**549 * Get information about the collection with additional data,550 * including the number of tokens it contains, its administrators,551 * the normalized address of the collection's owner, and decoded name and description.552 *553 * @param collectionId ID of collection554 * @example await getData(2)555 * @returns collection information object556 */557 async getData(collectionId: number): Promise<{558 id: number;559 name: string;560 description: string;561 tokensCount: number;562 admins: ICrossAccountId[];563 normalizedOwner: TSubstrateAccount;564 raw: any565 } | null> {566 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);567 const humanCollection = collection.toHuman(), collectionData = {568 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],569 raw: humanCollection,570 } as any, jsonCollection = collection.toJSON();571 if (humanCollection === null) return null;572 collectionData.raw.limits = jsonCollection.limits;573 collectionData.raw.permissions = jsonCollection.permissions;574 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);575 for (const key of ['name', 'description']) {576 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);577 }578579 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))580 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)581 : 0;582 collectionData.admins = await this.getAdmins(collectionId);583584 return collectionData;585 }586587 /**588 * Get the addresses of the collection's administrators, optionally normalized.589 *590 * @param collectionId ID of collection591 * @param normalize whether to normalize the addresses to the default ss58 format592 * @example await getAdmins(1)593 * @returns array of administrators594 */595 async getAdmins(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {596 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();597598 return normalize599 ? admins.map((address: any) => {600 return address.Substrate601 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}602 : address;603 })604 : admins;605 }606607 /**608 * Get the addresses added to the collection allow-list, optionally normalized.609 * @param collectionId ID of collection610 * @param normalize whether to normalize the addresses to the default ss58 format611 * @example await getAllowList(1)612 * @returns array of allow-listed addresses613 */614 async getAllowList(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {615 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();616 return normalize617 ? allowListed.map((address: any) => {618 return address.Substrate619 ? {Substrate: this.helper.address.normalizeSubstrate(address.Substrate)}620 : address;621 })622 : allowListed;623 }624625 /**626 * Get the effective limits of the collection instead of null for default values627 *628 * @param collectionId ID of collection629 * @example await getEffectiveLimits(2)630 * @returns object of collection limits631 */632 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {633 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();634 }635636 /**637 * Burns the collection if the signer has sufficient permissions and collection is empty.638 *639 * @param signer keyring of signer640 * @param collectionId ID of collection641 * @example await helper.collection.burn(aliceKeyring, 3);642 * @returns ```true``` if extrinsic success, otherwise ```false```643 */644 async burn(signer: TSigner, collectionId: number): Promise<boolean> {645 const result = await this.helper.executeExtrinsic(646 signer,647 'api.tx.unique.destroyCollection', [collectionId],648 true,649 );650651 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');652 }653654 /**655 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.656 *657 * @param signer keyring of signer658 * @param collectionId ID of collection659 * @param sponsorAddress Sponsor substrate address660 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")661 * @returns ```true``` if extrinsic success, otherwise ```false```662 */663 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {664 const result = await this.helper.executeExtrinsic(665 signer,666 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],667 true,668 );669670 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');671 }672673 /**674 * Confirms consent to sponsor the collection on behalf of the signer.675 *676 * @param signer keyring of signer677 * @param collectionId ID of collection678 * @example confirmSponsorship(aliceKeyring, 10)679 * @returns ```true``` if extrinsic success, otherwise ```false```680 */681 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {682 const result = await this.helper.executeExtrinsic(683 signer,684 'api.tx.unique.confirmSponsorship', [collectionId],685 true,686 );687688 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');689 }690691 /**692 * Removes the sponsor of a collection, regardless if it consented or not.693 *694 * @param signer keyring of signer695 * @param collectionId ID of collection696 * @example removeSponsor(aliceKeyring, 10)697 * @returns ```true``` if extrinsic success, otherwise ```false```698 */699 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {700 const result = await this.helper.executeExtrinsic(701 signer,702 'api.tx.unique.removeCollectionSponsor', [collectionId],703 true,704 );705706 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');707 }708709 /**710 * Sets the limits of the collection. At least one limit must be specified for a correct call.711 *712 * @param signer keyring of signer713 * @param collectionId ID of collection714 * @param limits collection limits object715 * @example716 * await setLimits(717 * aliceKeyring,718 * 10,719 * {720 * sponsorTransferTimeout: 0,721 * ownerCanDestroy: false722 * }723 * )724 * @returns ```true``` if extrinsic success, otherwise ```false```725 */726 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {727 const result = await this.helper.executeExtrinsic(728 signer,729 'api.tx.unique.setCollectionLimits', [collectionId, limits],730 true,731 );732733 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');734 }735736 /**737 * Changes the owner of the collection to the new Substrate address.738 *739 * @param signer keyring of signer740 * @param collectionId ID of collection741 * @param ownerAddress substrate address of new owner742 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")743 * @returns ```true``` if extrinsic success, otherwise ```false```744 */745 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {746 const result = await this.helper.executeExtrinsic(747 signer,748 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],749 true,750 );751752 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');753 }754755 /**756 * Adds a collection administrator.757 *758 * @param signer keyring of signer759 * @param collectionId ID of collection760 * @param adminAddressObj Administrator address (substrate or ethereum)761 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})762 * @returns ```true``` if extrinsic success, otherwise ```false```763 */764 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {765 const result = await this.helper.executeExtrinsic(766 signer,767 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],768 true,769 );770771 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');772 }773774 /**775 * Removes a collection administrator.776 *777 * @param signer keyring of signer778 * @param collectionId ID of collection779 * @param adminAddressObj Administrator address (substrate or ethereum)780 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})781 * @returns ```true``` if extrinsic success, otherwise ```false```782 */783 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {784 const result = await this.helper.executeExtrinsic(785 signer,786 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],787 true,788 );789790 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');791 }792793 /**794 * Check if user is in allow list.795 * 796 * @param collectionId ID of collection797 * @param user Account to check798 * @example await getAdmins(1)799 * @returns is user in allow list800 */801 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {802 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();803 }804805 /**806 * Adds an address to allow list807 * @param signer keyring of signer808 * @param collectionId ID of collection809 * @param addressObj address to add to the allow list810 * @returns ```true``` if extrinsic success, otherwise ```false```811 */812 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {813 const result = await this.helper.executeExtrinsic(814 signer,815 'api.tx.unique.addToAllowList', [collectionId, addressObj],816 true,817 );818819 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');820 }821822 /**823 * Removes an address from allow list824 *825 * @param signer keyring of signer826 * @param collectionId ID of collection827 * @param addressObj address to remove from the allow list828 * @returns ```true``` if extrinsic success, otherwise ```false```829 */830 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {831 const result = await this.helper.executeExtrinsic(832 signer,833 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],834 true,835 );836837 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');838 }839840 /**841 * Sets onchain permissions for selected collection.842 *843 * @param signer keyring of signer844 * @param collectionId ID of collection845 * @param permissions collection permissions object846 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});847 * @returns ```true``` if extrinsic success, otherwise ```false```848 */849 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {850 const result = await this.helper.executeExtrinsic(851 signer,852 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],853 true,854 );855856 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');857 }858859 /**860 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.861 *862 * @param signer keyring of signer863 * @param collectionId ID of collection864 * @param permissions nesting permissions object865 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});866 * @returns ```true``` if extrinsic success, otherwise ```false```867 */868 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {869 return await this.setPermissions(signer, collectionId, {nesting: permissions});870 }871872 /**873 * Disables nesting for selected collection.874 *875 * @param signer keyring of signer876 * @param collectionId ID of collection877 * @example disableNesting(aliceKeyring, 10);878 * @returns ```true``` if extrinsic success, otherwise ```false```879 */880 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {881 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});882 }883884 /**885 * Sets onchain properties to the collection.886 *887 * @param signer keyring of signer888 * @param collectionId ID of collection889 * @param properties array of property objects890 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);891 * @returns ```true``` if extrinsic success, otherwise ```false```892 */893 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {894 const result = await this.helper.executeExtrinsic(895 signer,896 'api.tx.unique.setCollectionProperties', [collectionId, properties],897 true,898 );899900 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');901 }902903 /**904 * Get collection properties.905 * 906 * @param collectionId ID of collection907 * @param propertyKeys optionally filter the returned properties to only these keys908 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);909 * @returns array of key-value pairs910 */911 async getProperties(collectionId: number, propertyKeys: string[] | null = null): Promise<IProperty[]> {912 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();913 }914915 /**916 * Deletes onchain properties from the collection.917 *918 * @param signer keyring of signer919 * @param collectionId ID of collection920 * @param propertyKeys array of property keys to delete921 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);922 * @returns ```true``` if extrinsic success, otherwise ```false```923 */924 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {925 const result = await this.helper.executeExtrinsic(926 signer,927 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],928 true,929 );930931 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');932 }933934 /**935 * Changes the owner of the token.936 *937 * @param signer keyring of signer938 * @param collectionId ID of collection939 * @param tokenId ID of token940 * @param addressObj address of a new owner941 * @param amount amount of tokens to be transfered. For NFT must be set to 1n942 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})943 * @returns true if the token success, otherwise false944 */945 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {946 const result = await this.helper.executeExtrinsic(947 signer,948 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],949 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,950 );951952 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);953 }954955 /**956 *957 * Change ownership of a token(s) on behalf of the owner.958 *959 * @param signer keyring of signer960 * @param collectionId ID of collection961 * @param tokenId ID of token962 * @param fromAddressObj address on behalf of which the token will be sent963 * @param toAddressObj new token owner964 * @param amount amount of tokens to be transfered. For NFT must be set to 1n965 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})966 * @returns true if the token success, otherwise false967 */968 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {969 const result = await this.helper.executeExtrinsic(970 signer,971 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],972 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,973 );974 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);975 }976977 /**978 *979 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.980 *981 * @param signer keyring of signer982 * @param collectionId ID of collection983 * @param tokenId ID of token984 * @param amount amount of tokens to be burned. For NFT must be set to 1n985 * @example burnToken(aliceKeyring, 10, 5);986 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```987 */988 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<{989 success: boolean,990 token: number | null991 }> {992 const burnResult = await this.helper.executeExtrinsic(993 signer,994 'api.tx.unique.burnItem', [collectionId, tokenId, amount],995 true, // `Unable to burn token for ${label}`,996 );997 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);998 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');999 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};1000 }10011002 /**1003 * Destroys a concrete instance of NFT on behalf of the owner1004 *1005 * @param signer keyring of signer1006 * @param collectionId ID of collection1007 * @param tokenId ID of token1008 * @param fromAddressObj address on behalf of which the token will be burnt1009 * @param amount amount of tokens to be burned. For NFT must be set to 1n1010 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1011 * @returns ```true``` if extrinsic success, otherwise ```false```1012 */1013 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1014 const burnResult = await this.helper.executeExtrinsic(1015 signer,1016 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1017 true, // `Unable to burn token from for ${label}`,1018 );1019 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1020 return burnedTokens.success && burnedTokens.tokens.length > 0;1021 }10221023 /**1024 * Set, change, or remove approved address to transfer the ownership of the NFT.1025 *1026 * @param signer keyring of signer1027 * @param collectionId ID of collection1028 * @param tokenId ID of token1029 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1030 * @param amount amount of token to be approved. For NFT must be set to 1n1031 * @returns ```true``` if extrinsic success, otherwise ```false```1032 */1033 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1034 const approveResult = await this.helper.executeExtrinsic(1035 signer,1036 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1037 true, // `Unable to approve token for ${label}`,1038 );10391040 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1041 }10421043 /**1044 * Get the amount of token pieces approved to transfer or burn. Normally 0.1045 *1046 * @param collectionId ID of collection1047 * @param tokenId ID of token1048 * @param toAccountObj address which is approved to use token pieces1049 * @param fromAccountObj address which may have allowed the use of its owned tokens1050 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1051 * @returns number of approved to transfer pieces1052 */1053 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1054 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1055 }10561057 /**1058 * Get the last created token ID in a collection1059 *1060 * @param collectionId ID of collection1061 * @example getLastTokenId(10);1062 * @returns id of the last created token1063 */1064 async getLastTokenId(collectionId: number): Promise<number> {1065 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1066 }10671068 /**1069 * Check if token exists1070 *1071 * @param collectionId ID of collection1072 * @param tokenId ID of token1073 * @example isTokenExists(10, 20);1074 * @returns true if the token exists, otherwise false1075 */1076 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {1077 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1078 }1079}10801081class NFTnRFT extends CollectionGroup {1082 /**1083 * Get tokens owned by account1084 *1085 * @param collectionId ID of collection1086 * @param addressObj tokens owner1087 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1088 * @returns array of token ids owned by account1089 */1090 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1091 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1092 }10931094 /**1095 * Get token data1096 *1097 * @param collectionId ID of collection1098 * @param tokenId ID of token1099 * @param propertyKeys optionally filter the token properties to only these keys1100 * @param blockHashAt optionally query the data at some block with this hash1101 * @example getToken(10, 5);1102 * @returns human readable token data1103 */1104 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1105 properties: IProperty[];1106 owner: ICrossAccountId;1107 normalizedOwner: ICrossAccountId;1108 }| null> {1109 let tokenData;1110 if(typeof blockHashAt === 'undefined') {1111 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1112 }1113 else {1114 if(propertyKeys.length == 0) {1115 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1116 if(!collection) return null;1117 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1118 }1119 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1120 }1121 tokenData = tokenData.toHuman();1122 if (tokenData === null || tokenData.owner === null) return null;1123 const owner = {} as any;1124 for (const key of Object.keys(tokenData.owner)) {1125 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() === 'substrate' ? this.helper.address.normalizeSubstrate(tokenData.owner[key]) : tokenData.owner[key];1126 }1127 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1128 return tokenData;1129 }11301131 /**1132 * Set permissions to change token properties1133 *1134 * @param signer keyring of signer1135 * @param collectionId ID of collection1136 * @param permissions permissions to change a property by the collection admin or token owner1137 * @example setTokenPropertyPermissions(1138 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1139 * )1140 * @returns true if extrinsic success otherwise false1141 */1142 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1143 const result = await this.helper.executeExtrinsic(1144 signer,1145 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1146 true,1147 );11481149 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1150 }11511152 /**1153 * Get token property permissions.1154 * 1155 * @param collectionId ID of collection1156 * @param propertyKeys optionally filter the returned property permissions to only these keys1157 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1158 * @returns array of key-permission pairs1159 */1160 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1161 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1162 }11631164 /**1165 * Set token properties1166 *1167 * @param signer keyring of signer1168 * @param collectionId ID of collection1169 * @param tokenId ID of token1170 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1171 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1172 * @returns ```true``` if extrinsic success, otherwise ```false```1173 */1174 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1175 const result = await this.helper.executeExtrinsic(1176 signer,1177 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1178 true,1179 );11801181 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1182 }11831184 /**1185 * Get properties, metadata assigned to a token.1186 * 1187 * @param collectionId ID of collection1188 * @param tokenId ID of token1189 * @param propertyKeys optionally filter the returned properties to only these keys1190 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1191 * @returns array of key-value pairs1192 */1193 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys: string[] | null = null): Promise<IProperty[]> {1194 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1195 }11961197 /**1198 * Delete the provided properties of a token1199 * @param signer keyring of signer1200 * @param collectionId ID of collection1201 * @param tokenId ID of token1202 * @param propertyKeys property keys to be deleted1203 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1204 * @returns ```true``` if extrinsic success, otherwise ```false```1205 */1206 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1207 const result = await this.helper.executeExtrinsic(1208 signer,1209 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1210 true,1211 );12121213 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1214 }12151216 /**1217 * Mint new collection1218 *1219 * @param signer keyring of signer1220 * @param collectionOptions basic collection options and properties1221 * @param mode NFT or RFT type of a collection1222 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1223 * @returns object of the created collection1224 */1225 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueCollectionBase> {1226 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1227 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1228 for (const key of ['name', 'description', 'tokenPrefix']) {1229 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);1230 }1231 const creationResult = await this.helper.executeExtrinsic(1232 signer,1233 'api.tx.unique.createCollectionEx', [collectionOptions],1234 true, // errorLabel,1235 );1236 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1237 }12381239 getCollectionObject(_collectionId: number): any {1240 return null;1241 }12421243 getTokenObject(_collectionId: number, _tokenId: number): any {1244 return null;1245 }1246}124712481249class NFTGroup extends NFTnRFT {1250 /**1251 * Get collection object1252 * @param collectionId ID of collection1253 * @example getCollectionObject(2);1254 * @returns instance of UniqueNFTCollection1255 */1256 getCollectionObject(collectionId: number): UniqueNFTCollection {1257 return new UniqueNFTCollection(collectionId, this.helper);1258 }12591260 /**1261 * Get token object1262 * @param collectionId ID of collection1263 * @param tokenId ID of token1264 * @example getTokenObject(10, 5);1265 * @returns instance of UniqueNFTToken1266 */1267 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1268 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1269 }12701271 /**1272 * Get token's owner1273 * @param collectionId ID of collection1274 * @param tokenId ID of token1275 * @param blockHashAt optionally query the data at the block with this hash1276 * @example getTokenOwner(10, 5);1277 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1278 */1279 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1280 let owner;1281 if (typeof blockHashAt === 'undefined') {1282 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1283 } else {1284 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1285 }1286 return crossAccountIdFromLower(owner.toJSON());1287 }12881289 /**1290 * Is token approved to transfer1291 * @param collectionId ID of collection1292 * @param tokenId ID of token1293 * @param toAccountObj address to be approved1294 * @returns ```true``` if extrinsic success, otherwise ```false```1295 */1296 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1297 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1298 }12991300 /**1301 * Changes the owner of the token.1302 *1303 * @param signer keyring of signer1304 * @param collectionId ID of collection1305 * @param tokenId ID of token1306 * @param addressObj address of a new owner1307 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1308 * @returns ```true``` if extrinsic success, otherwise ```false```1309 */1310 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1311 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1312 }13131314 /**1315 *1316 * Change ownership of a NFT on behalf of the owner.1317 *1318 * @param signer keyring of signer1319 * @param collectionId ID of collection1320 * @param tokenId ID of token1321 * @param fromAddressObj address on behalf of which the token will be sent1322 * @param toAddressObj new token owner1323 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1324 * @returns ```true``` if extrinsic success, otherwise ```false```1325 */1326 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1327 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1328 }13291330 /**1331 * Recursively find the address that owns the token1332 * @param collectionId ID of collection1333 * @param tokenId ID of token1334 * @param blockHashAt1335 * @example getTokenTopmostOwner(10, 5);1336 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1337 */1338 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1339 let owner;1340 if (typeof blockHashAt === 'undefined') {1341 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1342 } else {1343 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1344 }13451346 if (owner === null) return null;13471348 owner = owner.toHuman();13491350 return owner.Substrate ? {Substrate: this.helper.address.normalizeSubstrate(owner.Substrate)} : owner;1351 }13521353 /**1354 * Get tokens nested in the provided token1355 * @param collectionId ID of collection1356 * @param tokenId ID of token1357 * @param blockHashAt optionally query the data at the block with this hash1358 * @example getTokenChildren(10, 5);1359 * @returns tokens whose depth of nesting is <= 51360 */1361 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1362 let children;1363 if(typeof blockHashAt === 'undefined') {1364 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1365 } else {1366 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1367 }13681369 return children.toJSON().map((x: any) => {1370 return {collectionId: x.collection, tokenId: x.token};1371 });1372 }13731374 /**1375 * Nest one token into another1376 * @param signer keyring of signer1377 * @param tokenObj token to be nested1378 * @param rootTokenObj token to be parent1379 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1380 * @returns ```true``` if extrinsic success, otherwise ```false```1381 */1382 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1383 const rootTokenAddress = this.helper.util.getNestingTokenAddress(rootTokenObj);1384 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1385 if(!result) {1386 throw Error('Unable to nest token!');1387 }1388 return result;1389 }13901391 /**1392 * Remove token from nested state1393 * @param signer keyring of signer1394 * @param tokenObj token to unnest1395 * @param rootTokenObj parent of a token1396 * @param toAddressObj address of a new token owner1397 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1398 * @returns ```true``` if extrinsic success, otherwise ```false```1399 */1400 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1401 const rootTokenAddress = this.helper.util.getNestingTokenAddress(rootTokenObj);1402 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1403 if(!result) {1404 throw Error('Unable to unnest token!');1405 }1406 return result;1407 }14081409 /**1410 * Mint new collection1411 * @param signer keyring of signer1412 * @param collectionOptions Collection options1413 * @example1414 * mintCollection(aliceKeyring, {1415 * name: 'New',1416 * description: 'New collection',1417 * tokenPrefix: 'NEW',1418 * })1419 * @returns object of the created collection1420 */1421 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1422 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1423 }14241425 /**1426 * Mint new token1427 * @param signer keyring of signer1428 * @param data token data1429 * @returns created token object1430 */1431 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFTToken> {1432 const creationResult = await this.helper.executeExtrinsic(1433 signer,1434 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1435 nft: {1436 properties: data.properties,1437 },1438 }],1439 true,1440 );1441 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1442 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1443 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1444 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1445 }14461447 /**1448 * Mint multiple NFT tokens1449 * @param signer keyring of signer1450 * @param collectionId ID of collection1451 * @param tokens array of tokens with owner and properties1452 * @example1453 * mintMultipleTokens(aliceKeyring, 10, [{1454 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1455 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1456 * },{1457 * owner: {Ethereum: "0x9F0583DbB855d..."},1458 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1459 * }]);1460 * @returns ```true``` if extrinsic success, otherwise ```false```1461 */1462 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1463 const creationResult = await this.helper.executeExtrinsic(1464 signer,1465 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1466 true,1467 );1468 const collection = this.getCollectionObject(collectionId);1469 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1470 }14711472 /**1473 * Mint multiple NFT tokens with one owner1474 * @param signer keyring of signer1475 * @param collectionId ID of collection1476 * @param owner tokens owner1477 * @param tokens array of tokens with owner and properties1478 * @example1479 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1480 * properties: [{1481 * key: "gender",1482 * value: "female",1483 * },{1484 * key: "age",1485 * value: "33",1486 * }],1487 * }]);1488 * @returns array of newly created tokens1489 */1490 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1491 const rawTokens = [];1492 for (const token of tokens) {1493 const raw = {NFT: {properties: token.properties}};1494 rawTokens.push(raw);1495 }1496 const creationResult = await this.helper.executeExtrinsic(1497 signer,1498 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1499 true,1500 );1501 const collection = this.getCollectionObject(collectionId);1502 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1503 }15041505 /**1506 * Set, change, or remove approved address to transfer the ownership of the NFT.1507 *1508 * @param signer keyring of signer1509 * @param collectionId ID of collection1510 * @param tokenId ID of token1511 * @param toAddressObj address to approve1512 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1513 * @returns ```true``` if extrinsic success, otherwise ```false```1514 */1515 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1516 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1517 }1518}151915201521class RFTGroup extends NFTnRFT {1522 /**1523 * Get collection object1524 * @param collectionId ID of collection1525 * @example getCollectionObject(2);1526 * @returns instance of UniqueRFTCollection1527 */1528 getCollectionObject(collectionId: number): UniqueRFTCollection {1529 return new UniqueRFTCollection(collectionId, this.helper);1530 }15311532 /**1533 * Get token object1534 * @param collectionId ID of collection1535 * @param tokenId ID of token1536 * @example getTokenObject(10, 5);1537 * @returns instance of UniqueNFTToken1538 */1539 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1540 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1541 }15421543 /**1544 * Get top 10 token owners with the largest number of pieces1545 * @param collectionId ID of collection1546 * @param tokenId ID of token1547 * @example getTokenTop10Owners(10, 5);1548 * @returns array of top 10 owners1549 */1550 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1551 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1552 }15531554 /**1555 * Get number of pieces owned by address1556 * @param collectionId ID of collection1557 * @param tokenId ID of token1558 * @param addressObj address token owner1559 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1560 * @returns number of pieces ownerd by address1561 */1562 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1563 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1564 }15651566 /**1567 * Transfer pieces of token to another address1568 * @param signer keyring of signer1569 * @param collectionId ID of collection1570 * @param tokenId ID of token1571 * @param addressObj address of a new owner1572 * @param amount number of pieces to be transfered1573 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1574 * @returns ```true``` if extrinsic success, otherwise ```false```1575 */1576 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1577 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1578 }15791580 /**1581 * Change ownership of some pieces of RFT on behalf of the owner.1582 * @param signer keyring of signer1583 * @param collectionId ID of collection1584 * @param tokenId ID of token1585 * @param fromAddressObj address on behalf of which the token will be sent1586 * @param toAddressObj new token owner1587 * @param amount number of pieces to be transfered1588 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1589 * @returns ```true``` if extrinsic success, otherwise ```false```1590 */1591 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1592 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1593 }15941595 /**1596 * Mint new collection1597 * @param signer keyring of signer1598 * @param collectionOptions Collection options1599 * @example1600 * mintCollection(aliceKeyring, {1601 * name: 'New',1602 * description: 'New collection',1603 * tokenPrefix: 'NEW',1604 * })1605 * @returns object of the created collection1606 */1607 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1608 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1609 }16101611 /**1612 * Mint new token1613 * @param signer keyring of signer1614 * @param data token data1615 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1616 * @returns created token object1617 */1618 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFTToken> {1619 const creationResult = await this.helper.executeExtrinsic(1620 signer,1621 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1622 refungible: {1623 pieces: data.pieces,1624 properties: data.properties,1625 },1626 }],1627 true,1628 );1629 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1630 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1631 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1632 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1633 }16341635 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1636 throw Error('Not implemented');1637 const creationResult = await this.helper.executeExtrinsic(1638 signer,1639 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1640 true, // `Unable to mint RFT tokens for ${label}`,1641 );1642 const collection = this.getCollectionObject(collectionId);1643 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1644 }16451646 /**1647 * Mint multiple RFT tokens with one owner1648 * @param signer keyring of signer1649 * @param collectionId ID of collection1650 * @param owner tokens owner1651 * @param tokens array of tokens with properties and pieces1652 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1653 * @returns array of newly created RFT tokens1654 */1655 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1656 const rawTokens = [];1657 for (const token of tokens) {1658 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1659 rawTokens.push(raw);1660 }1661 const creationResult = await this.helper.executeExtrinsic(1662 signer,1663 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1664 true,1665 );1666 const collection = this.getCollectionObject(collectionId);1667 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1668 }16691670 /**1671 * Destroys a concrete instance of RFT.1672 * @param signer keyring of signer1673 * @param collectionId ID of collection1674 * @param tokenId ID of token1675 * @param amount number of pieces to be burnt1676 * @example burnToken(aliceKeyring, 10, 5);1677 * @returns ```true``` and burnt token number, if extrinsic is successful. Otherwise ```false``` and ```null```1678 */1679 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<{ success: boolean; token: number | null; }> {1680 return await super.burnToken(signer, collectionId, tokenId, amount);1681 }16821683 /**1684 * Destroys a concrete instance of RFT on behalf of the owner.1685 * @param signer keyring of signer1686 * @param collectionId ID of collection1687 * @param tokenId ID of token1688 * @param fromAddressObj address on behalf of which the token will be burnt1689 * @param amount number of pieces to be burnt1690 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1691 * @returns ```true``` if extrinsic success, otherwise ```false```1692 */1693 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1694 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1695 }16961697 /**1698 * Set, change, or remove approved address to transfer the ownership of the RFT.1699 *1700 * @param signer keyring of signer1701 * @param collectionId ID of collection1702 * @param tokenId ID of token1703 * @param toAddressObj address to approve1704 * @param amount number of pieces to be approved1705 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1706 * @returns true if the token success, otherwise false1707 */1708 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1709 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1710 }17111712 /**1713 * Get total number of pieces1714 * @param collectionId ID of collection1715 * @param tokenId ID of token1716 * @example getTokenTotalPieces(10, 5);1717 * @returns number of pieces1718 */1719 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1720 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1721 }17221723 /**1724 * Change number of token pieces. Signer must be the owner of all token pieces.1725 * @param signer keyring of signer1726 * @param collectionId ID of collection1727 * @param tokenId ID of token1728 * @param amount new number of pieces1729 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1730 * @returns true if the repartion was success, otherwise false1731 */1732 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1733 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1734 const repartitionResult = await this.helper.executeExtrinsic(1735 signer,1736 'api.tx.unique.repartition', [collectionId, tokenId, amount],1737 true,1738 );1739 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1740 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1741 }1742}174317441745class FTGroup extends CollectionGroup {1746 /**1747 * Get collection object1748 * @param collectionId ID of collection1749 * @example getCollectionObject(2);1750 * @returns instance of UniqueFTCollection1751 */1752 getCollectionObject(collectionId: number): UniqueFTCollection {1753 return new UniqueFTCollection(collectionId, this.helper);1754 }17551756 /**1757 * Mint new fungible collection1758 * @param signer keyring of signer1759 * @param collectionOptions Collection options1760 * @param decimalPoints number of token decimals1761 * @example1762 * mintCollection(aliceKeyring, {1763 * name: 'New',1764 * description: 'New collection',1765 * tokenPrefix: 'NEW',1766 * }, 18)1767 * @returns newly created fungible collection1768 */1769 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {1770 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1771 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1772 collectionOptions.mode = {fungible: decimalPoints};1773 for (const key of ['name', 'description', 'tokenPrefix']) {1774 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);1775 }1776 const creationResult = await this.helper.executeExtrinsic(1777 signer,1778 'api.tx.unique.createCollectionEx', [collectionOptions],1779 true,1780 );1781 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1782 }17831784 /**1785 * Mint tokens1786 * @param signer keyring of signer1787 * @param collectionId ID of collection1788 * @param owner address owner of new tokens1789 * @param amount amount of tokens to be meanted1790 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1791 * @returns ```true``` if extrinsic success, otherwise ```false```1792 */1793 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1794 const creationResult = await this.helper.executeExtrinsic(1795 signer,1796 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1797 fungible: {1798 value: amount,1799 },1800 }],1801 true, // `Unable to mint fungible tokens for ${label}`,1802 );1803 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1804 }18051806 /**1807 * Mint multiple Fungible tokens with one owner1808 * @param signer keyring of signer1809 * @param collectionId ID of collection1810 * @param owner tokens owner1811 * @param tokens array of tokens with properties and pieces1812 * @returns ```true``` if extrinsic success, otherwise ```false```1813 */1814 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1815 const rawTokens = [];1816 for (const token of tokens) {1817 const raw = {Fungible: {Value: token.value}};1818 rawTokens.push(raw);1819 }1820 const creationResult = await this.helper.executeExtrinsic(1821 signer,1822 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1823 true,1824 );1825 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1826 }18271828 /**1829 * Get the top 10 owners with the largest balance for the Fungible collection1830 * @param collectionId ID of collection1831 * @example getTop10Owners(10);1832 * @returns array of ```ICrossAccountId```1833 */1834 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1835 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1836 }18371838 /**1839 * Get account balance1840 * @param collectionId ID of collection1841 * @param addressObj address of owner1842 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1843 * @returns amount of fungible tokens owned by address1844 */1845 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1846 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1847 }18481849 /**1850 * Transfer tokens to address1851 * @param signer keyring of signer1852 * @param collectionId ID of collection1853 * @param toAddressObj address recipient1854 * @param amount amount of tokens to be sent1855 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1856 * @returns ```true``` if extrinsic success, otherwise ```false```1857 */1858 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1859 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1860 }18611862 /**1863 * Transfer some tokens on behalf of the owner.1864 * @param signer keyring of signer1865 * @param collectionId ID of collection1866 * @param fromAddressObj address on behalf of which tokens will be sent1867 * @param toAddressObj address where token to be sent1868 * @param amount number of tokens to be sent1869 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1870 * @returns ```true``` if extrinsic success, otherwise ```false```1871 */1872 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1873 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1874 }18751876 /**1877 * Destroy some amount of tokens1878 * @param signer keyring of signer1879 * @param collectionId ID of collection1880 * @param amount amount of tokens to be destroyed1881 * @example burnTokens(aliceKeyring, 10, 1000n);1882 * @returns ```true``` if extrinsic success, otherwise ```false```1883 */1884 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1885 return (await super.burnToken(signer, collectionId, 0, amount)).success;1886 }18871888 /**1889 * Burn some tokens on behalf of the owner.1890 * @param signer keyring of signer1891 * @param collectionId ID of collection1892 * @param fromAddressObj address on behalf of which tokens will be burnt1893 * @param amount amount of tokens to be burnt1894 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1895 * @returns ```true``` if extrinsic success, otherwise ```false```1896 */1897 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1898 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);1899 }19001901 /**1902 * Get total collection supply1903 * @param collectionId1904 * @returns1905 */1906 async getTotalPieces(collectionId: number): Promise<bigint> {1907 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1908 }19091910 /**1911 * Set, change, or remove approved address to transfer tokens.1912 *1913 * @param signer keyring of signer1914 * @param collectionId ID of collection1915 * @param toAddressObj address to be approved1916 * @param amount amount of tokens to be approved1917 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1918 * @returns ```true``` if extrinsic success, otherwise ```false```1919 */1920 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1921 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1922 }19231924 /**1925 * Get amount of fungible tokens approved to transfer1926 * @param collectionId ID of collection1927 * @param fromAddressObj owner of tokens1928 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1929 * @returns number of tokens approved for the transfer1930 */1931 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1932 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1933 }1934}193519361937class ChainGroup extends HelperGroup {1938 /**1939 * Get system properties of a chain1940 * @example getChainProperties();1941 * @returns ss58Format, token decimals, and token symbol1942 */1943 getChainProperties(): IChainProperties {1944 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1945 return {1946 ss58Format: properties.ss58Format.toJSON(),1947 tokenDecimals: properties.tokenDecimals.toJSON(),1948 tokenSymbol: properties.tokenSymbol.toJSON(),1949 };1950 }19511952 /**1953 * Get chain header1954 * @example getLatestBlockNumber();1955 * @returns the number of the last block1956 */1957 async getLatestBlockNumber(): Promise<number> {1958 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1959 }19601961 /**1962 * Get block hash by block number1963 * @param blockNumber number of block1964 * @example getBlockHashByNumber(12345);1965 * @returns hash of a block1966 */1967 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1968 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1969 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1970 return blockHash;1971 }19721973 // TODO add docs1974 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {1975 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);1976 if (!blockHash) return null;1977 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;1978 }19791980 /**1981 * Get account nonce1982 * @param address substrate address1983 * @example getNonce("5GrwvaEF5zXb26Fz...");1984 * @returns number, account's nonce1985 */1986 async getNonce(address: TSubstrateAccount): Promise<number> {1987 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1988 }1989}199019911992class BalanceGroup extends HelperGroup {1993 /**1994 * Representation of the native token in the smallest unit1995 * @example getOneTokenNominal()1996 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1997 */1998 getOneTokenNominal(): bigint {1999 const chainProperties = this.helper.chain.getChainProperties();2000 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2001 }20022003 /**2004 * Get substrate address balance2005 * @param address substrate address2006 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2007 * @returns amount of tokens on address2008 */2009 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2010 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2011 }20122013 /**2014 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2015 * @param address substrate address2016 * @returns2017 */2018 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2019 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2020 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2021 }20222023 /**2024 * Get ethereum address balance2025 * @param address ethereum address2026 * @example getEthereum("0x9F0583DbB855d...")2027 * @returns amount of tokens on address2028 */2029 async getEthereum(address: TEthereumAccount): Promise<bigint> {2030 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2031 }20322033 /**2034 * Transfer tokens to substrate address2035 * @param signer keyring of signer2036 * @param address substrate address of a recipient2037 * @param amount amount of tokens to be transfered2038 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2039 * @returns ```true``` if extrinsic success, otherwise ```false```2040 */2041 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2042 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}`*/);20432044 let transfer = {from: null, to: null, amount: 0n} as any;2045 result.result.events.forEach(({event: {data, method, section}}) => {2046 if ((section === 'balances') && (method === 'Transfer')) {2047 transfer = {2048 from: this.helper.address.normalizeSubstrate(data[0]),2049 to: this.helper.address.normalizeSubstrate(data[1]),2050 amount: BigInt(data[2]),2051 };2052 }2053 });2054 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;2055 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;2056 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2057 return isSuccess;2058 }2059}206020612062class AddressGroup extends HelperGroup {2063 /**2064 * Normalizes the address to the specified ss58 format, by default ```42```.2065 * @param address substrate address2066 * @param ss58Format format for address conversion, by default ```42```2067 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2068 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2069 */2070 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2071 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);2072 }20732074 /**2075 * Get address in the connected chain format2076 * @param address substrate address2077 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2078 * @returns address in chain format2079 */2080 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {2081 const info = this.helper.chain.getChainProperties();2082 return encodeAddress(decodeAddress(address), info.ss58Format);2083 }20842085 /**2086 * Get substrate mirror of an ethereum address2087 * @param ethAddress ethereum address2088 * @param toChainFormat false for normalized account2089 * @example ethToSubstrate('0x9F0583DbB855d...')2090 * @returns substrate mirror of a provided ethereum address2091 */2092 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {2093 if(!toChainFormat) return evmToAddress(ethAddress);2094 const info = this.helper.chain.getChainProperties();2095 return evmToAddress(ethAddress, info.ss58Format);2096 }20972098 /**2099 * Get ethereum mirror of a substrate address2100 * @param subAddress substrate account2101 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2102 * @returns ethereum mirror of a provided substrate address2103 */2104 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2105 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));2106 }2107}21082109class StakingGroup extends HelperGroup {2110 /**2111 * Stake tokens for App Promotion2112 * @param signer keyring of signer2113 * @param amountToStake amount of tokens to stake2114 * @param label extra label for log2115 * @returns2116 */2117 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2118 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2119 const stakeResult = await this.helper.executeExtrinsic(2120 signer, 'api.tx.appPromotion.stake',2121 [amountToStake], true,2122 );2123 // TODO extract info from stakeResult2124 return true;2125 }21262127 /**2128 * Unstake tokens for App Promotion2129 * @param signer keyring of signer2130 * @param amountToUnstake amount of tokens to unstake2131 * @param label extra label for log2132 * @returns block number where balances will be unlocked2133 */2134 async unstake(signer: TSigner, label?: string): Promise<number> {2135 if(typeof label === 'undefined') label = `${signer.address}`;2136 const unstakeResult = await this.helper.executeExtrinsic(2137 signer, 'api.tx.appPromotion.unstake',2138 [], true,2139 );2140 // TODO extract block number fron events2141 return 1;2142 }21432144 /**2145 * Get total staked amount for address2146 * @param address substrate or ethereum address2147 * @returns total staked amount2148 */2149 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2150 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2151 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2152 }21532154 /**2155 * Get total staked per block2156 * @param address substrate or ethereum address2157 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2158 */2159 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2160 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2161 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2162 return { 2163 block: block.toBigInt(),2164 amount: amount.toBigInt(),2165 };2166 });2167 }21682169 /**2170 * Get total pending unstake amount for address2171 * @param address substrate or ethereum address2172 * @returns total pending unstake amount2173 */2174 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2175 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2176 }21772178 /**2179 * Get pending unstake amount per block for address2180 * @param address substrate or ethereum address2181 * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2182 */2183 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2184 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2185 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2186 return {2187 block: block.toBigInt(),2188 amount: amount.toBigInt(),2189 };2190 });2191 return result;2192 }2193}21942195export class UniqueHelper extends ChainHelperBase {2196 chain: ChainGroup;2197 balance: BalanceGroup;2198 address: AddressGroup;2199 collection: CollectionGroup;2200 nft: NFTGroup;2201 rft: RFTGroup;2202 ft: FTGroup;2203 staking: StakingGroup;22042205 constructor(logger?: ILogger) {2206 super(logger);2207 this.chain = new ChainGroup(this);2208 this.balance = new BalanceGroup(this);2209 this.address = new AddressGroup(this);2210 this.collection = new CollectionGroup(this);2211 this.nft = new NFTGroup(this);2212 this.rft = new RFTGroup(this);2213 this.ft = new FTGroup(this);2214 this.staking = new StakingGroup(this);2215 }2216}221722182219export class UniqueCollectionBase {2220 helper: UniqueHelper;2221 collectionId: number;22222223 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2224 this.collectionId = collectionId;2225 this.helper = uniqueHelper;2226 }22272228 async getData() {2229 return await this.helper.collection.getData(this.collectionId);2230 }22312232 async getLastTokenId() {2233 return await this.helper.collection.getLastTokenId(this.collectionId);2234 }22352236 async isTokenExists(tokenId: number) {2237 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2238 }22392240 async getAdmins() {2241 return await this.helper.collection.getAdmins(this.collectionId);2242 }22432244 async getAllowList() {2245 return await this.helper.collection.getAllowList(this.collectionId);2246 }22472248 async getEffectiveLimits() {2249 return await this.helper.collection.getEffectiveLimits(this.collectionId);2250 }22512252 async getProperties(propertyKeys: string[] | null = null) {2253 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);2254 }22552256 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2257 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2258 }22592260 async confirmSponsorship(signer: TSigner) {2261 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2262 }22632264 async removeSponsor(signer: TSigner) {2265 return await this.helper.collection.removeSponsor(signer, this.collectionId);2266 }22672268 async setLimits(signer: TSigner, limits: ICollectionLimits) {2269 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2270 }22712272 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2273 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2274 }22752276 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2277 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2278 }22792280 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2281 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2282 }22832284 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2285 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2286 }22872288 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2289 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2290 }22912292 async setProperties(signer: TSigner, properties: IProperty[]) {2293 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2294 }22952296 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2297 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2298 }22992300 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2301 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2302 }23032304 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2305 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2306 }23072308 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2309 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2310 }23112312 async disableNesting(signer: TSigner) {2313 return await this.helper.collection.disableNesting(signer, this.collectionId);2314 }23152316 async burn(signer: TSigner) {2317 return await this.helper.collection.burn(signer, this.collectionId);2318 }2319}232023212322export class UniqueNFTCollection extends UniqueCollectionBase {2323 getTokenObject(tokenId: number) {2324 return new UniqueNFTToken(tokenId, this);2325 }23262327 async getTokensByAddress(addressObj: ICrossAccountId) {2328 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2329 }23302331 async getToken(tokenId: number, blockHashAt?: string) {2332 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2333 }23342335 async getTokenOwner(tokenId: number, blockHashAt?: string) {2336 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2337 }23382339 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2340 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2341 }23422343 async getTokenChildren(tokenId: number, blockHashAt?: string) {2344 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2345 }23462347 async getPropertyPermissions(propertyKeys: string[] | null = null) {2348 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);2349 }23502351 async getTokenProperties(tokenId: number, propertyKeys: string[] | null = null) {2352 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2353 }23542355 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2356 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2357 }23582359 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2360 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2361 }23622363 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2364 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2365 }23662367 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2368 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2369 }23702371 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2372 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2373 }23742375 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2376 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2377 }23782379 async burnToken(signer: TSigner, tokenId: number) {2380 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2381 }23822383 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {2384 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);2385 }23862387 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2388 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2389 }23902391 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2392 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2393 }23942395 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2396 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2397 }23982399 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2400 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2401 }24022403 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2404 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2405 }2406}240724082409export class UniqueRFTCollection extends UniqueCollectionBase {2410 getTokenObject(tokenId: number) {2411 return new UniqueRFTToken(tokenId, this);2412 }24132414 async getToken(tokenId: number, blockHashAt?: string) {2415 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);2416 }24172418 async getTokensByAddress(addressObj: ICrossAccountId) {2419 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2420 }24212422 async getTop10TokenOwners(tokenId: number) {2423 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2424 }24252426 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2427 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2428 }24292430 async getTokenTotalPieces(tokenId: number) {2431 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2432 }24332434 async getPropertyPermissions(propertyKeys: string[] | null = null) {2435 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);2436 }24372438 async getTokenProperties(tokenId: number, propertyKeys: string[] | null = null) {2439 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2440 }24412442 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2443 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2444 }24452446 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2447 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2448 }24492450 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2451 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2452 }24532454 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2455 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2456 }24572458 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2459 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2460 }24612462 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2463 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2464 }24652466 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {2467 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2468 }24692470 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2471 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2472 }24732474 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n) {2475 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);2476 }24772478 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2479 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2480 }24812482 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2483 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2484 }24852486 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2487 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2488 }2489}249024912492export class UniqueFTCollection extends UniqueCollectionBase {2493 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {2494 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);2495 }24962497 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {2498 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);2499 }25002501 async getBalance(addressObj: ICrossAccountId) {2502 return await this.helper.ft.getBalance(this.collectionId, addressObj);2503 }25042505 async getTop10Owners() {2506 return await this.helper.ft.getTop10Owners(this.collectionId);2507 }25082509 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2510 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2511 }25122513 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2514 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2515 }25162517 async burnTokens(signer: TSigner, amount=1n) {2518 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2519 }25202521 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2522 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2523 }25242525 async getTotalPieces() {2526 return await this.helper.ft.getTotalPieces(this.collectionId);2527 }25282529 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2530 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2531 }25322533 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2534 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2535 }2536}253725382539export class UniqueTokenBase implements IToken {2540 collection: UniqueNFTCollection | UniqueRFTCollection;2541 collectionId: number;2542 tokenId: number;25432544 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2545 this.collection = collection;2546 this.collectionId = collection.collectionId;2547 this.tokenId = tokenId;2548 }25492550 async getNextSponsored(addressObj: ICrossAccountId) {2551 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2552 }25532554 async getProperties(propertyKeys: string[] | null = null) {2555 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);2556 }25572558 async setProperties(signer: TSigner, properties: IProperty[]) {2559 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2560 }25612562 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2563 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2564 }25652566 nestingAddress() {2567 return this.collection.helper.util.getNestingTokenAddress(this);2568 }2569}257025712572export class UniqueNFTToken extends UniqueTokenBase {2573 collection: UniqueNFTCollection;25742575 constructor(tokenId: number, collection: UniqueNFTCollection) {2576 super(tokenId, collection);2577 this.collection = collection;2578 }25792580 async getData(blockHashAt?: string) {2581 return await this.collection.getToken(this.tokenId, blockHashAt);2582 }25832584 async getOwner(blockHashAt?: string) {2585 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2586 }25872588 async getTopmostOwner(blockHashAt?: string) {2589 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2590 }25912592 async getChildren(blockHashAt?: string) {2593 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2594 }25952596 async nest(signer: TSigner, toTokenObj: IToken) {2597 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2598 }25992600 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2601 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2602 }26032604 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2605 return await this.collection.transferToken(signer, this.tokenId, addressObj);2606 }26072608 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2609 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2610 }26112612 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2613 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2614 }26152616 async isApproved(toAddressObj: ICrossAccountId) {2617 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2618 }26192620 async burn(signer: TSigner) {2621 return await this.collection.burnToken(signer, this.tokenId);2622 }26232624 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {2625 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);2626 }2627}26282629export class UniqueRFTToken extends UniqueTokenBase {2630 collection: UniqueRFTCollection;26312632 constructor(tokenId: number, collection: UniqueRFTCollection) {2633 super(tokenId, collection);2634 this.collection = collection;2635 }26362637 async getData(blockHashAt?: string) {2638 return await this.collection.getToken(this.tokenId, blockHashAt);2639 }26402641 async getTop10Owners() {2642 return await this.collection.getTop10TokenOwners(this.tokenId);2643 }26442645 async getBalance(addressObj: ICrossAccountId) {2646 return await this.collection.getTokenBalance(this.tokenId, addressObj);2647 }26482649 async getTotalPieces() {2650 return await this.collection.getTokenTotalPieces(this.tokenId);2651 }26522653 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2654 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2655 }26562657 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2658 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2659 }26602661 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2662 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2663 }26642665 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2666 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2667 }26682669 async repartition(signer: TSigner, amount: bigint) {2670 return await this.collection.repartitionToken(signer, this.tokenId, amount);2671 }26722673 async burn(signer: TSigner, amount=1n) {2674 return await this.collection.burnToken(signer, this.tokenId, amount);2675 }26762677 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2678 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);2679 }2680}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents, SignerOptions} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {IApiListeners, IBlock, IEvent, IChainProperties, ICollectionCreationOptions, ICollectionLimits, ICollectionPermissions, ICrossAccountId, ICrossAccountIdLower, ILogger, INestingPermissions, IProperty, IStakingInfo, ISubstrateBalance, IToken, ITokenPropertyPermission, ITransactionResult, IUniqueHelperLog, TApiAllowedListeners, TEthereumAccount, TSigner, TSubstrateAccount, TUniqueNetworks} from './types';1314export const crossAccountIdFromLower = (lowerAddress: ICrossAccountIdLower): ICrossAccountId => {15 const address = {} as ICrossAccountId;16 if(lowerAddress.substrate) address.Substrate = lowerAddress.substrate;17 if(lowerAddress.ethereum) address.Ethereum = lowerAddress.ethereum;18 return address;19};2021const nesting = {22 toChecksumAddress(address: string): string {23 if (typeof address === 'undefined') return '';2425 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);2627 address = address.toLowerCase().replace(/^0x/i,'');28 const addressHash = keccakAsHex(address).replace(/^0x/i,'');29 const checksumAddress = ['0x'];3031 for (let i = 0; i < address.length; i++) {32 // If ith character is 8 to f then make it uppercase33 if (parseInt(addressHash[i], 16) > 7) {34 checksumAddress.push(address[i].toUpperCase());35 } else {36 checksumAddress.push(address[i]);37 }38 }39 return checksumAddress.join('');40 },41 tokenIdToAddress(collectionId: number, tokenId: number) {42 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);43 },44};4546class UniqueUtil {47 static transactionStatus = {48 NOT_READY: 'NotReady',49 FAIL: 'Fail',50 SUCCESS: 'Success',51 };5253 static chainLogType = {54 EXTRINSIC: 'extrinsic',55 RPC: 'rpc',56 };5758 static getNestingTokenAddress(token: IToken) {59 return {Ethereum: this.getNestingTokenAddressRaw(token).toLowerCase()};60 }6162 static getNestingTokenAddressRaw(token: IToken) {63 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);64 }6566 static getDefaultLogger(): ILogger {67 return {68 log(msg: any, level = 'INFO') {69 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));70 },71 level: {72 ERROR: 'ERROR',73 WARNING: 'WARNING',74 INFO: 'INFO',75 },76 };77 }7879 static vec2str(arr: string[] | number[]) {80 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');81 }8283 static str2vec(string: string) {84 if (typeof string !== 'string') return string;85 return Array.from(string).map(x => x.charCodeAt(0));86 }8788 static fromSeed(seed: string, ss58Format = 42) {89 const keyring = new Keyring({type: 'sr25519', ss58Format});90 return keyring.addFromUri(seed);91 }9293 static normalizeSubstrateAddress(address: string, ss58Format = 42) {94 return encodeAddress(decodeAddress(address), ss58Format);95 }9697 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult) {98 if (creationResult.status !== this.transactionStatus.SUCCESS) {99 throw Error('Unable to create collection!');100 }101102 let collectionId = null;103 creationResult.result.events.forEach(({event: {data, method, section}}) => {104 if ((section === 'common') && (method === 'CollectionCreated')) {105 collectionId = parseInt(data[0].toString(), 10);106 }107 });108109 if (collectionId === null) {110 throw Error('No CollectionCreated event was found!');111 }112113 return collectionId;114 }115116 static extractTokensFromCreationResult(creationResult: ITransactionResult) {117 if (creationResult.status !== this.transactionStatus.SUCCESS) {118 throw Error('Unable to create tokens!');119 }120 let success = false;121 const tokens = [] as any;122 creationResult.result.events.forEach(({event: {data, method, section}}) => {123 if (method === 'ExtrinsicSuccess') {124 success = true;125 } else if ((section === 'common') && (method === 'ItemCreated')) {126 tokens.push({127 collectionId: parseInt(data[0].toString(), 10),128 tokenId: parseInt(data[1].toString(), 10),129 owner: data[2].toJSON(),130 });131 }132 });133 return {success, tokens};134 }135136 static extractTokensFromBurnResult(burnResult: ITransactionResult) {137 if (burnResult.status !== this.transactionStatus.SUCCESS) {138 throw Error('Unable to burn tokens!');139 }140 let success = false;141 const tokens = [] as any;142 burnResult.result.events.forEach(({event: {data, method, section}}) => {143 if (method === 'ExtrinsicSuccess') {144 success = true;145 } else if ((section === 'common') && (method === 'ItemDestroyed')) {146 tokens.push({147 collectionId: parseInt(data[0].toString(), 10),148 tokenId: parseInt(data[1].toString(), 10),149 owner: data[2].toJSON(),150 });151 }152 });153 return {success, tokens};154 }155156 static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string) {157 let eventId = null;158 events.forEach(({event: {data, method, section}}) => {159 if ((section === expectedSection) && (method === expectedMethod)) {160 eventId = parseInt(data[0].toString(), 10);161 }162 });163164 if (eventId === null) {165 throw Error(`No ${expectedMethod} event was found!`);166 }167 return eventId === collectionId;168 }169170 static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {171 const normalizeAddress = (address: string | ICrossAccountId) => {172 if(typeof address === 'string') return address;173 const obj = {} as any;174 Object.keys(address).forEach(k => {175 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];176 });177 if(obj.substrate) return {Substrate: this.normalizeSubstrateAddress(obj.substrate)};178 if(obj.ethereum) return {Ethereum: obj.ethereum.toLocaleLowerCase()};179 return address;180 };181 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;182 events.forEach(({event: {data, method, section}}) => {183 if ((section === 'common') && (method === 'Transfer')) {184 const hData = (data as any).toJSON();185 transfer = {186 collectionId: hData[0],187 tokenId: hData[1],188 from: normalizeAddress(hData[2]),189 to: normalizeAddress(hData[3]),190 amount: BigInt(hData[4]),191 };192 }193 });194 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;195 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);196 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);197 isSuccess = isSuccess && amount === transfer.amount;198 return isSuccess;199 }200}201202class UniqueEventHelper {203 private static extractIndex(index: any): [number, number] | string {204 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];205 return index.toJSON();206 }207208 private static extractSub(data: any, subTypes: any): {[key: string]: any} {209 let obj: any = {};210 let index = 0;211212 if (data.entries) {213 for(const [key, value] of data.entries()) {214 obj[key] = this.extractData(value, subTypes[index]);215 index++;216 }217 } else obj = data.toJSON();218219 return obj;220 }221 222 private static extractData(data: any, type: any): any {223 if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();224 if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();225 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);226 return data.toHuman();227 }228229 public static extractEvents(records: ITransactionResult): IEvent[] {230 const parsedEvents: IEvent[] = [];231232 records.result.events.forEach((record) => {233 const {event, phase} = record;234 const types = (event as any).typeDef;235236 const eventData: IEvent = {237 section: event.section.toString(),238 method: event.method.toString(),239 index: this.extractIndex(event.index),240 data: [],241 phase: phase.toJSON(),242 };243244 event.data.forEach((val: any, index: number) => {245 eventData.data.push(this.extractData(val, types[index]));246 });247248 parsedEvents.push(eventData);249 });250251 return parsedEvents;252 }253}254255class ChainHelperBase {256 transactionStatus = UniqueUtil.transactionStatus;257 chainLogType = UniqueUtil.chainLogType;258 util: typeof UniqueUtil;259 eventHelper: typeof UniqueEventHelper;260 logger: ILogger;261 api: ApiPromise | null;262 forcedNetwork: TUniqueNetworks | null;263 network: TUniqueNetworks | null;264 chainLog: IUniqueHelperLog[];265266 constructor(logger?: ILogger) {267 this.util = UniqueUtil;268 this.eventHelper = UniqueEventHelper;269 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();270 this.logger = logger;271 this.api = null;272 this.forcedNetwork = null;273 this.network = null;274 this.chainLog = [];275 }276277 clearChainLog(): void {278 this.chainLog = [];279 }280281 forceNetwork(value: TUniqueNetworks): void {282 this.forcedNetwork = value;283 }284285 async connect(wsEndpoint: string, listeners?: IApiListeners) {286 if (this.api !== null) throw Error('Already connected');287 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);288 this.api = api;289 this.network = network;290 }291292 async disconnect() {293 if (this.api === null) return;294 await this.api.disconnect();295 this.api = null;296 this.network = null;297 }298299 static async detectNetwork(api: ApiPromise): Promise<TUniqueNetworks> {300 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;301 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;302 return 'opal';303 }304305 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TUniqueNetworks> {306 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});307 await api.isReady;308309 const network = await this.detectNetwork(api);310311 await api.disconnect();312313 return network;314 }315316 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TUniqueNetworks | null): Promise<{317 api: ApiPromise;318 network: TUniqueNetworks;319 }> {320 if(typeof network === 'undefined' || network === null) network = 'opal';321 const supportedRPC = {322 opal: {323 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,324 },325 quartz: {326 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,327 },328 unique: {329 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,330 },331 };332 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);333 const rpc = supportedRPC[network];334335 // TODO: investigate how to replace rpc in runtime336 // api._rpcCore.addUserInterfaces(rpc);337338 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});339340 await api.isReadyOrError;341342 if (typeof listeners === 'undefined') listeners = {};343 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {344 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;345 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);346 }347348 return {api, network};349 }350351 getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {352 const {events, status} = data;353 if (status.isReady) {354 return this.transactionStatus.NOT_READY;355 }356 if (status.isBroadcast) {357 return this.transactionStatus.NOT_READY;358 }359 if (status.isInBlock || status.isFinalized) {360 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');361 if (errors.length > 0) {362 return this.transactionStatus.FAIL;363 }364 if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {365 return this.transactionStatus.SUCCESS;366 }367 }368369 return this.transactionStatus.FAIL;370 }371372 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {373 const sign = (callback: any) => {374 if(options !== null) return transaction.signAndSend(sender, options, callback);375 return transaction.signAndSend(sender, callback);376 };377 // eslint-disable-next-line no-async-promise-executor378 return new Promise(async (resolve, reject) => {379 try {380 const unsub = await sign((result: any) => {381 const status = this.getTransactionStatus(result);382383 if (status === this.transactionStatus.SUCCESS) {384 this.logger.log(`${label} successful`);385 unsub();386 resolve({result, status});387 } else if (status === this.transactionStatus.FAIL) {388 let moduleError = null;389390 if (result.hasOwnProperty('dispatchError')) {391 const dispatchError = result['dispatchError'];392393 if (dispatchError) {394 if (dispatchError.isModule) {395 const modErr = dispatchError.asModule;396 const errorMeta = dispatchError.registry.findMetaError(modErr);397398 moduleError = `${errorMeta.section}.${errorMeta.name}`;399 } else {400 moduleError = dispatchError.toHuman();401 }402 } else {403 this.logger.log(result, this.logger.level.ERROR);404 }405 }406407 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);408 unsub();409 reject({status, moduleError, result});410 }411 });412 } catch (e) {413 this.logger.log(e, this.logger.level.ERROR);414 reject(e);415 }416 });417 }418419 constructApiCall(apiCall: string, params: any[]) {420 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);421 let call = this.api as any;422 for(const part of apiCall.slice(4).split('.')) {423 call = call[part];424 }425 return call(...params);426 }427428 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {429 if(this.api === null) throw Error('API not initialized');430 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);431432 const startTime = (new Date()).getTime();433 let result: ITransactionResult;434 let events: IEvent[] = [];435 try {436 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;437 events = this.eventHelper.extractEvents(result);438 }439 catch(e) {440 if(!(e as object).hasOwnProperty('status')) throw e;441 result = e as ITransactionResult;442 }443444 const endTime = (new Date()).getTime();445446 const log = {447 executedAt: endTime,448 executionTime: endTime - startTime,449 type: this.chainLogType.EXTRINSIC,450 status: result.status,451 call: extrinsic,452 signer: this.getSignerAddress(sender),453 params,454 } as IUniqueHelperLog;455456 if(result.status !== this.transactionStatus.SUCCESS && result.moduleError) log.moduleError = result.moduleError;457 if(events.length > 0) log.events = events;458459 this.chainLog.push(log);460461 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) throw Error(`${result.moduleError}`);462 return result;463 }464465 async callRpc(rpc: string, params?: any[]) {466 if(typeof params === 'undefined') params = [];467 if(this.api === null) throw Error('API not initialized');468 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);469470 const startTime = (new Date()).getTime();471 let result;472 let error = null;473 const log = {474 type: this.chainLogType.RPC,475 call: rpc,476 params,477 } as IUniqueHelperLog;478479 try {480 result = await this.constructApiCall(rpc, params);481 }482 catch(e) {483 error = e;484 }485486 const endTime = (new Date()).getTime();487488 log.executedAt = endTime;489 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';490 log.executionTime = endTime - startTime;491492 this.chainLog.push(log);493494 if(error !== null) throw error;495496 return result;497 }498499 getSignerAddress(signer: IKeyringPair | string): string {500 if(typeof signer === 'string') return signer;501 return signer.address;502 }503504 fetchAllPalletNames(): string[] {505 if(this.api === null) throw Error('API not initialized');506 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());507 }508509 fetchMissingPalletNames(requiredPallets: string[]): string[] {510 const palletNames = this.fetchAllPalletNames();511 return requiredPallets.filter(p => !palletNames.includes(p));512 }513}514515516class HelperGroup {517 helper: UniqueHelper;518519 constructor(uniqueHelper: UniqueHelper) {520 this.helper = uniqueHelper;521 }522}523524525class CollectionGroup extends HelperGroup {526 /**527 * Get number of blocks when sponsored transaction is available.528 *529 * @param collectionId ID of collection530 * @param tokenId ID of token531 * @param addressObj address for which the sponsorship is checked532 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});533 * @returns number of blocks or null if sponsorship hasn't been set534 */535 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {536 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();537 }538539 /**540 * Get the number of created collections.541 *542 * @returns number of created collections543 */544 async getTotalCount(): Promise<number> {545 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();546 }547548 /**549 * Get information about the collection with additional data,550 * including the number of tokens it contains, its administrators,551 * the normalized address of the collection's owner, and decoded name and description.552 *553 * @param collectionId ID of collection554 * @example await getData(2)555 * @returns collection information object556 */557 async getData(collectionId: number): Promise<{558 id: number;559 name: string;560 description: string;561 tokensCount: number;562 admins: ICrossAccountId[];563 normalizedOwner: TSubstrateAccount;564 raw: any565 } | null> {566 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);567 const humanCollection = collection.toHuman(), collectionData = {568 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],569 raw: humanCollection,570 } as any, jsonCollection = collection.toJSON();571 if (humanCollection === null) return null;572 collectionData.raw.limits = jsonCollection.limits;573 collectionData.raw.permissions = jsonCollection.permissions;574 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);575 for (const key of ['name', 'description']) {576 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);577 }578579 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))580 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)581 : 0;582 collectionData.admins = await this.getAdmins(collectionId);583584 return collectionData;585 }586587 /**588 * Get the addresses of the collection's administrators, optionally normalized.589 *590 * @param collectionId ID of collection591 * @param normalize whether to normalize the addresses to the default ss58 format592 * @example await getAdmins(1)593 * @returns array of administrators594 */595 async getAdmins(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {596 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();597598 return normalize599 ? admins.map((address: any) => this.helper.address.normalizeCrossAccountIfSubstrate(address))600 : admins;601 }602603 /**604 * Get the addresses added to the collection allow-list, optionally normalized.605 * @param collectionId ID of collection606 * @param normalize whether to normalize the addresses to the default ss58 format607 * @example await getAllowList(1)608 * @returns array of allow-listed addresses609 */610 async getAllowList(collectionId: number, normalize = false): Promise<ICrossAccountId[]> {611 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();612 return normalize613 ? allowListed.map((address: any) => this.helper.address.normalizeCrossAccountIfSubstrate(address))614 : allowListed;615 }616617 /**618 * Get the effective limits of the collection instead of null for default values619 *620 * @param collectionId ID of collection621 * @example await getEffectiveLimits(2)622 * @returns object of collection limits623 */624 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {625 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();626 }627628 /**629 * Burns the collection if the signer has sufficient permissions and collection is empty.630 *631 * @param signer keyring of signer632 * @param collectionId ID of collection633 * @example await helper.collection.burn(aliceKeyring, 3);634 * @returns ```true``` if extrinsic success, otherwise ```false```635 */636 async burn(signer: TSigner, collectionId: number): Promise<boolean> {637 const result = await this.helper.executeExtrinsic(638 signer,639 'api.tx.unique.destroyCollection', [collectionId],640 true,641 );642643 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');644 }645646 /**647 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.648 *649 * @param signer keyring of signer650 * @param collectionId ID of collection651 * @param sponsorAddress Sponsor substrate address652 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")653 * @returns ```true``` if extrinsic success, otherwise ```false```654 */655 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {656 const result = await this.helper.executeExtrinsic(657 signer,658 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],659 true,660 );661662 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorSet');663 }664665 /**666 * Confirms consent to sponsor the collection on behalf of the signer.667 *668 * @param signer keyring of signer669 * @param collectionId ID of collection670 * @example confirmSponsorship(aliceKeyring, 10)671 * @returns ```true``` if extrinsic success, otherwise ```false```672 */673 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {674 const result = await this.helper.executeExtrinsic(675 signer,676 'api.tx.unique.confirmSponsorship', [collectionId],677 true,678 );679680 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'SponsorshipConfirmed');681 }682683 /**684 * Removes the sponsor of a collection, regardless if it consented or not.685 *686 * @param signer keyring of signer687 * @param collectionId ID of collection688 * @example removeSponsor(aliceKeyring, 10)689 * @returns ```true``` if extrinsic success, otherwise ```false```690 */691 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {692 const result = await this.helper.executeExtrinsic(693 signer,694 'api.tx.unique.removeCollectionSponsor', [collectionId],695 true,696 );697698 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionSponsorRemoved');699 }700701 /**702 * Sets the limits of the collection. At least one limit must be specified for a correct call.703 *704 * @param signer keyring of signer705 * @param collectionId ID of collection706 * @param limits collection limits object707 * @example708 * await setLimits(709 * aliceKeyring,710 * 10,711 * {712 * sponsorTransferTimeout: 0,713 * ownerCanDestroy: false714 * }715 * )716 * @returns ```true``` if extrinsic success, otherwise ```false```717 */718 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {719 const result = await this.helper.executeExtrinsic(720 signer,721 'api.tx.unique.setCollectionLimits', [collectionId, limits],722 true,723 );724725 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionLimitSet');726 }727728 /**729 * Changes the owner of the collection to the new Substrate address.730 *731 * @param signer keyring of signer732 * @param collectionId ID of collection733 * @param ownerAddress substrate address of new owner734 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")735 * @returns ```true``` if extrinsic success, otherwise ```false```736 */737 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {738 const result = await this.helper.executeExtrinsic(739 signer,740 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],741 true,742 );743744 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionOwnedChanged');745 }746747 /**748 * Adds a collection administrator.749 *750 * @param signer keyring of signer751 * @param collectionId ID of collection752 * @param adminAddressObj Administrator address (substrate or ethereum)753 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})754 * @returns ```true``` if extrinsic success, otherwise ```false```755 */756 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {757 const result = await this.helper.executeExtrinsic(758 signer,759 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],760 true,761 );762763 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminAdded');764 }765766 /**767 * Removes a collection administrator.768 *769 * @param signer keyring of signer770 * @param collectionId ID of collection771 * @param adminAddressObj Administrator address (substrate or ethereum)772 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})773 * @returns ```true``` if extrinsic success, otherwise ```false```774 */775 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {776 const result = await this.helper.executeExtrinsic(777 signer,778 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],779 true,780 );781782 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionAdminRemoved');783 }784785 /**786 * Check if user is in allow list.787 * 788 * @param collectionId ID of collection789 * @param user Account to check790 * @example await getAdmins(1)791 * @returns is user in allow list792 */793 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {794 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();795 }796797 /**798 * Adds an address to allow list799 * @param signer keyring of signer800 * @param collectionId ID of collection801 * @param addressObj address to add to the allow list802 * @returns ```true``` if extrinsic success, otherwise ```false```803 */804 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {805 const result = await this.helper.executeExtrinsic(806 signer,807 'api.tx.unique.addToAllowList', [collectionId, addressObj],808 true,809 );810811 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressAdded');812 }813814 /**815 * Removes an address from allow list816 *817 * @param signer keyring of signer818 * @param collectionId ID of collection819 * @param addressObj address to remove from the allow list820 * @returns ```true``` if extrinsic success, otherwise ```false```821 */822 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {823 const result = await this.helper.executeExtrinsic(824 signer,825 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],826 true,827 );828829 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'AllowListAddressRemoved');830 }831832 /**833 * Sets onchain permissions for selected collection.834 *835 * @param signer keyring of signer836 * @param collectionId ID of collection837 * @param permissions collection permissions object838 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});839 * @returns ```true``` if extrinsic success, otherwise ```false```840 */841 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {842 const result = await this.helper.executeExtrinsic(843 signer,844 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],845 true,846 );847848 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'unique', 'CollectionPermissionSet');849 }850851 /**852 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.853 *854 * @param signer keyring of signer855 * @param collectionId ID of collection856 * @param permissions nesting permissions object857 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});858 * @returns ```true``` if extrinsic success, otherwise ```false```859 */860 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {861 return await this.setPermissions(signer, collectionId, {nesting: permissions});862 }863864 /**865 * Disables nesting for selected collection.866 *867 * @param signer keyring of signer868 * @param collectionId ID of collection869 * @example disableNesting(aliceKeyring, 10);870 * @returns ```true``` if extrinsic success, otherwise ```false```871 */872 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {873 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});874 }875876 /**877 * Sets onchain properties to the collection.878 *879 * @param signer keyring of signer880 * @param collectionId ID of collection881 * @param properties array of property objects882 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);883 * @returns ```true``` if extrinsic success, otherwise ```false```884 */885 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {886 const result = await this.helper.executeExtrinsic(887 signer,888 'api.tx.unique.setCollectionProperties', [collectionId, properties],889 true,890 );891892 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');893 }894895 /**896 * Get collection properties.897 * 898 * @param collectionId ID of collection899 * @param propertyKeys optionally filter the returned properties to only these keys900 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);901 * @returns array of key-value pairs902 */903 async getProperties(collectionId: number, propertyKeys: string[] | null = null): Promise<IProperty[]> {904 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();905 }906907 /**908 * Deletes onchain properties from the collection.909 *910 * @param signer keyring of signer911 * @param collectionId ID of collection912 * @param propertyKeys array of property keys to delete913 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);914 * @returns ```true``` if extrinsic success, otherwise ```false```915 */916 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {917 const result = await this.helper.executeExtrinsic(918 signer,919 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],920 true,921 );922923 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');924 }925926 /**927 * Changes the owner of the token.928 *929 * @param signer keyring of signer930 * @param collectionId ID of collection931 * @param tokenId ID of token932 * @param addressObj address of a new owner933 * @param amount amount of tokens to be transfered. For NFT must be set to 1n934 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})935 * @returns true if the token success, otherwise false936 */937 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {938 const result = await this.helper.executeExtrinsic(939 signer,940 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],941 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,942 );943944 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);945 }946947 /**948 *949 * Change ownership of a token(s) on behalf of the owner.950 *951 * @param signer keyring of signer952 * @param collectionId ID of collection953 * @param tokenId ID of token954 * @param fromAddressObj address on behalf of which the token will be sent955 * @param toAddressObj new token owner956 * @param amount amount of tokens to be transfered. For NFT must be set to 1n957 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})958 * @returns true if the token success, otherwise false959 */960 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {961 const result = await this.helper.executeExtrinsic(962 signer,963 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],964 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,965 );966 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);967 }968969 /**970 *971 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.972 *973 * @param signer keyring of signer974 * @param collectionId ID of collection975 * @param tokenId ID of token976 * @param amount amount of tokens to be burned. For NFT must be set to 1n977 * @example burnToken(aliceKeyring, 10, 5);978 * @returns ```true``` and burnt token number is extrinsic success. Otherwise ```false``` and ```null```979 */980 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<{981 success: boolean,982 token: number | null983 }> {984 const burnResult = await this.helper.executeExtrinsic(985 signer,986 'api.tx.unique.burnItem', [collectionId, tokenId, amount],987 true, // `Unable to burn token for ${label}`,988 );989 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);990 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');991 return {success: burnedTokens.success, token: burnedTokens.tokens.length > 0 ? burnedTokens.tokens[0] : null};992 }993994 /**995 * Destroys a concrete instance of NFT on behalf of the owner996 *997 * @param signer keyring of signer998 * @param collectionId ID of collection999 * @param tokenId ID of token1000 * @param fromAddressObj address on behalf of which the token will be burnt1001 * @param amount amount of tokens to be burned. For NFT must be set to 1n1002 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1003 * @returns ```true``` if extrinsic success, otherwise ```false```1004 */1005 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1006 const burnResult = await this.helper.executeExtrinsic(1007 signer,1008 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1009 true, // `Unable to burn token from for ${label}`,1010 );1011 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1012 return burnedTokens.success && burnedTokens.tokens.length > 0;1013 }10141015 /**1016 * Set, change, or remove approved address to transfer the ownership of the NFT.1017 *1018 * @param signer keyring of signer1019 * @param collectionId ID of collection1020 * @param tokenId ID of token1021 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1022 * @param amount amount of token to be approved. For NFT must be set to 1n1023 * @returns ```true``` if extrinsic success, otherwise ```false```1024 */1025 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1026 const approveResult = await this.helper.executeExtrinsic(1027 signer,1028 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1029 true, // `Unable to approve token for ${label}`,1030 );10311032 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1033 }10341035 /**1036 * Get the amount of token pieces approved to transfer or burn. Normally 0.1037 *1038 * @param collectionId ID of collection1039 * @param tokenId ID of token1040 * @param toAccountObj address which is approved to use token pieces1041 * @param fromAccountObj address which may have allowed the use of its owned tokens1042 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1043 * @returns number of approved to transfer pieces1044 */1045 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1046 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1047 }10481049 /**1050 * Get the last created token ID in a collection1051 *1052 * @param collectionId ID of collection1053 * @example getLastTokenId(10);1054 * @returns id of the last created token1055 */1056 async getLastTokenId(collectionId: number): Promise<number> {1057 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1058 }10591060 /**1061 * Check if token exists1062 *1063 * @param collectionId ID of collection1064 * @param tokenId ID of token1065 * @example isTokenExists(10, 20);1066 * @returns true if the token exists, otherwise false1067 */1068 async isTokenExists(collectionId: number, tokenId: number): Promise<boolean> {1069 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1070 }1071}10721073class NFTnRFT extends CollectionGroup {1074 /**1075 * Get tokens owned by account1076 *1077 * @param collectionId ID of collection1078 * @param addressObj tokens owner1079 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1080 * @returns array of token ids owned by account1081 */1082 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1083 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1084 }10851086 /**1087 * Get token data1088 *1089 * @param collectionId ID of collection1090 * @param tokenId ID of token1091 * @param propertyKeys optionally filter the token properties to only these keys1092 * @param blockHashAt optionally query the data at some block with this hash1093 * @example getToken(10, 5);1094 * @returns human readable token data1095 */1096 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1097 properties: IProperty[];1098 owner: ICrossAccountId;1099 normalizedOwner: ICrossAccountId;1100 }| null> {1101 let tokenData;1102 if(typeof blockHashAt === 'undefined') {1103 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1104 }1105 else {1106 if(propertyKeys.length == 0) {1107 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1108 if(!collection) return null;1109 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1110 }1111 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1112 }1113 tokenData = tokenData.toHuman();1114 if (tokenData === null || tokenData.owner === null) return null;1115 const owner = {} as any;1116 for (const key of Object.keys(tokenData.owner)) {1117 owner[key.toLocaleLowerCase()] = this.helper.address.normalizeCrossAccountIfSubstrate(tokenData.owner[key]);1118 }1119 tokenData.normalizedOwner = crossAccountIdFromLower(owner);1120 return tokenData;1121 }11221123 /**1124 * Set permissions to change token properties1125 *1126 * @param signer keyring of signer1127 * @param collectionId ID of collection1128 * @param permissions permissions to change a property by the collection admin or token owner1129 * @example setTokenPropertyPermissions(1130 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1131 * )1132 * @returns true if extrinsic success otherwise false1133 */1134 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1135 const result = await this.helper.executeExtrinsic(1136 signer,1137 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1138 true,1139 );11401141 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1142 }11431144 /**1145 * Get token property permissions.1146 * 1147 * @param collectionId ID of collection1148 * @param propertyKeys optionally filter the returned property permissions to only these keys1149 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1150 * @returns array of key-permission pairs1151 */1152 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1153 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1154 }11551156 /**1157 * Set token properties1158 *1159 * @param signer keyring of signer1160 * @param collectionId ID of collection1161 * @param tokenId ID of token1162 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1163 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1164 * @returns ```true``` if extrinsic success, otherwise ```false```1165 */1166 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1167 const result = await this.helper.executeExtrinsic(1168 signer,1169 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1170 true,1171 );11721173 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1174 }11751176 /**1177 * Get properties, metadata assigned to a token.1178 * 1179 * @param collectionId ID of collection1180 * @param tokenId ID of token1181 * @param propertyKeys optionally filter the returned properties to only these keys1182 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1183 * @returns array of key-value pairs1184 */1185 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys: string[] | null = null): Promise<IProperty[]> {1186 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1187 }11881189 /**1190 * Delete the provided properties of a token1191 * @param signer keyring of signer1192 * @param collectionId ID of collection1193 * @param tokenId ID of token1194 * @param propertyKeys property keys to be deleted1195 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1196 * @returns ```true``` if extrinsic success, otherwise ```false```1197 */1198 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1199 const result = await this.helper.executeExtrinsic(1200 signer,1201 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1202 true,1203 );12041205 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1206 }12071208 /**1209 * Mint new collection1210 *1211 * @param signer keyring of signer1212 * @param collectionOptions basic collection options and properties1213 * @param mode NFT or RFT type of a collection1214 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1215 * @returns object of the created collection1216 */1217 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueCollectionBase> {1218 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1219 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1220 for (const key of ['name', 'description', 'tokenPrefix']) {1221 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);1222 }1223 const creationResult = await this.helper.executeExtrinsic(1224 signer,1225 'api.tx.unique.createCollectionEx', [collectionOptions],1226 true, // errorLabel,1227 );1228 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1229 }12301231 getCollectionObject(_collectionId: number): any {1232 return null;1233 }12341235 getTokenObject(_collectionId: number, _tokenId: number): any {1236 return null;1237 }1238}123912401241class NFTGroup extends NFTnRFT {1242 /**1243 * Get collection object1244 * @param collectionId ID of collection1245 * @example getCollectionObject(2);1246 * @returns instance of UniqueNFTCollection1247 */1248 getCollectionObject(collectionId: number): UniqueNFTCollection {1249 return new UniqueNFTCollection(collectionId, this.helper);1250 }12511252 /**1253 * Get token object1254 * @param collectionId ID of collection1255 * @param tokenId ID of token1256 * @example getTokenObject(10, 5);1257 * @returns instance of UniqueNFTToken1258 */1259 getTokenObject(collectionId: number, tokenId: number): UniqueNFTToken {1260 return new UniqueNFTToken(tokenId, this.getCollectionObject(collectionId));1261 }12621263 /**1264 * Get token's owner1265 * @param collectionId ID of collection1266 * @param tokenId ID of token1267 * @param blockHashAt optionally query the data at the block with this hash1268 * @example getTokenOwner(10, 5);1269 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1270 */1271 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId> {1272 let owner;1273 if (typeof blockHashAt === 'undefined') {1274 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1275 } else {1276 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1277 }1278 return crossAccountIdFromLower(owner.toJSON());1279 }12801281 /**1282 * Is token approved to transfer1283 * @param collectionId ID of collection1284 * @param tokenId ID of token1285 * @param toAccountObj address to be approved1286 * @returns ```true``` if extrinsic success, otherwise ```false```1287 */1288 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1289 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1290 }12911292 /**1293 * Changes the owner of the token.1294 *1295 * @param signer keyring of signer1296 * @param collectionId ID of collection1297 * @param tokenId ID of token1298 * @param addressObj address of a new owner1299 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1300 * @returns ```true``` if extrinsic success, otherwise ```false```1301 */1302 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1303 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1304 }13051306 /**1307 *1308 * Change ownership of a NFT on behalf of the owner.1309 *1310 * @param signer keyring of signer1311 * @param collectionId ID of collection1312 * @param tokenId ID of token1313 * @param fromAddressObj address on behalf of which the token will be sent1314 * @param toAddressObj new token owner1315 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1316 * @returns ```true``` if extrinsic success, otherwise ```false```1317 */1318 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1319 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1320 }13211322 /**1323 * Recursively find the address that owns the token1324 * @param collectionId ID of collection1325 * @param tokenId ID of token1326 * @param blockHashAt1327 * @example getTokenTopmostOwner(10, 5);1328 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1329 */1330 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<ICrossAccountId | null> {1331 let owner;1332 if (typeof blockHashAt === 'undefined') {1333 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1334 } else {1335 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1336 }13371338 if (owner === null) return null;13391340 return owner.toHuman();1341 }13421343 /**1344 * Get tokens nested in the provided token1345 * @param collectionId ID of collection1346 * @param tokenId ID of token1347 * @param blockHashAt optionally query the data at the block with this hash1348 * @example getTokenChildren(10, 5);1349 * @returns tokens whose depth of nesting is <= 51350 */1351 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1352 let children;1353 if(typeof blockHashAt === 'undefined') {1354 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1355 } else {1356 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1357 }13581359 return children.toJSON().map((x: any) => {1360 return {collectionId: x.collection, tokenId: x.token};1361 });1362 }13631364 /**1365 * Nest one token into another1366 * @param signer keyring of signer1367 * @param tokenObj token to be nested1368 * @param rootTokenObj token to be parent1369 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1370 * @returns ```true``` if extrinsic success, otherwise ```false```1371 */1372 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1373 const rootTokenAddress = this.helper.util.getNestingTokenAddress(rootTokenObj);1374 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1375 if(!result) {1376 throw Error('Unable to nest token!');1377 }1378 return result;1379 }13801381 /**1382 * Remove token from nested state1383 * @param signer keyring of signer1384 * @param tokenObj token to unnest1385 * @param rootTokenObj parent of a token1386 * @param toAddressObj address of a new token owner1387 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1388 * @returns ```true``` if extrinsic success, otherwise ```false```1389 */1390 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1391 const rootTokenAddress = this.helper.util.getNestingTokenAddress(rootTokenObj);1392 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1393 if(!result) {1394 throw Error('Unable to unnest token!');1395 }1396 return result;1397 }13981399 /**1400 * Mint new collection1401 * @param signer keyring of signer1402 * @param collectionOptions Collection options1403 * @example1404 * mintCollection(aliceKeyring, {1405 * name: 'New',1406 * description: 'New collection',1407 * tokenPrefix: 'NEW',1408 * })1409 * @returns object of the created collection1410 */1411 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1412 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1413 }14141415 /**1416 * Mint new token1417 * @param signer keyring of signer1418 * @param data token data1419 * @returns created token object1420 */1421 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFTToken> {1422 const creationResult = await this.helper.executeExtrinsic(1423 signer,1424 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1425 nft: {1426 properties: data.properties,1427 },1428 }],1429 true,1430 );1431 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1432 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1433 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1434 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1435 }14361437 /**1438 * Mint multiple NFT tokens1439 * @param signer keyring of signer1440 * @param collectionId ID of collection1441 * @param tokens array of tokens with owner and properties1442 * @example1443 * mintMultipleTokens(aliceKeyring, 10, [{1444 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1445 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1446 * },{1447 * owner: {Ethereum: "0x9F0583DbB855d..."},1448 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1449 * }]);1450 * @returns ```true``` if extrinsic success, otherwise ```false```1451 */1452 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1453 const creationResult = await this.helper.executeExtrinsic(1454 signer,1455 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1456 true,1457 );1458 const collection = this.getCollectionObject(collectionId);1459 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1460 }14611462 /**1463 * Mint multiple NFT tokens with one owner1464 * @param signer keyring of signer1465 * @param collectionId ID of collection1466 * @param owner tokens owner1467 * @param tokens array of tokens with owner and properties1468 * @example1469 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1470 * properties: [{1471 * key: "gender",1472 * value: "female",1473 * },{1474 * key: "age",1475 * value: "33",1476 * }],1477 * }]);1478 * @returns array of newly created tokens1479 */1480 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFTToken[]> {1481 const rawTokens = [];1482 for (const token of tokens) {1483 const raw = {NFT: {properties: token.properties}};1484 rawTokens.push(raw);1485 }1486 const creationResult = await this.helper.executeExtrinsic(1487 signer,1488 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1489 true,1490 );1491 const collection = this.getCollectionObject(collectionId);1492 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1493 }14941495 /**1496 * Set, change, or remove approved address to transfer the ownership of the NFT.1497 *1498 * @param signer keyring of signer1499 * @param collectionId ID of collection1500 * @param tokenId ID of token1501 * @param toAddressObj address to approve1502 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1503 * @returns ```true``` if extrinsic success, otherwise ```false```1504 */1505 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1506 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1507 }1508}150915101511class RFTGroup extends NFTnRFT {1512 /**1513 * Get collection object1514 * @param collectionId ID of collection1515 * @example getCollectionObject(2);1516 * @returns instance of UniqueRFTCollection1517 */1518 getCollectionObject(collectionId: number): UniqueRFTCollection {1519 return new UniqueRFTCollection(collectionId, this.helper);1520 }15211522 /**1523 * Get token object1524 * @param collectionId ID of collection1525 * @param tokenId ID of token1526 * @example getTokenObject(10, 5);1527 * @returns instance of UniqueNFTToken1528 */1529 getTokenObject(collectionId: number, tokenId: number): UniqueRFTToken {1530 return new UniqueRFTToken(tokenId, this.getCollectionObject(collectionId));1531 }15321533 /**1534 * Get top 10 token owners with the largest number of pieces1535 * @param collectionId ID of collection1536 * @param tokenId ID of token1537 * @example getTokenTop10Owners(10, 5);1538 * @returns array of top 10 owners1539 */1540 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<ICrossAccountId[]> {1541 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(crossAccountIdFromLower);1542 }15431544 /**1545 * Get number of pieces owned by address1546 * @param collectionId ID of collection1547 * @param tokenId ID of token1548 * @param addressObj address token owner1549 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1550 * @returns number of pieces ownerd by address1551 */1552 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1553 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1554 }15551556 /**1557 * Transfer pieces of token to another address1558 * @param signer keyring of signer1559 * @param collectionId ID of collection1560 * @param tokenId ID of token1561 * @param addressObj address of a new owner1562 * @param amount number of pieces to be transfered1563 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1564 * @returns ```true``` if extrinsic success, otherwise ```false```1565 */1566 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1567 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1568 }15691570 /**1571 * Change ownership of some pieces of RFT on behalf of the owner.1572 * @param signer keyring of signer1573 * @param collectionId ID of collection1574 * @param tokenId ID of token1575 * @param fromAddressObj address on behalf of which the token will be sent1576 * @param toAddressObj new token owner1577 * @param amount number of pieces to be transfered1578 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1579 * @returns ```true``` if extrinsic success, otherwise ```false```1580 */1581 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1582 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1583 }15841585 /**1586 * Mint new collection1587 * @param signer keyring of signer1588 * @param collectionOptions Collection options1589 * @example1590 * mintCollection(aliceKeyring, {1591 * name: 'New',1592 * description: 'New collection',1593 * tokenPrefix: 'NEW',1594 * })1595 * @returns object of the created collection1596 */1597 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1598 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1599 }16001601 /**1602 * Mint new token1603 * @param signer keyring of signer1604 * @param data token data1605 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1606 * @returns created token object1607 */1608 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFTToken> {1609 const creationResult = await this.helper.executeExtrinsic(1610 signer,1611 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1612 refungible: {1613 pieces: data.pieces,1614 properties: data.properties,1615 },1616 }],1617 true,1618 );1619 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1620 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1621 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1622 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1623 }16241625 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1626 throw Error('Not implemented');1627 const creationResult = await this.helper.executeExtrinsic(1628 signer,1629 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1630 true, // `Unable to mint RFT tokens for ${label}`,1631 );1632 const collection = this.getCollectionObject(collectionId);1633 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1634 }16351636 /**1637 * Mint multiple RFT tokens with one owner1638 * @param signer keyring of signer1639 * @param collectionId ID of collection1640 * @param owner tokens owner1641 * @param tokens array of tokens with properties and pieces1642 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1643 * @returns array of newly created RFT tokens1644 */1645 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFTToken[]> {1646 const rawTokens = [];1647 for (const token of tokens) {1648 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1649 rawTokens.push(raw);1650 }1651 const creationResult = await this.helper.executeExtrinsic(1652 signer,1653 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1654 true,1655 );1656 const collection = this.getCollectionObject(collectionId);1657 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1658 }16591660 /**1661 * Destroys a concrete instance of RFT.1662 * @param signer keyring of signer1663 * @param collectionId ID of collection1664 * @param tokenId ID of token1665 * @param amount number of pieces to be burnt1666 * @example burnToken(aliceKeyring, 10, 5);1667 * @returns ```true``` and burnt token number, if extrinsic is successful. Otherwise ```false``` and ```null```1668 */1669 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<{ success: boolean; token: number | null; }> {1670 return await super.burnToken(signer, collectionId, tokenId, amount);1671 }16721673 /**1674 * Destroys a concrete instance of RFT on behalf of the owner.1675 * @param signer keyring of signer1676 * @param collectionId ID of collection1677 * @param tokenId ID of token1678 * @param fromAddressObj address on behalf of which the token will be burnt1679 * @param amount number of pieces to be burnt1680 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1681 * @returns ```true``` if extrinsic success, otherwise ```false```1682 */1683 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1684 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1685 }16861687 /**1688 * Set, change, or remove approved address to transfer the ownership of the RFT.1689 *1690 * @param signer keyring of signer1691 * @param collectionId ID of collection1692 * @param tokenId ID of token1693 * @param toAddressObj address to approve1694 * @param amount number of pieces to be approved1695 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1696 * @returns true if the token success, otherwise false1697 */1698 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1699 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1700 }17011702 /**1703 * Get total number of pieces1704 * @param collectionId ID of collection1705 * @param tokenId ID of token1706 * @example getTokenTotalPieces(10, 5);1707 * @returns number of pieces1708 */1709 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1710 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1711 }17121713 /**1714 * Change number of token pieces. Signer must be the owner of all token pieces.1715 * @param signer keyring of signer1716 * @param collectionId ID of collection1717 * @param tokenId ID of token1718 * @param amount new number of pieces1719 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1720 * @returns true if the repartion was success, otherwise false1721 */1722 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1723 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1724 const repartitionResult = await this.helper.executeExtrinsic(1725 signer,1726 'api.tx.unique.repartition', [collectionId, tokenId, amount],1727 true,1728 );1729 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1730 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1731 }1732}173317341735class FTGroup extends CollectionGroup {1736 /**1737 * Get collection object1738 * @param collectionId ID of collection1739 * @example getCollectionObject(2);1740 * @returns instance of UniqueFTCollection1741 */1742 getCollectionObject(collectionId: number): UniqueFTCollection {1743 return new UniqueFTCollection(collectionId, this.helper);1744 }17451746 /**1747 * Mint new fungible collection1748 * @param signer keyring of signer1749 * @param collectionOptions Collection options1750 * @param decimalPoints number of token decimals1751 * @example1752 * mintCollection(aliceKeyring, {1753 * name: 'New',1754 * description: 'New collection',1755 * tokenPrefix: 'NEW',1756 * }, 18)1757 * @returns newly created fungible collection1758 */1759 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {1760 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1761 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1762 collectionOptions.mode = {fungible: decimalPoints};1763 for (const key of ['name', 'description', 'tokenPrefix']) {1764 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);1765 }1766 const creationResult = await this.helper.executeExtrinsic(1767 signer,1768 'api.tx.unique.createCollectionEx', [collectionOptions],1769 true,1770 );1771 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1772 }17731774 /**1775 * Mint tokens1776 * @param signer keyring of signer1777 * @param collectionId ID of collection1778 * @param owner address owner of new tokens1779 * @param amount amount of tokens to be meanted1780 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);1781 * @returns ```true``` if extrinsic success, otherwise ```false```1782 */1783 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {1784 const creationResult = await this.helper.executeExtrinsic(1785 signer,1786 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {1787 fungible: {1788 value: amount,1789 },1790 }],1791 true, // `Unable to mint fungible tokens for ${label}`,1792 );1793 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1794 }17951796 /**1797 * Mint multiple Fungible tokens with one owner1798 * @param signer keyring of signer1799 * @param collectionId ID of collection1800 * @param owner tokens owner1801 * @param tokens array of tokens with properties and pieces1802 * @returns ```true``` if extrinsic success, otherwise ```false```1803 */1804 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {1805 const rawTokens = [];1806 for (const token of tokens) {1807 const raw = {Fungible: {Value: token.value}};1808 rawTokens.push(raw);1809 }1810 const creationResult = await this.helper.executeExtrinsic(1811 signer,1812 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1813 true,1814 );1815 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');1816 }18171818 /**1819 * Get the top 10 owners with the largest balance for the Fungible collection1820 * @param collectionId ID of collection1821 * @example getTop10Owners(10);1822 * @returns array of ```ICrossAccountId```1823 */1824 async getTop10Owners(collectionId: number): Promise<ICrossAccountId[]> {1825 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(crossAccountIdFromLower);1826 }18271828 /**1829 * Get account balance1830 * @param collectionId ID of collection1831 * @param addressObj address of owner1832 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})1833 * @returns amount of fungible tokens owned by address1834 */1835 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {1836 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();1837 }18381839 /**1840 * Transfer tokens to address1841 * @param signer keyring of signer1842 * @param collectionId ID of collection1843 * @param toAddressObj address recipient1844 * @param amount amount of tokens to be sent1845 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1846 * @returns ```true``` if extrinsic success, otherwise ```false```1847 */1848 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1849 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);1850 }18511852 /**1853 * Transfer some tokens on behalf of the owner.1854 * @param signer keyring of signer1855 * @param collectionId ID of collection1856 * @param fromAddressObj address on behalf of which tokens will be sent1857 * @param toAddressObj address where token to be sent1858 * @param amount number of tokens to be sent1859 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);1860 * @returns ```true``` if extrinsic success, otherwise ```false```1861 */1862 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1863 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);1864 }18651866 /**1867 * Destroy some amount of tokens1868 * @param signer keyring of signer1869 * @param collectionId ID of collection1870 * @param amount amount of tokens to be destroyed1871 * @example burnTokens(aliceKeyring, 10, 1000n);1872 * @returns ```true``` if extrinsic success, otherwise ```false```1873 */1874 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {1875 return (await super.burnToken(signer, collectionId, 0, amount)).success;1876 }18771878 /**1879 * Burn some tokens on behalf of the owner.1880 * @param signer keyring of signer1881 * @param collectionId ID of collection1882 * @param fromAddressObj address on behalf of which tokens will be burnt1883 * @param amount amount of tokens to be burnt1884 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);1885 * @returns ```true``` if extrinsic success, otherwise ```false```1886 */1887 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1888 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);1889 }18901891 /**1892 * Get total collection supply1893 * @param collectionId1894 * @returns1895 */1896 async getTotalPieces(collectionId: number): Promise<bigint> {1897 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();1898 }18991900 /**1901 * Set, change, or remove approved address to transfer tokens.1902 *1903 * @param signer keyring of signer1904 * @param collectionId ID of collection1905 * @param toAddressObj address to be approved1906 * @param amount amount of tokens to be approved1907 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)1908 * @returns ```true``` if extrinsic success, otherwise ```false```1909 */1910 async approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {1911 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);1912 }19131914 /**1915 * Get amount of fungible tokens approved to transfer1916 * @param collectionId ID of collection1917 * @param fromAddressObj owner of tokens1918 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner1919 * @returns number of tokens approved for the transfer1920 */1921 async getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {1922 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);1923 }1924}192519261927class ChainGroup extends HelperGroup {1928 /**1929 * Get system properties of a chain1930 * @example getChainProperties();1931 * @returns ss58Format, token decimals, and token symbol1932 */1933 getChainProperties(): IChainProperties {1934 const properties = (this.helper.api as any).registry.getChainProperties().toJSON();1935 return {1936 ss58Format: properties.ss58Format.toJSON(),1937 tokenDecimals: properties.tokenDecimals.toJSON(),1938 tokenSymbol: properties.tokenSymbol.toJSON(),1939 };1940 }19411942 /**1943 * Get chain header1944 * @example getLatestBlockNumber();1945 * @returns the number of the last block1946 */1947 async getLatestBlockNumber(): Promise<number> {1948 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();1949 }19501951 /**1952 * Get block hash by block number1953 * @param blockNumber number of block1954 * @example getBlockHashByNumber(12345);1955 * @returns hash of a block1956 */1957 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {1958 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();1959 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;1960 return blockHash;1961 }19621963 // TODO add docs1964 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {1965 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);1966 if (!blockHash) return null;1967 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;1968 }19691970 /**1971 * Get account nonce1972 * @param address substrate address1973 * @example getNonce("5GrwvaEF5zXb26Fz...");1974 * @returns number, account's nonce1975 */1976 async getNonce(address: TSubstrateAccount): Promise<number> {1977 return (await (this.helper.api as any).query.system.account(address)).nonce.toNumber();1978 }1979}198019811982class BalanceGroup extends HelperGroup {1983 /**1984 * Representation of the native token in the smallest unit1985 * @example getOneTokenNominal()1986 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.1987 */1988 getOneTokenNominal(): bigint {1989 const chainProperties = this.helper.chain.getChainProperties();1990 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);1991 }19921993 /**1994 * Get substrate address balance1995 * @param address substrate address1996 * @example getSubstrate("5GrwvaEF5zXb26Fz...")1997 * @returns amount of tokens on address1998 */1999 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2000 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2001 }20022003 /**2004 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2005 * @param address substrate address2006 * @returns2007 */2008 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2009 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2010 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2011 }20122013 /**2014 * Get ethereum address balance2015 * @param address ethereum address2016 * @example getEthereum("0x9F0583DbB855d...")2017 * @returns amount of tokens on address2018 */2019 async getEthereum(address: TEthereumAccount): Promise<bigint> {2020 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2021 }20222023 /**2024 * Transfer tokens to substrate address2025 * @param signer keyring of signer2026 * @param address substrate address of a recipient2027 * @param amount amount of tokens to be transfered2028 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2029 * @returns ```true``` if extrinsic success, otherwise ```false```2030 */2031 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2032 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}`*/);20332034 let transfer = {from: null, to: null, amount: 0n} as any;2035 result.result.events.forEach(({event: {data, method, section}}) => {2036 if ((section === 'balances') && (method === 'Transfer')) {2037 transfer = {2038 from: this.helper.address.normalizeSubstrate(data[0]),2039 to: this.helper.address.normalizeSubstrate(data[1]),2040 amount: BigInt(data[2]),2041 };2042 }2043 });2044 let isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from;2045 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(address) === transfer.to;2046 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2047 return isSuccess;2048 }2049}205020512052class AddressGroup extends HelperGroup {2053 /**2054 * Normalizes the address to the specified ss58 format, by default ```42```.2055 * @param address substrate address2056 * @param ss58Format format for address conversion, by default ```42```2057 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2058 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2059 */2060 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2061 return this.helper.util.normalizeSubstrateAddress(address, ss58Format);2062 }20632064 /**2065 * Normalizes the address of an account ONLY if it's Substrate to the specified ss58 format, by default ```42```.2066 * @param account account of either Substrate type or Ethereum, but only Substrate will be changed2067 * @param ss58Format format for address conversion, by default ```42```2068 * @example normalizeCrossAccountIfSubstrate({Substrate: "unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx"}) // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2069 * @returns untouched ethereum account or substrate account converted to normalized (i.e., starting with 5) or specified explicitly representation2070 */2071 normalizeCrossAccountIfSubstrate(account: ICrossAccountId, ss58Format = 42): ICrossAccountId {2072 return account.Substrate2073 ? {Substrate: this.normalizeSubstrate(account.Substrate, ss58Format)}2074 : account;2075 }20762077 /**2078 * Get address in the connected chain format2079 * @param address substrate address2080 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2081 * @returns address in chain format2082 */2083 async normalizeSubstrateToChainFormat(address: TSubstrateAccount): Promise<TSubstrateAccount> {2084 const info = this.helper.chain.getChainProperties();2085 return encodeAddress(decodeAddress(address), info.ss58Format);2086 }20872088 /**2089 * Get substrate mirror of an ethereum address2090 * @param ethAddress ethereum address2091 * @param toChainFormat false for normalized account2092 * @example ethToSubstrate('0x9F0583DbB855d...')2093 * @returns substrate mirror of a provided ethereum address2094 */2095 async ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): Promise<TSubstrateAccount> {2096 if(!toChainFormat) return evmToAddress(ethAddress);2097 const info = this.helper.chain.getChainProperties();2098 return evmToAddress(ethAddress, info.ss58Format);2099 }21002101 /**2102 * Get ethereum mirror of a substrate address2103 * @param subAddress substrate account2104 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2105 * @returns ethereum mirror of a provided substrate address2106 */2107 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2108 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(subAddress), i => i.toString(16).padStart(2, '0')).join(''));2109 }2110}21112112class StakingGroup extends HelperGroup {2113 /**2114 * Stake tokens for App Promotion2115 * @param signer keyring of signer2116 * @param amountToStake amount of tokens to stake2117 * @param label extra label for log2118 * @returns2119 */2120 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2121 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2122 const stakeResult = await this.helper.executeExtrinsic(2123 signer, 'api.tx.appPromotion.stake',2124 [amountToStake], true,2125 );2126 // TODO extract info from stakeResult2127 return true;2128 }21292130 /**2131 * Unstake tokens for App Promotion2132 * @param signer keyring of signer2133 * @param amountToUnstake amount of tokens to unstake2134 * @param label extra label for log2135 * @returns block number where balances will be unlocked2136 */2137 async unstake(signer: TSigner, label?: string): Promise<number> {2138 if(typeof label === 'undefined') label = `${signer.address}`;2139 const unstakeResult = await this.helper.executeExtrinsic(2140 signer, 'api.tx.appPromotion.unstake',2141 [], true,2142 );2143 // TODO extract block number fron events2144 return 1;2145 }21462147 /**2148 * Get total staked amount for address2149 * @param address substrate or ethereum address2150 * @returns total staked amount2151 */2152 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2153 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2154 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2155 }21562157 /**2158 * Get total staked per block2159 * @param address substrate or ethereum address2160 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2161 */2162 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2163 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2164 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2165 return { 2166 block: block.toBigInt(),2167 amount: amount.toBigInt(),2168 };2169 });2170 }21712172 /**2173 * Get total pending unstake amount for address2174 * @param address substrate or ethereum address2175 * @returns total pending unstake amount2176 */2177 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2178 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2179 }21802181 /**2182 * Get pending unstake amount per block for address2183 * @param address substrate or ethereum address2184 * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2185 */2186 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2187 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2188 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2189 return {2190 block: block.toBigInt(),2191 amount: amount.toBigInt(),2192 };2193 });2194 return result;2195 }2196}21972198export class UniqueHelper extends ChainHelperBase {2199 chain: ChainGroup;2200 balance: BalanceGroup;2201 address: AddressGroup;2202 collection: CollectionGroup;2203 nft: NFTGroup;2204 rft: RFTGroup;2205 ft: FTGroup;2206 staking: StakingGroup;22072208 constructor(logger?: ILogger) {2209 super(logger);2210 this.chain = new ChainGroup(this);2211 this.balance = new BalanceGroup(this);2212 this.address = new AddressGroup(this);2213 this.collection = new CollectionGroup(this);2214 this.nft = new NFTGroup(this);2215 this.rft = new RFTGroup(this);2216 this.ft = new FTGroup(this);2217 this.staking = new StakingGroup(this);2218 }2219}222022212222export class UniqueCollectionBase {2223 helper: UniqueHelper;2224 collectionId: number;22252226 constructor(collectionId: number, uniqueHelper: UniqueHelper) {2227 this.collectionId = collectionId;2228 this.helper = uniqueHelper;2229 }22302231 async getData() {2232 return await this.helper.collection.getData(this.collectionId);2233 }22342235 async getLastTokenId() {2236 return await this.helper.collection.getLastTokenId(this.collectionId);2237 }22382239 async isTokenExists(tokenId: number) {2240 return await this.helper.collection.isTokenExists(this.collectionId, tokenId);2241 }22422243 async getAdmins() {2244 return await this.helper.collection.getAdmins(this.collectionId);2245 }22462247 async getAllowList() {2248 return await this.helper.collection.getAllowList(this.collectionId);2249 }22502251 async getEffectiveLimits() {2252 return await this.helper.collection.getEffectiveLimits(this.collectionId);2253 }22542255 async getProperties(propertyKeys: string[] | null = null) {2256 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);2257 }22582259 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {2260 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);2261 }22622263 async confirmSponsorship(signer: TSigner) {2264 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);2265 }22662267 async removeSponsor(signer: TSigner) {2268 return await this.helper.collection.removeSponsor(signer, this.collectionId);2269 }22702271 async setLimits(signer: TSigner, limits: ICollectionLimits) {2272 return await this.helper.collection.setLimits(signer, this.collectionId, limits);2273 }22742275 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {2276 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);2277 }22782279 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2280 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);2281 }22822283 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {2284 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);2285 }22862287 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {2288 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);2289 }22902291 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {2292 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);2293 }22942295 async setProperties(signer: TSigner, properties: IProperty[]) {2296 return await this.helper.collection.setProperties(signer, this.collectionId, properties);2297 }22982299 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2300 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);2301 }23022303 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {2304 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);2305 }23062307 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {2308 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);2309 }23102311 async enableNesting(signer: TSigner, permissions: INestingPermissions) {2312 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);2313 }23142315 async disableNesting(signer: TSigner) {2316 return await this.helper.collection.disableNesting(signer, this.collectionId);2317 }23182319 async burn(signer: TSigner) {2320 return await this.helper.collection.burn(signer, this.collectionId);2321 }2322}232323242325export class UniqueNFTCollection extends UniqueCollectionBase {2326 getTokenObject(tokenId: number) {2327 return new UniqueNFTToken(tokenId, this);2328 }23292330 async getTokensByAddress(addressObj: ICrossAccountId) {2331 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);2332 }23332334 async getToken(tokenId: number, blockHashAt?: string) {2335 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);2336 }23372338 async getTokenOwner(tokenId: number, blockHashAt?: string) {2339 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);2340 }23412342 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {2343 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);2344 }23452346 async getTokenChildren(tokenId: number, blockHashAt?: string) {2347 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);2348 }23492350 async getPropertyPermissions(propertyKeys: string[] | null = null) {2351 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);2352 }23532354 async getTokenProperties(tokenId: number, propertyKeys: string[] | null = null) {2355 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2356 }23572358 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {2359 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);2360 }23612362 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2363 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);2364 }23652366 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {2367 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);2368 }23692370 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {2371 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);2372 }23732374 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2375 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});2376 }23772378 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {2379 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);2380 }23812382 async burnToken(signer: TSigner, tokenId: number) {2383 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);2384 }23852386 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {2387 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);2388 }23892390 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2391 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);2392 }23932394 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2395 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2396 }23972398 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2399 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2400 }24012402 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {2403 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);2404 }24052406 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2407 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);2408 }2409}241024112412export class UniqueRFTCollection extends UniqueCollectionBase {2413 getTokenObject(tokenId: number) {2414 return new UniqueRFTToken(tokenId, this);2415 }24162417 async getToken(tokenId: number, blockHashAt?: string) {2418 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);2419 }24202421 async getTokensByAddress(addressObj: ICrossAccountId) {2422 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);2423 }24242425 async getTop10TokenOwners(tokenId: number) {2426 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);2427 }24282429 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {2430 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);2431 }24322433 async getTokenTotalPieces(tokenId: number) {2434 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);2435 }24362437 async getPropertyPermissions(propertyKeys: string[] | null = null) {2438 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);2439 }24402441 async getTokenProperties(tokenId: number, propertyKeys: string[] | null = null) {2442 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);2443 }24442445 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {2446 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);2447 }24482449 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2450 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);2451 }24522453 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2454 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);2455 }24562457 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2458 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);2459 }24602461 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {2462 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);2463 }24642465 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {2466 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});2467 }24682469 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {2470 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);2471 }24722473 async burnToken(signer: TSigner, tokenId: number, amount=1n) {2474 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);2475 }24762477 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n) {2478 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);2479 }24802481 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {2482 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);2483 }24842485 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {2486 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);2487 }24882489 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {2490 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);2491 }2492}249324942495export class UniqueFTCollection extends UniqueCollectionBase {2496 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {2497 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);2498 }24992500 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {2501 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);2502 }25032504 async getBalance(addressObj: ICrossAccountId) {2505 return await this.helper.ft.getBalance(this.collectionId, addressObj);2506 }25072508 async getTop10Owners() {2509 return await this.helper.ft.getTop10Owners(this.collectionId);2510 }25112512 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2513 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);2514 }25152516 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2517 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);2518 }25192520 async burnTokens(signer: TSigner, amount=1n) {2521 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);2522 }25232524 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2525 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);2526 }25272528 async getTotalPieces() {2529 return await this.helper.ft.getTotalPieces(this.collectionId);2530 }25312532 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2533 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);2534 }25352536 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2537 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);2538 }2539}254025412542export class UniqueTokenBase implements IToken {2543 collection: UniqueNFTCollection | UniqueRFTCollection;2544 collectionId: number;2545 tokenId: number;25462547 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {2548 this.collection = collection;2549 this.collectionId = collection.collectionId;2550 this.tokenId = tokenId;2551 }25522553 async getNextSponsored(addressObj: ICrossAccountId) {2554 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);2555 }25562557 async getProperties(propertyKeys: string[] | null = null) {2558 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);2559 }25602561 async setProperties(signer: TSigner, properties: IProperty[]) {2562 return await this.collection.setTokenProperties(signer, this.tokenId, properties);2563 }25642565 async deleteProperties(signer: TSigner, propertyKeys: string[]) {2566 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);2567 }25682569 nestingAddress() {2570 return this.collection.helper.util.getNestingTokenAddress(this);2571 }2572}257325742575export class UniqueNFTToken extends UniqueTokenBase {2576 collection: UniqueNFTCollection;25772578 constructor(tokenId: number, collection: UniqueNFTCollection) {2579 super(tokenId, collection);2580 this.collection = collection;2581 }25822583 async getData(blockHashAt?: string) {2584 return await this.collection.getToken(this.tokenId, blockHashAt);2585 }25862587 async getOwner(blockHashAt?: string) {2588 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);2589 }25902591 async getTopmostOwner(blockHashAt?: string) {2592 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);2593 }25942595 async getChildren(blockHashAt?: string) {2596 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);2597 }25982599 async nest(signer: TSigner, toTokenObj: IToken) {2600 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);2601 }26022603 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {2604 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);2605 }26062607 async transfer(signer: TSigner, addressObj: ICrossAccountId) {2608 return await this.collection.transferToken(signer, this.tokenId, addressObj);2609 }26102611 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2612 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);2613 }26142615 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {2616 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);2617 }26182619 async isApproved(toAddressObj: ICrossAccountId) {2620 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);2621 }26222623 async burn(signer: TSigner) {2624 return await this.collection.burnToken(signer, this.tokenId);2625 }26262627 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {2628 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);2629 }2630}26312632export class UniqueRFTToken extends UniqueTokenBase {2633 collection: UniqueRFTCollection;26342635 constructor(tokenId: number, collection: UniqueRFTCollection) {2636 super(tokenId, collection);2637 this.collection = collection;2638 }26392640 async getData(blockHashAt?: string) {2641 return await this.collection.getToken(this.tokenId, blockHashAt);2642 }26432644 async getTop10Owners() {2645 return await this.collection.getTop10TokenOwners(this.tokenId);2646 }26472648 async getBalance(addressObj: ICrossAccountId) {2649 return await this.collection.getTokenBalance(this.tokenId, addressObj);2650 }26512652 async getTotalPieces() {2653 return await this.collection.getTokenTotalPieces(this.tokenId);2654 }26552656 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {2657 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);2658 }26592660 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2661 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);2662 }26632664 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {2665 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);2666 }26672668 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {2669 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);2670 }26712672 async repartition(signer: TSigner, amount: bigint) {2673 return await this.collection.repartitionToken(signer, this.tokenId, amount);2674 }26752676 async burn(signer: TSigner, amount=1n) {2677 return await this.collection.burnToken(signer, this.tokenId, amount);2678 }26792680 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {2681 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);2682 }2683}