difftreelog
fix add wsEndpoint to playgrnd helpers
in: master
2 files changed
tests/src/util/playgrounds/unique.dev.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/unique.dev.ts
+++ b/tests/src/util/playgrounds/unique.dev.ts
@@ -117,6 +117,7 @@
});
await this.api.isReadyOrError;
this.network = await UniqueHelper.detectNetwork(this.api);
+ this.wsEndpoint = wsEndpoint;
}
}
@@ -339,7 +340,7 @@
'chainql',
[
`--tla-code=data=${kvStr}`,
- '-e', 'function(data) cql.dump(cql.chain("wss://ws-opal.unique.network:443").latest._meta, data, {omit_empty:true})',
+ '-e', `function(data) cql.dump(cql.chain("${this.helper.getEndpoint()}").latest._meta, data, {omit_empty:true})`,
],
);
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, base58Encode, blake2AsU8a} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {hexToU8a} from '@polkadot/util/hex';13import {u8aConcat} from '@polkadot/util/u8a';14import {15 IApiListeners,16 IBlock,17 IEvent,18 IChainProperties,19 ICollectionCreationOptions,20 ICollectionLimits,21 ICollectionPermissions,22 ICrossAccountId,23 ICrossAccountIdLower,24 ILogger,25 INestingPermissions,26 IProperty,27 IStakingInfo,28 ISchedulerOptions,29 ISubstrateBalance,30 IToken,31 ITokenPropertyPermission,32 ITransactionResult,33 IUniqueHelperLog,34 TApiAllowedListeners,35 TEthereumAccount,36 TSigner,37 TSubstrateAccount,38 TNetworks,39 IForeignAssetMetadata,40 AcalaAssetMetadata,41 MoonbeamAssetInfo,42 DemocracyStandardAccountVote,43 IEthCrossAccountId,44} from './types';45import {RuntimeDispatchInfo} from '@polkadot/types/interfaces';46import type {Vec} from '@polkadot/types-codec';47import {FrameSystemEventRecord} from '@polkadot/types/lookup';4849export class CrossAccountId implements ICrossAccountId {50 Substrate?: TSubstrateAccount;51 Ethereum?: TEthereumAccount;5253 constructor(account: ICrossAccountId) {54 if (account.Substrate) this.Substrate = account.Substrate;55 if (account.Ethereum) this.Ethereum = account.Ethereum;56 }5758 static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {59 switch (domain) {60 case 'Substrate': return new CrossAccountId({Substrate: account.address});61 case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();62 }63 }6465 static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {66 return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});67 }6869 static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {70 return encodeAddress(decodeAddress(address), ss58Format);71 }7273 static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {74 return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});75 }7677 withNormalizedSubstrate(ss58Format = 42): CrossAccountId {78 if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);79 return this;80 }8182 static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {83 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));84 }8586 toEthereum(): CrossAccountId {87 if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});88 return this;89 }9091 static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {92 return evmToAddress(address, ss58Format);93 }9495 toSubstrate(ss58Format?: number): CrossAccountId {96 if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});97 return this;98 }99100 toLowerCase(): CrossAccountId {101 if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();102 if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();103 return this;104 }105}106107const nesting = {108 toChecksumAddress(address: string): string {109 if (typeof address === 'undefined') return '';110111 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);112113 address = address.toLowerCase().replace(/^0x/i,'');114 const addressHash = keccakAsHex(address).replace(/^0x/i,'');115 const checksumAddress = ['0x'];116117 for (let i = 0; i < address.length; i++) {118 // If ith character is 8 to f then make it uppercase119 if (parseInt(addressHash[i], 16) > 7) {120 checksumAddress.push(address[i].toUpperCase());121 } else {122 checksumAddress.push(address[i]);123 }124 }125 return checksumAddress.join('');126 },127 tokenIdToAddress(collectionId: number, tokenId: number) {128 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);129 },130};131132class UniqueUtil {133 static transactionStatus = {134 NOT_READY: 'NotReady',135 FAIL: 'Fail',136 SUCCESS: 'Success',137 };138139 static chainLogType = {140 EXTRINSIC: 'extrinsic',141 RPC: 'rpc',142 };143144 static getTokenAccount(token: IToken): CrossAccountId {145 return new CrossAccountId({Ethereum: this.getTokenAddress(token)});146 }147148 static getTokenAddress(token: IToken): string {149 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);150 }151152 static getDefaultLogger(): ILogger {153 return {154 log(msg: any, level = 'INFO') {155 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));156 },157 level: {158 ERROR: 'ERROR',159 WARNING: 'WARNING',160 INFO: 'INFO',161 },162 };163 }164165 static vec2str(arr: string[] | number[]) {166 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');167 }168169 static str2vec(string: string) {170 if (typeof string !== 'string') return string;171 return Array.from(string).map(x => x.charCodeAt(0));172 }173174 static fromSeed(seed: string, ss58Format = 42) {175 const keyring = new Keyring({type: 'sr25519', ss58Format});176 return keyring.addFromUri(seed);177 }178179 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {180 if (creationResult.status !== this.transactionStatus.SUCCESS) {181 throw Error('Unable to create collection!');182 }183184 let collectionId = null;185 creationResult.result.events.forEach(({event: {data, method, section}}) => {186 if ((section === 'common') && (method === 'CollectionCreated')) {187 collectionId = parseInt(data[0].toString(), 10);188 }189 });190191 if (collectionId === null) {192 throw Error('No CollectionCreated event was found!');193 }194195 return collectionId;196 }197198 static extractTokensFromCreationResult(creationResult: ITransactionResult): {199 success: boolean,200 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],201 } {202 if (creationResult.status !== this.transactionStatus.SUCCESS) {203 throw Error('Unable to create tokens!');204 }205 let success = false;206 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];207 creationResult.result.events.forEach(({event: {data, method, section}}) => {208 if (method === 'ExtrinsicSuccess') {209 success = true;210 } else if ((section === 'common') && (method === 'ItemCreated')) {211 tokens.push({212 collectionId: parseInt(data[0].toString(), 10),213 tokenId: parseInt(data[1].toString(), 10),214 owner: data[2].toHuman(),215 amount: data[3].toBigInt(),216 });217 }218 });219 return {success, tokens};220 }221222 static extractTokensFromBurnResult(burnResult: ITransactionResult): {223 success: boolean,224 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],225 } {226 if (burnResult.status !== this.transactionStatus.SUCCESS) {227 throw Error('Unable to burn tokens!');228 }229 let success = false;230 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];231 burnResult.result.events.forEach(({event: {data, method, section}}) => {232 if (method === 'ExtrinsicSuccess') {233 success = true;234 } else if ((section === 'common') && (method === 'ItemDestroyed')) {235 tokens.push({236 collectionId: parseInt(data[0].toString(), 10),237 tokenId: parseInt(data[1].toString(), 10),238 owner: data[2].toHuman(),239 amount: data[3].toBigInt(),240 });241 }242 });243 return {success, tokens};244 }245246 static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {247 let eventId = null;248 events.forEach(({event: {data, method, section}}) => {249 if ((section === expectedSection) && (method === expectedMethod)) {250 eventId = parseInt(data[0].toString(), 10);251 }252 });253254 if (eventId === null) {255 throw Error(`No ${expectedMethod} event was found!`);256 }257 return eventId === collectionId;258 }259260 static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {261 const normalizeAddress = (address: string | ICrossAccountId) => {262 if(typeof address === 'string') return address;263 const obj = {} as any;264 Object.keys(address).forEach(k => {265 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];266 });267 if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);268 if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();269 return address;270 };271 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;272 events.forEach(({event: {data, method, section}}) => {273 if ((section === 'common') && (method === 'Transfer')) {274 const hData = (data as any).toJSON();275 transfer = {276 collectionId: hData[0],277 tokenId: hData[1],278 from: normalizeAddress(hData[2]),279 to: normalizeAddress(hData[3]),280 amount: BigInt(hData[4]),281 };282 }283 });284 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;285 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);286 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);287 isSuccess = isSuccess && amount === transfer.amount;288 return isSuccess;289 }290291 static bigIntToDecimals(number: bigint, decimals = 18) {292 const numberStr = number.toString();293 const dotPos = numberStr.length - decimals;294295 if (dotPos <= 0) {296 return '0.' + '0'.repeat(Math.abs(dotPos)) + numberStr;297 } else {298 const intPart = numberStr.substring(0, dotPos);299 const fractPart = numberStr.substring(dotPos);300 return intPart + '.' + fractPart;301 }302 }303}304305class UniqueEventHelper {306 private static extractIndex(index: any): [number, number] | string {307 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];308 return index.toJSON();309 }310311 private static extractSub(data: any, subTypes: any): {[key: string]: any} {312 let obj: any = {};313 let index = 0;314315 if (data.entries) {316 for(const [key, value] of data.entries()) {317 obj[key] = this.extractData(value, subTypes[index]);318 index++;319 }320 } else obj = data.toJSON();321322 return obj;323 }324325 private static toHuman(data: any) {326 return data && data.toHuman ? data.toHuman() : `${data}`;327 }328329 private static extractData(data: any, type: any): any {330 if(!type) return this.toHuman(data);331 if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();332 if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();333 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);334 return this.toHuman(data);335 }336337 public static extractEvents(events: {event: any, phase: any}[]): IEvent[] {338 const parsedEvents: IEvent[] = [];339340 events.forEach((record) => {341 const {event, phase} = record;342 const types = event.typeDef;343344 const eventData: IEvent = {345 section: event.section.toString(),346 method: event.method.toString(),347 index: this.extractIndex(event.index),348 data: [],349 phase: phase.toJSON(),350 };351352 event.data.forEach((val: any, index: number) => {353 eventData.data.push(this.extractData(val, types[index]));354 });355356 parsedEvents.push(eventData);357 });358359 return parsedEvents;360 }361}362363export class ChainHelperBase {364 helperBase: any;365366 transactionStatus = UniqueUtil.transactionStatus;367 chainLogType = UniqueUtil.chainLogType;368 util: typeof UniqueUtil;369 eventHelper: typeof UniqueEventHelper;370 logger: ILogger;371 api: ApiPromise | null;372 forcedNetwork: TNetworks | null;373 network: TNetworks | null;374 chainLog: IUniqueHelperLog[];375 children: ChainHelperBase[];376 address: AddressGroup;377 chain: ChainGroup;378379 constructor(logger?: ILogger, helperBase?: any) {380 this.helperBase = helperBase;381382 this.util = UniqueUtil;383 this.eventHelper = UniqueEventHelper;384 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();385 this.logger = logger;386 this.api = null;387 this.forcedNetwork = null;388 this.network = null;389 this.chainLog = [];390 this.children = [];391 this.address = new AddressGroup(this);392 this.chain = new ChainGroup(this);393 }394395 clone(helperCls: ChainHelperBaseConstructor, options: {[key: string]: any} = {}) {396 Object.setPrototypeOf(helperCls.prototype, this);397 const newHelper = new helperCls(this.logger, options);398399 newHelper.api = this.api;400 newHelper.network = this.network;401 newHelper.forceNetwork = this.forceNetwork;402403 this.children.push(newHelper);404405 return newHelper;406 }407408 getApi(): ApiPromise {409 if(this.api === null) throw Error('API not initialized');410 return this.api;411 }412413 async subscribeEvents(expectedEvents: {section: string, names: string[]}[]) {414 const collectedEvents: IEvent[] = [];415 const unsubscribe = await this.getApi().query.system.events((events: Vec<FrameSystemEventRecord>) => {416 const ievents = this.eventHelper.extractEvents(events);417 ievents.forEach((event) => {418 expectedEvents.forEach((e => {419 if (event.section === e.section && e.names.includes(event.method)) {420 collectedEvents.push(event);421 }422 }));423 });424 });425 return {unsubscribe: unsubscribe as any, collectedEvents};426 }427428 clearChainLog(): void {429 this.chainLog = [];430 }431432 forceNetwork(value: TNetworks): void {433 this.forcedNetwork = value;434 }435436 async connect(wsEndpoint: string, listeners?: IApiListeners) {437 if (this.api !== null) throw Error('Already connected');438 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);439 this.api = api;440 this.network = network;441 }442443 async disconnect() {444 for (const child of this.children) {445 child.clearApi();446 }447448 if (this.api === null) return;449 await this.api.disconnect();450 this.clearApi();451 }452453 clearApi() {454 this.api = null;455 this.network = null;456 }457458 static async detectNetwork(api: ApiPromise): Promise<TNetworks> {459 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;460 const xcmChains = ['rococo', 'westend', 'westmint', 'acala', 'karura', 'moonbeam', 'moonriver'];461462 if(xcmChains.indexOf(spec.specName) > -1) return spec.specName;463464 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;465 return 'opal';466 }467468 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TNetworks> {469 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});470 await api.isReady;471472 const network = await this.detectNetwork(api);473474 await api.disconnect();475476 return network;477 }478479 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TNetworks | null): Promise<{480 api: ApiPromise;481 network: TNetworks;482 }> {483 if(typeof network === 'undefined' || network === null) network = 'opal';484 const supportedRPC = {485 opal: {486 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,487 },488 quartz: {489 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,490 },491 unique: {492 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,493 },494 rococo: {},495 westend: {},496 moonbeam: {},497 moonriver: {},498 acala: {},499 karura: {},500 westmint: {},501 };502 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);503 const rpc = supportedRPC[network];504505 // TODO: investigate how to replace rpc in runtime506 // api._rpcCore.addUserInterfaces(rpc);507508 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});509510 await api.isReadyOrError;511512 if (typeof listeners === 'undefined') listeners = {};513 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {514 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;515 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);516 }517518 return {api, network};519 }520521 getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {522 const {events, status} = data;523 if (status.isReady) {524 return this.transactionStatus.NOT_READY;525 }526 if (status.isBroadcast) {527 return this.transactionStatus.NOT_READY;528 }529 if (status.isInBlock || status.isFinalized) {530 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');531 if (errors.length > 0) {532 return this.transactionStatus.FAIL;533 }534 if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {535 return this.transactionStatus.SUCCESS;536 }537 }538539 return this.transactionStatus.FAIL;540 }541542 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {543 const sign = (callback: any) => {544 if(options !== null) return transaction.signAndSend(sender, options, callback);545 return transaction.signAndSend(sender, callback);546 };547 // eslint-disable-next-line no-async-promise-executor548 return new Promise(async (resolve, reject) => {549 try {550 const unsub = await sign((result: any) => {551 const status = this.getTransactionStatus(result);552553 if (status === this.transactionStatus.SUCCESS) {554 this.logger.log(`${label} successful`);555 unsub();556 resolve({result, status});557 } else if (status === this.transactionStatus.FAIL) {558 let moduleError = null;559560 if (result.hasOwnProperty('dispatchError')) {561 const dispatchError = result['dispatchError'];562563 if (dispatchError) {564 if (dispatchError.isModule) {565 const modErr = dispatchError.asModule;566 const errorMeta = dispatchError.registry.findMetaError(modErr);567568 moduleError = `${errorMeta.section}.${errorMeta.name}`;569 } else {570 moduleError = dispatchError.toHuman();571 }572 } else {573 this.logger.log(result, this.logger.level.ERROR);574 }575 }576577 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);578 unsub();579 reject({status, moduleError, result});580 }581 });582 } catch (e) {583 this.logger.log(e, this.logger.level.ERROR);584 reject(e);585 }586 });587 }588589 async signTransactionWithoutSending(signer: TSigner, tx: any) {590 const api = this.getApi();591 const signingInfo = await api.derive.tx.signingInfo(signer.address);592593 tx.sign(signer, {594 blockHash: api.genesisHash,595 genesisHash: api.genesisHash,596 runtimeVersion: api.runtimeVersion,597 nonce: signingInfo.nonce,598 });599600 return tx.toHex();601 }602603 async getPaymentInfo(signer: TSigner, tx: any, len: number | null) {604 const api = this.getApi();605 const signingInfo = await api.derive.tx.signingInfo(signer.address);606607 // We need to sign the tx because608 // unsigned transactions does not have an inclusion fee609 tx.sign(signer, {610 blockHash: api.genesisHash,611 genesisHash: api.genesisHash,612 runtimeVersion: api.runtimeVersion,613 nonce: signingInfo.nonce,614 });615616 if (len === null) {617 return (await this.callRpc('api.rpc.payment.queryInfo', [tx.toHex()])) as RuntimeDispatchInfo;618 } else {619 return (await api.call.transactionPaymentApi.queryInfo(tx, len)) as RuntimeDispatchInfo;620 }621 }622623 constructApiCall(apiCall: string, params: any[]) {624 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);625 let call = this.getApi() as any;626 for(const part of apiCall.slice(4).split('.')) {627 call = call[part];628 }629 return call(...params);630 }631632 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {633 if(this.api === null) throw Error('API not initialized');634 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);635636 const startTime = (new Date()).getTime();637 let result: ITransactionResult;638 let events: IEvent[] = [];639 try {640 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;641 events = this.eventHelper.extractEvents(result.result.events);642 }643 catch(e) {644 if(!(e as object).hasOwnProperty('status')) throw e;645 result = e as ITransactionResult;646 }647648 const endTime = (new Date()).getTime();649650 const log = {651 executedAt: endTime,652 executionTime: endTime - startTime,653 type: this.chainLogType.EXTRINSIC,654 status: result.status,655 call: extrinsic,656 signer: this.getSignerAddress(sender),657 params,658 } as IUniqueHelperLog;659660 if(result.status !== this.transactionStatus.SUCCESS) {661 if (result.moduleError) log.moduleError = result.moduleError;662 else if (result.result.dispatchError) log.dispatchError = result.result.dispatchError;663 }664 if(events.length > 0) log.events = events;665666 this.chainLog.push(log);667668 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {669 if (result.moduleError) throw Error(`${result.moduleError}`);670 else if (result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));671 }672 return result;673 }674675 async callRpc(rpc: string, params?: any[]) {676 if(typeof params === 'undefined') params = [];677 if(this.api === null) throw Error('API not initialized');678 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);679680 const startTime = (new Date()).getTime();681 let result;682 let error = null;683 const log = {684 type: this.chainLogType.RPC,685 call: rpc,686 params,687 } as IUniqueHelperLog;688689 try {690 result = await this.constructApiCall(rpc, params);691 }692 catch(e) {693 error = e;694 }695696 const endTime = (new Date()).getTime();697698 log.executedAt = endTime;699 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';700 log.executionTime = endTime - startTime;701702 this.chainLog.push(log);703704 if(error !== null) throw error;705706 return result;707 }708709 getSignerAddress(signer: IKeyringPair | string): string {710 if(typeof signer === 'string') return signer;711 return signer.address;712 }713714 fetchAllPalletNames(): string[] {715 if(this.api === null) throw Error('API not initialized');716 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());717 }718719 fetchMissingPalletNames(requiredPallets: string[]): string[] {720 const palletNames = this.fetchAllPalletNames();721 return requiredPallets.filter(p => !palletNames.includes(p));722 }723}724725726class HelperGroup<T extends ChainHelperBase> {727 helper: T;728729 constructor(uniqueHelper: T) {730 this.helper = uniqueHelper;731 }732}733734735class CollectionGroup extends HelperGroup<UniqueHelper> {736 /**737 * Get number of blocks when sponsored transaction is available.738 *739 * @param collectionId ID of collection740 * @param tokenId ID of token741 * @param addressObj address for which the sponsorship is checked742 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});743 * @returns number of blocks or null if sponsorship hasn't been set744 */745 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {746 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();747 }748749 /**750 * Get the number of created collections.751 *752 * @returns number of created collections753 */754 async getTotalCount(): Promise<number> {755 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();756 }757758 /**759 * Get information about the collection with additional data,760 * including the number of tokens it contains, its administrators,761 * the normalized address of the collection's owner, and decoded name and description.762 *763 * @param collectionId ID of collection764 * @example await getData(2)765 * @returns collection information object766 */767 async getData(collectionId: number): Promise<{768 id: number;769 name: string;770 description: string;771 tokensCount: number;772 admins: CrossAccountId[];773 normalizedOwner: TSubstrateAccount;774 raw: any775 } | null> {776 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);777 const humanCollection = collection.toHuman(), collectionData = {778 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],779 raw: humanCollection,780 } as any, jsonCollection = collection.toJSON();781 if (humanCollection === null) return null;782 collectionData.raw.limits = jsonCollection.limits;783 collectionData.raw.permissions = jsonCollection.permissions;784 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);785 for (const key of ['name', 'description']) {786 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);787 }788789 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))790 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)791 : 0;792 collectionData.admins = await this.getAdmins(collectionId);793794 return collectionData;795 }796797 /**798 * Get the addresses of the collection's administrators, optionally normalized.799 *800 * @param collectionId ID of collection801 * @param normalize whether to normalize the addresses to the default ss58 format802 * @example await getAdmins(1)803 * @returns array of administrators804 */805 async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {806 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();807808 return normalize809 ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())810 : admins;811 }812813 /**814 * Get the addresses added to the collection allow-list, optionally normalized.815 * @param collectionId ID of collection816 * @param normalize whether to normalize the addresses to the default ss58 format817 * @example await getAllowList(1)818 * @returns array of allow-listed addresses819 */820 async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {821 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();822 return normalize823 ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())824 : allowListed;825 }826827 /**828 * Get the effective limits of the collection instead of null for default values829 *830 * @param collectionId ID of collection831 * @example await getEffectiveLimits(2)832 * @returns object of collection limits833 */834 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {835 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();836 }837838 /**839 * Burns the collection if the signer has sufficient permissions and collection is empty.840 *841 * @param signer keyring of signer842 * @param collectionId ID of collection843 * @example await helper.collection.burn(aliceKeyring, 3);844 * @returns ```true``` if extrinsic success, otherwise ```false```845 */846 async burn(signer: TSigner, collectionId: number): Promise<boolean> {847 const result = await this.helper.executeExtrinsic(848 signer,849 'api.tx.unique.destroyCollection', [collectionId],850 true,851 );852853 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');854 }855856 /**857 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.858 *859 * @param signer keyring of signer860 * @param collectionId ID of collection861 * @param sponsorAddress Sponsor substrate address862 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")863 * @returns ```true``` if extrinsic success, otherwise ```false```864 */865 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {866 const result = await this.helper.executeExtrinsic(867 signer,868 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],869 true,870 );871872 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorSet');873 }874875 /**876 * Confirms consent to sponsor the collection on behalf of the signer.877 *878 * @param signer keyring of signer879 * @param collectionId ID of collection880 * @example confirmSponsorship(aliceKeyring, 10)881 * @returns ```true``` if extrinsic success, otherwise ```false```882 */883 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {884 const result = await this.helper.executeExtrinsic(885 signer,886 'api.tx.unique.confirmSponsorship', [collectionId],887 true,888 );889890 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'SponsorshipConfirmed');891 }892893 /**894 * Removes the sponsor of a collection, regardless if it consented or not.895 *896 * @param signer keyring of signer897 * @param collectionId ID of collection898 * @example removeSponsor(aliceKeyring, 10)899 * @returns ```true``` if extrinsic success, otherwise ```false```900 */901 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {902 const result = await this.helper.executeExtrinsic(903 signer,904 'api.tx.unique.removeCollectionSponsor', [collectionId],905 true,906 );907908 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorRemoved');909 }910911 /**912 * Sets the limits of the collection. At least one limit must be specified for a correct call.913 *914 * @param signer keyring of signer915 * @param collectionId ID of collection916 * @param limits collection limits object917 * @example918 * await setLimits(919 * aliceKeyring,920 * 10,921 * {922 * sponsorTransferTimeout: 0,923 * ownerCanDestroy: false924 * }925 * )926 * @returns ```true``` if extrinsic success, otherwise ```false```927 */928 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {929 const result = await this.helper.executeExtrinsic(930 signer,931 'api.tx.unique.setCollectionLimits', [collectionId, limits],932 true,933 );934935 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionLimitSet');936 }937938 /**939 * Changes the owner of the collection to the new Substrate address.940 *941 * @param signer keyring of signer942 * @param collectionId ID of collection943 * @param ownerAddress substrate address of new owner944 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")945 * @returns ```true``` if extrinsic success, otherwise ```false```946 */947 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {948 const result = await this.helper.executeExtrinsic(949 signer,950 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],951 true,952 );953954 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionOwnerChanged');955 }956957 /**958 * Adds a collection administrator.959 *960 * @param signer keyring of signer961 * @param collectionId ID of collection962 * @param adminAddressObj Administrator address (substrate or ethereum)963 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})964 * @returns ```true``` if extrinsic success, otherwise ```false```965 */966 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {967 const result = await this.helper.executeExtrinsic(968 signer,969 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],970 true,971 );972973 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminAdded');974 }975976 /**977 * Removes a collection administrator.978 *979 * @param signer keyring of signer980 * @param collectionId ID of collection981 * @param adminAddressObj Administrator address (substrate or ethereum)982 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})983 * @returns ```true``` if extrinsic success, otherwise ```false```984 */985 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {986 const result = await this.helper.executeExtrinsic(987 signer,988 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],989 true,990 );991992 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminRemoved');993 }994995 /**996 * Check if user is in allow list.997 *998 * @param collectionId ID of collection999 * @param user Account to check1000 * @example await getAdmins(1)1001 * @returns is user in allow list1002 */1003 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {1004 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();1005 }10061007 /**1008 * Adds an address to allow list1009 * @param signer keyring of signer1010 * @param collectionId ID of collection1011 * @param addressObj address to add to the allow list1012 * @returns ```true``` if extrinsic success, otherwise ```false```1013 */1014 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1015 const result = await this.helper.executeExtrinsic(1016 signer,1017 'api.tx.unique.addToAllowList', [collectionId, addressObj],1018 true,1019 );10201021 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressAdded');1022 }10231024 /**1025 * Removes an address from allow list1026 *1027 * @param signer keyring of signer1028 * @param collectionId ID of collection1029 * @param addressObj address to remove from the allow list1030 * @returns ```true``` if extrinsic success, otherwise ```false```1031 */1032 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1033 const result = await this.helper.executeExtrinsic(1034 signer,1035 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],1036 true,1037 );10381039 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressRemoved');1040 }10411042 /**1043 * Sets onchain permissions for selected collection.1044 *1045 * @param signer keyring of signer1046 * @param collectionId ID of collection1047 * @param permissions collection permissions object1048 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});1049 * @returns ```true``` if extrinsic success, otherwise ```false```1050 */1051 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {1052 const result = await this.helper.executeExtrinsic(1053 signer,1054 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],1055 true,1056 );10571058 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPermissionSet');1059 }10601061 /**1062 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.1063 *1064 * @param signer keyring of signer1065 * @param collectionId ID of collection1066 * @param permissions nesting permissions object1067 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});1068 * @returns ```true``` if extrinsic success, otherwise ```false```1069 */1070 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {1071 return await this.setPermissions(signer, collectionId, {nesting: permissions});1072 }10731074 /**1075 * Disables nesting for selected collection.1076 *1077 * @param signer keyring of signer1078 * @param collectionId ID of collection1079 * @example disableNesting(aliceKeyring, 10);1080 * @returns ```true``` if extrinsic success, otherwise ```false```1081 */1082 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {1083 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});1084 }10851086 /**1087 * Sets onchain properties to the collection.1088 *1089 * @param signer keyring of signer1090 * @param collectionId ID of collection1091 * @param properties array of property objects1092 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);1093 * @returns ```true``` if extrinsic success, otherwise ```false```1094 */1095 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {1096 const result = await this.helper.executeExtrinsic(1097 signer,1098 'api.tx.unique.setCollectionProperties', [collectionId, properties],1099 true,1100 );11011102 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');1103 }11041105 /**1106 * Get collection properties.1107 *1108 * @param collectionId ID of collection1109 * @param propertyKeys optionally filter the returned properties to only these keys1110 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);1111 * @returns array of key-value pairs1112 */1113 async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1114 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();1115 }11161117 async getPropertiesConsumedSpace(collectionId: number): Promise<number> {1118 const api = this.helper.getApi();1119 const props = (await api.query.common.collectionProperties(collectionId)).toJSON();11201121 return (props! as any).consumedSpace;1122 }11231124 async getCollectionOptions(collectionId: number) {1125 return (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1126 }11271128 /**1129 * Deletes onchain properties from the collection.1130 *1131 * @param signer keyring of signer1132 * @param collectionId ID of collection1133 * @param propertyKeys array of property keys to delete1134 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);1135 * @returns ```true``` if extrinsic success, otherwise ```false```1136 */1137 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {1138 const result = await this.helper.executeExtrinsic(1139 signer,1140 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],1141 true,1142 );11431144 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1145 }11461147 /**1148 * Changes the owner of the token.1149 *1150 * @param signer keyring of signer1151 * @param collectionId ID of collection1152 * @param tokenId ID of token1153 * @param addressObj address of a new owner1154 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1155 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1156 * @returns true if the token success, otherwise false1157 */1158 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1159 const result = await this.helper.executeExtrinsic(1160 signer,1161 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1162 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1163 );11641165 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1166 }11671168 /**1169 *1170 * Change ownership of a token(s) on behalf of the owner.1171 *1172 * @param signer keyring of signer1173 * @param collectionId ID of collection1174 * @param tokenId ID of token1175 * @param fromAddressObj address on behalf of which the token will be sent1176 * @param toAddressObj new token owner1177 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1178 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1179 * @returns true if the token success, otherwise false1180 */1181 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1182 const result = await this.helper.executeExtrinsic(1183 signer,1184 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1185 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1186 );1187 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1188 }11891190 /**1191 *1192 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1193 *1194 * @param signer keyring of signer1195 * @param collectionId ID of collection1196 * @param tokenId ID of token1197 * @param amount amount of tokens to be burned. For NFT must be set to 1n1198 * @example burnToken(aliceKeyring, 10, 5);1199 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1200 */1201 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1202 const burnResult = await this.helper.executeExtrinsic(1203 signer,1204 'api.tx.unique.burnItem', [collectionId, tokenId, amount],1205 true, // `Unable to burn token for ${label}`,1206 );1207 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1208 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1209 return burnedTokens.success;1210 }12111212 /**1213 * Destroys a concrete instance of NFT on behalf of the owner1214 *1215 * @param signer keyring of signer1216 * @param collectionId ID of collection1217 * @param tokenId ID of token1218 * @param fromAddressObj address on behalf of which the token will be burnt1219 * @param amount amount of tokens to be burned. For NFT must be set to 1n1220 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1221 * @returns ```true``` if extrinsic success, otherwise ```false```1222 */1223 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1224 const burnResult = await this.helper.executeExtrinsic(1225 signer,1226 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1227 true, // `Unable to burn token from for ${label}`,1228 );1229 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1230 return burnedTokens.success && burnedTokens.tokens.length > 0;1231 }12321233 /**1234 * Set, change, or remove approved address to transfer the ownership of the NFT.1235 *1236 * @param signer keyring of signer1237 * @param collectionId ID of collection1238 * @param tokenId ID of token1239 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1240 * @param amount amount of token to be approved. For NFT must be set to 1n1241 * @returns ```true``` if extrinsic success, otherwise ```false```1242 */1243 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1244 const approveResult = await this.helper.executeExtrinsic(1245 signer,1246 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1247 true, // `Unable to approve token for ${label}`,1248 );12491250 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1251 }12521253 /**1254 * Get the amount of token pieces approved to transfer or burn. Normally 0.1255 *1256 * @param collectionId ID of collection1257 * @param tokenId ID of token1258 * @param toAccountObj address which is approved to use token pieces1259 * @param fromAccountObj address which may have allowed the use of its owned tokens1260 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1261 * @returns number of approved to transfer pieces1262 */1263 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1264 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1265 }12661267 /**1268 * Get the last created token ID in a collection1269 *1270 * @param collectionId ID of collection1271 * @example getLastTokenId(10);1272 * @returns id of the last created token1273 */1274 async getLastTokenId(collectionId: number): Promise<number> {1275 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1276 }12771278 /**1279 * Check if token exists1280 *1281 * @param collectionId ID of collection1282 * @param tokenId ID of token1283 * @example doesTokenExist(10, 20);1284 * @returns true if the token exists, otherwise false1285 */1286 async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1287 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1288 }1289}12901291class NFTnRFT extends CollectionGroup {1292 /**1293 * Get tokens owned by account1294 *1295 * @param collectionId ID of collection1296 * @param addressObj tokens owner1297 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1298 * @returns array of token ids owned by account1299 */1300 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1301 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1302 }13031304 /**1305 * Get token data1306 *1307 * @param collectionId ID of collection1308 * @param tokenId ID of token1309 * @param propertyKeys optionally filter the token properties to only these keys1310 * @param blockHashAt optionally query the data at some block with this hash1311 * @example getToken(10, 5);1312 * @returns human readable token data1313 */1314 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1315 properties: IProperty[];1316 owner: CrossAccountId;1317 normalizedOwner: CrossAccountId;1318 }| null> {1319 let tokenData;1320 if(typeof blockHashAt === 'undefined') {1321 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1322 }1323 else {1324 if(propertyKeys.length == 0) {1325 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1326 if(!collection) return null;1327 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1328 }1329 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1330 }1331 tokenData = tokenData.toHuman();1332 if (tokenData === null || tokenData.owner === null) return null;1333 const owner = {} as any;1334 for (const key of Object.keys(tokenData.owner)) {1335 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate'1336 ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key])1337 : tokenData.owner[key];1338 }1339 tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1340 return tokenData;1341 }13421343 /**1344 * Set permissions to change token properties1345 *1346 * @param signer keyring of signer1347 * @param collectionId ID of collection1348 * @param permissions permissions to change a property by the collection admin or token owner1349 * @example setTokenPropertyPermissions(1350 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1351 * )1352 * @returns true if extrinsic success otherwise false1353 */1354 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1355 const result = await this.helper.executeExtrinsic(1356 signer,1357 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1358 true,1359 );13601361 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1362 }13631364 /**1365 * Get token property permissions.1366 *1367 * @param collectionId ID of collection1368 * @param propertyKeys optionally filter the returned property permissions to only these keys1369 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1370 * @returns array of key-permission pairs1371 */1372 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1373 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1374 }13751376 /**1377 * Set token properties1378 *1379 * @param signer keyring of signer1380 * @param collectionId ID of collection1381 * @param tokenId ID of token1382 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1383 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1384 * @returns ```true``` if extrinsic success, otherwise ```false```1385 */1386 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1387 const result = await this.helper.executeExtrinsic(1388 signer,1389 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1390 true,1391 );13921393 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1394 }13951396 /**1397 * Get properties, metadata assigned to a token.1398 *1399 * @param collectionId ID of collection1400 * @param tokenId ID of token1401 * @param propertyKeys optionally filter the returned properties to only these keys1402 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1403 * @returns array of key-value pairs1404 */1405 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1406 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1407 }14081409 /**1410 * Delete the provided properties of a token1411 * @param signer keyring of signer1412 * @param collectionId ID of collection1413 * @param tokenId ID of token1414 * @param propertyKeys property keys to be deleted1415 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1416 * @returns ```true``` if extrinsic success, otherwise ```false```1417 */1418 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1419 const result = await this.helper.executeExtrinsic(1420 signer,1421 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1422 true,1423 );14241425 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1426 }14271428 /**1429 * Mint new collection1430 *1431 * @param signer keyring of signer1432 * @param collectionOptions basic collection options and properties1433 * @param mode NFT or RFT type of a collection1434 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1435 * @returns object of the created collection1436 */1437 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1438 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1439 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1440 for (const key of ['name', 'description', 'tokenPrefix']) {1441 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);1442 }1443 const creationResult = await this.helper.executeExtrinsic(1444 signer,1445 'api.tx.unique.createCollectionEx', [collectionOptions],1446 true, // errorLabel,1447 );1448 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1449 }14501451 getCollectionObject(_collectionId: number): any {1452 return null;1453 }14541455 getTokenObject(_collectionId: number, _tokenId: number): any {1456 return null;1457 }14581459 /**1460 * Tells whether the given `owner` approves the `operator`.1461 * @param collectionId ID of collection1462 * @param owner owner address1463 * @param operator operator addrees1464 * @returns true if operator is enabled1465 */1466 async allowanceForAll(collectionId: number, owner: ICrossAccountId, operator: ICrossAccountId): Promise<boolean> {1467 return (await this.helper.callRpc('api.rpc.unique.allowanceForAll', [collectionId, owner, operator])).toJSON();1468 }14691470 /** Sets or unsets the approval of a given operator.1471 * The `operator` is allowed to transfer all tokens of the `caller` on their behalf.1472 * @param operator Operator1473 * @param approved Should operator status be granted or revoked?1474 * @returns ```true``` if extrinsic success, otherwise ```false```1475 */1476 async setAllowanceForAll(signer: TSigner, collectionId: number, operator: ICrossAccountId, approved: boolean): Promise<boolean> {1477 const result = await this.helper.executeExtrinsic(1478 signer,1479 'api.tx.unique.setAllowanceForAll', [collectionId, operator, approved],1480 true,1481 );1482 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'ApprovedForAll');1483 }1484}148514861487class NFTGroup extends NFTnRFT {1488 /**1489 * Get collection object1490 * @param collectionId ID of collection1491 * @example getCollectionObject(2);1492 * @returns instance of UniqueNFTCollection1493 */1494 getCollectionObject(collectionId: number): UniqueNFTCollection {1495 return new UniqueNFTCollection(collectionId, this.helper);1496 }14971498 /**1499 * Get token object1500 * @param collectionId ID of collection1501 * @param tokenId ID of token1502 * @example getTokenObject(10, 5);1503 * @returns instance of UniqueNFTToken1504 */1505 getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1506 return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1507 }15081509 /**1510 * Get token's owner1511 * @param collectionId ID of collection1512 * @param tokenId ID of token1513 * @param blockHashAt optionally query the data at the block with this hash1514 * @example getTokenOwner(10, 5);1515 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1516 */1517 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1518 let owner;1519 if (typeof blockHashAt === 'undefined') {1520 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1521 } else {1522 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1523 }1524 return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1525 }15261527 /**1528 * Is token approved to transfer1529 * @param collectionId ID of collection1530 * @param tokenId ID of token1531 * @param toAccountObj address to be approved1532 * @returns ```true``` if extrinsic success, otherwise ```false```1533 */1534 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1535 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1536 }15371538 /**1539 * Changes the owner of the token.1540 *1541 * @param signer keyring of signer1542 * @param collectionId ID of collection1543 * @param tokenId ID of token1544 * @param addressObj address of a new owner1545 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1546 * @returns ```true``` if extrinsic success, otherwise ```false```1547 */1548 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1549 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1550 }15511552 /**1553 *1554 * Change ownership of a NFT on behalf of the owner.1555 *1556 * @param signer keyring of signer1557 * @param collectionId ID of collection1558 * @param tokenId ID of token1559 * @param fromAddressObj address on behalf of which the token will be sent1560 * @param toAddressObj new token owner1561 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1562 * @returns ```true``` if extrinsic success, otherwise ```false```1563 */1564 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1565 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1566 }15671568 /**1569 * Recursively find the address that owns the token1570 * @param collectionId ID of collection1571 * @param tokenId ID of token1572 * @param blockHashAt1573 * @example getTokenTopmostOwner(10, 5);1574 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1575 */1576 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1577 let owner;1578 if (typeof blockHashAt === 'undefined') {1579 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1580 } else {1581 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1582 }15831584 if (owner === null) return null;15851586 return owner.toHuman();1587 }15881589 /**1590 * Get tokens nested in the provided token1591 * @param collectionId ID of collection1592 * @param tokenId ID of token1593 * @param blockHashAt optionally query the data at the block with this hash1594 * @example getTokenChildren(10, 5);1595 * @returns tokens whose depth of nesting is <= 51596 */1597 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1598 let children;1599 if(typeof blockHashAt === 'undefined') {1600 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1601 } else {1602 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1603 }16041605 return children.toJSON().map((x: any) => {1606 return {collectionId: x.collection, tokenId: x.token};1607 });1608 }16091610 /**1611 * Nest one token into another1612 * @param signer keyring of signer1613 * @param tokenObj token to be nested1614 * @param rootTokenObj token to be parent1615 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1616 * @returns ```true``` if extrinsic success, otherwise ```false```1617 */1618 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1619 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1620 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1621 if(!result) {1622 throw Error('Unable to nest token!');1623 }1624 return result;1625 }16261627 /**1628 * Remove token from nested state1629 * @param signer keyring of signer1630 * @param tokenObj token to unnest1631 * @param rootTokenObj parent of a token1632 * @param toAddressObj address of a new token owner1633 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1634 * @returns ```true``` if extrinsic success, otherwise ```false```1635 */1636 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1637 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1638 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1639 if(!result) {1640 throw Error('Unable to unnest token!');1641 }1642 return result;1643 }16441645 /**1646 * Mint new collection1647 * @param signer keyring of signer1648 * @param collectionOptions Collection options1649 * @example1650 * mintCollection(aliceKeyring, {1651 * name: 'New',1652 * description: 'New collection',1653 * tokenPrefix: 'NEW',1654 * })1655 * @returns object of the created collection1656 */1657 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1658 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1659 }16601661 /**1662 * Mint new token1663 * @param signer keyring of signer1664 * @param data token data1665 * @returns created token object1666 */1667 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1668 const creationResult = await this.helper.executeExtrinsic(1669 signer,1670 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1671 nft: {1672 properties: data.properties,1673 },1674 }],1675 true,1676 );1677 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1678 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1679 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1680 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1681 }16821683 /**1684 * Mint multiple NFT tokens1685 * @param signer keyring of signer1686 * @param collectionId ID of collection1687 * @param tokens array of tokens with owner and properties1688 * @example1689 * mintMultipleTokens(aliceKeyring, 10, [{1690 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1691 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1692 * },{1693 * owner: {Ethereum: "0x9F0583DbB855d..."},1694 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1695 * }]);1696 * @returns ```true``` if extrinsic success, otherwise ```false```1697 */1698 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1699 const creationResult = await this.helper.executeExtrinsic(1700 signer,1701 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1702 true,1703 );1704 const collection = this.getCollectionObject(collectionId);1705 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1706 }17071708 /**1709 * Mint multiple NFT tokens with one owner1710 * @param signer keyring of signer1711 * @param collectionId ID of collection1712 * @param owner tokens owner1713 * @param tokens array of tokens with owner and properties1714 * @example1715 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1716 * properties: [{1717 * key: "gender",1718 * value: "female",1719 * },{1720 * key: "age",1721 * value: "33",1722 * }],1723 * }]);1724 * @returns array of newly created tokens1725 */1726 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1727 const rawTokens = [];1728 for (const token of tokens) {1729 const raw = {NFT: {properties: token.properties}};1730 rawTokens.push(raw);1731 }1732 const creationResult = await this.helper.executeExtrinsic(1733 signer,1734 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1735 true,1736 );1737 const collection = this.getCollectionObject(collectionId);1738 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1739 }17401741 /**1742 * Set, change, or remove approved address to transfer the ownership of the NFT.1743 *1744 * @param signer keyring of signer1745 * @param collectionId ID of collection1746 * @param tokenId ID of token1747 * @param toAddressObj address to approve1748 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1749 * @returns ```true``` if extrinsic success, otherwise ```false```1750 */1751 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1752 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1753 }1754}175517561757class RFTGroup extends NFTnRFT {1758 /**1759 * Get collection object1760 * @param collectionId ID of collection1761 * @example getCollectionObject(2);1762 * @returns instance of UniqueRFTCollection1763 */1764 getCollectionObject(collectionId: number): UniqueRFTCollection {1765 return new UniqueRFTCollection(collectionId, this.helper);1766 }17671768 /**1769 * Get token object1770 * @param collectionId ID of collection1771 * @param tokenId ID of token1772 * @example getTokenObject(10, 5);1773 * @returns instance of UniqueNFTToken1774 */1775 getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1776 return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1777 }17781779 /**1780 * Get top 10 token owners with the largest number of pieces1781 * @param collectionId ID of collection1782 * @param tokenId ID of token1783 * @example getTokenTop10Owners(10, 5);1784 * @returns array of top 10 owners1785 */1786 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1787 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1788 }17891790 /**1791 * Get number of pieces owned by address1792 * @param collectionId ID of collection1793 * @param tokenId ID of token1794 * @param addressObj address token owner1795 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1796 * @returns number of pieces ownerd by address1797 */1798 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1799 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1800 }18011802 /**1803 * Transfer pieces of token to another address1804 * @param signer keyring of signer1805 * @param collectionId ID of collection1806 * @param tokenId ID of token1807 * @param addressObj address of a new owner1808 * @param amount number of pieces to be transfered1809 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1810 * @returns ```true``` if extrinsic success, otherwise ```false```1811 */1812 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1813 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1814 }18151816 /**1817 * Change ownership of some pieces of RFT on behalf of the owner.1818 * @param signer keyring of signer1819 * @param collectionId ID of collection1820 * @param tokenId ID of token1821 * @param fromAddressObj address on behalf of which the token will be sent1822 * @param toAddressObj new token owner1823 * @param amount number of pieces to be transfered1824 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1825 * @returns ```true``` if extrinsic success, otherwise ```false```1826 */1827 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1828 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1829 }18301831 /**1832 * Mint new collection1833 * @param signer keyring of signer1834 * @param collectionOptions Collection options1835 * @example1836 * mintCollection(aliceKeyring, {1837 * name: 'New',1838 * description: 'New collection',1839 * tokenPrefix: 'NEW',1840 * })1841 * @returns object of the created collection1842 */1843 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1844 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1845 }18461847 /**1848 * Mint new token1849 * @param signer keyring of signer1850 * @param data token data1851 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1852 * @returns created token object1853 */1854 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1855 const creationResult = await this.helper.executeExtrinsic(1856 signer,1857 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1858 refungible: {1859 pieces: data.pieces,1860 properties: data.properties,1861 },1862 }],1863 true,1864 );1865 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1866 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1867 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1868 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1869 }18701871 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1872 throw Error('Not implemented');1873 const creationResult = await this.helper.executeExtrinsic(1874 signer,1875 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1876 true, // `Unable to mint RFT tokens for ${label}`,1877 );1878 const collection = this.getCollectionObject(collectionId);1879 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1880 }18811882 /**1883 * Mint multiple RFT tokens with one owner1884 * @param signer keyring of signer1885 * @param collectionId ID of collection1886 * @param owner tokens owner1887 * @param tokens array of tokens with properties and pieces1888 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1889 * @returns array of newly created RFT tokens1890 */1891 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1892 const rawTokens = [];1893 for (const token of tokens) {1894 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1895 rawTokens.push(raw);1896 }1897 const creationResult = await this.helper.executeExtrinsic(1898 signer,1899 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1900 true,1901 );1902 const collection = this.getCollectionObject(collectionId);1903 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1904 }19051906 /**1907 * Destroys a concrete instance of RFT.1908 * @param signer keyring of signer1909 * @param collectionId ID of collection1910 * @param tokenId ID of token1911 * @param amount number of pieces to be burnt1912 * @example burnToken(aliceKeyring, 10, 5);1913 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1914 */1915 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1916 return await super.burnToken(signer, collectionId, tokenId, amount);1917 }19181919 /**1920 * Destroys a concrete instance of RFT on behalf of the owner.1921 * @param signer keyring of signer1922 * @param collectionId ID of collection1923 * @param tokenId ID of token1924 * @param fromAddressObj address on behalf of which the token will be burnt1925 * @param amount number of pieces to be burnt1926 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1927 * @returns ```true``` if extrinsic success, otherwise ```false```1928 */1929 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1930 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1931 }19321933 /**1934 * Set, change, or remove approved address to transfer the ownership of the RFT.1935 *1936 * @param signer keyring of signer1937 * @param collectionId ID of collection1938 * @param tokenId ID of token1939 * @param toAddressObj address to approve1940 * @param amount number of pieces to be approved1941 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1942 * @returns true if the token success, otherwise false1943 */1944 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1945 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1946 }19471948 /**1949 * Get total number of pieces1950 * @param collectionId ID of collection1951 * @param tokenId ID of token1952 * @example getTokenTotalPieces(10, 5);1953 * @returns number of pieces1954 */1955 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1956 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1957 }19581959 /**1960 * Change number of token pieces. Signer must be the owner of all token pieces.1961 * @param signer keyring of signer1962 * @param collectionId ID of collection1963 * @param tokenId ID of token1964 * @param amount new number of pieces1965 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1966 * @returns true if the repartion was success, otherwise false1967 */1968 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1969 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1970 const repartitionResult = await this.helper.executeExtrinsic(1971 signer,1972 'api.tx.unique.repartition', [collectionId, tokenId, amount],1973 true,1974 );1975 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1976 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1977 }1978}197919801981class FTGroup extends CollectionGroup {1982 /**1983 * Get collection object1984 * @param collectionId ID of collection1985 * @example getCollectionObject(2);1986 * @returns instance of UniqueFTCollection1987 */1988 getCollectionObject(collectionId: number): UniqueFTCollection {1989 return new UniqueFTCollection(collectionId, this.helper);1990 }19911992 /**1993 * Mint new fungible collection1994 * @param signer keyring of signer1995 * @param collectionOptions Collection options1996 * @param decimalPoints number of token decimals1997 * @example1998 * mintCollection(aliceKeyring, {1999 * name: 'New',2000 * description: 'New collection',2001 * tokenPrefix: 'NEW',2002 * }, 18)2003 * @returns newly created fungible collection2004 */2005 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {2006 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object2007 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');2008 collectionOptions.mode = {fungible: decimalPoints};2009 for (const key of ['name', 'description', 'tokenPrefix']) {2010 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);2011 }2012 const creationResult = await this.helper.executeExtrinsic(2013 signer,2014 'api.tx.unique.createCollectionEx', [collectionOptions],2015 true,2016 );2017 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));2018 }20192020 /**2021 * Mint tokens2022 * @param signer keyring of signer2023 * @param collectionId ID of collection2024 * @param owner address owner of new tokens2025 * @param amount amount of tokens to be meanted2026 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);2027 * @returns ```true``` if extrinsic success, otherwise ```false```2028 */2029 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {2030 const creationResult = await this.helper.executeExtrinsic(2031 signer,2032 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {2033 fungible: {2034 value: amount,2035 },2036 }],2037 true, // `Unable to mint fungible tokens for ${label}`,2038 );2039 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2040 }20412042 /**2043 * Mint multiple Fungible tokens with one owner2044 * @param signer keyring of signer2045 * @param collectionId ID of collection2046 * @param owner tokens owner2047 * @param tokens array of tokens with properties and pieces2048 * @returns ```true``` if extrinsic success, otherwise ```false```2049 */2050 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {2051 const rawTokens = [];2052 for (const token of tokens) {2053 const raw = {Fungible: {Value: token.value}};2054 rawTokens.push(raw);2055 }2056 const creationResult = await this.helper.executeExtrinsic(2057 signer,2058 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2059 true,2060 );2061 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2062 }20632064 /**2065 * Get the top 10 owners with the largest balance for the Fungible collection2066 * @param collectionId ID of collection2067 * @example getTop10Owners(10);2068 * @returns array of ```ICrossAccountId```2069 */2070 async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {2071 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);2072 }20732074 /**2075 * Get account balance2076 * @param collectionId ID of collection2077 * @param addressObj address of owner2078 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})2079 * @returns amount of fungible tokens owned by address2080 */2081 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {2082 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();2083 }20842085 /**2086 * Transfer tokens to address2087 * @param signer keyring of signer2088 * @param collectionId ID of collection2089 * @param toAddressObj address recipient2090 * @param amount amount of tokens to be sent2091 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2092 * @returns ```true``` if extrinsic success, otherwise ```false```2093 */2094 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2095 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);2096 }20972098 /**2099 * Transfer some tokens on behalf of the owner.2100 * @param signer keyring of signer2101 * @param collectionId ID of collection2102 * @param fromAddressObj address on behalf of which tokens will be sent2103 * @param toAddressObj address where token to be sent2104 * @param amount number of tokens to be sent2105 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);2106 * @returns ```true``` if extrinsic success, otherwise ```false```2107 */2108 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2109 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);2110 }21112112 /**2113 * Destroy some amount of tokens2114 * @param signer keyring of signer2115 * @param collectionId ID of collection2116 * @param amount amount of tokens to be destroyed2117 * @example burnTokens(aliceKeyring, 10, 1000n);2118 * @returns ```true``` if extrinsic success, otherwise ```false```2119 */2120 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {2121 return await super.burnToken(signer, collectionId, 0, amount);2122 }21232124 /**2125 * Burn some tokens on behalf of the owner.2126 * @param signer keyring of signer2127 * @param collectionId ID of collection2128 * @param fromAddressObj address on behalf of which tokens will be burnt2129 * @param amount amount of tokens to be burnt2130 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2131 * @returns ```true``` if extrinsic success, otherwise ```false```2132 */2133 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {2134 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);2135 }21362137 /**2138 * Get total collection supply2139 * @param collectionId2140 * @returns2141 */2142 async getTotalPieces(collectionId: number): Promise<bigint> {2143 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();2144 }21452146 /**2147 * Set, change, or remove approved address to transfer tokens.2148 *2149 * @param signer keyring of signer2150 * @param collectionId ID of collection2151 * @param toAddressObj address to be approved2152 * @param amount amount of tokens to be approved2153 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)2154 * @returns ```true``` if extrinsic success, otherwise ```false```2155 */2156 approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2157 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);2158 }21592160 /**2161 * Get amount of fungible tokens approved to transfer2162 * @param collectionId ID of collection2163 * @param fromAddressObj owner of tokens2164 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner2165 * @returns number of tokens approved for the transfer2166 */2167 getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2168 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2169 }2170}217121722173class ChainGroup extends HelperGroup<ChainHelperBase> {2174 /**2175 * Get system properties of a chain2176 * @example getChainProperties();2177 * @returns ss58Format, token decimals, and token symbol2178 */2179 getChainProperties(): IChainProperties {2180 const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2181 return {2182 ss58Format: properties.ss58Format.toJSON(),2183 tokenDecimals: properties.tokenDecimals.toJSON(),2184 tokenSymbol: properties.tokenSymbol.toJSON(),2185 };2186 }21872188 /**2189 * Get chain header2190 * @example getLatestBlockNumber();2191 * @returns the number of the last block2192 */2193 async getLatestBlockNumber(): Promise<number> {2194 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2195 }21962197 /**2198 * Get block hash by block number2199 * @param blockNumber number of block2200 * @example getBlockHashByNumber(12345);2201 * @returns hash of a block2202 */2203 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2204 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2205 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2206 return blockHash;2207 }22082209 // TODO add docs2210 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2211 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2212 if (!blockHash) return null;2213 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2214 }22152216 /**2217 * Get latest relay block2218 * @returns {number} relay block2219 */2220 async getRelayBlockNumber(): Promise<bigint> {2221 const blockNumber = (await this.helper.callRpc('api.query.parachainSystem.validationData')).toJSON().relayParentNumber;2222 return BigInt(blockNumber);2223 }22242225 /**2226 * Get account nonce2227 * @param address substrate address2228 * @example getNonce("5GrwvaEF5zXb26Fz...");2229 * @returns number, account's nonce2230 */2231 async getNonce(address: TSubstrateAccount): Promise<number> {2232 return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2233 }2234}22352236class SubstrateBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2237 /**2238 * Get substrate address balance2239 * @param address substrate address2240 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2241 * @returns amount of tokens on address2242 */2243 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2244 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2245 }22462247 /**2248 * Transfer tokens to substrate address2249 * @param signer keyring of signer2250 * @param address substrate address of a recipient2251 * @param amount amount of tokens to be transfered2252 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2253 * @returns ```true``` if extrinsic success, otherwise ```false```2254 */2255 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2256 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}`*/);22572258 let transfer = {from: null, to: null, amount: 0n} as any;2259 result.result.events.forEach(({event: {data, method, section}}) => {2260 if ((section === 'balances') && (method === 'Transfer')) {2261 transfer = {2262 from: this.helper.address.normalizeSubstrate(data[0]),2263 to: this.helper.address.normalizeSubstrate(data[1]),2264 amount: BigInt(data[2]),2265 };2266 }2267 });2268 const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from2269 && this.helper.address.normalizeSubstrate(address) === transfer.to2270 && BigInt(amount) === transfer.amount;2271 return isSuccess;2272 }22732274 /**2275 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2276 * @param address substrate address2277 * @returns2278 */2279 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2280 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2281 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2282 }22832284 async getLocked(address: TSubstrateAccount): Promise<[{id: string, amount: bigint, reason: string}]> {2285 const locks = (await this.helper.callRpc('api.query.balances.locks', [address])).toHuman();2286 return locks.map((lock: any) => {return {id: lock.id, amount: BigInt(lock.amount.replace(/,/g, '')), reasons: lock.reasons};});2287 }2288}22892290class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2291 /**2292 * Get ethereum address balance2293 * @param address ethereum address2294 * @example getEthereum("0x9F0583DbB855d...")2295 * @returns amount of tokens on address2296 */2297 async getEthereum(address: TEthereumAccount): Promise<bigint> {2298 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2299 }23002301 /**2302 * Transfer tokens to address2303 * @param signer keyring of signer2304 * @param address Ethereum address of a recipient2305 * @param amount amount of tokens to be transfered2306 * @example transferToEthereum(alithKeyring, "0x9F0583DbB855d...", 100_000_000_000n);2307 * @returns ```true``` if extrinsic success, otherwise ```false```2308 */2309 async transferToEthereum(signer: TSigner, address: TEthereumAccount, amount: bigint | string): Promise<boolean> {2310 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true);23112312 let transfer = {from: null, to: null, amount: 0n} as any;2313 result.result.events.forEach(({event: {data, method, section}}) => {2314 if ((section === 'balances') && (method === 'Transfer')) {2315 transfer = {2316 from: data[0].toString(),2317 to: data[1].toString(),2318 amount: BigInt(data[2]),2319 };2320 }2321 });2322 const isSuccess = (typeof signer === 'string' ? signer : signer.address) === transfer.from2323 && address === transfer.to2324 && BigInt(amount) === transfer.amount;2325 return isSuccess;2326 }2327}23282329class BalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2330 subBalanceGroup: SubstrateBalanceGroup<T>;2331 ethBalanceGroup: EthereumBalanceGroup<T>;23322333 constructor(helper: T) {2334 super(helper);2335 this.subBalanceGroup = new SubstrateBalanceGroup(helper);2336 this.ethBalanceGroup = new EthereumBalanceGroup(helper);2337 }23382339 getCollectionCreationPrice(): bigint {2340 return 2n * this.getOneTokenNominal();2341 }2342 /**2343 * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2344 * @example getOneTokenNominal()2345 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2346 */2347 getOneTokenNominal(): bigint {2348 const chainProperties = this.helper.chain.getChainProperties();2349 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2350 }23512352 /**2353 * Get substrate address balance2354 * @param address substrate address2355 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2356 * @returns amount of tokens on address2357 */2358 getSubstrate(address: TSubstrateAccount): Promise<bigint> {2359 return this.subBalanceGroup.getSubstrate(address);2360 }23612362 /**2363 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2364 * @param address substrate address2365 * @returns2366 */2367 getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2368 return this.subBalanceGroup.getSubstrateFull(address);2369 }23702371 /**2372 * Get locked balances2373 * @param address substrate address2374 * @returns locked balances with reason via api.query.balances.locks2375 */2376 getLocked(address: TSubstrateAccount) {2377 return this.subBalanceGroup.getLocked(address);2378 }23792380 /**2381 * Get ethereum address balance2382 * @param address ethereum address2383 * @example getEthereum("0x9F0583DbB855d...")2384 * @returns amount of tokens on address2385 */2386 getEthereum(address: TEthereumAccount): Promise<bigint> {2387 return this.ethBalanceGroup.getEthereum(address);2388 }23892390 /**2391 * Transfer tokens to substrate address2392 * @param signer keyring of signer2393 * @param address substrate address of a recipient2394 * @param amount amount of tokens to be transfered2395 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2396 * @returns ```true``` if extrinsic success, otherwise ```false```2397 */2398 transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2399 return this.subBalanceGroup.transferToSubstrate(signer, address, amount);2400 }24012402 async forceTransferToSubstrate(signer: TSigner, from: TSubstrateAccount, to: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2403 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceTransfer', [from, to, amount], true);24042405 let transfer = {from: null, to: null, amount: 0n} as any;2406 result.result.events.forEach(({event: {data, method, section}}) => {2407 if ((section === 'balances') && (method === 'Transfer')) {2408 transfer = {2409 from: this.helper.address.normalizeSubstrate(data[0]),2410 to: this.helper.address.normalizeSubstrate(data[1]),2411 amount: BigInt(data[2]),2412 };2413 }2414 });2415 let isSuccess = this.helper.address.normalizeSubstrate(from) === transfer.from;2416 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(to) === transfer.to;2417 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2418 return isSuccess;2419 }24202421 /**2422 * Transfer tokens with the unlock period2423 * @param signer signers Keyring2424 * @param address Substrate address of recipient2425 * @param schedule Schedule params2426 * @example vestedTransfer(signer, recepient.address, 20000, 100, 10, 50 * nominal); // total amount of vested tokens will be 100 * 50 = 50002427 */2428 async vestedTransfer(signer: TSigner, address: TSubstrateAccount, schedule: {start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}): Promise<void> {2429 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.vestedTransfer', [address, schedule]);2430 const event = result.result.events2431 .find(e => e.event.section === 'vesting' &&2432 e.event.method === 'VestingScheduleAdded' &&2433 e.event.data[0].toHuman() === signer.address);2434 if (!event) throw Error('Cannot find transfer in events');2435 }24362437 /**2438 * Get schedule for recepient of vested transfer2439 * @param address Substrate address of recipient2440 * @returns2441 */2442 async getVestingSchedules(address: TSubstrateAccount): Promise<{start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}[]> {2443 const schedule = (await this.helper.callRpc('api.query.vesting.vestingSchedules', [address])).toJSON();2444 return schedule.map((schedule: any) => {2445 return {2446 start: BigInt(schedule.start),2447 period: BigInt(schedule.period),2448 periodCount: BigInt(schedule.periodCount),2449 perPeriod: BigInt(schedule.perPeriod),2450 };2451 });2452 }24532454 /**2455 * Claim vested tokens2456 * @param signer signers Keyring2457 */2458 async claim(signer: TSigner) {2459 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.claim', []);2460 const event = result.result.events2461 .find(e => e.event.section === 'vesting' &&2462 e.event.method === 'Claimed' &&2463 e.event.data[0].toHuman() === signer.address);2464 if (!event) throw Error('Cannot find claim in events');2465 }2466}24672468class AddressGroup extends HelperGroup<ChainHelperBase> {2469 /**2470 * Normalizes the address to the specified ss58 format, by default ```42```.2471 * @param address substrate address2472 * @param ss58Format format for address conversion, by default ```42```2473 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2474 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2475 */2476 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2477 return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2478 }24792480 /**2481 * Get address in the connected chain format2482 * @param address substrate address2483 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2484 * @returns address in chain format2485 */2486 normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2487 return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2488 }24892490 /**2491 * Get substrate mirror of an ethereum address2492 * @param ethAddress ethereum address2493 * @param toChainFormat false for normalized account2494 * @example ethToSubstrate('0x9F0583DbB855d...')2495 * @returns substrate mirror of a provided ethereum address2496 */2497 ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2498 return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2499 }25002501 /**2502 * Get ethereum mirror of a substrate address2503 * @param subAddress substrate account2504 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2505 * @returns ethereum mirror of a provided substrate address2506 */2507 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2508 return CrossAccountId.translateSubToEth(subAddress);2509 }25102511 /**2512 * Encode key to substrate address2513 * @param key key for encoding address2514 * @param ss58Format prefix for encoding to the address of the corresponding network2515 * @returns encoded substrate address2516 */2517 encodeSubstrateAddress (key: Uint8Array | string | bigint, ss58Format = 42): string {2518 const u8a :Uint8Array = typeof key === 'string'2519 ? hexToU8a(key)2520 : typeof key === 'bigint'2521 ? hexToU8a(key.toString(16))2522 : key;25232524 if (ss58Format < 0 || ss58Format > 16383 || [46, 47].includes(ss58Format)) {2525 throw new Error(`ss58Format is not valid, received ${typeofss58Format} "${ss58Format}"`);2526 }25272528 const allowedDecodedLengths = [1, 2, 4, 8, 32, 33];2529 if (!allowedDecodedLengths.includes(u8a.length)) {2530 throw new Error(`key length is not valid, received ${u8a.length}, valid values are ${allowedDecodedLengths.join(', ')}`);2531 }25322533 const u8aPrefix = ss58Format < 642534 ? new Uint8Array([ss58Format])2535 : new Uint8Array([2536 ((ss58Format & 0xfc) >> 2) | 0x40,2537 (ss58Format >> 8) | ((ss58Format & 0x03) << 6),2538 ]);25392540 const input = u8aConcat(u8aPrefix, u8a);25412542 return base58Encode(u8aConcat(2543 input,2544 blake2AsU8a(input).subarray(0, [32, 33].includes(u8a.length) ? 2 : 1),2545 ));2546 }25472548 /**2549 * Restore substrate address from bigint representation2550 * @param number decimal representation of substrate address2551 * @returns substrate address2552 */2553 restoreCrossAccountFromBigInt(number: bigint): TSubstrateAccount {2554 if (this.helper.api === null) {2555 throw 'Not connected';2556 }2557 const res = this.helper.api.registry.createType('AccountId', '0x' + number.toString(16).padStart(64, '0')).toJSON();2558 if (res === undefined || res === null) {2559 throw 'Restore address error';2560 }2561 return res.toString();2562 }25632564 /**2565 * Convert etherium cross account id to substrate cross account id2566 * @param ethCrossAccount etherium cross account2567 * @returns substrate cross account id2568 */2569 convertCrossAccountFromEthCrossAccount(ethCrossAccount: IEthCrossAccountId): ICrossAccountId {2570 if (ethCrossAccount.sub === '0') {2571 return {Ethereum: ethCrossAccount.eth.toLocaleLowerCase()};2572 }25732574 const ss58 = this.restoreCrossAccountFromBigInt(BigInt(ethCrossAccount.sub));2575 return {Substrate: ss58};2576 }25772578 paraSiblingSovereignAccount(paraid: number) {2579 // We are getting a *sibling* parachain sovereign account,2580 // so we need a sibling prefix: encoded(b"sibl") == 0x7369626c2581 const siblingPrefix = '0x7369626c';25822583 const encodedParaId = this.helper.getApi().createType('u32', paraid).toHex(true).substring(2);2584 const suffix = '000000000000000000000000000000000000000000000000';25852586 return siblingPrefix + encodedParaId + suffix;2587 }2588}25892590class StakingGroup extends HelperGroup<UniqueHelper> {2591 /**2592 * Stake tokens for App Promotion2593 * @param signer keyring of signer2594 * @param amountToStake amount of tokens to stake2595 * @param label extra label for log2596 * @returns2597 */2598 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2599 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2600 const _stakeResult = await this.helper.executeExtrinsic(2601 signer, 'api.tx.appPromotion.stake',2602 [amountToStake], true,2603 );2604 // TODO extract info from stakeResult2605 return true;2606 }26072608 /**2609 * Unstake tokens for App Promotion2610 * @param signer keyring of signer2611 * @param amountToUnstake amount of tokens to unstake2612 * @param label extra label for log2613 * @returns block number where balances will be unlocked2614 */2615 async unstake(signer: TSigner, label?: string): Promise<number> {2616 if(typeof label === 'undefined') label = `${signer.address}`;2617 const _unstakeResult = await this.helper.executeExtrinsic(2618 signer, 'api.tx.appPromotion.unstake',2619 [], true,2620 );2621 // TODO extract block number fron events2622 return 1;2623 }26242625 /**2626 * Get total staked amount for address2627 * @param address substrate or ethereum address2628 * @returns total staked amount2629 */2630 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2631 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2632 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2633 }26342635 /**2636 * Get total staked per block2637 * @param address substrate or ethereum address2638 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2639 */2640 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2641 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2642 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2643 return {2644 block: block.toBigInt(),2645 amount: amount.toBigInt(),2646 };2647 });2648 }26492650 /**2651 * Get total pending unstake amount for address2652 * @param address substrate or ethereum address2653 * @returns total pending unstake amount2654 */2655 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2656 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2657 }26582659 /**2660 * Get pending unstake amount per block for address2661 * @param address substrate or ethereum address2662 * @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 block2663 */2664 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2665 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2666 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2667 return {2668 block: block.toBigInt(),2669 amount: amount.toBigInt(),2670 };2671 });2672 return result;2673 }2674}26752676class SchedulerGroup extends HelperGroup<UniqueHelper> {2677 constructor(helper: UniqueHelper) {2678 super(helper);2679 }26802681 cancelScheduled(signer: TSigner, scheduledId: string) {2682 return this.helper.executeExtrinsic(2683 signer,2684 'api.tx.scheduler.cancelNamed',2685 [scheduledId],2686 true,2687 );2688 }26892690 changePriority(signer: TSigner, scheduledId: string, priority: number) {2691 return this.helper.executeExtrinsic(2692 signer,2693 'api.tx.scheduler.changeNamedPriority',2694 [scheduledId, priority],2695 true,2696 );2697 }26982699 scheduleAt<T extends UniqueHelper>(2700 executionBlockNumber: number,2701 options: ISchedulerOptions = {},2702 ) {2703 return this.schedule<T>('schedule', executionBlockNumber, options);2704 }27052706 scheduleAfter<T extends UniqueHelper>(2707 blocksBeforeExecution: number,2708 options: ISchedulerOptions = {},2709 ) {2710 return this.schedule<T>('scheduleAfter', blocksBeforeExecution, options);2711 }27122713 schedule<T extends UniqueHelper>(2714 scheduleFn: 'schedule' | 'scheduleAfter',2715 blocksNum: number,2716 options: ISchedulerOptions = {},2717 ) {2718 // eslint-disable-next-line @typescript-eslint/naming-convention2719 const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2720 return this.helper.clone(ScheduledHelperType, {2721 scheduleFn,2722 blocksNum,2723 options,2724 }) as T;2725 }2726}27272728class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {2729 async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {2730 await this.helper.executeExtrinsic(2731 signer,2732 'api.tx.foreignAssets.registerForeignAsset',2733 [ownerAddress, location, metadata],2734 true,2735 );2736 }27372738 async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {2739 await this.helper.executeExtrinsic(2740 signer,2741 'api.tx.foreignAssets.updateForeignAsset',2742 [foreignAssetId, location, metadata],2743 true,2744 );2745 }2746}27472748class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {2749 palletName: string;27502751 constructor(helper: T, palletName: string) {2752 super(helper);27532754 this.palletName = palletName;2755 }27562757 async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: any) {2758 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, weightLimit], true);2759 }27602761 async teleportAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number) {2762 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.teleportAssets`, [destination, beneficiary, assets, feeAssetItem], true);2763 }27642765 async teleportNativeAsset(signer: TSigner, destinationParaId: number, targetAccount: Uint8Array, amount: bigint) {2766 const destination = {2767 V1: {2768 parents: 0,2769 interior: {2770 X1: {2771 Parachain: destinationParaId,2772 },2773 },2774 },2775 };27762777 const beneficiary = {2778 V1: {2779 parents: 0,2780 interior: {2781 X1: {2782 AccountId32: {2783 network: 'Any',2784 id: targetAccount,2785 },2786 },2787 },2788 },2789 };27902791 const assets = {2792 V1: [2793 {2794 id: {2795 Concrete: {2796 parents: 0,2797 interior: 'Here',2798 },2799 },2800 fun: {2801 Fungible: amount,2802 },2803 },2804 ],2805 };28062807 const feeAssetItem = 0;28082809 await this.teleportAssets(signer, destination, beneficiary, assets, feeAssetItem);2810 }2811}28122813class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2814 async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: any) {2815 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);2816 }28172818 async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: any) {2819 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);2820 }28212822 async transferMulticurrencies(signer: TSigner, currencies: any[], feeItem: number, destLocation: any, destWeight: any) {2823 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMulticurrencies', [currencies, feeItem, destLocation, destWeight], true);2824 }2825}28262827class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2828 async accounts(address: string, currencyId: any) {2829 const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;2830 return BigInt(free);2831 }2832}28332834class AssetsGroup<T extends ChainHelperBase> extends HelperGroup<T> {2835 async create(signer: TSigner, assetId: number, admin: string, minimalBalance: bigint) {2836 await this.helper.executeExtrinsic(signer, 'api.tx.assets.create', [assetId, admin, minimalBalance], true);2837 }28382839 async setMetadata(signer: TSigner, assetId: number, name: string, symbol: string, decimals: number) {2840 await this.helper.executeExtrinsic(signer, 'api.tx.assets.setMetadata', [assetId, name, symbol, decimals], true);2841 }28422843 async mint(signer: TSigner, assetId: number, beneficiary: string, amount: bigint) {2844 await this.helper.executeExtrinsic(signer, 'api.tx.assets.mint', [assetId, beneficiary, amount], true);2845 }28462847 async account(assetId: string | number, address: string) {2848 const accountAsset = (2849 await this.helper.callRpc('api.query.assets.account', [assetId, address])2850 ).toJSON()! as any;28512852 if (accountAsset !== null) {2853 return BigInt(accountAsset['balance']);2854 } else {2855 return null;2856 }2857 }2858}28592860class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {2861 async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {2862 await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);2863 }2864}28652866class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {2867 makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {2868 const apiPrefix = 'api.tx.assetManager.';28692870 const registerTx = this.helper.constructApiCall(2871 apiPrefix + 'registerForeignAsset',2872 [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],2873 );28742875 const setUnitsTx = this.helper.constructApiCall(2876 apiPrefix + 'setAssetUnitsPerSecond',2877 [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],2878 );28792880 const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);2881 const encodedProposal = batchCall?.method.toHex() || '';2882 return encodedProposal;2883 }28842885 async assetTypeId(location: any) {2886 return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);2887 }2888}28892890class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {2891 notePreimagePallet: string;28922893 constructor(helper: MoonbeamHelper, options: {[key: string]: any} = {}) {2894 super(helper);2895 this.notePreimagePallet = options.notePreimagePallet;2896 }28972898 async notePreimage(signer: TSigner, encodedProposal: string) {2899 await this.helper.executeExtrinsic(signer, `api.tx.${this.notePreimagePallet}.notePreimage`, [encodedProposal], true);2900 }29012902 externalProposeMajority(proposal: any) {2903 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposal]);2904 }29052906 fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {2907 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);2908 }29092910 async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {2911 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);2912 }2913}29142915class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {2916 collective: string;29172918 constructor(helper: MoonbeamHelper, collective: string) {2919 super(helper);29202921 this.collective = collective;2922 }29232924 async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {2925 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);2926 }29272928 async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {2929 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);2930 }29312932 async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: any, lengthBound: number) {2933 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);2934 }29352936 async proposalCount() {2937 return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));2938 }2939}29402941export type ChainHelperBaseConstructor = new(...args: any[]) => ChainHelperBase;2942export type UniqueHelperConstructor = new(...args: any[]) => UniqueHelper;29432944export class UniqueHelper extends ChainHelperBase {2945 balance: BalanceGroup<UniqueHelper>;2946 collection: CollectionGroup;2947 nft: NFTGroup;2948 rft: RFTGroup;2949 ft: FTGroup;2950 staking: StakingGroup;2951 scheduler: SchedulerGroup;2952 foreignAssets: ForeignAssetsGroup;2953 xcm: XcmGroup<UniqueHelper>;2954 xTokens: XTokensGroup<UniqueHelper>;2955 tokens: TokensGroup<UniqueHelper>;29562957 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2958 super(logger, options.helperBase ?? UniqueHelper);29592960 this.balance = new BalanceGroup(this);2961 this.collection = new CollectionGroup(this);2962 this.nft = new NFTGroup(this);2963 this.rft = new RFTGroup(this);2964 this.ft = new FTGroup(this);2965 this.staking = new StakingGroup(this);2966 this.scheduler = new SchedulerGroup(this);2967 this.foreignAssets = new ForeignAssetsGroup(this);2968 this.xcm = new XcmGroup(this, 'polkadotXcm');2969 this.xTokens = new XTokensGroup(this);2970 this.tokens = new TokensGroup(this);2971 }29722973 getSudo<T extends UniqueHelper>() {2974 // eslint-disable-next-line @typescript-eslint/naming-convention2975 const SudoHelperType = SudoHelper(this.helperBase);2976 return this.clone(SudoHelperType) as T;2977 }2978}29792980export class XcmChainHelper extends ChainHelperBase {2981 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {2982 const wsProvider = new WsProvider(wsEndpoint);2983 this.api = new ApiPromise({2984 provider: wsProvider,2985 });2986 await this.api.isReadyOrError;2987 this.network = await UniqueHelper.detectNetwork(this.api);2988 }2989}29902991export class RelayHelper extends XcmChainHelper {2992 balance: SubstrateBalanceGroup<RelayHelper>;2993 xcm: XcmGroup<RelayHelper>;29942995 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2996 super(logger, options.helperBase ?? RelayHelper);29972998 this.balance = new SubstrateBalanceGroup(this);2999 this.xcm = new XcmGroup(this, 'xcmPallet');3000 }3001}30023003export class WestmintHelper extends XcmChainHelper {3004 balance: SubstrateBalanceGroup<WestmintHelper>;3005 xcm: XcmGroup<WestmintHelper>;3006 assets: AssetsGroup<WestmintHelper>;3007 xTokens: XTokensGroup<WestmintHelper>;30083009 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3010 super(logger, options.helperBase ?? WestmintHelper);30113012 this.balance = new SubstrateBalanceGroup(this);3013 this.xcm = new XcmGroup(this, 'polkadotXcm');3014 this.assets = new AssetsGroup(this);3015 this.xTokens = new XTokensGroup(this);3016 }3017}30183019export class MoonbeamHelper extends XcmChainHelper {3020 balance: EthereumBalanceGroup<MoonbeamHelper>;3021 assetManager: MoonbeamAssetManagerGroup;3022 assets: AssetsGroup<MoonbeamHelper>;3023 xTokens: XTokensGroup<MoonbeamHelper>;3024 democracy: MoonbeamDemocracyGroup;3025 collective: {3026 council: MoonbeamCollectiveGroup,3027 techCommittee: MoonbeamCollectiveGroup,3028 };30293030 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3031 super(logger, options.helperBase ?? MoonbeamHelper);30323033 this.balance = new EthereumBalanceGroup(this);3034 this.assetManager = new MoonbeamAssetManagerGroup(this);3035 this.assets = new AssetsGroup(this);3036 this.xTokens = new XTokensGroup(this);3037 this.democracy = new MoonbeamDemocracyGroup(this, options);3038 this.collective = {3039 council: new MoonbeamCollectiveGroup(this, 'councilCollective'),3040 techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),3041 };3042 }3043}30443045export class AcalaHelper extends XcmChainHelper {3046 balance: SubstrateBalanceGroup<AcalaHelper>;3047 assetRegistry: AcalaAssetRegistryGroup;3048 xTokens: XTokensGroup<AcalaHelper>;3049 tokens: TokensGroup<AcalaHelper>;30503051 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3052 super(logger, options.helperBase ?? AcalaHelper);30533054 this.balance = new SubstrateBalanceGroup(this);3055 this.assetRegistry = new AcalaAssetRegistryGroup(this);3056 this.xTokens = new XTokensGroup(this);3057 this.tokens = new TokensGroup(this);3058 }30593060 getSudo<T extends AcalaHelper>() {3061 // eslint-disable-next-line @typescript-eslint/naming-convention3062 const SudoHelperType = SudoHelper(this.helperBase);3063 return this.clone(SudoHelperType) as T;3064 }3065}30663067// eslint-disable-next-line @typescript-eslint/naming-convention3068function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {3069 return class extends Base {3070 scheduleFn: 'schedule' | 'scheduleAfter';3071 blocksNum: number;3072 options: ISchedulerOptions;30733074 constructor(...args: any[]) {3075 const logger = args[0] as ILogger;3076 const options = args[1] as {3077 scheduleFn: 'schedule' | 'scheduleAfter',3078 blocksNum: number,3079 options: ISchedulerOptions3080 };30813082 super(logger);30833084 this.scheduleFn = options.scheduleFn;3085 this.blocksNum = options.blocksNum;3086 this.options = options.options;3087 }30883089 executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {3090 const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);30913092 const mandatorySchedArgs = [3093 this.blocksNum,3094 this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,3095 this.options.priority ?? null,3096 scheduledTx,3097 ];30983099 let schedArgs;3100 let scheduleFn;31013102 if (this.options.scheduledId) {3103 schedArgs = [this.options.scheduledId!, ...mandatorySchedArgs];31043105 if (this.scheduleFn == 'schedule') {3106 scheduleFn = 'scheduleNamed';3107 } else if (this.scheduleFn == 'scheduleAfter') {3108 scheduleFn = 'scheduleNamedAfter';3109 }3110 } else {3111 schedArgs = mandatorySchedArgs;3112 scheduleFn = this.scheduleFn;3113 }31143115 const extrinsic = 'api.tx.scheduler.' + scheduleFn;31163117 return super.executeExtrinsic(3118 sender,3119 extrinsic,3120 schedArgs,3121 expectSuccess,3122 );3123 }3124 };3125}31263127// eslint-disable-next-line @typescript-eslint/naming-convention3128function SudoHelper<T extends ChainHelperBaseConstructor>(Base: T) {3129 return class extends Base {3130 constructor(...args: any[]) {3131 super(...args);3132 }31333134 executeExtrinsic (3135 sender: IKeyringPair,3136 extrinsic: string,3137 params: any[],3138 expectSuccess?: boolean,3139 ): Promise<ITransactionResult> {3140 const call = this.constructApiCall(extrinsic, params);3141 return super.executeExtrinsic(3142 sender,3143 'api.tx.sudo.sudo',3144 [call],3145 expectSuccess,3146 );3147 }3148 };3149}31503151export class UniqueBaseCollection {3152 helper: UniqueHelper;3153 collectionId: number;31543155 constructor(collectionId: number, uniqueHelper: UniqueHelper) {3156 this.collectionId = collectionId;3157 this.helper = uniqueHelper;3158 }31593160 async getData() {3161 return await this.helper.collection.getData(this.collectionId);3162 }31633164 async getLastTokenId() {3165 return await this.helper.collection.getLastTokenId(this.collectionId);3166 }31673168 async doesTokenExist(tokenId: number) {3169 return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);3170 }31713172 async getAdmins() {3173 return await this.helper.collection.getAdmins(this.collectionId);3174 }31753176 async getAllowList() {3177 return await this.helper.collection.getAllowList(this.collectionId);3178 }31793180 async getEffectiveLimits() {3181 return await this.helper.collection.getEffectiveLimits(this.collectionId);3182 }31833184 async getProperties(propertyKeys?: string[] | null) {3185 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);3186 }31873188 async getPropertiesConsumedSpace() {3189 return await this.helper.collection.getPropertiesConsumedSpace(this.collectionId);3190 }31913192 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {3193 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);3194 }31953196 async getOptions() {3197 return await this.helper.collection.getCollectionOptions(this.collectionId);3198 }31993200 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {3201 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);3202 }32033204 async confirmSponsorship(signer: TSigner) {3205 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);3206 }32073208 async removeSponsor(signer: TSigner) {3209 return await this.helper.collection.removeSponsor(signer, this.collectionId);3210 }32113212 async setLimits(signer: TSigner, limits: ICollectionLimits) {3213 return await this.helper.collection.setLimits(signer, this.collectionId, limits);3214 }32153216 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {3217 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);3218 }32193220 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3221 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);3222 }32233224 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {3225 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);3226 }32273228 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {3229 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);3230 }32313232 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3233 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);3234 }32353236 async setProperties(signer: TSigner, properties: IProperty[]) {3237 return await this.helper.collection.setProperties(signer, this.collectionId, properties);3238 }32393240 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3241 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);3242 }32433244 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {3245 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);3246 }32473248 async enableNesting(signer: TSigner, permissions: INestingPermissions) {3249 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);3250 }32513252 async disableNesting(signer: TSigner) {3253 return await this.helper.collection.disableNesting(signer, this.collectionId);3254 }32553256 async burn(signer: TSigner) {3257 return await this.helper.collection.burn(signer, this.collectionId);3258 }32593260 scheduleAt<T extends UniqueHelper>(3261 executionBlockNumber: number,3262 options: ISchedulerOptions = {},3263 ) {3264 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3265 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3266 }32673268 scheduleAfter<T extends UniqueHelper>(3269 blocksBeforeExecution: number,3270 options: ISchedulerOptions = {},3271 ) {3272 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3273 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3274 }32753276 getSudo<T extends UniqueHelper>() {3277 return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());3278 }3279}328032813282export class UniqueNFTCollection extends UniqueBaseCollection {3283 getTokenObject(tokenId: number) {3284 return new UniqueNFToken(tokenId, this);3285 }32863287 async getTokensByAddress(addressObj: ICrossAccountId) {3288 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);3289 }32903291 async getToken(tokenId: number, blockHashAt?: string) {3292 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);3293 }32943295 async getTokenOwner(tokenId: number, blockHashAt?: string) {3296 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);3297 }32983299 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {3300 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);3301 }33023303 async getTokenChildren(tokenId: number, blockHashAt?: string) {3304 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);3305 }33063307 async getPropertyPermissions(propertyKeys: string[] | null = null) {3308 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);3309 }33103311 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3312 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3313 }33143315 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3316 const api = this.helper.getApi();3317 const props = (await api.query.nonfungible.tokenProperties(this.collectionId, tokenId)).toJSON();33183319 return (props! as any).consumedSpace;3320 }33213322 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {3323 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);3324 }33253326 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3327 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);3328 }33293330 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {3331 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);3332 }33333334 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {3335 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);3336 }33373338 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3339 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});3340 }33413342 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {3343 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);3344 }33453346 async burnToken(signer: TSigner, tokenId: number) {3347 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);3348 }33493350 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {3351 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);3352 }33533354 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3355 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);3356 }33573358 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3359 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3360 }33613362 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3363 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3364 }33653366 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {3367 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);3368 }33693370 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3371 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);3372 }33733374 scheduleAt<T extends UniqueHelper>(3375 executionBlockNumber: number,3376 options: ISchedulerOptions = {},3377 ) {3378 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3379 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3380 }33813382 scheduleAfter<T extends UniqueHelper>(3383 blocksBeforeExecution: number,3384 options: ISchedulerOptions = {},3385 ) {3386 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3387 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3388 }33893390 getSudo<T extends UniqueHelper>() {3391 return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());3392 }3393}339433953396export class UniqueRFTCollection extends UniqueBaseCollection {3397 getTokenObject(tokenId: number) {3398 return new UniqueRFToken(tokenId, this);3399 }34003401 async getToken(tokenId: number, blockHashAt?: string) {3402 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);3403 }34043405 async getTokensByAddress(addressObj: ICrossAccountId) {3406 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);3407 }34083409 async getTop10TokenOwners(tokenId: number) {3410 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);3411 }34123413 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {3414 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);3415 }34163417 async getTokenTotalPieces(tokenId: number) {3418 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);3419 }34203421 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3422 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);3423 }34243425 async getPropertyPermissions(propertyKeys: string[] | null = null) {3426 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);3427 }34283429 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3430 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3431 }34323433 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3434 const api = this.helper.getApi();3435 const props = (await api.query.refungible.tokenProperties(this.collectionId, tokenId)).toJSON();34363437 return (props! as any).consumedSpace;3438 }34393440 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {3441 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);3442 }34433444 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3445 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);3446 }34473448 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {3449 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);3450 }34513452 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {3453 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);3454 }34553456 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3457 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});3458 }34593460 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {3461 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);3462 }34633464 async burnToken(signer: TSigner, tokenId: number, amount=1n) {3465 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);3466 }34673468 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n) {3469 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);3470 }34713472 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3473 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);3474 }34753476 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3477 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3478 }34793480 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3481 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3482 }34833484 scheduleAt<T extends UniqueHelper>(3485 executionBlockNumber: number,3486 options: ISchedulerOptions = {},3487 ) {3488 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3489 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3490 }34913492 scheduleAfter<T extends UniqueHelper>(3493 blocksBeforeExecution: number,3494 options: ISchedulerOptions = {},3495 ) {3496 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3497 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3498 }34993500 getSudo<T extends UniqueHelper>() {3501 return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());3502 }3503}350435053506export class UniqueFTCollection extends UniqueBaseCollection {3507 async getBalance(addressObj: ICrossAccountId) {3508 return await this.helper.ft.getBalance(this.collectionId, addressObj);3509 }35103511 async getTotalPieces() {3512 return await this.helper.ft.getTotalPieces(this.collectionId);3513 }35143515 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3516 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);3517 }35183519 async getTop10Owners() {3520 return await this.helper.ft.getTop10Owners(this.collectionId);3521 }35223523 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {3524 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);3525 }35263527 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {3528 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);3529 }35303531 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3532 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);3533 }35343535 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3536 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);3537 }35383539 async burnTokens(signer: TSigner, amount=1n) {3540 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);3541 }35423543 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3544 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);3545 }35463547 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3548 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);3549 }35503551 scheduleAt<T extends UniqueHelper>(3552 executionBlockNumber: number,3553 options: ISchedulerOptions = {},3554 ) {3555 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3556 return new UniqueFTCollection(this.collectionId, scheduledHelper);3557 }35583559 scheduleAfter<T extends UniqueHelper>(3560 blocksBeforeExecution: number,3561 options: ISchedulerOptions = {},3562 ) {3563 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3564 return new UniqueFTCollection(this.collectionId, scheduledHelper);3565 }35663567 getSudo<T extends UniqueHelper>() {3568 return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());3569 }3570}357135723573export class UniqueBaseToken {3574 collection: UniqueNFTCollection | UniqueRFTCollection;3575 collectionId: number;3576 tokenId: number;35773578 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {3579 this.collection = collection;3580 this.collectionId = collection.collectionId;3581 this.tokenId = tokenId;3582 }35833584 async getNextSponsored(addressObj: ICrossAccountId) {3585 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);3586 }35873588 async getProperties(propertyKeys?: string[] | null) {3589 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);3590 }35913592 async getTokenPropertiesConsumedSpace() {3593 return await this.collection.getTokenPropertiesConsumedSpace(this.tokenId);3594 }35953596 async setProperties(signer: TSigner, properties: IProperty[]) {3597 return await this.collection.setTokenProperties(signer, this.tokenId, properties);3598 }35993600 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3601 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);3602 }36033604 async doesExist() {3605 return await this.collection.doesTokenExist(this.tokenId);3606 }36073608 nestingAccount() {3609 return this.collection.helper.util.getTokenAccount(this);3610 }36113612 scheduleAt<T extends UniqueHelper>(3613 executionBlockNumber: number,3614 options: ISchedulerOptions = {},3615 ) {3616 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3617 return new UniqueBaseToken(this.tokenId, scheduledCollection);3618 }36193620 scheduleAfter<T extends UniqueHelper>(3621 blocksBeforeExecution: number,3622 options: ISchedulerOptions = {},3623 ) {3624 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3625 return new UniqueBaseToken(this.tokenId, scheduledCollection);3626 }36273628 getSudo<T extends UniqueHelper>() {3629 return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());3630 }3631}363236333634export class UniqueNFToken extends UniqueBaseToken {3635 collection: UniqueNFTCollection;36363637 constructor(tokenId: number, collection: UniqueNFTCollection) {3638 super(tokenId, collection);3639 this.collection = collection;3640 }36413642 async getData(blockHashAt?: string) {3643 return await this.collection.getToken(this.tokenId, blockHashAt);3644 }36453646 async getOwner(blockHashAt?: string) {3647 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);3648 }36493650 async getTopmostOwner(blockHashAt?: string) {3651 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);3652 }36533654 async getChildren(blockHashAt?: string) {3655 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);3656 }36573658 async nest(signer: TSigner, toTokenObj: IToken) {3659 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);3660 }36613662 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3663 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);3664 }36653666 async transfer(signer: TSigner, addressObj: ICrossAccountId) {3667 return await this.collection.transferToken(signer, this.tokenId, addressObj);3668 }36693670 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3671 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);3672 }36733674 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {3675 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);3676 }36773678 async isApproved(toAddressObj: ICrossAccountId) {3679 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);3680 }36813682 async burn(signer: TSigner) {3683 return await this.collection.burnToken(signer, this.tokenId);3684 }36853686 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {3687 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);3688 }36893690 scheduleAt<T extends UniqueHelper>(3691 executionBlockNumber: number,3692 options: ISchedulerOptions = {},3693 ) {3694 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3695 return new UniqueNFToken(this.tokenId, scheduledCollection);3696 }36973698 scheduleAfter<T extends UniqueHelper>(3699 blocksBeforeExecution: number,3700 options: ISchedulerOptions = {},3701 ) {3702 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3703 return new UniqueNFToken(this.tokenId, scheduledCollection);3704 }37053706 getSudo<T extends UniqueHelper>() {3707 return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());3708 }3709}37103711export class UniqueRFToken extends UniqueBaseToken {3712 collection: UniqueRFTCollection;37133714 constructor(tokenId: number, collection: UniqueRFTCollection) {3715 super(tokenId, collection);3716 this.collection = collection;3717 }37183719 async getData(blockHashAt?: string) {3720 return await this.collection.getToken(this.tokenId, blockHashAt);3721 }37223723 async getTop10Owners() {3724 return await this.collection.getTop10TokenOwners(this.tokenId);3725 }37263727 async getBalance(addressObj: ICrossAccountId) {3728 return await this.collection.getTokenBalance(this.tokenId, addressObj);3729 }37303731 async getTotalPieces() {3732 return await this.collection.getTokenTotalPieces(this.tokenId);3733 }37343735 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {3736 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);3737 }37383739 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {3740 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);3741 }37423743 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3744 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);3745 }37463747 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3748 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);3749 }37503751 async repartition(signer: TSigner, amount: bigint) {3752 return await this.collection.repartitionToken(signer, this.tokenId, amount);3753 }37543755 async burn(signer: TSigner, amount=1n) {3756 return await this.collection.burnToken(signer, this.tokenId, amount);3757 }37583759 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3760 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);3761 }37623763 scheduleAt<T extends UniqueHelper>(3764 executionBlockNumber: number,3765 options: ISchedulerOptions = {},3766 ) {3767 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3768 return new UniqueRFToken(this.tokenId, scheduledCollection);3769 }37703771 scheduleAfter<T extends UniqueHelper>(3772 blocksBeforeExecution: number,3773 options: ISchedulerOptions = {},3774 ) {3775 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3776 return new UniqueRFToken(this.tokenId, scheduledCollection);3777 }37783779 getSudo<T extends UniqueHelper>() {3780 return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());3781 }3782}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, base58Encode, blake2AsU8a} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {hexToU8a} from '@polkadot/util/hex';13import {u8aConcat} from '@polkadot/util/u8a';14import {15 IApiListeners,16 IBlock,17 IEvent,18 IChainProperties,19 ICollectionCreationOptions,20 ICollectionLimits,21 ICollectionPermissions,22 ICrossAccountId,23 ICrossAccountIdLower,24 ILogger,25 INestingPermissions,26 IProperty,27 IStakingInfo,28 ISchedulerOptions,29 ISubstrateBalance,30 IToken,31 ITokenPropertyPermission,32 ITransactionResult,33 IUniqueHelperLog,34 TApiAllowedListeners,35 TEthereumAccount,36 TSigner,37 TSubstrateAccount,38 TNetworks,39 IForeignAssetMetadata,40 AcalaAssetMetadata,41 MoonbeamAssetInfo,42 DemocracyStandardAccountVote,43 IEthCrossAccountId,44} from './types';45import {RuntimeDispatchInfo} from '@polkadot/types/interfaces';46import type {Vec} from '@polkadot/types-codec';47import {FrameSystemEventRecord} from '@polkadot/types/lookup';4849export class CrossAccountId implements ICrossAccountId {50 Substrate?: TSubstrateAccount;51 Ethereum?: TEthereumAccount;5253 constructor(account: ICrossAccountId) {54 if (account.Substrate) this.Substrate = account.Substrate;55 if (account.Ethereum) this.Ethereum = account.Ethereum;56 }5758 static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {59 switch (domain) {60 case 'Substrate': return new CrossAccountId({Substrate: account.address});61 case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();62 }63 }6465 static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {66 return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});67 }6869 static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {70 return encodeAddress(decodeAddress(address), ss58Format);71 }7273 static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {74 return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});75 }7677 withNormalizedSubstrate(ss58Format = 42): CrossAccountId {78 if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);79 return this;80 }8182 static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {83 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));84 }8586 toEthereum(): CrossAccountId {87 if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});88 return this;89 }9091 static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {92 return evmToAddress(address, ss58Format);93 }9495 toSubstrate(ss58Format?: number): CrossAccountId {96 if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});97 return this;98 }99100 toLowerCase(): CrossAccountId {101 if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();102 if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();103 return this;104 }105}106107const nesting = {108 toChecksumAddress(address: string): string {109 if (typeof address === 'undefined') return '';110111 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);112113 address = address.toLowerCase().replace(/^0x/i,'');114 const addressHash = keccakAsHex(address).replace(/^0x/i,'');115 const checksumAddress = ['0x'];116117 for (let i = 0; i < address.length; i++) {118 // If ith character is 8 to f then make it uppercase119 if (parseInt(addressHash[i], 16) > 7) {120 checksumAddress.push(address[i].toUpperCase());121 } else {122 checksumAddress.push(address[i]);123 }124 }125 return checksumAddress.join('');126 },127 tokenIdToAddress(collectionId: number, tokenId: number) {128 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);129 },130};131132class UniqueUtil {133 static transactionStatus = {134 NOT_READY: 'NotReady',135 FAIL: 'Fail',136 SUCCESS: 'Success',137 };138139 static chainLogType = {140 EXTRINSIC: 'extrinsic',141 RPC: 'rpc',142 };143144 static getTokenAccount(token: IToken): CrossAccountId {145 return new CrossAccountId({Ethereum: this.getTokenAddress(token)});146 }147148 static getTokenAddress(token: IToken): string {149 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);150 }151152 static getDefaultLogger(): ILogger {153 return {154 log(msg: any, level = 'INFO') {155 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));156 },157 level: {158 ERROR: 'ERROR',159 WARNING: 'WARNING',160 INFO: 'INFO',161 },162 };163 }164165 static vec2str(arr: string[] | number[]) {166 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');167 }168169 static str2vec(string: string) {170 if (typeof string !== 'string') return string;171 return Array.from(string).map(x => x.charCodeAt(0));172 }173174 static fromSeed(seed: string, ss58Format = 42) {175 const keyring = new Keyring({type: 'sr25519', ss58Format});176 return keyring.addFromUri(seed);177 }178179 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {180 if (creationResult.status !== this.transactionStatus.SUCCESS) {181 throw Error('Unable to create collection!');182 }183184 let collectionId = null;185 creationResult.result.events.forEach(({event: {data, method, section}}) => {186 if ((section === 'common') && (method === 'CollectionCreated')) {187 collectionId = parseInt(data[0].toString(), 10);188 }189 });190191 if (collectionId === null) {192 throw Error('No CollectionCreated event was found!');193 }194195 return collectionId;196 }197198 static extractTokensFromCreationResult(creationResult: ITransactionResult): {199 success: boolean,200 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],201 } {202 if (creationResult.status !== this.transactionStatus.SUCCESS) {203 throw Error('Unable to create tokens!');204 }205 let success = false;206 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];207 creationResult.result.events.forEach(({event: {data, method, section}}) => {208 if (method === 'ExtrinsicSuccess') {209 success = true;210 } else if ((section === 'common') && (method === 'ItemCreated')) {211 tokens.push({212 collectionId: parseInt(data[0].toString(), 10),213 tokenId: parseInt(data[1].toString(), 10),214 owner: data[2].toHuman(),215 amount: data[3].toBigInt(),216 });217 }218 });219 return {success, tokens};220 }221222 static extractTokensFromBurnResult(burnResult: ITransactionResult): {223 success: boolean,224 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],225 } {226 if (burnResult.status !== this.transactionStatus.SUCCESS) {227 throw Error('Unable to burn tokens!');228 }229 let success = false;230 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];231 burnResult.result.events.forEach(({event: {data, method, section}}) => {232 if (method === 'ExtrinsicSuccess') {233 success = true;234 } else if ((section === 'common') && (method === 'ItemDestroyed')) {235 tokens.push({236 collectionId: parseInt(data[0].toString(), 10),237 tokenId: parseInt(data[1].toString(), 10),238 owner: data[2].toHuman(),239 amount: data[3].toBigInt(),240 });241 }242 });243 return {success, tokens};244 }245246 static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {247 let eventId = null;248 events.forEach(({event: {data, method, section}}) => {249 if ((section === expectedSection) && (method === expectedMethod)) {250 eventId = parseInt(data[0].toString(), 10);251 }252 });253254 if (eventId === null) {255 throw Error(`No ${expectedMethod} event was found!`);256 }257 return eventId === collectionId;258 }259260 static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {261 const normalizeAddress = (address: string | ICrossAccountId) => {262 if(typeof address === 'string') return address;263 const obj = {} as any;264 Object.keys(address).forEach(k => {265 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];266 });267 if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);268 if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();269 return address;270 };271 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;272 events.forEach(({event: {data, method, section}}) => {273 if ((section === 'common') && (method === 'Transfer')) {274 const hData = (data as any).toJSON();275 transfer = {276 collectionId: hData[0],277 tokenId: hData[1],278 from: normalizeAddress(hData[2]),279 to: normalizeAddress(hData[3]),280 amount: BigInt(hData[4]),281 };282 }283 });284 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;285 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);286 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);287 isSuccess = isSuccess && amount === transfer.amount;288 return isSuccess;289 }290291 static bigIntToDecimals(number: bigint, decimals = 18) {292 const numberStr = number.toString();293 const dotPos = numberStr.length - decimals;294295 if (dotPos <= 0) {296 return '0.' + '0'.repeat(Math.abs(dotPos)) + numberStr;297 } else {298 const intPart = numberStr.substring(0, dotPos);299 const fractPart = numberStr.substring(dotPos);300 return intPart + '.' + fractPart;301 }302 }303}304305class UniqueEventHelper {306 private static extractIndex(index: any): [number, number] | string {307 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];308 return index.toJSON();309 }310311 private static extractSub(data: any, subTypes: any): {[key: string]: any} {312 let obj: any = {};313 let index = 0;314315 if (data.entries) {316 for(const [key, value] of data.entries()) {317 obj[key] = this.extractData(value, subTypes[index]);318 index++;319 }320 } else obj = data.toJSON();321322 return obj;323 }324325 private static toHuman(data: any) {326 return data && data.toHuman ? data.toHuman() : `${data}`;327 }328329 private static extractData(data: any, type: any): any {330 if(!type) return this.toHuman(data);331 if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();332 if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();333 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);334 return this.toHuman(data);335 }336337 public static extractEvents(events: {event: any, phase: any}[]): IEvent[] {338 const parsedEvents: IEvent[] = [];339340 events.forEach((record) => {341 const {event, phase} = record;342 const types = event.typeDef;343344 const eventData: IEvent = {345 section: event.section.toString(),346 method: event.method.toString(),347 index: this.extractIndex(event.index),348 data: [],349 phase: phase.toJSON(),350 };351352 event.data.forEach((val: any, index: number) => {353 eventData.data.push(this.extractData(val, types[index]));354 });355356 parsedEvents.push(eventData);357 });358359 return parsedEvents;360 }361}362363export class ChainHelperBase {364 helperBase: any;365366 transactionStatus = UniqueUtil.transactionStatus;367 chainLogType = UniqueUtil.chainLogType;368 util: typeof UniqueUtil;369 eventHelper: typeof UniqueEventHelper;370 logger: ILogger;371 api: ApiPromise | null;372 forcedNetwork: TNetworks | null;373 network: TNetworks | null;374 wsEndpoint: string | null;375 chainLog: IUniqueHelperLog[];376 children: ChainHelperBase[];377 address: AddressGroup;378 chain: ChainGroup;379380 constructor(logger?: ILogger, helperBase?: any) {381 this.helperBase = helperBase;382383 this.util = UniqueUtil;384 this.eventHelper = UniqueEventHelper;385 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();386 this.logger = logger;387 this.api = null;388 this.forcedNetwork = null;389 this.network = null;390 this.wsEndpoint = null;391 this.chainLog = [];392 this.children = [];393 this.address = new AddressGroup(this);394 this.chain = new ChainGroup(this);395 }396397 clone(helperCls: ChainHelperBaseConstructor, options: {[key: string]: any} = {}) {398 Object.setPrototypeOf(helperCls.prototype, this);399 const newHelper = new helperCls(this.logger, options);400401 newHelper.api = this.api;402 newHelper.network = this.network;403 newHelper.forceNetwork = this.forceNetwork;404405 this.children.push(newHelper);406407 return newHelper;408 }409410 getEndpoint(): string {411 if (this.wsEndpoint === null) throw Error('No connection was established');412 return this.wsEndpoint;413 }414415 getApi(): ApiPromise {416 if(this.api === null) throw Error('API not initialized');417 return this.api;418 }419420 async subscribeEvents(expectedEvents: {section: string, names: string[]}[]) {421 const collectedEvents: IEvent[] = [];422 const unsubscribe = await this.getApi().query.system.events((events: Vec<FrameSystemEventRecord>) => {423 const ievents = this.eventHelper.extractEvents(events);424 ievents.forEach((event) => {425 expectedEvents.forEach((e => {426 if (event.section === e.section && e.names.includes(event.method)) {427 collectedEvents.push(event);428 }429 }));430 });431 });432 return {unsubscribe: unsubscribe as any, collectedEvents};433 }434435 clearChainLog(): void {436 this.chainLog = [];437 }438439 forceNetwork(value: TNetworks): void {440 this.forcedNetwork = value;441 }442443 async connect(wsEndpoint: string, listeners?: IApiListeners) {444 if (this.api !== null) throw Error('Already connected');445 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);446 this.wsEndpoint = wsEndpoint;447 this.api = api;448 this.network = network;449 }450451 async disconnect() {452 for (const child of this.children) {453 child.clearApi();454 }455456 if (this.api === null) return;457 await this.api.disconnect();458 this.clearApi();459 }460461 clearApi() {462 this.api = null;463 this.network = null;464 }465466 static async detectNetwork(api: ApiPromise): Promise<TNetworks> {467 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;468 const xcmChains = ['rococo', 'westend', 'westmint', 'acala', 'karura', 'moonbeam', 'moonriver'];469470 if(xcmChains.indexOf(spec.specName) > -1) return spec.specName;471472 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;473 return 'opal';474 }475476 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TNetworks> {477 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});478 await api.isReady;479480 const network = await this.detectNetwork(api);481482 await api.disconnect();483484 return network;485 }486487 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TNetworks | null): Promise<{488 api: ApiPromise;489 network: TNetworks;490 }> {491 if(typeof network === 'undefined' || network === null) network = 'opal';492 const supportedRPC = {493 opal: {494 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,495 },496 quartz: {497 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,498 },499 unique: {500 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,501 },502 rococo: {},503 westend: {},504 moonbeam: {},505 moonriver: {},506 acala: {},507 karura: {},508 westmint: {},509 };510 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);511 const rpc = supportedRPC[network];512513 // TODO: investigate how to replace rpc in runtime514 // api._rpcCore.addUserInterfaces(rpc);515516 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});517518 await api.isReadyOrError;519520 if (typeof listeners === 'undefined') listeners = {};521 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {522 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;523 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);524 }525526 return {api, network};527 }528529 getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {530 const {events, status} = data;531 if (status.isReady) {532 return this.transactionStatus.NOT_READY;533 }534 if (status.isBroadcast) {535 return this.transactionStatus.NOT_READY;536 }537 if (status.isInBlock || status.isFinalized) {538 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');539 if (errors.length > 0) {540 return this.transactionStatus.FAIL;541 }542 if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {543 return this.transactionStatus.SUCCESS;544 }545 }546547 return this.transactionStatus.FAIL;548 }549550 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {551 const sign = (callback: any) => {552 if(options !== null) return transaction.signAndSend(sender, options, callback);553 return transaction.signAndSend(sender, callback);554 };555 // eslint-disable-next-line no-async-promise-executor556 return new Promise(async (resolve, reject) => {557 try {558 const unsub = await sign((result: any) => {559 const status = this.getTransactionStatus(result);560561 if (status === this.transactionStatus.SUCCESS) {562 this.logger.log(`${label} successful`);563 unsub();564 resolve({result, status});565 } else if (status === this.transactionStatus.FAIL) {566 let moduleError = null;567568 if (result.hasOwnProperty('dispatchError')) {569 const dispatchError = result['dispatchError'];570571 if (dispatchError) {572 if (dispatchError.isModule) {573 const modErr = dispatchError.asModule;574 const errorMeta = dispatchError.registry.findMetaError(modErr);575576 moduleError = `${errorMeta.section}.${errorMeta.name}`;577 } else {578 moduleError = dispatchError.toHuman();579 }580 } else {581 this.logger.log(result, this.logger.level.ERROR);582 }583 }584585 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);586 unsub();587 reject({status, moduleError, result});588 }589 });590 } catch (e) {591 this.logger.log(e, this.logger.level.ERROR);592 reject(e);593 }594 });595 }596597 async signTransactionWithoutSending(signer: TSigner, tx: any) {598 const api = this.getApi();599 const signingInfo = await api.derive.tx.signingInfo(signer.address);600601 tx.sign(signer, {602 blockHash: api.genesisHash,603 genesisHash: api.genesisHash,604 runtimeVersion: api.runtimeVersion,605 nonce: signingInfo.nonce,606 });607608 return tx.toHex();609 }610611 async getPaymentInfo(signer: TSigner, tx: any, len: number | null) {612 const api = this.getApi();613 const signingInfo = await api.derive.tx.signingInfo(signer.address);614615 // We need to sign the tx because616 // unsigned transactions does not have an inclusion fee617 tx.sign(signer, {618 blockHash: api.genesisHash,619 genesisHash: api.genesisHash,620 runtimeVersion: api.runtimeVersion,621 nonce: signingInfo.nonce,622 });623624 if (len === null) {625 return (await this.callRpc('api.rpc.payment.queryInfo', [tx.toHex()])) as RuntimeDispatchInfo;626 } else {627 return (await api.call.transactionPaymentApi.queryInfo(tx, len)) as RuntimeDispatchInfo;628 }629 }630631 constructApiCall(apiCall: string, params: any[]) {632 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);633 let call = this.getApi() as any;634 for(const part of apiCall.slice(4).split('.')) {635 call = call[part];636 }637 return call(...params);638 }639640 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {641 if(this.api === null) throw Error('API not initialized');642 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);643644 const startTime = (new Date()).getTime();645 let result: ITransactionResult;646 let events: IEvent[] = [];647 try {648 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;649 events = this.eventHelper.extractEvents(result.result.events);650 }651 catch(e) {652 if(!(e as object).hasOwnProperty('status')) throw e;653 result = e as ITransactionResult;654 }655656 const endTime = (new Date()).getTime();657658 const log = {659 executedAt: endTime,660 executionTime: endTime - startTime,661 type: this.chainLogType.EXTRINSIC,662 status: result.status,663 call: extrinsic,664 signer: this.getSignerAddress(sender),665 params,666 } as IUniqueHelperLog;667668 if(result.status !== this.transactionStatus.SUCCESS) {669 if (result.moduleError) log.moduleError = result.moduleError;670 else if (result.result.dispatchError) log.dispatchError = result.result.dispatchError;671 }672 if(events.length > 0) log.events = events;673674 this.chainLog.push(log);675676 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {677 if (result.moduleError) throw Error(`${result.moduleError}`);678 else if (result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));679 }680 return result;681 }682683 async callRpc(rpc: string, params?: any[]) {684 if(typeof params === 'undefined') params = [];685 if(this.api === null) throw Error('API not initialized');686 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);687688 const startTime = (new Date()).getTime();689 let result;690 let error = null;691 const log = {692 type: this.chainLogType.RPC,693 call: rpc,694 params,695 } as IUniqueHelperLog;696697 try {698 result = await this.constructApiCall(rpc, params);699 }700 catch(e) {701 error = e;702 }703704 const endTime = (new Date()).getTime();705706 log.executedAt = endTime;707 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';708 log.executionTime = endTime - startTime;709710 this.chainLog.push(log);711712 if(error !== null) throw error;713714 return result;715 }716717 getSignerAddress(signer: IKeyringPair | string): string {718 if(typeof signer === 'string') return signer;719 return signer.address;720 }721722 fetchAllPalletNames(): string[] {723 if(this.api === null) throw Error('API not initialized');724 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());725 }726727 fetchMissingPalletNames(requiredPallets: string[]): string[] {728 const palletNames = this.fetchAllPalletNames();729 return requiredPallets.filter(p => !palletNames.includes(p));730 }731}732733734class HelperGroup<T extends ChainHelperBase> {735 helper: T;736737 constructor(uniqueHelper: T) {738 this.helper = uniqueHelper;739 }740}741742743class CollectionGroup extends HelperGroup<UniqueHelper> {744 /**745 * Get number of blocks when sponsored transaction is available.746 *747 * @param collectionId ID of collection748 * @param tokenId ID of token749 * @param addressObj address for which the sponsorship is checked750 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});751 * @returns number of blocks or null if sponsorship hasn't been set752 */753 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {754 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();755 }756757 /**758 * Get the number of created collections.759 *760 * @returns number of created collections761 */762 async getTotalCount(): Promise<number> {763 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();764 }765766 /**767 * Get information about the collection with additional data,768 * including the number of tokens it contains, its administrators,769 * the normalized address of the collection's owner, and decoded name and description.770 *771 * @param collectionId ID of collection772 * @example await getData(2)773 * @returns collection information object774 */775 async getData(collectionId: number): Promise<{776 id: number;777 name: string;778 description: string;779 tokensCount: number;780 admins: CrossAccountId[];781 normalizedOwner: TSubstrateAccount;782 raw: any783 } | null> {784 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);785 const humanCollection = collection.toHuman(), collectionData = {786 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],787 raw: humanCollection,788 } as any, jsonCollection = collection.toJSON();789 if (humanCollection === null) return null;790 collectionData.raw.limits = jsonCollection.limits;791 collectionData.raw.permissions = jsonCollection.permissions;792 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);793 for (const key of ['name', 'description']) {794 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);795 }796797 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))798 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)799 : 0;800 collectionData.admins = await this.getAdmins(collectionId);801802 return collectionData;803 }804805 /**806 * Get the addresses of the collection's administrators, optionally normalized.807 *808 * @param collectionId ID of collection809 * @param normalize whether to normalize the addresses to the default ss58 format810 * @example await getAdmins(1)811 * @returns array of administrators812 */813 async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {814 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();815816 return normalize817 ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())818 : admins;819 }820821 /**822 * Get the addresses added to the collection allow-list, optionally normalized.823 * @param collectionId ID of collection824 * @param normalize whether to normalize the addresses to the default ss58 format825 * @example await getAllowList(1)826 * @returns array of allow-listed addresses827 */828 async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {829 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();830 return normalize831 ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())832 : allowListed;833 }834835 /**836 * Get the effective limits of the collection instead of null for default values837 *838 * @param collectionId ID of collection839 * @example await getEffectiveLimits(2)840 * @returns object of collection limits841 */842 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {843 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();844 }845846 /**847 * Burns the collection if the signer has sufficient permissions and collection is empty.848 *849 * @param signer keyring of signer850 * @param collectionId ID of collection851 * @example await helper.collection.burn(aliceKeyring, 3);852 * @returns ```true``` if extrinsic success, otherwise ```false```853 */854 async burn(signer: TSigner, collectionId: number): Promise<boolean> {855 const result = await this.helper.executeExtrinsic(856 signer,857 'api.tx.unique.destroyCollection', [collectionId],858 true,859 );860861 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');862 }863864 /**865 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.866 *867 * @param signer keyring of signer868 * @param collectionId ID of collection869 * @param sponsorAddress Sponsor substrate address870 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")871 * @returns ```true``` if extrinsic success, otherwise ```false```872 */873 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {874 const result = await this.helper.executeExtrinsic(875 signer,876 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],877 true,878 );879880 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorSet');881 }882883 /**884 * Confirms consent to sponsor the collection on behalf of the signer.885 *886 * @param signer keyring of signer887 * @param collectionId ID of collection888 * @example confirmSponsorship(aliceKeyring, 10)889 * @returns ```true``` if extrinsic success, otherwise ```false```890 */891 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {892 const result = await this.helper.executeExtrinsic(893 signer,894 'api.tx.unique.confirmSponsorship', [collectionId],895 true,896 );897898 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'SponsorshipConfirmed');899 }900901 /**902 * Removes the sponsor of a collection, regardless if it consented or not.903 *904 * @param signer keyring of signer905 * @param collectionId ID of collection906 * @example removeSponsor(aliceKeyring, 10)907 * @returns ```true``` if extrinsic success, otherwise ```false```908 */909 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {910 const result = await this.helper.executeExtrinsic(911 signer,912 'api.tx.unique.removeCollectionSponsor', [collectionId],913 true,914 );915916 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorRemoved');917 }918919 /**920 * Sets the limits of the collection. At least one limit must be specified for a correct call.921 *922 * @param signer keyring of signer923 * @param collectionId ID of collection924 * @param limits collection limits object925 * @example926 * await setLimits(927 * aliceKeyring,928 * 10,929 * {930 * sponsorTransferTimeout: 0,931 * ownerCanDestroy: false932 * }933 * )934 * @returns ```true``` if extrinsic success, otherwise ```false```935 */936 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {937 const result = await this.helper.executeExtrinsic(938 signer,939 'api.tx.unique.setCollectionLimits', [collectionId, limits],940 true,941 );942943 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionLimitSet');944 }945946 /**947 * Changes the owner of the collection to the new Substrate address.948 *949 * @param signer keyring of signer950 * @param collectionId ID of collection951 * @param ownerAddress substrate address of new owner952 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")953 * @returns ```true``` if extrinsic success, otherwise ```false```954 */955 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {956 const result = await this.helper.executeExtrinsic(957 signer,958 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],959 true,960 );961962 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionOwnerChanged');963 }964965 /**966 * Adds a collection administrator.967 *968 * @param signer keyring of signer969 * @param collectionId ID of collection970 * @param adminAddressObj Administrator address (substrate or ethereum)971 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})972 * @returns ```true``` if extrinsic success, otherwise ```false```973 */974 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {975 const result = await this.helper.executeExtrinsic(976 signer,977 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],978 true,979 );980981 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminAdded');982 }983984 /**985 * Removes a collection administrator.986 *987 * @param signer keyring of signer988 * @param collectionId ID of collection989 * @param adminAddressObj Administrator address (substrate or ethereum)990 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})991 * @returns ```true``` if extrinsic success, otherwise ```false```992 */993 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {994 const result = await this.helper.executeExtrinsic(995 signer,996 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],997 true,998 );9991000 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminRemoved');1001 }10021003 /**1004 * Check if user is in allow list.1005 *1006 * @param collectionId ID of collection1007 * @param user Account to check1008 * @example await getAdmins(1)1009 * @returns is user in allow list1010 */1011 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {1012 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();1013 }10141015 /**1016 * Adds an address to allow list1017 * @param signer keyring of signer1018 * @param collectionId ID of collection1019 * @param addressObj address to add to the allow list1020 * @returns ```true``` if extrinsic success, otherwise ```false```1021 */1022 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1023 const result = await this.helper.executeExtrinsic(1024 signer,1025 'api.tx.unique.addToAllowList', [collectionId, addressObj],1026 true,1027 );10281029 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressAdded');1030 }10311032 /**1033 * Removes an address from allow list1034 *1035 * @param signer keyring of signer1036 * @param collectionId ID of collection1037 * @param addressObj address to remove from the allow list1038 * @returns ```true``` if extrinsic success, otherwise ```false```1039 */1040 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1041 const result = await this.helper.executeExtrinsic(1042 signer,1043 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],1044 true,1045 );10461047 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressRemoved');1048 }10491050 /**1051 * Sets onchain permissions for selected collection.1052 *1053 * @param signer keyring of signer1054 * @param collectionId ID of collection1055 * @param permissions collection permissions object1056 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});1057 * @returns ```true``` if extrinsic success, otherwise ```false```1058 */1059 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {1060 const result = await this.helper.executeExtrinsic(1061 signer,1062 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],1063 true,1064 );10651066 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPermissionSet');1067 }10681069 /**1070 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.1071 *1072 * @param signer keyring of signer1073 * @param collectionId ID of collection1074 * @param permissions nesting permissions object1075 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});1076 * @returns ```true``` if extrinsic success, otherwise ```false```1077 */1078 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {1079 return await this.setPermissions(signer, collectionId, {nesting: permissions});1080 }10811082 /**1083 * Disables nesting for selected collection.1084 *1085 * @param signer keyring of signer1086 * @param collectionId ID of collection1087 * @example disableNesting(aliceKeyring, 10);1088 * @returns ```true``` if extrinsic success, otherwise ```false```1089 */1090 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {1091 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});1092 }10931094 /**1095 * Sets onchain properties to the collection.1096 *1097 * @param signer keyring of signer1098 * @param collectionId ID of collection1099 * @param properties array of property objects1100 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);1101 * @returns ```true``` if extrinsic success, otherwise ```false```1102 */1103 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {1104 const result = await this.helper.executeExtrinsic(1105 signer,1106 'api.tx.unique.setCollectionProperties', [collectionId, properties],1107 true,1108 );11091110 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');1111 }11121113 /**1114 * Get collection properties.1115 *1116 * @param collectionId ID of collection1117 * @param propertyKeys optionally filter the returned properties to only these keys1118 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);1119 * @returns array of key-value pairs1120 */1121 async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1122 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();1123 }11241125 async getPropertiesConsumedSpace(collectionId: number): Promise<number> {1126 const api = this.helper.getApi();1127 const props = (await api.query.common.collectionProperties(collectionId)).toJSON();11281129 return (props! as any).consumedSpace;1130 }11311132 async getCollectionOptions(collectionId: number) {1133 return (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1134 }11351136 /**1137 * Deletes onchain properties from the collection.1138 *1139 * @param signer keyring of signer1140 * @param collectionId ID of collection1141 * @param propertyKeys array of property keys to delete1142 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);1143 * @returns ```true``` if extrinsic success, otherwise ```false```1144 */1145 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {1146 const result = await this.helper.executeExtrinsic(1147 signer,1148 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],1149 true,1150 );11511152 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1153 }11541155 /**1156 * Changes the owner of the token.1157 *1158 * @param signer keyring of signer1159 * @param collectionId ID of collection1160 * @param tokenId ID of token1161 * @param addressObj address of a new owner1162 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1163 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1164 * @returns true if the token success, otherwise false1165 */1166 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1167 const result = await this.helper.executeExtrinsic(1168 signer,1169 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1170 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1171 );11721173 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1174 }11751176 /**1177 *1178 * Change ownership of a token(s) on behalf of the owner.1179 *1180 * @param signer keyring of signer1181 * @param collectionId ID of collection1182 * @param tokenId ID of token1183 * @param fromAddressObj address on behalf of which the token will be sent1184 * @param toAddressObj new token owner1185 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1186 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1187 * @returns true if the token success, otherwise false1188 */1189 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1190 const result = await this.helper.executeExtrinsic(1191 signer,1192 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1193 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1194 );1195 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1196 }11971198 /**1199 *1200 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1201 *1202 * @param signer keyring of signer1203 * @param collectionId ID of collection1204 * @param tokenId ID of token1205 * @param amount amount of tokens to be burned. For NFT must be set to 1n1206 * @example burnToken(aliceKeyring, 10, 5);1207 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1208 */1209 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1210 const burnResult = await this.helper.executeExtrinsic(1211 signer,1212 'api.tx.unique.burnItem', [collectionId, tokenId, amount],1213 true, // `Unable to burn token for ${label}`,1214 );1215 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1216 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1217 return burnedTokens.success;1218 }12191220 /**1221 * Destroys a concrete instance of NFT on behalf of the owner1222 *1223 * @param signer keyring of signer1224 * @param collectionId ID of collection1225 * @param tokenId ID of token1226 * @param fromAddressObj address on behalf of which the token will be burnt1227 * @param amount amount of tokens to be burned. For NFT must be set to 1n1228 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1229 * @returns ```true``` if extrinsic success, otherwise ```false```1230 */1231 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1232 const burnResult = await this.helper.executeExtrinsic(1233 signer,1234 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1235 true, // `Unable to burn token from for ${label}`,1236 );1237 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1238 return burnedTokens.success && burnedTokens.tokens.length > 0;1239 }12401241 /**1242 * Set, change, or remove approved address to transfer the ownership of the NFT.1243 *1244 * @param signer keyring of signer1245 * @param collectionId ID of collection1246 * @param tokenId ID of token1247 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1248 * @param amount amount of token to be approved. For NFT must be set to 1n1249 * @returns ```true``` if extrinsic success, otherwise ```false```1250 */1251 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1252 const approveResult = await this.helper.executeExtrinsic(1253 signer,1254 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1255 true, // `Unable to approve token for ${label}`,1256 );12571258 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1259 }12601261 /**1262 * Get the amount of token pieces approved to transfer or burn. Normally 0.1263 *1264 * @param collectionId ID of collection1265 * @param tokenId ID of token1266 * @param toAccountObj address which is approved to use token pieces1267 * @param fromAccountObj address which may have allowed the use of its owned tokens1268 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1269 * @returns number of approved to transfer pieces1270 */1271 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1272 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1273 }12741275 /**1276 * Get the last created token ID in a collection1277 *1278 * @param collectionId ID of collection1279 * @example getLastTokenId(10);1280 * @returns id of the last created token1281 */1282 async getLastTokenId(collectionId: number): Promise<number> {1283 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1284 }12851286 /**1287 * Check if token exists1288 *1289 * @param collectionId ID of collection1290 * @param tokenId ID of token1291 * @example doesTokenExist(10, 20);1292 * @returns true if the token exists, otherwise false1293 */1294 async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1295 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1296 }1297}12981299class NFTnRFT extends CollectionGroup {1300 /**1301 * Get tokens owned by account1302 *1303 * @param collectionId ID of collection1304 * @param addressObj tokens owner1305 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1306 * @returns array of token ids owned by account1307 */1308 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1309 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1310 }13111312 /**1313 * Get token data1314 *1315 * @param collectionId ID of collection1316 * @param tokenId ID of token1317 * @param propertyKeys optionally filter the token properties to only these keys1318 * @param blockHashAt optionally query the data at some block with this hash1319 * @example getToken(10, 5);1320 * @returns human readable token data1321 */1322 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1323 properties: IProperty[];1324 owner: CrossAccountId;1325 normalizedOwner: CrossAccountId;1326 }| null> {1327 let tokenData;1328 if(typeof blockHashAt === 'undefined') {1329 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1330 }1331 else {1332 if(propertyKeys.length == 0) {1333 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1334 if(!collection) return null;1335 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1336 }1337 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1338 }1339 tokenData = tokenData.toHuman();1340 if (tokenData === null || tokenData.owner === null) return null;1341 const owner = {} as any;1342 for (const key of Object.keys(tokenData.owner)) {1343 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate'1344 ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key])1345 : tokenData.owner[key];1346 }1347 tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1348 return tokenData;1349 }13501351 /**1352 * Set permissions to change token properties1353 *1354 * @param signer keyring of signer1355 * @param collectionId ID of collection1356 * @param permissions permissions to change a property by the collection admin or token owner1357 * @example setTokenPropertyPermissions(1358 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1359 * )1360 * @returns true if extrinsic success otherwise false1361 */1362 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1363 const result = await this.helper.executeExtrinsic(1364 signer,1365 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1366 true,1367 );13681369 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1370 }13711372 /**1373 * Get token property permissions.1374 *1375 * @param collectionId ID of collection1376 * @param propertyKeys optionally filter the returned property permissions to only these keys1377 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1378 * @returns array of key-permission pairs1379 */1380 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1381 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1382 }13831384 /**1385 * Set token properties1386 *1387 * @param signer keyring of signer1388 * @param collectionId ID of collection1389 * @param tokenId ID of token1390 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1391 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1392 * @returns ```true``` if extrinsic success, otherwise ```false```1393 */1394 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1395 const result = await this.helper.executeExtrinsic(1396 signer,1397 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1398 true,1399 );14001401 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1402 }14031404 /**1405 * Get properties, metadata assigned to a token.1406 *1407 * @param collectionId ID of collection1408 * @param tokenId ID of token1409 * @param propertyKeys optionally filter the returned properties to only these keys1410 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1411 * @returns array of key-value pairs1412 */1413 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1414 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1415 }14161417 /**1418 * Delete the provided properties of a token1419 * @param signer keyring of signer1420 * @param collectionId ID of collection1421 * @param tokenId ID of token1422 * @param propertyKeys property keys to be deleted1423 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1424 * @returns ```true``` if extrinsic success, otherwise ```false```1425 */1426 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1427 const result = await this.helper.executeExtrinsic(1428 signer,1429 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1430 true,1431 );14321433 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1434 }14351436 /**1437 * Mint new collection1438 *1439 * @param signer keyring of signer1440 * @param collectionOptions basic collection options and properties1441 * @param mode NFT or RFT type of a collection1442 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1443 * @returns object of the created collection1444 */1445 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1446 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1447 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1448 for (const key of ['name', 'description', 'tokenPrefix']) {1449 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);1450 }1451 const creationResult = await this.helper.executeExtrinsic(1452 signer,1453 'api.tx.unique.createCollectionEx', [collectionOptions],1454 true, // errorLabel,1455 );1456 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1457 }14581459 getCollectionObject(_collectionId: number): any {1460 return null;1461 }14621463 getTokenObject(_collectionId: number, _tokenId: number): any {1464 return null;1465 }14661467 /**1468 * Tells whether the given `owner` approves the `operator`.1469 * @param collectionId ID of collection1470 * @param owner owner address1471 * @param operator operator addrees1472 * @returns true if operator is enabled1473 */1474 async allowanceForAll(collectionId: number, owner: ICrossAccountId, operator: ICrossAccountId): Promise<boolean> {1475 return (await this.helper.callRpc('api.rpc.unique.allowanceForAll', [collectionId, owner, operator])).toJSON();1476 }14771478 /** Sets or unsets the approval of a given operator.1479 * The `operator` is allowed to transfer all tokens of the `caller` on their behalf.1480 * @param operator Operator1481 * @param approved Should operator status be granted or revoked?1482 * @returns ```true``` if extrinsic success, otherwise ```false```1483 */1484 async setAllowanceForAll(signer: TSigner, collectionId: number, operator: ICrossAccountId, approved: boolean): Promise<boolean> {1485 const result = await this.helper.executeExtrinsic(1486 signer,1487 'api.tx.unique.setAllowanceForAll', [collectionId, operator, approved],1488 true,1489 );1490 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'ApprovedForAll');1491 }1492}149314941495class NFTGroup extends NFTnRFT {1496 /**1497 * Get collection object1498 * @param collectionId ID of collection1499 * @example getCollectionObject(2);1500 * @returns instance of UniqueNFTCollection1501 */1502 getCollectionObject(collectionId: number): UniqueNFTCollection {1503 return new UniqueNFTCollection(collectionId, this.helper);1504 }15051506 /**1507 * Get token object1508 * @param collectionId ID of collection1509 * @param tokenId ID of token1510 * @example getTokenObject(10, 5);1511 * @returns instance of UniqueNFTToken1512 */1513 getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1514 return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1515 }15161517 /**1518 * Get token's owner1519 * @param collectionId ID of collection1520 * @param tokenId ID of token1521 * @param blockHashAt optionally query the data at the block with this hash1522 * @example getTokenOwner(10, 5);1523 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1524 */1525 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1526 let owner;1527 if (typeof blockHashAt === 'undefined') {1528 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1529 } else {1530 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1531 }1532 return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1533 }15341535 /**1536 * Is token approved to transfer1537 * @param collectionId ID of collection1538 * @param tokenId ID of token1539 * @param toAccountObj address to be approved1540 * @returns ```true``` if extrinsic success, otherwise ```false```1541 */1542 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1543 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1544 }15451546 /**1547 * Changes the owner of the token.1548 *1549 * @param signer keyring of signer1550 * @param collectionId ID of collection1551 * @param tokenId ID of token1552 * @param addressObj address of a new owner1553 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1554 * @returns ```true``` if extrinsic success, otherwise ```false```1555 */1556 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1557 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1558 }15591560 /**1561 *1562 * Change ownership of a NFT on behalf of the owner.1563 *1564 * @param signer keyring of signer1565 * @param collectionId ID of collection1566 * @param tokenId ID of token1567 * @param fromAddressObj address on behalf of which the token will be sent1568 * @param toAddressObj new token owner1569 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1570 * @returns ```true``` if extrinsic success, otherwise ```false```1571 */1572 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1573 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1574 }15751576 /**1577 * Recursively find the address that owns the token1578 * @param collectionId ID of collection1579 * @param tokenId ID of token1580 * @param blockHashAt1581 * @example getTokenTopmostOwner(10, 5);1582 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1583 */1584 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1585 let owner;1586 if (typeof blockHashAt === 'undefined') {1587 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1588 } else {1589 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1590 }15911592 if (owner === null) return null;15931594 return owner.toHuman();1595 }15961597 /**1598 * Get tokens nested in the provided token1599 * @param collectionId ID of collection1600 * @param tokenId ID of token1601 * @param blockHashAt optionally query the data at the block with this hash1602 * @example getTokenChildren(10, 5);1603 * @returns tokens whose depth of nesting is <= 51604 */1605 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1606 let children;1607 if(typeof blockHashAt === 'undefined') {1608 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1609 } else {1610 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1611 }16121613 return children.toJSON().map((x: any) => {1614 return {collectionId: x.collection, tokenId: x.token};1615 });1616 }16171618 /**1619 * Nest one token into another1620 * @param signer keyring of signer1621 * @param tokenObj token to be nested1622 * @param rootTokenObj token to be parent1623 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1624 * @returns ```true``` if extrinsic success, otherwise ```false```1625 */1626 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1627 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1628 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1629 if(!result) {1630 throw Error('Unable to nest token!');1631 }1632 return result;1633 }16341635 /**1636 * Remove token from nested state1637 * @param signer keyring of signer1638 * @param tokenObj token to unnest1639 * @param rootTokenObj parent of a token1640 * @param toAddressObj address of a new token owner1641 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1642 * @returns ```true``` if extrinsic success, otherwise ```false```1643 */1644 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1645 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1646 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1647 if(!result) {1648 throw Error('Unable to unnest token!');1649 }1650 return result;1651 }16521653 /**1654 * Mint new collection1655 * @param signer keyring of signer1656 * @param collectionOptions Collection options1657 * @example1658 * mintCollection(aliceKeyring, {1659 * name: 'New',1660 * description: 'New collection',1661 * tokenPrefix: 'NEW',1662 * })1663 * @returns object of the created collection1664 */1665 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1666 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1667 }16681669 /**1670 * Mint new token1671 * @param signer keyring of signer1672 * @param data token data1673 * @returns created token object1674 */1675 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1676 const creationResult = await this.helper.executeExtrinsic(1677 signer,1678 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1679 nft: {1680 properties: data.properties,1681 },1682 }],1683 true,1684 );1685 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1686 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1687 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1688 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1689 }16901691 /**1692 * Mint multiple NFT tokens1693 * @param signer keyring of signer1694 * @param collectionId ID of collection1695 * @param tokens array of tokens with owner and properties1696 * @example1697 * mintMultipleTokens(aliceKeyring, 10, [{1698 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1699 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1700 * },{1701 * owner: {Ethereum: "0x9F0583DbB855d..."},1702 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1703 * }]);1704 * @returns ```true``` if extrinsic success, otherwise ```false```1705 */1706 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1707 const creationResult = await this.helper.executeExtrinsic(1708 signer,1709 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1710 true,1711 );1712 const collection = this.getCollectionObject(collectionId);1713 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1714 }17151716 /**1717 * Mint multiple NFT tokens with one owner1718 * @param signer keyring of signer1719 * @param collectionId ID of collection1720 * @param owner tokens owner1721 * @param tokens array of tokens with owner and properties1722 * @example1723 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1724 * properties: [{1725 * key: "gender",1726 * value: "female",1727 * },{1728 * key: "age",1729 * value: "33",1730 * }],1731 * }]);1732 * @returns array of newly created tokens1733 */1734 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1735 const rawTokens = [];1736 for (const token of tokens) {1737 const raw = {NFT: {properties: token.properties}};1738 rawTokens.push(raw);1739 }1740 const creationResult = await this.helper.executeExtrinsic(1741 signer,1742 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1743 true,1744 );1745 const collection = this.getCollectionObject(collectionId);1746 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1747 }17481749 /**1750 * Set, change, or remove approved address to transfer the ownership of the NFT.1751 *1752 * @param signer keyring of signer1753 * @param collectionId ID of collection1754 * @param tokenId ID of token1755 * @param toAddressObj address to approve1756 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1757 * @returns ```true``` if extrinsic success, otherwise ```false```1758 */1759 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1760 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1761 }1762}176317641765class RFTGroup extends NFTnRFT {1766 /**1767 * Get collection object1768 * @param collectionId ID of collection1769 * @example getCollectionObject(2);1770 * @returns instance of UniqueRFTCollection1771 */1772 getCollectionObject(collectionId: number): UniqueRFTCollection {1773 return new UniqueRFTCollection(collectionId, this.helper);1774 }17751776 /**1777 * Get token object1778 * @param collectionId ID of collection1779 * @param tokenId ID of token1780 * @example getTokenObject(10, 5);1781 * @returns instance of UniqueNFTToken1782 */1783 getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1784 return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1785 }17861787 /**1788 * Get top 10 token owners with the largest number of pieces1789 * @param collectionId ID of collection1790 * @param tokenId ID of token1791 * @example getTokenTop10Owners(10, 5);1792 * @returns array of top 10 owners1793 */1794 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1795 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1796 }17971798 /**1799 * Get number of pieces owned by address1800 * @param collectionId ID of collection1801 * @param tokenId ID of token1802 * @param addressObj address token owner1803 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1804 * @returns number of pieces ownerd by address1805 */1806 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1807 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1808 }18091810 /**1811 * Transfer pieces of token to another address1812 * @param signer keyring of signer1813 * @param collectionId ID of collection1814 * @param tokenId ID of token1815 * @param addressObj address of a new owner1816 * @param amount number of pieces to be transfered1817 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1818 * @returns ```true``` if extrinsic success, otherwise ```false```1819 */1820 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1821 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1822 }18231824 /**1825 * Change ownership of some pieces of RFT on behalf of the owner.1826 * @param signer keyring of signer1827 * @param collectionId ID of collection1828 * @param tokenId ID of token1829 * @param fromAddressObj address on behalf of which the token will be sent1830 * @param toAddressObj new token owner1831 * @param amount number of pieces to be transfered1832 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1833 * @returns ```true``` if extrinsic success, otherwise ```false```1834 */1835 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1836 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1837 }18381839 /**1840 * Mint new collection1841 * @param signer keyring of signer1842 * @param collectionOptions Collection options1843 * @example1844 * mintCollection(aliceKeyring, {1845 * name: 'New',1846 * description: 'New collection',1847 * tokenPrefix: 'NEW',1848 * })1849 * @returns object of the created collection1850 */1851 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1852 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1853 }18541855 /**1856 * Mint new token1857 * @param signer keyring of signer1858 * @param data token data1859 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1860 * @returns created token object1861 */1862 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1863 const creationResult = await this.helper.executeExtrinsic(1864 signer,1865 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1866 refungible: {1867 pieces: data.pieces,1868 properties: data.properties,1869 },1870 }],1871 true,1872 );1873 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1874 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1875 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1876 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1877 }18781879 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1880 throw Error('Not implemented');1881 const creationResult = await this.helper.executeExtrinsic(1882 signer,1883 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1884 true, // `Unable to mint RFT tokens for ${label}`,1885 );1886 const collection = this.getCollectionObject(collectionId);1887 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1888 }18891890 /**1891 * Mint multiple RFT tokens with one owner1892 * @param signer keyring of signer1893 * @param collectionId ID of collection1894 * @param owner tokens owner1895 * @param tokens array of tokens with properties and pieces1896 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1897 * @returns array of newly created RFT tokens1898 */1899 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1900 const rawTokens = [];1901 for (const token of tokens) {1902 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1903 rawTokens.push(raw);1904 }1905 const creationResult = await this.helper.executeExtrinsic(1906 signer,1907 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1908 true,1909 );1910 const collection = this.getCollectionObject(collectionId);1911 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1912 }19131914 /**1915 * Destroys a concrete instance of RFT.1916 * @param signer keyring of signer1917 * @param collectionId ID of collection1918 * @param tokenId ID of token1919 * @param amount number of pieces to be burnt1920 * @example burnToken(aliceKeyring, 10, 5);1921 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1922 */1923 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1924 return await super.burnToken(signer, collectionId, tokenId, amount);1925 }19261927 /**1928 * Destroys a concrete instance of RFT on behalf of the owner.1929 * @param signer keyring of signer1930 * @param collectionId ID of collection1931 * @param tokenId ID of token1932 * @param fromAddressObj address on behalf of which the token will be burnt1933 * @param amount number of pieces to be burnt1934 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1935 * @returns ```true``` if extrinsic success, otherwise ```false```1936 */1937 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1938 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1939 }19401941 /**1942 * Set, change, or remove approved address to transfer the ownership of the RFT.1943 *1944 * @param signer keyring of signer1945 * @param collectionId ID of collection1946 * @param tokenId ID of token1947 * @param toAddressObj address to approve1948 * @param amount number of pieces to be approved1949 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1950 * @returns true if the token success, otherwise false1951 */1952 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1953 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1954 }19551956 /**1957 * Get total number of pieces1958 * @param collectionId ID of collection1959 * @param tokenId ID of token1960 * @example getTokenTotalPieces(10, 5);1961 * @returns number of pieces1962 */1963 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1964 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1965 }19661967 /**1968 * Change number of token pieces. Signer must be the owner of all token pieces.1969 * @param signer keyring of signer1970 * @param collectionId ID of collection1971 * @param tokenId ID of token1972 * @param amount new number of pieces1973 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1974 * @returns true if the repartion was success, otherwise false1975 */1976 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1977 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1978 const repartitionResult = await this.helper.executeExtrinsic(1979 signer,1980 'api.tx.unique.repartition', [collectionId, tokenId, amount],1981 true,1982 );1983 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1984 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1985 }1986}198719881989class FTGroup extends CollectionGroup {1990 /**1991 * Get collection object1992 * @param collectionId ID of collection1993 * @example getCollectionObject(2);1994 * @returns instance of UniqueFTCollection1995 */1996 getCollectionObject(collectionId: number): UniqueFTCollection {1997 return new UniqueFTCollection(collectionId, this.helper);1998 }19992000 /**2001 * Mint new fungible collection2002 * @param signer keyring of signer2003 * @param collectionOptions Collection options2004 * @param decimalPoints number of token decimals2005 * @example2006 * mintCollection(aliceKeyring, {2007 * name: 'New',2008 * description: 'New collection',2009 * tokenPrefix: 'NEW',2010 * }, 18)2011 * @returns newly created fungible collection2012 */2013 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {2014 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object2015 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');2016 collectionOptions.mode = {fungible: decimalPoints};2017 for (const key of ['name', 'description', 'tokenPrefix']) {2018 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);2019 }2020 const creationResult = await this.helper.executeExtrinsic(2021 signer,2022 'api.tx.unique.createCollectionEx', [collectionOptions],2023 true,2024 );2025 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));2026 }20272028 /**2029 * Mint tokens2030 * @param signer keyring of signer2031 * @param collectionId ID of collection2032 * @param owner address owner of new tokens2033 * @param amount amount of tokens to be meanted2034 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);2035 * @returns ```true``` if extrinsic success, otherwise ```false```2036 */2037 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {2038 const creationResult = await this.helper.executeExtrinsic(2039 signer,2040 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {2041 fungible: {2042 value: amount,2043 },2044 }],2045 true, // `Unable to mint fungible tokens for ${label}`,2046 );2047 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2048 }20492050 /**2051 * Mint multiple Fungible tokens with one owner2052 * @param signer keyring of signer2053 * @param collectionId ID of collection2054 * @param owner tokens owner2055 * @param tokens array of tokens with properties and pieces2056 * @returns ```true``` if extrinsic success, otherwise ```false```2057 */2058 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {2059 const rawTokens = [];2060 for (const token of tokens) {2061 const raw = {Fungible: {Value: token.value}};2062 rawTokens.push(raw);2063 }2064 const creationResult = await this.helper.executeExtrinsic(2065 signer,2066 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2067 true,2068 );2069 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2070 }20712072 /**2073 * Get the top 10 owners with the largest balance for the Fungible collection2074 * @param collectionId ID of collection2075 * @example getTop10Owners(10);2076 * @returns array of ```ICrossAccountId```2077 */2078 async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {2079 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);2080 }20812082 /**2083 * Get account balance2084 * @param collectionId ID of collection2085 * @param addressObj address of owner2086 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})2087 * @returns amount of fungible tokens owned by address2088 */2089 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {2090 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();2091 }20922093 /**2094 * Transfer tokens to address2095 * @param signer keyring of signer2096 * @param collectionId ID of collection2097 * @param toAddressObj address recipient2098 * @param amount amount of tokens to be sent2099 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2100 * @returns ```true``` if extrinsic success, otherwise ```false```2101 */2102 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2103 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);2104 }21052106 /**2107 * Transfer some tokens on behalf of the owner.2108 * @param signer keyring of signer2109 * @param collectionId ID of collection2110 * @param fromAddressObj address on behalf of which tokens will be sent2111 * @param toAddressObj address where token to be sent2112 * @param amount number of tokens to be sent2113 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);2114 * @returns ```true``` if extrinsic success, otherwise ```false```2115 */2116 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2117 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);2118 }21192120 /**2121 * Destroy some amount of tokens2122 * @param signer keyring of signer2123 * @param collectionId ID of collection2124 * @param amount amount of tokens to be destroyed2125 * @example burnTokens(aliceKeyring, 10, 1000n);2126 * @returns ```true``` if extrinsic success, otherwise ```false```2127 */2128 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {2129 return await super.burnToken(signer, collectionId, 0, amount);2130 }21312132 /**2133 * Burn some tokens on behalf of the owner.2134 * @param signer keyring of signer2135 * @param collectionId ID of collection2136 * @param fromAddressObj address on behalf of which tokens will be burnt2137 * @param amount amount of tokens to be burnt2138 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2139 * @returns ```true``` if extrinsic success, otherwise ```false```2140 */2141 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {2142 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);2143 }21442145 /**2146 * Get total collection supply2147 * @param collectionId2148 * @returns2149 */2150 async getTotalPieces(collectionId: number): Promise<bigint> {2151 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();2152 }21532154 /**2155 * Set, change, or remove approved address to transfer tokens.2156 *2157 * @param signer keyring of signer2158 * @param collectionId ID of collection2159 * @param toAddressObj address to be approved2160 * @param amount amount of tokens to be approved2161 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)2162 * @returns ```true``` if extrinsic success, otherwise ```false```2163 */2164 approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2165 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);2166 }21672168 /**2169 * Get amount of fungible tokens approved to transfer2170 * @param collectionId ID of collection2171 * @param fromAddressObj owner of tokens2172 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner2173 * @returns number of tokens approved for the transfer2174 */2175 getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2176 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2177 }2178}217921802181class ChainGroup extends HelperGroup<ChainHelperBase> {2182 /**2183 * Get system properties of a chain2184 * @example getChainProperties();2185 * @returns ss58Format, token decimals, and token symbol2186 */2187 getChainProperties(): IChainProperties {2188 const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2189 return {2190 ss58Format: properties.ss58Format.toJSON(),2191 tokenDecimals: properties.tokenDecimals.toJSON(),2192 tokenSymbol: properties.tokenSymbol.toJSON(),2193 };2194 }21952196 /**2197 * Get chain header2198 * @example getLatestBlockNumber();2199 * @returns the number of the last block2200 */2201 async getLatestBlockNumber(): Promise<number> {2202 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2203 }22042205 /**2206 * Get block hash by block number2207 * @param blockNumber number of block2208 * @example getBlockHashByNumber(12345);2209 * @returns hash of a block2210 */2211 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2212 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2213 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2214 return blockHash;2215 }22162217 // TODO add docs2218 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2219 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2220 if (!blockHash) return null;2221 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2222 }22232224 /**2225 * Get latest relay block2226 * @returns {number} relay block2227 */2228 async getRelayBlockNumber(): Promise<bigint> {2229 const blockNumber = (await this.helper.callRpc('api.query.parachainSystem.validationData')).toJSON().relayParentNumber;2230 return BigInt(blockNumber);2231 }22322233 /**2234 * Get account nonce2235 * @param address substrate address2236 * @example getNonce("5GrwvaEF5zXb26Fz...");2237 * @returns number, account's nonce2238 */2239 async getNonce(address: TSubstrateAccount): Promise<number> {2240 return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2241 }2242}22432244class SubstrateBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2245 /**2246 * Get substrate address balance2247 * @param address substrate address2248 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2249 * @returns amount of tokens on address2250 */2251 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2252 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2253 }22542255 /**2256 * Transfer tokens to substrate address2257 * @param signer keyring of signer2258 * @param address substrate address of a recipient2259 * @param amount amount of tokens to be transfered2260 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2261 * @returns ```true``` if extrinsic success, otherwise ```false```2262 */2263 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2264 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}`*/);22652266 let transfer = {from: null, to: null, amount: 0n} as any;2267 result.result.events.forEach(({event: {data, method, section}}) => {2268 if ((section === 'balances') && (method === 'Transfer')) {2269 transfer = {2270 from: this.helper.address.normalizeSubstrate(data[0]),2271 to: this.helper.address.normalizeSubstrate(data[1]),2272 amount: BigInt(data[2]),2273 };2274 }2275 });2276 const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from2277 && this.helper.address.normalizeSubstrate(address) === transfer.to2278 && BigInt(amount) === transfer.amount;2279 return isSuccess;2280 }22812282 /**2283 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2284 * @param address substrate address2285 * @returns2286 */2287 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2288 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2289 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2290 }22912292 async getLocked(address: TSubstrateAccount): Promise<[{id: string, amount: bigint, reason: string}]> {2293 const locks = (await this.helper.callRpc('api.query.balances.locks', [address])).toHuman();2294 return locks.map((lock: any) => {return {id: lock.id, amount: BigInt(lock.amount.replace(/,/g, '')), reasons: lock.reasons};});2295 }2296}22972298class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2299 /**2300 * Get ethereum address balance2301 * @param address ethereum address2302 * @example getEthereum("0x9F0583DbB855d...")2303 * @returns amount of tokens on address2304 */2305 async getEthereum(address: TEthereumAccount): Promise<bigint> {2306 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2307 }23082309 /**2310 * Transfer tokens to address2311 * @param signer keyring of signer2312 * @param address Ethereum address of a recipient2313 * @param amount amount of tokens to be transfered2314 * @example transferToEthereum(alithKeyring, "0x9F0583DbB855d...", 100_000_000_000n);2315 * @returns ```true``` if extrinsic success, otherwise ```false```2316 */2317 async transferToEthereum(signer: TSigner, address: TEthereumAccount, amount: bigint | string): Promise<boolean> {2318 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true);23192320 let transfer = {from: null, to: null, amount: 0n} as any;2321 result.result.events.forEach(({event: {data, method, section}}) => {2322 if ((section === 'balances') && (method === 'Transfer')) {2323 transfer = {2324 from: data[0].toString(),2325 to: data[1].toString(),2326 amount: BigInt(data[2]),2327 };2328 }2329 });2330 const isSuccess = (typeof signer === 'string' ? signer : signer.address) === transfer.from2331 && address === transfer.to2332 && BigInt(amount) === transfer.amount;2333 return isSuccess;2334 }2335}23362337class BalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2338 subBalanceGroup: SubstrateBalanceGroup<T>;2339 ethBalanceGroup: EthereumBalanceGroup<T>;23402341 constructor(helper: T) {2342 super(helper);2343 this.subBalanceGroup = new SubstrateBalanceGroup(helper);2344 this.ethBalanceGroup = new EthereumBalanceGroup(helper);2345 }23462347 getCollectionCreationPrice(): bigint {2348 return 2n * this.getOneTokenNominal();2349 }2350 /**2351 * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2352 * @example getOneTokenNominal()2353 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2354 */2355 getOneTokenNominal(): bigint {2356 const chainProperties = this.helper.chain.getChainProperties();2357 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2358 }23592360 /**2361 * Get substrate address balance2362 * @param address substrate address2363 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2364 * @returns amount of tokens on address2365 */2366 getSubstrate(address: TSubstrateAccount): Promise<bigint> {2367 return this.subBalanceGroup.getSubstrate(address);2368 }23692370 /**2371 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2372 * @param address substrate address2373 * @returns2374 */2375 getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2376 return this.subBalanceGroup.getSubstrateFull(address);2377 }23782379 /**2380 * Get locked balances2381 * @param address substrate address2382 * @returns locked balances with reason via api.query.balances.locks2383 */2384 getLocked(address: TSubstrateAccount) {2385 return this.subBalanceGroup.getLocked(address);2386 }23872388 /**2389 * Get ethereum address balance2390 * @param address ethereum address2391 * @example getEthereum("0x9F0583DbB855d...")2392 * @returns amount of tokens on address2393 */2394 getEthereum(address: TEthereumAccount): Promise<bigint> {2395 return this.ethBalanceGroup.getEthereum(address);2396 }23972398 /**2399 * Transfer tokens to substrate address2400 * @param signer keyring of signer2401 * @param address substrate address of a recipient2402 * @param amount amount of tokens to be transfered2403 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2404 * @returns ```true``` if extrinsic success, otherwise ```false```2405 */2406 transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2407 return this.subBalanceGroup.transferToSubstrate(signer, address, amount);2408 }24092410 async forceTransferToSubstrate(signer: TSigner, from: TSubstrateAccount, to: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2411 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceTransfer', [from, to, amount], true);24122413 let transfer = {from: null, to: null, amount: 0n} as any;2414 result.result.events.forEach(({event: {data, method, section}}) => {2415 if ((section === 'balances') && (method === 'Transfer')) {2416 transfer = {2417 from: this.helper.address.normalizeSubstrate(data[0]),2418 to: this.helper.address.normalizeSubstrate(data[1]),2419 amount: BigInt(data[2]),2420 };2421 }2422 });2423 let isSuccess = this.helper.address.normalizeSubstrate(from) === transfer.from;2424 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(to) === transfer.to;2425 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2426 return isSuccess;2427 }24282429 /**2430 * Transfer tokens with the unlock period2431 * @param signer signers Keyring2432 * @param address Substrate address of recipient2433 * @param schedule Schedule params2434 * @example vestedTransfer(signer, recepient.address, 20000, 100, 10, 50 * nominal); // total amount of vested tokens will be 100 * 50 = 50002435 */2436 async vestedTransfer(signer: TSigner, address: TSubstrateAccount, schedule: {start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}): Promise<void> {2437 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.vestedTransfer', [address, schedule]);2438 const event = result.result.events2439 .find(e => e.event.section === 'vesting' &&2440 e.event.method === 'VestingScheduleAdded' &&2441 e.event.data[0].toHuman() === signer.address);2442 if (!event) throw Error('Cannot find transfer in events');2443 }24442445 /**2446 * Get schedule for recepient of vested transfer2447 * @param address Substrate address of recipient2448 * @returns2449 */2450 async getVestingSchedules(address: TSubstrateAccount): Promise<{start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}[]> {2451 const schedule = (await this.helper.callRpc('api.query.vesting.vestingSchedules', [address])).toJSON();2452 return schedule.map((schedule: any) => {2453 return {2454 start: BigInt(schedule.start),2455 period: BigInt(schedule.period),2456 periodCount: BigInt(schedule.periodCount),2457 perPeriod: BigInt(schedule.perPeriod),2458 };2459 });2460 }24612462 /**2463 * Claim vested tokens2464 * @param signer signers Keyring2465 */2466 async claim(signer: TSigner) {2467 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.claim', []);2468 const event = result.result.events2469 .find(e => e.event.section === 'vesting' &&2470 e.event.method === 'Claimed' &&2471 e.event.data[0].toHuman() === signer.address);2472 if (!event) throw Error('Cannot find claim in events');2473 }2474}24752476class AddressGroup extends HelperGroup<ChainHelperBase> {2477 /**2478 * Normalizes the address to the specified ss58 format, by default ```42```.2479 * @param address substrate address2480 * @param ss58Format format for address conversion, by default ```42```2481 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2482 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2483 */2484 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2485 return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2486 }24872488 /**2489 * Get address in the connected chain format2490 * @param address substrate address2491 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2492 * @returns address in chain format2493 */2494 normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2495 return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2496 }24972498 /**2499 * Get substrate mirror of an ethereum address2500 * @param ethAddress ethereum address2501 * @param toChainFormat false for normalized account2502 * @example ethToSubstrate('0x9F0583DbB855d...')2503 * @returns substrate mirror of a provided ethereum address2504 */2505 ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2506 return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2507 }25082509 /**2510 * Get ethereum mirror of a substrate address2511 * @param subAddress substrate account2512 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2513 * @returns ethereum mirror of a provided substrate address2514 */2515 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2516 return CrossAccountId.translateSubToEth(subAddress);2517 }25182519 /**2520 * Encode key to substrate address2521 * @param key key for encoding address2522 * @param ss58Format prefix for encoding to the address of the corresponding network2523 * @returns encoded substrate address2524 */2525 encodeSubstrateAddress (key: Uint8Array | string | bigint, ss58Format = 42): string {2526 const u8a :Uint8Array = typeof key === 'string'2527 ? hexToU8a(key)2528 : typeof key === 'bigint'2529 ? hexToU8a(key.toString(16))2530 : key;25312532 if (ss58Format < 0 || ss58Format > 16383 || [46, 47].includes(ss58Format)) {2533 throw new Error(`ss58Format is not valid, received ${typeofss58Format} "${ss58Format}"`);2534 }25352536 const allowedDecodedLengths = [1, 2, 4, 8, 32, 33];2537 if (!allowedDecodedLengths.includes(u8a.length)) {2538 throw new Error(`key length is not valid, received ${u8a.length}, valid values are ${allowedDecodedLengths.join(', ')}`);2539 }25402541 const u8aPrefix = ss58Format < 642542 ? new Uint8Array([ss58Format])2543 : new Uint8Array([2544 ((ss58Format & 0xfc) >> 2) | 0x40,2545 (ss58Format >> 8) | ((ss58Format & 0x03) << 6),2546 ]);25472548 const input = u8aConcat(u8aPrefix, u8a);25492550 return base58Encode(u8aConcat(2551 input,2552 blake2AsU8a(input).subarray(0, [32, 33].includes(u8a.length) ? 2 : 1),2553 ));2554 }25552556 /**2557 * Restore substrate address from bigint representation2558 * @param number decimal representation of substrate address2559 * @returns substrate address2560 */2561 restoreCrossAccountFromBigInt(number: bigint): TSubstrateAccount {2562 if (this.helper.api === null) {2563 throw 'Not connected';2564 }2565 const res = this.helper.api.registry.createType('AccountId', '0x' + number.toString(16).padStart(64, '0')).toJSON();2566 if (res === undefined || res === null) {2567 throw 'Restore address error';2568 }2569 return res.toString();2570 }25712572 /**2573 * Convert etherium cross account id to substrate cross account id2574 * @param ethCrossAccount etherium cross account2575 * @returns substrate cross account id2576 */2577 convertCrossAccountFromEthCrossAccount(ethCrossAccount: IEthCrossAccountId): ICrossAccountId {2578 if (ethCrossAccount.sub === '0') {2579 return {Ethereum: ethCrossAccount.eth.toLocaleLowerCase()};2580 }25812582 const ss58 = this.restoreCrossAccountFromBigInt(BigInt(ethCrossAccount.sub));2583 return {Substrate: ss58};2584 }25852586 paraSiblingSovereignAccount(paraid: number) {2587 // We are getting a *sibling* parachain sovereign account,2588 // so we need a sibling prefix: encoded(b"sibl") == 0x7369626c2589 const siblingPrefix = '0x7369626c';25902591 const encodedParaId = this.helper.getApi().createType('u32', paraid).toHex(true).substring(2);2592 const suffix = '000000000000000000000000000000000000000000000000';25932594 return siblingPrefix + encodedParaId + suffix;2595 }2596}25972598class StakingGroup extends HelperGroup<UniqueHelper> {2599 /**2600 * Stake tokens for App Promotion2601 * @param signer keyring of signer2602 * @param amountToStake amount of tokens to stake2603 * @param label extra label for log2604 * @returns2605 */2606 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2607 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2608 const _stakeResult = await this.helper.executeExtrinsic(2609 signer, 'api.tx.appPromotion.stake',2610 [amountToStake], true,2611 );2612 // TODO extract info from stakeResult2613 return true;2614 }26152616 /**2617 * Unstake tokens for App Promotion2618 * @param signer keyring of signer2619 * @param amountToUnstake amount of tokens to unstake2620 * @param label extra label for log2621 * @returns block number where balances will be unlocked2622 */2623 async unstake(signer: TSigner, label?: string): Promise<number> {2624 if(typeof label === 'undefined') label = `${signer.address}`;2625 const _unstakeResult = await this.helper.executeExtrinsic(2626 signer, 'api.tx.appPromotion.unstake',2627 [], true,2628 );2629 // TODO extract block number fron events2630 return 1;2631 }26322633 /**2634 * Get total staked amount for address2635 * @param address substrate or ethereum address2636 * @returns total staked amount2637 */2638 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2639 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2640 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2641 }26422643 /**2644 * Get total staked per block2645 * @param address substrate or ethereum address2646 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2647 */2648 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2649 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2650 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2651 return {2652 block: block.toBigInt(),2653 amount: amount.toBigInt(),2654 };2655 });2656 }26572658 /**2659 * Get total pending unstake amount for address2660 * @param address substrate or ethereum address2661 * @returns total pending unstake amount2662 */2663 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2664 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2665 }26662667 /**2668 * Get pending unstake amount per block for address2669 * @param address substrate or ethereum address2670 * @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 block2671 */2672 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2673 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2674 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2675 return {2676 block: block.toBigInt(),2677 amount: amount.toBigInt(),2678 };2679 });2680 return result;2681 }2682}26832684class SchedulerGroup extends HelperGroup<UniqueHelper> {2685 constructor(helper: UniqueHelper) {2686 super(helper);2687 }26882689 cancelScheduled(signer: TSigner, scheduledId: string) {2690 return this.helper.executeExtrinsic(2691 signer,2692 'api.tx.scheduler.cancelNamed',2693 [scheduledId],2694 true,2695 );2696 }26972698 changePriority(signer: TSigner, scheduledId: string, priority: number) {2699 return this.helper.executeExtrinsic(2700 signer,2701 'api.tx.scheduler.changeNamedPriority',2702 [scheduledId, priority],2703 true,2704 );2705 }27062707 scheduleAt<T extends UniqueHelper>(2708 executionBlockNumber: number,2709 options: ISchedulerOptions = {},2710 ) {2711 return this.schedule<T>('schedule', executionBlockNumber, options);2712 }27132714 scheduleAfter<T extends UniqueHelper>(2715 blocksBeforeExecution: number,2716 options: ISchedulerOptions = {},2717 ) {2718 return this.schedule<T>('scheduleAfter', blocksBeforeExecution, options);2719 }27202721 schedule<T extends UniqueHelper>(2722 scheduleFn: 'schedule' | 'scheduleAfter',2723 blocksNum: number,2724 options: ISchedulerOptions = {},2725 ) {2726 // eslint-disable-next-line @typescript-eslint/naming-convention2727 const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2728 return this.helper.clone(ScheduledHelperType, {2729 scheduleFn,2730 blocksNum,2731 options,2732 }) as T;2733 }2734}27352736class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {2737 async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {2738 await this.helper.executeExtrinsic(2739 signer,2740 'api.tx.foreignAssets.registerForeignAsset',2741 [ownerAddress, location, metadata],2742 true,2743 );2744 }27452746 async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {2747 await this.helper.executeExtrinsic(2748 signer,2749 'api.tx.foreignAssets.updateForeignAsset',2750 [foreignAssetId, location, metadata],2751 true,2752 );2753 }2754}27552756class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {2757 palletName: string;27582759 constructor(helper: T, palletName: string) {2760 super(helper);27612762 this.palletName = palletName;2763 }27642765 async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: any) {2766 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, weightLimit], true);2767 }27682769 async teleportAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number) {2770 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.teleportAssets`, [destination, beneficiary, assets, feeAssetItem], true);2771 }27722773 async teleportNativeAsset(signer: TSigner, destinationParaId: number, targetAccount: Uint8Array, amount: bigint) {2774 const destination = {2775 V1: {2776 parents: 0,2777 interior: {2778 X1: {2779 Parachain: destinationParaId,2780 },2781 },2782 },2783 };27842785 const beneficiary = {2786 V1: {2787 parents: 0,2788 interior: {2789 X1: {2790 AccountId32: {2791 network: 'Any',2792 id: targetAccount,2793 },2794 },2795 },2796 },2797 };27982799 const assets = {2800 V1: [2801 {2802 id: {2803 Concrete: {2804 parents: 0,2805 interior: 'Here',2806 },2807 },2808 fun: {2809 Fungible: amount,2810 },2811 },2812 ],2813 };28142815 const feeAssetItem = 0;28162817 await this.teleportAssets(signer, destination, beneficiary, assets, feeAssetItem);2818 }2819}28202821class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2822 async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: any) {2823 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);2824 }28252826 async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: any) {2827 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);2828 }28292830 async transferMulticurrencies(signer: TSigner, currencies: any[], feeItem: number, destLocation: any, destWeight: any) {2831 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMulticurrencies', [currencies, feeItem, destLocation, destWeight], true);2832 }2833}28342835class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2836 async accounts(address: string, currencyId: any) {2837 const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;2838 return BigInt(free);2839 }2840}28412842class AssetsGroup<T extends ChainHelperBase> extends HelperGroup<T> {2843 async create(signer: TSigner, assetId: number, admin: string, minimalBalance: bigint) {2844 await this.helper.executeExtrinsic(signer, 'api.tx.assets.create', [assetId, admin, minimalBalance], true);2845 }28462847 async setMetadata(signer: TSigner, assetId: number, name: string, symbol: string, decimals: number) {2848 await this.helper.executeExtrinsic(signer, 'api.tx.assets.setMetadata', [assetId, name, symbol, decimals], true);2849 }28502851 async mint(signer: TSigner, assetId: number, beneficiary: string, amount: bigint) {2852 await this.helper.executeExtrinsic(signer, 'api.tx.assets.mint', [assetId, beneficiary, amount], true);2853 }28542855 async account(assetId: string | number, address: string) {2856 const accountAsset = (2857 await this.helper.callRpc('api.query.assets.account', [assetId, address])2858 ).toJSON()! as any;28592860 if (accountAsset !== null) {2861 return BigInt(accountAsset['balance']);2862 } else {2863 return null;2864 }2865 }2866}28672868class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {2869 async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {2870 await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);2871 }2872}28732874class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {2875 makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {2876 const apiPrefix = 'api.tx.assetManager.';28772878 const registerTx = this.helper.constructApiCall(2879 apiPrefix + 'registerForeignAsset',2880 [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],2881 );28822883 const setUnitsTx = this.helper.constructApiCall(2884 apiPrefix + 'setAssetUnitsPerSecond',2885 [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],2886 );28872888 const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);2889 const encodedProposal = batchCall?.method.toHex() || '';2890 return encodedProposal;2891 }28922893 async assetTypeId(location: any) {2894 return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);2895 }2896}28972898class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {2899 notePreimagePallet: string;29002901 constructor(helper: MoonbeamHelper, options: {[key: string]: any} = {}) {2902 super(helper);2903 this.notePreimagePallet = options.notePreimagePallet;2904 }29052906 async notePreimage(signer: TSigner, encodedProposal: string) {2907 await this.helper.executeExtrinsic(signer, `api.tx.${this.notePreimagePallet}.notePreimage`, [encodedProposal], true);2908 }29092910 externalProposeMajority(proposal: any) {2911 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposal]);2912 }29132914 fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {2915 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);2916 }29172918 async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {2919 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);2920 }2921}29222923class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {2924 collective: string;29252926 constructor(helper: MoonbeamHelper, collective: string) {2927 super(helper);29282929 this.collective = collective;2930 }29312932 async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {2933 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);2934 }29352936 async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {2937 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);2938 }29392940 async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: any, lengthBound: number) {2941 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);2942 }29432944 async proposalCount() {2945 return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));2946 }2947}29482949export type ChainHelperBaseConstructor = new(...args: any[]) => ChainHelperBase;2950export type UniqueHelperConstructor = new(...args: any[]) => UniqueHelper;29512952export class UniqueHelper extends ChainHelperBase {2953 balance: BalanceGroup<UniqueHelper>;2954 collection: CollectionGroup;2955 nft: NFTGroup;2956 rft: RFTGroup;2957 ft: FTGroup;2958 staking: StakingGroup;2959 scheduler: SchedulerGroup;2960 foreignAssets: ForeignAssetsGroup;2961 xcm: XcmGroup<UniqueHelper>;2962 xTokens: XTokensGroup<UniqueHelper>;2963 tokens: TokensGroup<UniqueHelper>;29642965 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2966 super(logger, options.helperBase ?? UniqueHelper);29672968 this.balance = new BalanceGroup(this);2969 this.collection = new CollectionGroup(this);2970 this.nft = new NFTGroup(this);2971 this.rft = new RFTGroup(this);2972 this.ft = new FTGroup(this);2973 this.staking = new StakingGroup(this);2974 this.scheduler = new SchedulerGroup(this);2975 this.foreignAssets = new ForeignAssetsGroup(this);2976 this.xcm = new XcmGroup(this, 'polkadotXcm');2977 this.xTokens = new XTokensGroup(this);2978 this.tokens = new TokensGroup(this);2979 }29802981 getSudo<T extends UniqueHelper>() {2982 // eslint-disable-next-line @typescript-eslint/naming-convention2983 const SudoHelperType = SudoHelper(this.helperBase);2984 return this.clone(SudoHelperType) as T;2985 }2986}29872988export class XcmChainHelper extends ChainHelperBase {2989 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {2990 const wsProvider = new WsProvider(wsEndpoint);2991 this.api = new ApiPromise({2992 provider: wsProvider,2993 });2994 await this.api.isReadyOrError;2995 this.network = await UniqueHelper.detectNetwork(this.api);2996 }2997}29982999export class RelayHelper extends XcmChainHelper {3000 balance: SubstrateBalanceGroup<RelayHelper>;3001 xcm: XcmGroup<RelayHelper>;30023003 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3004 super(logger, options.helperBase ?? RelayHelper);30053006 this.balance = new SubstrateBalanceGroup(this);3007 this.xcm = new XcmGroup(this, 'xcmPallet');3008 }3009}30103011export class WestmintHelper extends XcmChainHelper {3012 balance: SubstrateBalanceGroup<WestmintHelper>;3013 xcm: XcmGroup<WestmintHelper>;3014 assets: AssetsGroup<WestmintHelper>;3015 xTokens: XTokensGroup<WestmintHelper>;30163017 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3018 super(logger, options.helperBase ?? WestmintHelper);30193020 this.balance = new SubstrateBalanceGroup(this);3021 this.xcm = new XcmGroup(this, 'polkadotXcm');3022 this.assets = new AssetsGroup(this);3023 this.xTokens = new XTokensGroup(this);3024 }3025}30263027export class MoonbeamHelper extends XcmChainHelper {3028 balance: EthereumBalanceGroup<MoonbeamHelper>;3029 assetManager: MoonbeamAssetManagerGroup;3030 assets: AssetsGroup<MoonbeamHelper>;3031 xTokens: XTokensGroup<MoonbeamHelper>;3032 democracy: MoonbeamDemocracyGroup;3033 collective: {3034 council: MoonbeamCollectiveGroup,3035 techCommittee: MoonbeamCollectiveGroup,3036 };30373038 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3039 super(logger, options.helperBase ?? MoonbeamHelper);30403041 this.balance = new EthereumBalanceGroup(this);3042 this.assetManager = new MoonbeamAssetManagerGroup(this);3043 this.assets = new AssetsGroup(this);3044 this.xTokens = new XTokensGroup(this);3045 this.democracy = new MoonbeamDemocracyGroup(this, options);3046 this.collective = {3047 council: new MoonbeamCollectiveGroup(this, 'councilCollective'),3048 techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),3049 };3050 }3051}30523053export class AcalaHelper extends XcmChainHelper {3054 balance: SubstrateBalanceGroup<AcalaHelper>;3055 assetRegistry: AcalaAssetRegistryGroup;3056 xTokens: XTokensGroup<AcalaHelper>;3057 tokens: TokensGroup<AcalaHelper>;30583059 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3060 super(logger, options.helperBase ?? AcalaHelper);30613062 this.balance = new SubstrateBalanceGroup(this);3063 this.assetRegistry = new AcalaAssetRegistryGroup(this);3064 this.xTokens = new XTokensGroup(this);3065 this.tokens = new TokensGroup(this);3066 }30673068 getSudo<T extends AcalaHelper>() {3069 // eslint-disable-next-line @typescript-eslint/naming-convention3070 const SudoHelperType = SudoHelper(this.helperBase);3071 return this.clone(SudoHelperType) as T;3072 }3073}30743075// eslint-disable-next-line @typescript-eslint/naming-convention3076function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {3077 return class extends Base {3078 scheduleFn: 'schedule' | 'scheduleAfter';3079 blocksNum: number;3080 options: ISchedulerOptions;30813082 constructor(...args: any[]) {3083 const logger = args[0] as ILogger;3084 const options = args[1] as {3085 scheduleFn: 'schedule' | 'scheduleAfter',3086 blocksNum: number,3087 options: ISchedulerOptions3088 };30893090 super(logger);30913092 this.scheduleFn = options.scheduleFn;3093 this.blocksNum = options.blocksNum;3094 this.options = options.options;3095 }30963097 executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {3098 const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);30993100 const mandatorySchedArgs = [3101 this.blocksNum,3102 this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,3103 this.options.priority ?? null,3104 scheduledTx,3105 ];31063107 let schedArgs;3108 let scheduleFn;31093110 if (this.options.scheduledId) {3111 schedArgs = [this.options.scheduledId!, ...mandatorySchedArgs];31123113 if (this.scheduleFn == 'schedule') {3114 scheduleFn = 'scheduleNamed';3115 } else if (this.scheduleFn == 'scheduleAfter') {3116 scheduleFn = 'scheduleNamedAfter';3117 }3118 } else {3119 schedArgs = mandatorySchedArgs;3120 scheduleFn = this.scheduleFn;3121 }31223123 const extrinsic = 'api.tx.scheduler.' + scheduleFn;31243125 return super.executeExtrinsic(3126 sender,3127 extrinsic,3128 schedArgs,3129 expectSuccess,3130 );3131 }3132 };3133}31343135// eslint-disable-next-line @typescript-eslint/naming-convention3136function SudoHelper<T extends ChainHelperBaseConstructor>(Base: T) {3137 return class extends Base {3138 constructor(...args: any[]) {3139 super(...args);3140 }31413142 executeExtrinsic (3143 sender: IKeyringPair,3144 extrinsic: string,3145 params: any[],3146 expectSuccess?: boolean,3147 ): Promise<ITransactionResult> {3148 const call = this.constructApiCall(extrinsic, params);3149 return super.executeExtrinsic(3150 sender,3151 'api.tx.sudo.sudo',3152 [call],3153 expectSuccess,3154 );3155 }3156 };3157}31583159export class UniqueBaseCollection {3160 helper: UniqueHelper;3161 collectionId: number;31623163 constructor(collectionId: number, uniqueHelper: UniqueHelper) {3164 this.collectionId = collectionId;3165 this.helper = uniqueHelper;3166 }31673168 async getData() {3169 return await this.helper.collection.getData(this.collectionId);3170 }31713172 async getLastTokenId() {3173 return await this.helper.collection.getLastTokenId(this.collectionId);3174 }31753176 async doesTokenExist(tokenId: number) {3177 return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);3178 }31793180 async getAdmins() {3181 return await this.helper.collection.getAdmins(this.collectionId);3182 }31833184 async getAllowList() {3185 return await this.helper.collection.getAllowList(this.collectionId);3186 }31873188 async getEffectiveLimits() {3189 return await this.helper.collection.getEffectiveLimits(this.collectionId);3190 }31913192 async getProperties(propertyKeys?: string[] | null) {3193 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);3194 }31953196 async getPropertiesConsumedSpace() {3197 return await this.helper.collection.getPropertiesConsumedSpace(this.collectionId);3198 }31993200 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {3201 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);3202 }32033204 async getOptions() {3205 return await this.helper.collection.getCollectionOptions(this.collectionId);3206 }32073208 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {3209 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);3210 }32113212 async confirmSponsorship(signer: TSigner) {3213 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);3214 }32153216 async removeSponsor(signer: TSigner) {3217 return await this.helper.collection.removeSponsor(signer, this.collectionId);3218 }32193220 async setLimits(signer: TSigner, limits: ICollectionLimits) {3221 return await this.helper.collection.setLimits(signer, this.collectionId, limits);3222 }32233224 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {3225 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);3226 }32273228 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3229 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);3230 }32313232 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {3233 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);3234 }32353236 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {3237 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);3238 }32393240 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3241 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);3242 }32433244 async setProperties(signer: TSigner, properties: IProperty[]) {3245 return await this.helper.collection.setProperties(signer, this.collectionId, properties);3246 }32473248 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3249 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);3250 }32513252 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {3253 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);3254 }32553256 async enableNesting(signer: TSigner, permissions: INestingPermissions) {3257 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);3258 }32593260 async disableNesting(signer: TSigner) {3261 return await this.helper.collection.disableNesting(signer, this.collectionId);3262 }32633264 async burn(signer: TSigner) {3265 return await this.helper.collection.burn(signer, this.collectionId);3266 }32673268 scheduleAt<T extends UniqueHelper>(3269 executionBlockNumber: number,3270 options: ISchedulerOptions = {},3271 ) {3272 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3273 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3274 }32753276 scheduleAfter<T extends UniqueHelper>(3277 blocksBeforeExecution: number,3278 options: ISchedulerOptions = {},3279 ) {3280 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3281 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3282 }32833284 getSudo<T extends UniqueHelper>() {3285 return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());3286 }3287}328832893290export class UniqueNFTCollection extends UniqueBaseCollection {3291 getTokenObject(tokenId: number) {3292 return new UniqueNFToken(tokenId, this);3293 }32943295 async getTokensByAddress(addressObj: ICrossAccountId) {3296 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);3297 }32983299 async getToken(tokenId: number, blockHashAt?: string) {3300 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);3301 }33023303 async getTokenOwner(tokenId: number, blockHashAt?: string) {3304 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);3305 }33063307 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {3308 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);3309 }33103311 async getTokenChildren(tokenId: number, blockHashAt?: string) {3312 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);3313 }33143315 async getPropertyPermissions(propertyKeys: string[] | null = null) {3316 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);3317 }33183319 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3320 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3321 }33223323 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3324 const api = this.helper.getApi();3325 const props = (await api.query.nonfungible.tokenProperties(this.collectionId, tokenId)).toJSON();33263327 return (props! as any).consumedSpace;3328 }33293330 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {3331 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);3332 }33333334 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3335 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);3336 }33373338 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {3339 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);3340 }33413342 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {3343 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);3344 }33453346 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3347 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});3348 }33493350 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {3351 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);3352 }33533354 async burnToken(signer: TSigner, tokenId: number) {3355 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);3356 }33573358 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {3359 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);3360 }33613362 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3363 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);3364 }33653366 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3367 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3368 }33693370 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3371 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3372 }33733374 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {3375 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);3376 }33773378 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3379 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);3380 }33813382 scheduleAt<T extends UniqueHelper>(3383 executionBlockNumber: number,3384 options: ISchedulerOptions = {},3385 ) {3386 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3387 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3388 }33893390 scheduleAfter<T extends UniqueHelper>(3391 blocksBeforeExecution: number,3392 options: ISchedulerOptions = {},3393 ) {3394 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3395 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3396 }33973398 getSudo<T extends UniqueHelper>() {3399 return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());3400 }3401}340234033404export class UniqueRFTCollection extends UniqueBaseCollection {3405 getTokenObject(tokenId: number) {3406 return new UniqueRFToken(tokenId, this);3407 }34083409 async getToken(tokenId: number, blockHashAt?: string) {3410 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);3411 }34123413 async getTokensByAddress(addressObj: ICrossAccountId) {3414 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);3415 }34163417 async getTop10TokenOwners(tokenId: number) {3418 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);3419 }34203421 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {3422 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);3423 }34243425 async getTokenTotalPieces(tokenId: number) {3426 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);3427 }34283429 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3430 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);3431 }34323433 async getPropertyPermissions(propertyKeys: string[] | null = null) {3434 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);3435 }34363437 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3438 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3439 }34403441 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3442 const api = this.helper.getApi();3443 const props = (await api.query.refungible.tokenProperties(this.collectionId, tokenId)).toJSON();34443445 return (props! as any).consumedSpace;3446 }34473448 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {3449 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);3450 }34513452 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3453 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);3454 }34553456 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {3457 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);3458 }34593460 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {3461 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);3462 }34633464 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3465 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});3466 }34673468 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {3469 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);3470 }34713472 async burnToken(signer: TSigner, tokenId: number, amount=1n) {3473 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);3474 }34753476 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n) {3477 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);3478 }34793480 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3481 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);3482 }34833484 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3485 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3486 }34873488 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3489 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3490 }34913492 scheduleAt<T extends UniqueHelper>(3493 executionBlockNumber: number,3494 options: ISchedulerOptions = {},3495 ) {3496 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3497 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3498 }34993500 scheduleAfter<T extends UniqueHelper>(3501 blocksBeforeExecution: number,3502 options: ISchedulerOptions = {},3503 ) {3504 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3505 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3506 }35073508 getSudo<T extends UniqueHelper>() {3509 return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());3510 }3511}351235133514export class UniqueFTCollection extends UniqueBaseCollection {3515 async getBalance(addressObj: ICrossAccountId) {3516 return await this.helper.ft.getBalance(this.collectionId, addressObj);3517 }35183519 async getTotalPieces() {3520 return await this.helper.ft.getTotalPieces(this.collectionId);3521 }35223523 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3524 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);3525 }35263527 async getTop10Owners() {3528 return await this.helper.ft.getTop10Owners(this.collectionId);3529 }35303531 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {3532 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);3533 }35343535 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {3536 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);3537 }35383539 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3540 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);3541 }35423543 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3544 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);3545 }35463547 async burnTokens(signer: TSigner, amount=1n) {3548 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);3549 }35503551 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3552 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);3553 }35543555 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3556 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);3557 }35583559 scheduleAt<T extends UniqueHelper>(3560 executionBlockNumber: number,3561 options: ISchedulerOptions = {},3562 ) {3563 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3564 return new UniqueFTCollection(this.collectionId, scheduledHelper);3565 }35663567 scheduleAfter<T extends UniqueHelper>(3568 blocksBeforeExecution: number,3569 options: ISchedulerOptions = {},3570 ) {3571 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3572 return new UniqueFTCollection(this.collectionId, scheduledHelper);3573 }35743575 getSudo<T extends UniqueHelper>() {3576 return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());3577 }3578}357935803581export class UniqueBaseToken {3582 collection: UniqueNFTCollection | UniqueRFTCollection;3583 collectionId: number;3584 tokenId: number;35853586 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {3587 this.collection = collection;3588 this.collectionId = collection.collectionId;3589 this.tokenId = tokenId;3590 }35913592 async getNextSponsored(addressObj: ICrossAccountId) {3593 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);3594 }35953596 async getProperties(propertyKeys?: string[] | null) {3597 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);3598 }35993600 async getTokenPropertiesConsumedSpace() {3601 return await this.collection.getTokenPropertiesConsumedSpace(this.tokenId);3602 }36033604 async setProperties(signer: TSigner, properties: IProperty[]) {3605 return await this.collection.setTokenProperties(signer, this.tokenId, properties);3606 }36073608 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3609 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);3610 }36113612 async doesExist() {3613 return await this.collection.doesTokenExist(this.tokenId);3614 }36153616 nestingAccount() {3617 return this.collection.helper.util.getTokenAccount(this);3618 }36193620 scheduleAt<T extends UniqueHelper>(3621 executionBlockNumber: number,3622 options: ISchedulerOptions = {},3623 ) {3624 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3625 return new UniqueBaseToken(this.tokenId, scheduledCollection);3626 }36273628 scheduleAfter<T extends UniqueHelper>(3629 blocksBeforeExecution: number,3630 options: ISchedulerOptions = {},3631 ) {3632 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3633 return new UniqueBaseToken(this.tokenId, scheduledCollection);3634 }36353636 getSudo<T extends UniqueHelper>() {3637 return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());3638 }3639}364036413642export class UniqueNFToken extends UniqueBaseToken {3643 collection: UniqueNFTCollection;36443645 constructor(tokenId: number, collection: UniqueNFTCollection) {3646 super(tokenId, collection);3647 this.collection = collection;3648 }36493650 async getData(blockHashAt?: string) {3651 return await this.collection.getToken(this.tokenId, blockHashAt);3652 }36533654 async getOwner(blockHashAt?: string) {3655 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);3656 }36573658 async getTopmostOwner(blockHashAt?: string) {3659 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);3660 }36613662 async getChildren(blockHashAt?: string) {3663 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);3664 }36653666 async nest(signer: TSigner, toTokenObj: IToken) {3667 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);3668 }36693670 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3671 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);3672 }36733674 async transfer(signer: TSigner, addressObj: ICrossAccountId) {3675 return await this.collection.transferToken(signer, this.tokenId, addressObj);3676 }36773678 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3679 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);3680 }36813682 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {3683 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);3684 }36853686 async isApproved(toAddressObj: ICrossAccountId) {3687 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);3688 }36893690 async burn(signer: TSigner) {3691 return await this.collection.burnToken(signer, this.tokenId);3692 }36933694 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {3695 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);3696 }36973698 scheduleAt<T extends UniqueHelper>(3699 executionBlockNumber: number,3700 options: ISchedulerOptions = {},3701 ) {3702 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3703 return new UniqueNFToken(this.tokenId, scheduledCollection);3704 }37053706 scheduleAfter<T extends UniqueHelper>(3707 blocksBeforeExecution: number,3708 options: ISchedulerOptions = {},3709 ) {3710 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3711 return new UniqueNFToken(this.tokenId, scheduledCollection);3712 }37133714 getSudo<T extends UniqueHelper>() {3715 return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());3716 }3717}37183719export class UniqueRFToken extends UniqueBaseToken {3720 collection: UniqueRFTCollection;37213722 constructor(tokenId: number, collection: UniqueRFTCollection) {3723 super(tokenId, collection);3724 this.collection = collection;3725 }37263727 async getData(blockHashAt?: string) {3728 return await this.collection.getToken(this.tokenId, blockHashAt);3729 }37303731 async getTop10Owners() {3732 return await this.collection.getTop10TokenOwners(this.tokenId);3733 }37343735 async getBalance(addressObj: ICrossAccountId) {3736 return await this.collection.getTokenBalance(this.tokenId, addressObj);3737 }37383739 async getTotalPieces() {3740 return await this.collection.getTokenTotalPieces(this.tokenId);3741 }37423743 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {3744 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);3745 }37463747 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {3748 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);3749 }37503751 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3752 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);3753 }37543755 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3756 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);3757 }37583759 async repartition(signer: TSigner, amount: bigint) {3760 return await this.collection.repartitionToken(signer, this.tokenId, amount);3761 }37623763 async burn(signer: TSigner, amount=1n) {3764 return await this.collection.burnToken(signer, this.tokenId, amount);3765 }37663767 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3768 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);3769 }37703771 scheduleAt<T extends UniqueHelper>(3772 executionBlockNumber: number,3773 options: ISchedulerOptions = {},3774 ) {3775 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3776 return new UniqueRFToken(this.tokenId, scheduledCollection);3777 }37783779 scheduleAfter<T extends UniqueHelper>(3780 blocksBeforeExecution: number,3781 options: ISchedulerOptions = {},3782 ) {3783 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3784 return new UniqueRFToken(this.tokenId, scheduledCollection);3785 }37863787 getSudo<T extends UniqueHelper>() {3788 return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());3789 }3790}