difftreelog
test forbid creating ApiPromise without set endpoint
in: master
4 files changed
tests/src/.outdated/substrate/substrate-api.tsdiffbeforeafterboth--- a/tests/src/.outdated/substrate/substrate-api.ts
+++ b/tests/src/.outdated/substrate/substrate-api.ts
@@ -71,6 +71,7 @@
export async function getApiConnection(settings: ApiOptions | undefined = undefined): Promise<ApiPromise> {
settings = settings || defaultApiOptions();
+ if(!settings.provider) throw new Error('provider was not set');
const api = new ApiPromise(settings);
if (api) {
tests/src/eth/createCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createCollection.test.ts
+++ b/tests/src/eth/createCollection.test.ts
@@ -217,7 +217,8 @@
const collection = helper.nft.getCollectionObject(collectionId);
const data = (await collection.getData())!;
- expect(collectionCountAfter - collectionCountBefore).to.be.eq(1);
+ // Parallel test safety
+ expect(collectionCountAfter - collectionCountBefore).to.be.gte(1);
expect(collectionId).to.be.eq(collectionCountAfter);
expect(data.name).to.be.eq(name);
expect(data.description).to.be.eq(description);
tests/src/util/playgrounds/unique.dev.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/unique.dev.ts
+++ b/tests/src/util/playgrounds/unique.dev.ts
@@ -278,6 +278,7 @@
}
async connect(wsEndpoint: string, _listeners?: any): Promise<void> {
+ if(!wsEndpoint) throw new Error('wsEndpoint was not set');
const wsProvider = new WsProvider(wsEndpoint);
this.api = new ApiPromise({
provider: wsProvider,
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 {SignerOptions} from '@polkadot/api/types/submittable';10import '../../interfaces/augment-api';11import {AugmentedSubmittables} from '@polkadot/api-base/types/submittable';12import {ApiInterfaceEvents} from '@polkadot/api/types';13import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm, base58Encode, blake2AsU8a, blake2AsHex} from '@polkadot/util-crypto';14import {IKeyringPair} from '@polkadot/types/types';15import {hexToU8a} from '@polkadot/util/hex';16import {u8aConcat} from '@polkadot/util/u8a';17import {18 IApiListeners,19 IBlock,20 IEvent,21 IChainProperties,22 ICollectionCreationOptions,23 ICollectionLimits,24 ICollectionPermissions,25 ICrossAccountId,26 ICrossAccountIdLower,27 ILogger,28 INestingPermissions,29 IProperty,30 IStakingInfo,31 ISchedulerOptions,32 ISubstrateBalance,33 IToken,34 ITokenPropertyPermission,35 ITransactionResult,36 IUniqueHelperLog,37 TApiAllowedListeners,38 TEthereumAccount,39 TSigner,40 TSubstrateAccount,41 TNetworks,42 IForeignAssetMetadata,43 AcalaAssetMetadata,44 MoonbeamAssetInfo,45 DemocracyStandardAccountVote,46 IEthCrossAccountId,47 IPhasicEvent,48} from './types';49import {RuntimeDispatchInfo} from '@polkadot/types/interfaces';50import type {Vec} from '@polkadot/types-codec';51import {FrameSystemEventRecord, PalletDemocracyConviction} from '@polkadot/types/lookup';5253export class CrossAccountId {54 Substrate!: TSubstrateAccount;55 Ethereum!: TEthereumAccount;5657 constructor(account: ICrossAccountId) {58 if('Substrate' in account) this.Substrate = account.Substrate;59 else this.Ethereum = account.Ethereum;60 }6162 static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {63 switch (domain) {64 case 'Substrate': return new CrossAccountId({Substrate: account.address});65 case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();66 }67 }6869 static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {70 if('substrate' in address) return new CrossAccountId({Substrate: address.substrate});71 else return new CrossAccountId({Ethereum: address.ethereum});72 }7374 static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {75 return encodeAddress(decodeAddress(address), ss58Format);76 }7778 static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {79 return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});80 }8182 withNormalizedSubstrate(ss58Format = 42): CrossAccountId {83 if(this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);84 return this;85 }8687 static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {88 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));89 }9091 toEthereum(): CrossAccountId {92 if(this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});93 return this;94 }9596 static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {97 return evmToAddress(address, ss58Format);98 }99100 toSubstrate(ss58Format?: number): CrossAccountId {101 if(this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});102 return this;103 }104105 toLowerCase(): CrossAccountId {106 if(this.Substrate) this.Substrate = this.Substrate.toLowerCase();107 if(this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();108 return this;109 }110}111112const nesting = {113 toChecksumAddress(address: string): string {114 if(typeof address === 'undefined') return '';115116 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);117118 address = address.toLowerCase().replace(/^0x/i, '');119 const addressHash = keccakAsHex(address).replace(/^0x/i, '');120 const checksumAddress = ['0x'];121122 for(let i = 0; i < address.length; i++) {123 // If ith character is 8 to f then make it uppercase124 if(parseInt(addressHash[i], 16) > 7) {125 checksumAddress.push(address[i].toUpperCase());126 } else {127 checksumAddress.push(address[i]);128 }129 }130 return checksumAddress.join('');131 },132 tokenIdToAddress(collectionId: number, tokenId: number) {133 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);134 },135};136137class UniqueUtil {138 static transactionStatus = {139 NOT_READY: 'NotReady',140 FAIL: 'Fail',141 SUCCESS: 'Success',142 };143144 static chainLogType = {145 EXTRINSIC: 'extrinsic',146 RPC: 'rpc',147 };148149 static getTokenAccount(token: IToken): CrossAccountId {150 return new CrossAccountId({Ethereum: this.getTokenAddress(token)});151 }152153 static getTokenAddress(token: IToken): string {154 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);155 }156157 static getDefaultLogger(): ILogger {158 return {159 log(msg: any, level = 'INFO') {160 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));161 },162 level: {163 ERROR: 'ERROR',164 WARNING: 'WARNING',165 INFO: 'INFO',166 },167 };168 }169170 static vec2str(arr: string[] | number[]) {171 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');172 }173174 static str2vec(string: string) {175 if(typeof string !== 'string') return string;176 return Array.from(string).map(x => x.charCodeAt(0));177 }178179 static fromSeed(seed: string, ss58Format = 42) {180 const keyring = new Keyring({type: 'sr25519', ss58Format});181 return keyring.addFromUri(seed);182 }183184 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {185 if(creationResult.status !== this.transactionStatus.SUCCESS) {186 throw Error('Unable to create collection!');187 }188189 let collectionId = null;190 creationResult.result.events.forEach(({event: {data, method, section}}) => {191 if((section === 'common') && (method === 'CollectionCreated')) {192 collectionId = parseInt(data[0].toString(), 10);193 }194 });195196 if(collectionId === null) {197 throw Error('No CollectionCreated event was found!');198 }199200 return collectionId;201 }202203 static extractTokensFromCreationResult(creationResult: ITransactionResult): {204 success: boolean,205 tokens: { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[],206 } {207 if(creationResult.status !== this.transactionStatus.SUCCESS) {208 throw Error('Unable to create tokens!');209 }210 let success = false;211 const tokens = [] as { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[];212 creationResult.result.events.forEach(({event: {data, method, section}}) => {213 if(method === 'ExtrinsicSuccess') {214 success = true;215 } else if((section === 'common') && (method === 'ItemCreated')) {216 tokens.push({217 collectionId: parseInt(data[0].toString(), 10),218 tokenId: parseInt(data[1].toString(), 10),219 owner: data[2].toHuman(),220 amount: data[3].toBigInt(),221 });222 }223 });224 return {success, tokens};225 }226227 static extractTokensFromBurnResult(burnResult: ITransactionResult): {228 success: boolean,229 tokens: { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[],230 } {231 if(burnResult.status !== this.transactionStatus.SUCCESS) {232 throw Error('Unable to burn tokens!');233 }234 let success = false;235 const tokens = [] as { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[];236 burnResult.result.events.forEach(({event: {data, method, section}}) => {237 if(method === 'ExtrinsicSuccess') {238 success = true;239 } else if((section === 'common') && (method === 'ItemDestroyed')) {240 tokens.push({241 collectionId: parseInt(data[0].toString(), 10),242 tokenId: parseInt(data[1].toString(), 10),243 owner: data[2].toHuman(),244 amount: data[3].toBigInt(),245 });246 }247 });248 return {success, tokens};249 }250251 static findCollectionInEvents(events: { event: IEvent }[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {252 let eventId = null;253 events.forEach(({event: {data, method, section}}) => {254 if((section === expectedSection) && (method === expectedMethod)) {255 eventId = parseInt(data[0].toString(), 10);256 }257 });258259 if(eventId === null) {260 throw Error(`No ${expectedMethod} event was found!`);261 }262 return eventId === collectionId;263 }264265 static isTokenTransferSuccess(events: { event: IEvent }[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {266 const normalizeAddress = (address: string | ICrossAccountId) => {267 if(typeof address === 'string') return address;268 const obj = {} as any;269 Object.keys(address).forEach(k => {270 obj[k.toLocaleLowerCase()] = (address as any)[k];271 });272 if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);273 if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();274 return address;275 };276 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;277 events.forEach(({event: {data, method, section}}) => {278 if((section === 'common') && (method === 'Transfer')) {279 const hData = (data as any).toJSON();280 transfer = {281 collectionId: hData[0],282 tokenId: hData[1],283 from: normalizeAddress(hData[2]),284 to: normalizeAddress(hData[3]),285 amount: BigInt(hData[4]),286 };287 }288 });289 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;290 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);291 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);292 isSuccess = isSuccess && amount === transfer.amount;293 return isSuccess;294 }295296 static bigIntToDecimals(number: bigint, decimals = 18) {297 const numberStr = number.toString();298 const dotPos = numberStr.length - decimals;299300 if(dotPos <= 0) {301 return '0.' + '0'.repeat(Math.abs(dotPos)) + numberStr;302 } else {303 const intPart = numberStr.substring(0, dotPos);304 const fractPart = numberStr.substring(dotPos);305 return intPart + '.' + fractPart;306 }307 }308}309310class UniqueEventHelper {311 private static extractIndex(index: any): [number, number] | string {312 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];313 return index.toJSON();314 }315316 private static extractSub(data: any, subTypes: any): { [key: string]: any } {317 let obj: any = {};318 let index = 0;319320 if(data.entries) {321 for(const [key, value] of data.entries()) {322 obj[key] = this.extractData(value, subTypes[index]);323 index++;324 }325 } else obj = data.toJSON();326327 return obj;328 }329330 private static toHuman(data: any) {331 return data && data.toHuman ? data.toHuman() : `${data}`;332 }333334 private static extractData(data: any, type: any): any {335 if(!type) return this.toHuman(data);336 if(['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();337 if(['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();338 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);339 return this.toHuman(data);340 }341342 public static extractEvents(events: { event: any, phase: any }[]): IEvent[] {343 const parsedEvents: IEvent[] = [];344345 events.forEach((record) => {346 const {event, phase} = record;347 const types = event.typeDef;348349 const eventData: IEvent = {350 section: event.section.toString(),351 method: event.method.toString(),352 index: this.extractIndex(event.index),353 data: [],354 phase: phase.toJSON(),355 };356357 event.data.forEach((val: any, index: number) => {358 eventData.data.push(this.extractData(val, types[index]));359 });360361 parsedEvents.push(eventData);362 });363364 return parsedEvents;365 }366}367const InvalidTypeSymbol = Symbol('Invalid type');368// eslint-disable-next-line @typescript-eslint/no-unused-vars369export type Invalid<ErrorMessage> =370 | ((371 invalidType: typeof InvalidTypeSymbol,372 ..._: typeof InvalidTypeSymbol[]373 ) => typeof InvalidTypeSymbol)374 | null375 | undefined;376// Has slightly better error messages than Get377type Get2<T, P extends string, E> =378 P extends `${infer Key}.${infer Key2}` ? Key extends keyof T ? Key2 extends keyof T[Key] ? T[Key][Key2] : E : E : E;379type ForceFunction<T> = T extends (...args: any) => any ? T : (...args: any) => Invalid<'not a function'>;380381export class ChainHelperBase {382 helperBase: any;383384 transactionStatus = UniqueUtil.transactionStatus;385 chainLogType = UniqueUtil.chainLogType;386 util: typeof UniqueUtil;387 eventHelper: typeof UniqueEventHelper;388 logger: ILogger;389 api: ApiPromise | null;390 forcedNetwork: TNetworks | null;391 network: TNetworks | null;392 wsEndpoint: string | null;393 chainLog: IUniqueHelperLog[];394 children: ChainHelperBase[];395 address: AddressGroup;396 chain: ChainGroup;397398 constructor(logger?: ILogger, helperBase?: any) {399 this.helperBase = helperBase;400401 this.util = UniqueUtil;402 this.eventHelper = UniqueEventHelper;403 if(typeof logger == 'undefined') logger = this.util.getDefaultLogger();404 this.logger = logger;405 this.api = null;406 this.forcedNetwork = null;407 this.network = null;408 this.wsEndpoint = null;409 this.chainLog = [];410 this.children = [];411 this.address = new AddressGroup(this);412 this.chain = new ChainGroup(this);413 }414415 clone(helperCls: ChainHelperBaseConstructor, options: { [key: string]: any } = {}) {416 Object.setPrototypeOf(helperCls.prototype, this);417 const newHelper = new helperCls(this.logger, options);418419 newHelper.api = this.api;420 newHelper.network = this.network;421 newHelper.forceNetwork = this.forceNetwork;422423 this.children.push(newHelper);424425 return newHelper;426 }427428 getEndpoint(): string {429 if(this.wsEndpoint === null) throw Error('No connection was established');430 return this.wsEndpoint;431 }432433 getApi(): ApiPromise {434 if(this.api === null) throw Error('API not initialized');435 return this.api;436 }437438 async subscribeEvents(expectedEvents: { section: string, names: string[] }[]) {439 const collectedEvents: IEvent[] = [];440 const unsubscribe = await this.getApi().query.system.events((events: Vec<FrameSystemEventRecord>) => {441 const ievents = this.eventHelper.extractEvents(events);442 ievents.forEach((event) => {443 expectedEvents.forEach((e => {444 if(event.section === e.section && e.names.includes(event.method)) {445 collectedEvents.push(event);446 }447 }));448 });449 });450 return {unsubscribe: unsubscribe as any, collectedEvents};451 }452453 clearChainLog(): void {454 this.chainLog = [];455 }456457 forceNetwork(value: TNetworks): void {458 this.forcedNetwork = value;459 }460461 async connect(wsEndpoint: string, listeners?: IApiListeners) {462 if(this.api !== null) throw Error('Already connected');463 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);464 this.wsEndpoint = wsEndpoint;465 this.api = api;466 this.network = network;467 }468469 async disconnect() {470 for(const child of this.children) {471 child.clearApi();472 }473474 if(this.api === null) return;475 await this.api.disconnect();476 this.clearApi();477 }478479 clearApi() {480 this.api = null;481 this.network = null;482 }483484 static async detectNetwork(api: ApiPromise): Promise<TNetworks> {485 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;486 const xcmChains = ['rococo', 'westend', 'westmint', 'acala', 'karura', 'moonbeam', 'moonriver'];487488 if(xcmChains.indexOf(spec.specName) > -1) return spec.specName;489490 if(['quartz', 'unique', 'sapphire'].indexOf(spec.specName) > -1) return spec.specName;491 return 'opal';492 }493494 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TNetworks> {495 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});496 await api.isReady;497498 const network = await this.detectNetwork(api);499500 await api.disconnect();501502 return network;503 }504505 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TNetworks | null): Promise<{506 api: ApiPromise;507 network: TNetworks;508 }> {509 if(typeof network === 'undefined' || network === null) network = 'opal';510 const supportedRPC = {511 opal: {512 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,513 },514 quartz: {515 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,516 },517 unique: {518 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,519 },520 rococo: {},521 westend: {},522 moonbeam: {},523 moonriver: {},524 acala: {},525 karura: {},526 westmint: {},527 };528 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);529 const rpc = supportedRPC[network];530531 // TODO: investigate how to replace rpc in runtime532 // api._rpcCore.addUserInterfaces(rpc);533534 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});535536 await api.isReadyOrError;537538 if(typeof listeners === 'undefined') listeners = {};539 for(const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {540 if(!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;541 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);542 }543544 return {api, network};545 }546547 getTransactionStatus(data: { events: { event: IEvent }[], status: any }) {548 const {events, status} = data;549 if(status.isReady) {550 return this.transactionStatus.NOT_READY;551 }552 if(status.isBroadcast) {553 return this.transactionStatus.NOT_READY;554 }555 if(status.isInBlock || status.isFinalized) {556 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');557 if(errors.length > 0) {558 return this.transactionStatus.FAIL;559 }560 if(events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {561 return this.transactionStatus.SUCCESS;562 }563 }564565 return this.transactionStatus.FAIL;566 }567568 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {569 const sign = (callback: any) => {570 if(options !== null) return transaction.signAndSend(sender, options, callback);571 return transaction.signAndSend(sender, callback);572 };573 // eslint-disable-next-line no-async-promise-executor574 return new Promise(async (resolve, reject) => {575 try {576 const unsub = await sign((result: any) => {577 const status = this.getTransactionStatus(result);578579 if(status === this.transactionStatus.SUCCESS) {580 this.logger.log(`${label} successful`);581 unsub();582 resolve({result, status, blockHash: result.status.asInBlock.toHuman()});583 } else if(status === this.transactionStatus.FAIL) {584 let moduleError = null;585586 if(result.hasOwnProperty('dispatchError')) {587 const dispatchError = result['dispatchError'];588589 if(dispatchError) {590 if(dispatchError.isModule) {591 const modErr = dispatchError.asModule;592 const errorMeta = dispatchError.registry.findMetaError(modErr);593594 moduleError = `${errorMeta.section}.${errorMeta.name}`;595 } else if(dispatchError.isToken) {596 moduleError = `Token: ${dispatchError.asToken}`;597 } else {598 // May be [object Object] in case of unhandled non-unit enum599 moduleError = `Misc: ${dispatchError.toHuman()}`;600 }601 } else {602 this.logger.log(result, this.logger.level.ERROR);603 }604 }605606 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);607 unsub();608 reject({status, moduleError, result});609 }610 });611 } catch (e) {612 this.logger.log(e, this.logger.level.ERROR);613 reject(e);614 }615 });616 }617618 async signTransactionWithoutSending(signer: TSigner, tx: any) {619 const api = this.getApi();620 const signingInfo = await api.derive.tx.signingInfo(signer.address);621622 tx.sign(signer, {623 blockHash: api.genesisHash,624 genesisHash: api.genesisHash,625 runtimeVersion: api.runtimeVersion,626 nonce: signingInfo.nonce,627 });628629 return tx.toHex();630 }631632 async getPaymentInfo(signer: TSigner, tx: any, len: number | null) {633 const api = this.getApi();634 const signingInfo = await api.derive.tx.signingInfo(signer.address);635636 // We need to sign the tx because637 // unsigned transactions does not have an inclusion fee638 tx.sign(signer, {639 blockHash: api.genesisHash,640 genesisHash: api.genesisHash,641 runtimeVersion: api.runtimeVersion,642 nonce: signingInfo.nonce,643 });644645 if(len === null) {646 return (await this.callRpc('api.rpc.payment.queryInfo', [tx.toHex()])) as RuntimeDispatchInfo;647 } else {648 return (await api.call.transactionPaymentApi.queryInfo(tx, len)) as RuntimeDispatchInfo;649 }650 }651652 constructApiCall(apiCall: string, params: any[]) {653 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);654 let call = this.getApi() as any;655 for(const part of apiCall.slice(4).split('.')) {656 call = call[part];657 if(!call) {658 const advice = part.includes('_') ? ' Looks like it needs to be converted to camel case.' : '';659 throw Error(`Function ${part} of api call ${apiCall} not found.${advice}`);660 }661 }662 return call(...params);663 }664665 encodeApiCall(apiCall: string, params: any[]) {666 return this.constructApiCall(apiCall, params).method.toHex();667 }668669 async executeExtrinsic<670 E extends string,671 V extends (672 ...args: any) => any = ForceFunction<673 Get2<674 AugmentedSubmittables<'promise'>,675 E, (...args: any) => Invalid<'not found'>676 >677 >678 >(679 sender: TSigner,680 extrinsic: `api.tx.${E}`,681 params: Parameters<V>,682 expectSuccess = true,683 options: Partial<SignerOptions> | null = null,/*, failureMessage='expected success'*/684 ): Promise<ITransactionResult> {685 if(this.api === null) throw Error('API not initialized');686687 const startTime = (new Date()).getTime();688 let result: ITransactionResult;689 let events: IEvent[] = [];690 try {691 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;692 events = this.eventHelper.extractEvents(result.result.events);693 const errorEvent = events.find((event) => event.method == 'ExecutedFailed' || event.method == 'CreatedFailed');694 if(errorEvent)695 throw Error(errorEvent.method + ': ' + extrinsic);696 }697 catch (e) {698 if(!(e as object).hasOwnProperty('status')) throw e;699 result = e as ITransactionResult;700 }701702 const endTime = (new Date()).getTime();703704 const log = {705 executedAt: endTime,706 executionTime: endTime - startTime,707 type: this.chainLogType.EXTRINSIC,708 status: result.status,709 call: extrinsic,710 signer: this.getSignerAddress(sender),711 params,712 } as IUniqueHelperLog;713714 let errorMessage = '';715716 if(result.status !== this.transactionStatus.SUCCESS) {717 if(result.moduleError) {718 errorMessage = typeof result.moduleError === 'string'719 ? result.moduleError720 : `${Object.keys(result.moduleError)[0]}: ${Object.values(result.moduleError)[0]}`;721 log.moduleError = errorMessage;722 }723 else if(result.result.dispatchError) log.dispatchError = result.result.dispatchError;724 }725 if(events.length > 0) log.events = events;726727 this.chainLog.push(log);728729 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {730 if(result.moduleError) throw Error(`${errorMessage}`);731 else if(result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));732 }733 return result as any;734 }735 executeExtrinsicUncheckedWeight<736 E extends string,737 V extends (738 ...args: any) => any = ForceFunction<739 Get2<740 AugmentedSubmittables<'promise'>,741 E, (...args: any) => Invalid<'not found'>742 >743 >744 >(745 sender: TSigner,746 extrinsic: `api.tx.${E}`,747 params: Parameters<V>,748 expectSuccess = true,749 options: Partial<SignerOptions> | null = null,/*, failureMessage='expected success'*/750 ): Promise<ITransactionResult> {751 throw new Error('executeExtrinsicUncheckedWeight only supported in sudo');752 }753754 async callRpc755 // TODO: make it strongly typed, or use api.query/api.rpc directly756 // <757 // K extends 'rpc' | 'query',758 // E extends string,759 // V extends (...args: any) => any = ForceFunction<760 // Get2<761 // K extends 'rpc' ? DecoratedRpc<'promise', RpcInterface> : QueryableStorage<'promise'>,762 // E, (...args: any) => Invalid<'not found'>763 // >764 // >,765 // P = Parameters<V>,766 // >767 (rpc: string, params?: any[]): Promise<any> {768769 if(typeof params === 'undefined') params = [] as any;770 if(this.api === null) throw Error('API not initialized');771 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);772773 const startTime = (new Date()).getTime();774 let result;775 let error = null;776 const log = {777 type: this.chainLogType.RPC,778 call: rpc,779 params,780 } as any as IUniqueHelperLog;781782 try {783 result = await this.constructApiCall(rpc, params as any);784 }785 catch (e) {786 error = e;787 }788789 const endTime = (new Date()).getTime();790791 log.executedAt = endTime;792 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';793 log.executionTime = endTime - startTime;794795 this.chainLog.push(log);796797 if(error !== null) throw error;798799 return result;800 }801802 getSignerAddress(signer: IKeyringPair | string): string {803 if(typeof signer === 'string') return signer;804 return signer.address;805 }806807 fetchAllPalletNames(): string[] {808 if(this.api === null) throw Error('API not initialized');809 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase()).sort();810 }811812 fetchMissingPalletNames(requiredPallets: readonly string[]): string[] {813 const palletNames = this.fetchAllPalletNames();814 return requiredPallets.filter(p => !palletNames.includes(p));815 }816}817818819class HelperGroup<T extends ChainHelperBase> {820 helper: T;821822 constructor(uniqueHelper: T) {823 this.helper = uniqueHelper;824 }825}826827828class CollectionGroup extends HelperGroup<UniqueHelper> {829 /**830 * Get number of blocks when sponsored transaction is available.831 *832 * @param collectionId ID of collection833 * @param tokenId ID of token834 * @param addressObj address for which the sponsorship is checked835 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});836 * @returns number of blocks or null if sponsorship hasn't been set837 */838 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {839 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();840 }841842 /**843 * Get the number of created collections.844 *845 * @returns number of created collections846 */847 async getTotalCount(): Promise<number> {848 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();849 }850851 /**852 * Get information about the collection with additional data,853 * including the number of tokens it contains, its administrators,854 * the normalized address of the collection's owner, and decoded name and description.855 *856 * @param collectionId ID of collection857 * @example await getData(2)858 * @returns collection information object859 */860 async getData(collectionId: number): Promise<{861 id: number;862 name: string;863 description: string;864 tokensCount: number;865 admins: CrossAccountId[];866 normalizedOwner: TSubstrateAccount;867 raw: any868 } | null> {869 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);870 const humanCollection = collection.toHuman(), collectionData = {871 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],872 raw: humanCollection,873 } as any, jsonCollection = collection.toJSON();874 if(humanCollection === null) return null;875 collectionData.raw.limits = jsonCollection.limits;876 collectionData.raw.permissions = jsonCollection.permissions;877 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);878 for(const key of ['name', 'description']) {879 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);880 }881882 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))883 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)884 : 0;885 collectionData.admins = await this.getAdmins(collectionId);886887 return collectionData;888 }889890 /**891 * Get the addresses of the collection's administrators, optionally normalized.892 *893 * @param collectionId ID of collection894 * @param normalize whether to normalize the addresses to the default ss58 format895 * @example await getAdmins(1)896 * @returns array of administrators897 */898 async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {899 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();900901 return normalize902 ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())903 : admins;904 }905906 /**907 * Get the addresses added to the collection allow-list, optionally normalized.908 * @param collectionId ID of collection909 * @param normalize whether to normalize the addresses to the default ss58 format910 * @example await getAllowList(1)911 * @returns array of allow-listed addresses912 */913 async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {914 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();915 return normalize916 ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())917 : allowListed;918 }919920 /**921 * Get the effective limits of the collection instead of null for default values922 *923 * @param collectionId ID of collection924 * @example await getEffectiveLimits(2)925 * @returns object of collection limits926 */927 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {928 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();929 }930931 /**932 * Burns the collection if the signer has sufficient permissions and collection is empty.933 *934 * @param signer keyring of signer935 * @param collectionId ID of collection936 * @example await helper.collection.burn(aliceKeyring, 3);937 * @returns ```true``` if extrinsic success, otherwise ```false```938 */939 async burn(signer: TSigner, collectionId: number): Promise<boolean> {940 const result = await this.helper.executeExtrinsic(941 signer,942 'api.tx.unique.destroyCollection', [collectionId],943 true,944 );945946 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');947 }948949 /**950 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.951 *952 * @param signer keyring of signer953 * @param collectionId ID of collection954 * @param sponsorAddress Sponsor substrate address955 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")956 * @returns ```true``` if extrinsic success, otherwise ```false```957 */958 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {959 const result = await this.helper.executeExtrinsic(960 signer,961 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],962 true,963 );964965 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorSet');966 }967968 /**969 * Confirms consent to sponsor the collection on behalf of the signer.970 *971 * @param signer keyring of signer972 * @param collectionId ID of collection973 * @example confirmSponsorship(aliceKeyring, 10)974 * @returns ```true``` if extrinsic success, otherwise ```false```975 */976 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {977 const result = await this.helper.executeExtrinsic(978 signer,979 'api.tx.unique.confirmSponsorship', [collectionId],980 true,981 );982983 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'SponsorshipConfirmed');984 }985986 /**987 * Removes the sponsor of a collection, regardless if it consented or not.988 *989 * @param signer keyring of signer990 * @param collectionId ID of collection991 * @example removeSponsor(aliceKeyring, 10)992 * @returns ```true``` if extrinsic success, otherwise ```false```993 */994 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {995 const result = await this.helper.executeExtrinsic(996 signer,997 'api.tx.unique.removeCollectionSponsor', [collectionId],998 true,999 );10001001 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorRemoved');1002 }10031004 /**1005 * Sets the limits of the collection. At least one limit must be specified for a correct call.1006 *1007 * @param signer keyring of signer1008 * @param collectionId ID of collection1009 * @param limits collection limits object1010 * @example1011 * await setLimits(1012 * aliceKeyring,1013 * 10,1014 * {1015 * sponsorTransferTimeout: 0,1016 * ownerCanDestroy: false1017 * }1018 * )1019 * @returns ```true``` if extrinsic success, otherwise ```false```1020 */1021 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {1022 const result = await this.helper.executeExtrinsic(1023 signer,1024 'api.tx.unique.setCollectionLimits', [collectionId, limits],1025 true,1026 );10271028 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionLimitSet');1029 }10301031 /**1032 * Changes the owner of the collection to the new Substrate address.1033 *1034 * @param signer keyring of signer1035 * @param collectionId ID of collection1036 * @param ownerAddress substrate address of new owner1037 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")1038 * @returns ```true``` if extrinsic success, otherwise ```false```1039 */1040 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {1041 const result = await this.helper.executeExtrinsic(1042 signer,1043 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],1044 true,1045 );10461047 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionOwnerChanged');1048 }10491050 /**1051 * Adds a collection administrator.1052 *1053 * @param signer keyring of signer1054 * @param collectionId ID of collection1055 * @param adminAddressObj Administrator address (substrate or ethereum)1056 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})1057 * @returns ```true``` if extrinsic success, otherwise ```false```1058 */1059 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {1060 const result = await this.helper.executeExtrinsic(1061 signer,1062 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],1063 true,1064 );10651066 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminAdded');1067 }10681069 /**1070 * Removes a collection administrator.1071 *1072 * @param signer keyring of signer1073 * @param collectionId ID of collection1074 * @param adminAddressObj Administrator address (substrate or ethereum)1075 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})1076 * @returns ```true``` if extrinsic success, otherwise ```false```1077 */1078 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {1079 const result = await this.helper.executeExtrinsic(1080 signer,1081 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],1082 true,1083 );10841085 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminRemoved');1086 }10871088 /**1089 * Check if user is in allow list.1090 *1091 * @param collectionId ID of collection1092 * @param user Account to check1093 * @example await getAdmins(1)1094 * @returns is user in allow list1095 */1096 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {1097 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();1098 }10991100 /**1101 * Adds an address to allow list1102 * @param signer keyring of signer1103 * @param collectionId ID of collection1104 * @param addressObj address to add to the allow list1105 * @returns ```true``` if extrinsic success, otherwise ```false```1106 */1107 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1108 const result = await this.helper.executeExtrinsic(1109 signer,1110 'api.tx.unique.addToAllowList', [collectionId, addressObj],1111 true,1112 );11131114 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressAdded');1115 }11161117 /**1118 * Removes an address from allow list1119 *1120 * @param signer keyring of signer1121 * @param collectionId ID of collection1122 * @param addressObj address to remove from the allow list1123 * @returns ```true``` if extrinsic success, otherwise ```false```1124 */1125 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1126 const result = await this.helper.executeExtrinsic(1127 signer,1128 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],1129 true,1130 );11311132 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressRemoved');1133 }11341135 /**1136 * Sets onchain permissions for selected collection.1137 *1138 * @param signer keyring of signer1139 * @param collectionId ID of collection1140 * @param permissions collection permissions object1141 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});1142 * @returns ```true``` if extrinsic success, otherwise ```false```1143 */1144 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {1145 const result = await this.helper.executeExtrinsic(1146 signer,1147 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],1148 true,1149 );11501151 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPermissionSet');1152 }11531154 /**1155 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.1156 *1157 * @param signer keyring of signer1158 * @param collectionId ID of collection1159 * @param permissions nesting permissions object1160 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});1161 * @returns ```true``` if extrinsic success, otherwise ```false```1162 */1163 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {1164 return await this.setPermissions(signer, collectionId, {nesting: permissions});1165 }11661167 /**1168 * Disables nesting for selected collection.1169 *1170 * @param signer keyring of signer1171 * @param collectionId ID of collection1172 * @example disableNesting(aliceKeyring, 10);1173 * @returns ```true``` if extrinsic success, otherwise ```false```1174 */1175 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {1176 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});1177 }11781179 /**1180 * Sets onchain properties to the collection.1181 *1182 * @param signer keyring of signer1183 * @param collectionId ID of collection1184 * @param properties array of property objects1185 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);1186 * @returns ```true``` if extrinsic success, otherwise ```false```1187 */1188 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {1189 const result = await this.helper.executeExtrinsic(1190 signer,1191 'api.tx.unique.setCollectionProperties', [collectionId, properties],1192 true,1193 );11941195 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');1196 }11971198 /**1199 * Get collection properties.1200 *1201 * @param collectionId ID of collection1202 * @param propertyKeys optionally filter the returned properties to only these keys1203 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);1204 * @returns array of key-value pairs1205 */1206 async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1207 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();1208 }12091210 async getPropertiesConsumedSpace(collectionId: number): Promise<number> {1211 const api = this.helper.getApi();1212 const props = (await api.query.common.collectionProperties(collectionId)).toJSON();12131214 return (props! as any).consumedSpace;1215 }12161217 async getCollectionOptions(collectionId: number) {1218 return (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1219 }12201221 /**1222 * Deletes onchain properties from the collection.1223 *1224 * @param signer keyring of signer1225 * @param collectionId ID of collection1226 * @param propertyKeys array of property keys to delete1227 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);1228 * @returns ```true``` if extrinsic success, otherwise ```false```1229 */1230 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {1231 const result = await this.helper.executeExtrinsic(1232 signer,1233 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],1234 true,1235 );12361237 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1238 }12391240 /**1241 * Changes the owner of the token.1242 *1243 * @param signer keyring of signer1244 * @param collectionId ID of collection1245 * @param tokenId ID of token1246 * @param addressObj address of a new owner1247 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1248 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1249 * @returns true if the token success, otherwise false1250 */1251 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1252 const result = await this.helper.executeExtrinsic(1253 signer,1254 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1255 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1256 );12571258 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1259 }12601261 /**1262 *1263 * Change ownership of a token(s) on behalf of the owner.1264 *1265 * @param signer keyring of signer1266 * @param collectionId ID of collection1267 * @param tokenId ID of token1268 * @param fromAddressObj address on behalf of which the token will be sent1269 * @param toAddressObj new token owner1270 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1271 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1272 * @returns true if the token success, otherwise false1273 */1274 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1275 const result = await this.helper.executeExtrinsic(1276 signer,1277 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1278 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1279 );1280 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1281 }12821283 /**1284 *1285 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1286 *1287 * @param signer keyring of signer1288 * @param collectionId ID of collection1289 * @param tokenId ID of token1290 * @param amount amount of tokens to be burned. For NFT must be set to 1n1291 * @example burnToken(aliceKeyring, 10, 5);1292 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1293 */1294 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount = 1n): Promise<boolean> {1295 const burnResult = await this.helper.executeExtrinsic(1296 signer,1297 'api.tx.unique.burnItem', [collectionId, tokenId, amount],1298 true, // `Unable to burn token for ${label}`,1299 );1300 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1301 if(burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1302 return burnedTokens.success;1303 }13041305 /**1306 * Destroys a concrete instance of NFT on behalf of the owner1307 *1308 * @param signer keyring of signer1309 * @param collectionId ID of collection1310 * @param tokenId ID of token1311 * @param fromAddressObj address on behalf of which the token will be burnt1312 * @param amount amount of tokens to be burned. For NFT must be set to 1n1313 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1314 * @returns ```true``` if extrinsic success, otherwise ```false```1315 */1316 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1317 const burnResult = await this.helper.executeExtrinsic(1318 signer,1319 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1320 true, // `Unable to burn token from for ${label}`,1321 );1322 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1323 return burnedTokens.success && burnedTokens.tokens.length > 0;1324 }13251326 /**1327 * Set, change, or remove approved address to transfer the ownership of the NFT.1328 *1329 * @param signer keyring of signer1330 * @param collectionId ID of collection1331 * @param tokenId ID of token1332 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1333 * @param amount amount of token to be approved. For NFT must be set to 1n1334 * @returns ```true``` if extrinsic success, otherwise ```false```1335 */1336 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {1337 const approveResult = await this.helper.executeExtrinsic(1338 signer,1339 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1340 true, // `Unable to approve token for ${label}`,1341 );13421343 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1344 }13451346 /**1347 * Set, change, or remove approved address to transfer the ownership of the NFT from eth mirror.1348 *1349 * @param signer keyring of signer1350 * @param collectionId ID of collection1351 * @param tokenId ID of token1352 * @param fromAddressObj Signer's Ethereum address containing her tokens1353 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1354 * @param amount amount of token to be approved. For NFT must be set to 1n1355 * @returns ```true``` if extrinsic success, otherwise ```false```1356 */1357 async approveTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {1358 const approveResult = await this.helper.executeExtrinsic(1359 signer,1360 'api.tx.unique.approveFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1361 true, // `Unable to approve token for ${label}`,1362 );13631364 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1365 }13661367 /**1368 * Set, change, or remove approved address to transfer the ownership of the NFT from eth mirror.1369 *1370 * @param signer keyring of signer1371 * @param collectionId ID of collection1372 * @param tokenId ID of token1373 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1374 * @param amount amount of token to be approved. For NFT must be set to 1n1375 * @returns ```true``` if extrinsic success, otherwise ```false```1376 */1377 async approveTokenFromEth(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {1378 const ethMirror = CrossAccountId.fromKeyring(signer).toEthereum();1379 return await this.approveTokenFrom(signer, collectionId, tokenId, ethMirror, toAddressObj, amount);1380 }13811382 /**1383 * Get the amount of token pieces approved to transfer or burn. Normally 0.1384 *1385 * @param collectionId ID of collection1386 * @param tokenId ID of token1387 * @param toAccountObj address which is approved to use token pieces1388 * @param fromAccountObj address which may have allowed the use of its owned tokens1389 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1390 * @returns number of approved to transfer pieces1391 */1392 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1393 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1394 }13951396 /**1397 * Get the last created token ID in a collection1398 *1399 * @param collectionId ID of collection1400 * @example getLastTokenId(10);1401 * @returns id of the last created token1402 */1403 async getLastTokenId(collectionId: number): Promise<number> {1404 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1405 }14061407 /**1408 * Check if token exists1409 *1410 * @param collectionId ID of collection1411 * @param tokenId ID of token1412 * @example doesTokenExist(10, 20);1413 * @returns true if the token exists, otherwise false1414 */1415 async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1416 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1417 }1418}14191420class NFTnRFT extends CollectionGroup {1421 /**1422 * Get tokens owned by account1423 *1424 * @param collectionId ID of collection1425 * @param addressObj tokens owner1426 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1427 * @returns array of token ids owned by account1428 */1429 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1430 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1431 }14321433 /**1434 * Get token data1435 *1436 * @param collectionId ID of collection1437 * @param tokenId ID of token1438 * @param propertyKeys optionally filter the token properties to only these keys1439 * @param blockHashAt optionally query the data at some block with this hash1440 * @example getToken(10, 5);1441 * @returns human readable token data1442 */1443 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1444 properties: IProperty[];1445 owner: CrossAccountId;1446 normalizedOwner: CrossAccountId;1447 } | null> {1448 let tokenData;1449 if(typeof blockHashAt === 'undefined') {1450 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1451 }1452 else {1453 if(propertyKeys.length == 0) {1454 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1455 if(!collection) return null;1456 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1457 }1458 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1459 }1460 tokenData = tokenData.toHuman();1461 if(tokenData === null || tokenData.owner === null) return null;1462 const owner = {} as any;1463 for(const key of Object.keys(tokenData.owner)) {1464 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate'1465 ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key])1466 : tokenData.owner[key];1467 }1468 tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1469 return tokenData;1470 }14711472 /**1473 * Get token's owner1474 * @param collectionId ID of collection1475 * @param tokenId ID of token1476 * @param blockHashAt optionally query the data at the block with this hash1477 * @example getTokenOwner(10, 5);1478 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1479 */1480 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1481 let owner;1482 if(typeof blockHashAt === 'undefined') {1483 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1484 } else {1485 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1486 }1487 return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1488 }14891490 /**1491 * Recursively find the address that owns the token1492 * @param collectionId ID of collection1493 * @param tokenId ID of token1494 * @param blockHashAt1495 * @example getTokenTopmostOwner(10, 5);1496 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1497 */1498 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1499 let owner;1500 if(typeof blockHashAt === 'undefined') {1501 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1502 } else {1503 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1504 }15051506 if(owner === null) return null;15071508 return owner.toHuman();1509 }15101511 /**1512 * Nest one token into another1513 * @param signer keyring of signer1514 * @param tokenObj token to be nested1515 * @param rootTokenObj token to be parent1516 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1517 * @returns ```true``` if extrinsic success, otherwise ```false```1518 */1519 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1520 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1521 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1522 if(!result) {1523 throw Error('Unable to nest token!');1524 }1525 return result;1526 }15271528 /**1529 * Remove token from nested state1530 * @param signer keyring of signer1531 * @param tokenObj token to unnest1532 * @param rootTokenObj parent of a token1533 * @param toAddressObj address of a new token owner1534 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1535 * @returns ```true``` if extrinsic success, otherwise ```false```1536 */1537 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1538 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1539 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1540 if(!result) {1541 throw Error('Unable to unnest token!');1542 }1543 return result;1544 }15451546 /**1547 * Set permissions to change token properties1548 *1549 * @param signer keyring of signer1550 * @param collectionId ID of collection1551 * @param permissions permissions to change a property by the collection admin or token owner1552 * @example setTokenPropertyPermissions(1553 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1554 * )1555 * @returns true if extrinsic success otherwise false1556 */1557 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1558 const result = await this.helper.executeExtrinsic(1559 signer,1560 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1561 true,1562 );15631564 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1565 }15661567 /**1568 * Get token property permissions.1569 *1570 * @param collectionId ID of collection1571 * @param propertyKeys optionally filter the returned property permissions to only these keys1572 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1573 * @returns array of key-permission pairs1574 */1575 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1576 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1577 }15781579 /**1580 * Set token properties1581 *1582 * @param signer keyring of signer1583 * @param collectionId ID of collection1584 * @param tokenId ID of token1585 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1586 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1587 * @returns ```true``` if extrinsic success, otherwise ```false```1588 */1589 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1590 const result = await this.helper.executeExtrinsic(1591 signer,1592 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1593 true,1594 );15951596 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1597 }15981599 /**1600 * Get properties, metadata assigned to a token.1601 *1602 * @param collectionId ID of collection1603 * @param tokenId ID of token1604 * @param propertyKeys optionally filter the returned properties to only these keys1605 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1606 * @returns array of key-value pairs1607 */1608 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1609 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1610 }16111612 /**1613 * Delete the provided properties of a token1614 * @param signer keyring of signer1615 * @param collectionId ID of collection1616 * @param tokenId ID of token1617 * @param propertyKeys property keys to be deleted1618 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1619 * @returns ```true``` if extrinsic success, otherwise ```false```1620 */1621 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1622 const result = await this.helper.executeExtrinsic(1623 signer,1624 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1625 true,1626 );16271628 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1629 }16301631 /**1632 * Mint new collection1633 *1634 * @param signer keyring of signer1635 * @param collectionOptions basic collection options and properties1636 * @param mode NFT or RFT type of a collection1637 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1638 * @returns object of the created collection1639 */1640 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1641 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1642 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1643 for(const key of ['name', 'description', 'tokenPrefix']) {1644 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);1645 }16461647 let flags = 0;1648 // convert CollectionFlags to number and join them in one number1649 if(collectionOptions.flags) {1650 for(let i = 0; i < collectionOptions.flags.length; i++){1651 const flag = collectionOptions.flags[i];1652 flags = flags | flag;1653 }1654 }1655 collectionOptions.flags = [flags];16561657 const creationResult = await this.helper.executeExtrinsic(1658 signer,1659 'api.tx.unique.createCollectionEx', [collectionOptions],1660 true, // errorLabel,1661 );1662 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1663 }16641665 getCollectionObject(_collectionId: number): any {1666 return null;1667 }16681669 getTokenObject(_collectionId: number, _tokenId: number): any {1670 return null;1671 }16721673 /**1674 * Tells whether the given `owner` approves the `operator`.1675 * @param collectionId ID of collection1676 * @param owner owner address1677 * @param operator operator addrees1678 * @returns true if operator is enabled1679 */1680 async allowanceForAll(collectionId: number, owner: ICrossAccountId, operator: ICrossAccountId): Promise<boolean> {1681 return (await this.helper.callRpc('api.rpc.unique.allowanceForAll', [collectionId, owner, operator])).toJSON();1682 }16831684 /** Sets or unsets the approval of a given operator.1685 * The `operator` is allowed to transfer all tokens of the `caller` on their behalf.1686 * @param operator Operator1687 * @param approved Should operator status be granted or revoked?1688 * @returns ```true``` if extrinsic success, otherwise ```false```1689 */1690 async setAllowanceForAll(signer: TSigner, collectionId: number, operator: ICrossAccountId, approved: boolean): Promise<boolean> {1691 const result = await this.helper.executeExtrinsic(1692 signer,1693 'api.tx.unique.setAllowanceForAll', [collectionId, operator, approved],1694 true,1695 );1696 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'ApprovedForAll');1697 }1698}169917001701class NFTGroup extends NFTnRFT {1702 /**1703 * Get collection object1704 * @param collectionId ID of collection1705 * @example getCollectionObject(2);1706 * @returns instance of UniqueNFTCollection1707 */1708 getCollectionObject(collectionId: number): UniqueNFTCollection {1709 return new UniqueNFTCollection(collectionId, this.helper);1710 }17111712 /**1713 * Get token object1714 * @param collectionId ID of collection1715 * @param tokenId ID of token1716 * @example getTokenObject(10, 5);1717 * @returns instance of UniqueNFTToken1718 */1719 getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1720 return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1721 }17221723 /**1724 * Is token approved to transfer1725 * @param collectionId ID of collection1726 * @param tokenId ID of token1727 * @param toAccountObj address to be approved1728 * @returns ```true``` if extrinsic success, otherwise ```false```1729 */1730 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1731 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1732 }17331734 /**1735 * Changes the owner of the token.1736 *1737 * @param signer keyring of signer1738 * @param collectionId ID of collection1739 * @param tokenId ID of token1740 * @param addressObj address of a new owner1741 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1742 * @returns ```true``` if extrinsic success, otherwise ```false```1743 */1744 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1745 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1746 }17471748 /**1749 *1750 * Change ownership of a NFT on behalf of the owner.1751 *1752 * @param signer keyring of signer1753 * @param collectionId ID of collection1754 * @param tokenId ID of token1755 * @param fromAddressObj address on behalf of which the token will be sent1756 * @param toAddressObj new token owner1757 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1758 * @returns ```true``` if extrinsic success, otherwise ```false```1759 */1760 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1761 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1762 }17631764 /**1765 * Get tokens nested in the provided token1766 * @param collectionId ID of collection1767 * @param tokenId ID of token1768 * @param blockHashAt optionally query the data at the block with this hash1769 * @example getTokenChildren(10, 5);1770 * @returns tokens whose depth of nesting is <= 51771 */1772 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1773 let children;1774 if(typeof blockHashAt === 'undefined') {1775 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1776 } else {1777 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1778 }17791780 return children.toJSON().map((x: any) => ({collectionId: x.collection, tokenId: x.token}));1781 }17821783 /**1784 * Mint new collection1785 * @param signer keyring of signer1786 * @param collectionOptions Collection options1787 * @example1788 * mintCollection(aliceKeyring, {1789 * name: 'New',1790 * description: 'New collection',1791 * tokenPrefix: 'NEW',1792 * })1793 * @returns object of the created collection1794 */1795 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1796 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1797 }17981799 /**1800 * Mint new token1801 * @param signer keyring of signer1802 * @param data token data1803 * @returns created token object1804 */1805 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1806 const creationResult = await this.helper.executeExtrinsic(1807 signer,1808 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1809 NFT: {1810 properties: data.properties,1811 },1812 }],1813 true,1814 );1815 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1816 if(createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1817 if(createdTokens.tokens.length < 1) throw Error('No tokens minted');1818 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1819 }18201821 /**1822 * Mint multiple NFT tokens1823 * @param signer keyring of signer1824 * @param collectionId ID of collection1825 * @param tokens array of tokens with owner and properties1826 * @example1827 * mintMultipleTokens(aliceKeyring, 10, [{1828 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1829 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1830 * },{1831 * owner: {Ethereum: "0x9F0583DbB855d..."},1832 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1833 * }]);1834 * @returns ```true``` if extrinsic success, otherwise ```false```1835 */1836 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: { owner: ICrossAccountId, properties?: IProperty[] }[]): Promise<UniqueNFToken[]> {1837 const creationResult = await this.helper.executeExtrinsic(1838 signer,1839 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1840 true,1841 );1842 const collection = this.getCollectionObject(collectionId);1843 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1844 }18451846 /**1847 * Mint multiple NFT tokens with one owner1848 * @param signer keyring of signer1849 * @param collectionId ID of collection1850 * @param owner tokens owner1851 * @param tokens array of tokens with owner and properties1852 * @example1853 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1854 * properties: [{1855 * key: "gender",1856 * value: "female",1857 * },{1858 * key: "age",1859 * value: "33",1860 * }],1861 * }]);1862 * @returns array of newly created tokens1863 */1864 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: { properties?: IProperty[] }[]): Promise<UniqueNFToken[]> {1865 const rawTokens = [];1866 for(const token of tokens) {1867 const raw = {NFT: {properties: token.properties}};1868 rawTokens.push(raw);1869 }1870 const creationResult = await this.helper.executeExtrinsic(1871 signer,1872 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1873 true,1874 );1875 const collection = this.getCollectionObject(collectionId);1876 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1877 }18781879 /**1880 * Set, change, or remove approved address to transfer the ownership of the NFT.1881 *1882 * @param signer keyring of signer1883 * @param collectionId ID of collection1884 * @param tokenId ID of token1885 * @param toAddressObj address to approve1886 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1887 * @returns ```true``` if extrinsic success, otherwise ```false```1888 */1889 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {1890 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1891 }1892}189318941895class RFTGroup extends NFTnRFT {1896 /**1897 * Get collection object1898 * @param collectionId ID of collection1899 * @example getCollectionObject(2);1900 * @returns instance of UniqueRFTCollection1901 */1902 getCollectionObject(collectionId: number): UniqueRFTCollection {1903 return new UniqueRFTCollection(collectionId, this.helper);1904 }19051906 /**1907 * Get token object1908 * @param collectionId ID of collection1909 * @param tokenId ID of token1910 * @example getTokenObject(10, 5);1911 * @returns instance of UniqueNFTToken1912 */1913 getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1914 return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1915 }19161917 /**1918 * Get top 10 token owners with the largest number of pieces1919 * @param collectionId ID of collection1920 * @param tokenId ID of token1921 * @example getTokenTop10Owners(10, 5);1922 * @returns array of top 10 owners1923 */1924 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1925 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1926 }19271928 /**1929 * Get number of pieces owned by address1930 * @param collectionId ID of collection1931 * @param tokenId ID of token1932 * @param addressObj address token owner1933 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1934 * @returns number of pieces ownerd by address1935 */1936 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1937 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1938 }19391940 /**1941 * Transfer pieces of token to another address1942 * @param signer keyring of signer1943 * @param collectionId ID of collection1944 * @param tokenId ID of token1945 * @param addressObj address of a new owner1946 * @param amount number of pieces to be transfered1947 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1948 * @returns ```true``` if extrinsic success, otherwise ```false```1949 */1950 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1951 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1952 }19531954 /**1955 * Change ownership of some pieces of RFT on behalf of the owner.1956 * @param signer keyring of signer1957 * @param collectionId ID of collection1958 * @param tokenId ID of token1959 * @param fromAddressObj address on behalf of which the token will be sent1960 * @param toAddressObj new token owner1961 * @param amount number of pieces to be transfered1962 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1963 * @returns ```true``` if extrinsic success, otherwise ```false```1964 */1965 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1966 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1967 }19681969 /**1970 * Mint new collection1971 * @param signer keyring of signer1972 * @param collectionOptions Collection options1973 * @example1974 * mintCollection(aliceKeyring, {1975 * name: 'New',1976 * description: 'New collection',1977 * tokenPrefix: 'NEW',1978 * })1979 * @returns object of the created collection1980 */1981 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1982 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1983 }19841985 /**1986 * Mint new token1987 * @param signer keyring of signer1988 * @param data token data1989 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1990 * @returns created token object1991 */1992 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1993 const creationResult = await this.helper.executeExtrinsic(1994 signer,1995 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1996 ReFungible: {1997 pieces: data.pieces,1998 properties: data.properties,1999 },2000 }],2001 true,2002 );2003 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);2004 if(createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');2005 if(createdTokens.tokens.length < 1) throw Error('No tokens minted');2006 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);2007 }20082009 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: { owner: ICrossAccountId, pieces: bigint, properties?: IProperty[] }[]): Promise<UniqueRFToken[]> {2010 throw Error('Not implemented');2011 const creationResult = await this.helper.executeExtrinsic(2012 signer,2013 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],2014 true, // `Unable to mint RFT tokens for ${label}`,2015 );2016 const collection = this.getCollectionObject(collectionId);2017 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));2018 }20192020 /**2021 * Mint multiple RFT tokens with one owner2022 * @param signer keyring of signer2023 * @param collectionId ID of collection2024 * @param owner tokens owner2025 * @param tokens array of tokens with properties and pieces2026 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);2027 * @returns array of newly created RFT tokens2028 */2029 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: { pieces: bigint, properties?: IProperty[] }[]): Promise<UniqueRFToken[]> {2030 const rawTokens = [];2031 for(const token of tokens) {2032 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};2033 rawTokens.push(raw);2034 }2035 const creationResult = await this.helper.executeExtrinsic(2036 signer,2037 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2038 true,2039 );2040 const collection = this.getCollectionObject(collectionId);2041 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));2042 }20432044 /**2045 * Destroys a concrete instance of RFT.2046 * @param signer keyring of signer2047 * @param collectionId ID of collection2048 * @param tokenId ID of token2049 * @param amount number of pieces to be burnt2050 * @example burnToken(aliceKeyring, 10, 5);2051 * @returns ```true``` if the extrinsic is successful, otherwise ```false```2052 */2053 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount = 1n): Promise<boolean> {2054 return await super.burnToken(signer, collectionId, tokenId, amount);2055 }20562057 /**2058 * Destroys a concrete instance of RFT on behalf of the owner.2059 * @param signer keyring of signer2060 * @param collectionId ID of collection2061 * @param tokenId ID of token2062 * @param fromAddressObj address on behalf of which the token will be burnt2063 * @param amount number of pieces to be burnt2064 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)2065 * @returns ```true``` if extrinsic success, otherwise ```false```2066 */2067 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {2068 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);2069 }20702071 /**2072 * Set, change, or remove approved address to transfer the ownership of the RFT.2073 *2074 * @param signer keyring of signer2075 * @param collectionId ID of collection2076 * @param tokenId ID of token2077 * @param toAddressObj address to approve2078 * @param amount number of pieces to be approved2079 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);2080 * @returns true if the token success, otherwise false2081 */2082 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {2083 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);2084 }20852086 /**2087 * Get total number of pieces2088 * @param collectionId ID of collection2089 * @param tokenId ID of token2090 * @example getTokenTotalPieces(10, 5);2091 * @returns number of pieces2092 */2093 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {2094 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();2095 }20962097 /**2098 * Change number of token pieces. Signer must be the owner of all token pieces.2099 * @param signer keyring of signer2100 * @param collectionId ID of collection2101 * @param tokenId ID of token2102 * @param amount new number of pieces2103 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);2104 * @returns true if the repartion was success, otherwise false2105 */2106 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {2107 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);2108 const repartitionResult = await this.helper.executeExtrinsic(2109 signer,2110 'api.tx.unique.repartition', [collectionId, tokenId, amount],2111 true,2112 );2113 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');2114 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');2115 }2116}211721182119class FTGroup extends CollectionGroup {2120 /**2121 * Get collection object2122 * @param collectionId ID of collection2123 * @example getCollectionObject(2);2124 * @returns instance of UniqueFTCollection2125 */2126 getCollectionObject(collectionId: number): UniqueFTCollection {2127 return new UniqueFTCollection(collectionId, this.helper);2128 }21292130 /**2131 * Mint new fungible collection2132 * @param signer keyring of signer2133 * @param collectionOptions Collection options2134 * @param decimalPoints number of token decimals2135 * @example2136 * mintCollection(aliceKeyring, {2137 * name: 'New',2138 * description: 'New collection',2139 * tokenPrefix: 'NEW',2140 * }, 18)2141 * @returns newly created fungible collection2142 */2143 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {2144 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object2145 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');2146 collectionOptions.mode = {fungible: decimalPoints};2147 for(const key of ['name', 'description', 'tokenPrefix']) {2148 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);2149 }2150 const creationResult = await this.helper.executeExtrinsic(2151 signer,2152 'api.tx.unique.createCollectionEx', [collectionOptions],2153 true,2154 );2155 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));2156 }21572158 /**2159 * Mint tokens2160 * @param signer keyring of signer2161 * @param collectionId ID of collection2162 * @param owner address owner of new tokens2163 * @param amount amount of tokens to be meanted2164 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);2165 * @returns ```true``` if extrinsic success, otherwise ```false```2166 */2167 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {2168 const creationResult = await this.helper.executeExtrinsic(2169 signer,2170 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {2171 Fungible: {2172 value: amount,2173 },2174 }],2175 true, // `Unable to mint fungible tokens for ${label}`,2176 );2177 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2178 }21792180 /**2181 * Mint multiple Fungible tokens with one owner2182 * @param signer keyring of signer2183 * @param collectionId ID of collection2184 * @param owner tokens owner2185 * @param tokens array of tokens with properties and pieces2186 * @returns ```true``` if extrinsic success, otherwise ```false```2187 */2188 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: { value: bigint }[], owner: ICrossAccountId): Promise<boolean> {2189 const rawTokens = [];2190 for(const token of tokens) {2191 const raw = {Fungible: {Value: token.value}};2192 rawTokens.push(raw);2193 }2194 const creationResult = await this.helper.executeExtrinsic(2195 signer,2196 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2197 true,2198 );2199 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2200 }22012202 /**2203 * Get the top 10 owners with the largest balance for the Fungible collection2204 * @param collectionId ID of collection2205 * @example getTop10Owners(10);2206 * @returns array of ```ICrossAccountId```2207 */2208 async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {2209 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);2210 }22112212 /**2213 * Get account balance2214 * @param collectionId ID of collection2215 * @param addressObj address of owner2216 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})2217 * @returns amount of fungible tokens owned by address2218 */2219 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {2220 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();2221 }22222223 /**2224 * Transfer tokens to address2225 * @param signer keyring of signer2226 * @param collectionId ID of collection2227 * @param toAddressObj address recipient2228 * @param amount amount of tokens to be sent2229 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2230 * @returns ```true``` if extrinsic success, otherwise ```false```2231 */2232 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount = 1n) {2233 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);2234 }22352236 /**2237 * Transfer some tokens on behalf of the owner.2238 * @param signer keyring of signer2239 * @param collectionId ID of collection2240 * @param fromAddressObj address on behalf of which tokens will be sent2241 * @param toAddressObj address where token to be sent2242 * @param amount number of tokens to be sent2243 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);2244 * @returns ```true``` if extrinsic success, otherwise ```false```2245 */2246 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {2247 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);2248 }22492250 /**2251 * Destroy some amount of tokens2252 * @param signer keyring of signer2253 * @param collectionId ID of collection2254 * @param amount amount of tokens to be destroyed2255 * @example burnTokens(aliceKeyring, 10, 1000n);2256 * @returns ```true``` if extrinsic success, otherwise ```false```2257 */2258 async burnTokens(signer: IKeyringPair, collectionId: number, amount = 1n): Promise<boolean> {2259 return await super.burnToken(signer, collectionId, 0, amount);2260 }22612262 /**2263 * Burn some tokens on behalf of the owner.2264 * @param signer keyring of signer2265 * @param collectionId ID of collection2266 * @param fromAddressObj address on behalf of which tokens will be burnt2267 * @param amount amount of tokens to be burnt2268 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2269 * @returns ```true``` if extrinsic success, otherwise ```false```2270 */2271 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {2272 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);2273 }22742275 /**2276 * Get total collection supply2277 * @param collectionId2278 * @returns2279 */2280 async getTotalPieces(collectionId: number): Promise<bigint> {2281 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();2282 }22832284 /**2285 * Set, change, or remove approved address to transfer tokens.2286 *2287 * @param signer keyring of signer2288 * @param collectionId ID of collection2289 * @param toAddressObj address to be approved2290 * @param amount amount of tokens to be approved2291 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)2292 * @returns ```true``` if extrinsic success, otherwise ```false```2293 */2294 approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount = 1n) {2295 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);2296 }22972298 /**2299 * Get amount of fungible tokens approved to transfer2300 * @param collectionId ID of collection2301 * @param fromAddressObj owner of tokens2302 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner2303 * @returns number of tokens approved for the transfer2304 */2305 getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2306 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2307 }2308}230923102311class ChainGroup extends HelperGroup<ChainHelperBase> {2312 /**2313 * Get system properties of a chain2314 * @example getChainProperties();2315 * @returns ss58Format, token decimals, and token symbol2316 */2317 getChainProperties(): IChainProperties {2318 const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2319 return {2320 ss58Format: properties.ss58Format.toJSON(),2321 tokenDecimals: properties.tokenDecimals.toJSON(),2322 tokenSymbol: properties.tokenSymbol.toJSON(),2323 };2324 }23252326 /**2327 * Get chain header2328 * @example getLatestBlockNumber();2329 * @returns the number of the last block2330 */2331 async getLatestBlockNumber(): Promise<number> {2332 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2333 }23342335 /**2336 * Get block hash by block number2337 * @param blockNumber number of block2338 * @example getBlockHashByNumber(12345);2339 * @returns hash of a block2340 */2341 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2342 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2343 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2344 return blockHash;2345 }23462347 // TODO add docs2348 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2349 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2350 if(!blockHash) return null;2351 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2352 }23532354 /**2355 * Get latest relay block2356 * @returns {number} relay block2357 */2358 async getRelayBlockNumber(): Promise<bigint> {2359 const blockNumber = (await this.helper.callRpc('api.query.parachainSystem.validationData')).toJSON().relayParentNumber;2360 return BigInt(blockNumber);2361 }23622363 /**2364 * Get account nonce2365 * @param address substrate address2366 * @example getNonce("5GrwvaEF5zXb26Fz...");2367 * @returns number, account's nonce2368 */2369 async getNonce(address: TSubstrateAccount): Promise<number> {2370 return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2371 }2372}23732374class SubstrateBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2375 /**2376 * Get substrate address balance2377 * @param address substrate address2378 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2379 * @returns amount of tokens on address2380 */2381 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2382 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2383 }23842385 /**2386 * Transfer tokens to substrate address2387 * @param signer keyring of signer2388 * @param address substrate address of a recipient2389 * @param amount amount of tokens to be transfered2390 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2391 * @returns ```true``` if extrinsic success, otherwise ```false```2392 */2393 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2394 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}`*/);23952396 let transfer = {from: null, to: null, amount: 0n} as any;2397 result.result.events.forEach(({event: {data, method, section}}) => {2398 if((section === 'balances') && (method === 'Transfer')) {2399 transfer = {2400 from: this.helper.address.normalizeSubstrate(data[0]),2401 to: this.helper.address.normalizeSubstrate(data[1]),2402 amount: BigInt(data[2]),2403 };2404 }2405 });2406 const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from2407 && this.helper.address.normalizeSubstrate(address) === transfer.to2408 && BigInt(amount) === transfer.amount;2409 return isSuccess;2410 }24112412 /**2413 * Get full substrate balance including free, frozen, and reserved2414 * @param address substrate address2415 * @returns2416 */2417 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2418 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2419 return {free: accountInfo.free.toBigInt(), frozen: accountInfo.frozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2420 }24212422 /**2423 * Get total issuance2424 * @returns2425 */2426 async getTotalIssuance(): Promise<bigint> {2427 const total = (await this.helper.callRpc('api.query.balances.totalIssuance', []));2428 return total.toBigInt();2429 }24302431 async getLocked(address: TSubstrateAccount): Promise<{ id: string, amount: bigint, reason: string }[]> {2432 const locks = (await this.helper.callRpc('api.query.balances.locks', [address])).toHuman();2433 return locks.map((lock: any) => ({id: lock.id, amount: BigInt(lock.amount.replace(/,/g, '')), reasons: lock.reasons}));2434 }2435 async getFrozen(address: TSubstrateAccount): Promise<{ id: string, amount: bigint }[]> {2436 const locks = (await this.helper.api!.query.balances.freezes(address)) as unknown as Array<any>;2437 return locks.map(lock => ({id: lock.id.toUtf8(), amount: lock.amount.toBigInt()}));2438 }2439}24402441class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2442 /**2443 * Get ethereum address balance2444 * @param address ethereum address2445 * @example getEthereum("0x9F0583DbB855d...")2446 * @returns amount of tokens on address2447 */2448 async getEthereum(address: TEthereumAccount): Promise<bigint> {2449 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2450 }24512452 /**2453 * Transfer tokens to address2454 * @param signer keyring of signer2455 * @param address Ethereum address of a recipient2456 * @param amount amount of tokens to be transfered2457 * @example transferToEthereum(alithKeyring, "0x9F0583DbB855d...", 100_000_000_000n);2458 * @returns ```true``` if extrinsic success, otherwise ```false```2459 */2460 async transferToEthereum(signer: TSigner, address: TEthereumAccount, amount: bigint | string): Promise<boolean> {2461 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true);24622463 let transfer = {from: null, to: null, amount: 0n} as any;2464 result.result.events.forEach(({event: {data, method, section}}) => {2465 if((section === 'balances') && (method === 'Transfer')) {2466 transfer = {2467 from: data[0].toString(),2468 to: data[1].toString(),2469 amount: BigInt(data[2]),2470 };2471 }2472 });2473 const isSuccess = (typeof signer === 'string' ? signer : signer.address) === transfer.from2474 && address === transfer.to2475 && BigInt(amount) === transfer.amount;2476 return isSuccess;2477 }2478}24792480class BalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2481 subBalanceGroup: SubstrateBalanceGroup<T>;2482 ethBalanceGroup: EthereumBalanceGroup<T>;24832484 constructor(helper: T) {2485 super(helper);2486 this.subBalanceGroup = new SubstrateBalanceGroup(helper);2487 this.ethBalanceGroup = new EthereumBalanceGroup(helper);2488 }24892490 getCollectionCreationPrice(): bigint {2491 return 2n * this.getOneTokenNominal();2492 }2493 /**2494 * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2495 * @example getOneTokenNominal()2496 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2497 */2498 getOneTokenNominal(): bigint {2499 const chainProperties = this.helper.chain.getChainProperties();2500 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2501 }25022503 /**2504 * Get substrate address balance2505 * @param address substrate address2506 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2507 * @returns amount of tokens on address2508 */2509 getSubstrate(address: TSubstrateAccount): Promise<bigint> {2510 return this.subBalanceGroup.getSubstrate(address);2511 }25122513 /**2514 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2515 * @param address substrate address2516 * @returns2517 */2518 getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2519 return this.subBalanceGroup.getSubstrateFull(address);2520 }25212522 /**2523 * Get total issuance2524 * @returns2525 */2526 getTotalIssuance(): Promise<bigint> {2527 return this.subBalanceGroup.getTotalIssuance();2528 }25292530 /**2531 * Get locked balances2532 * @param address substrate address2533 * @returns locked balances with reason via api.query.balances.locks2534 * @deprecated all the methods should switch to getFrozen2535 */2536 getLocked(address: TSubstrateAccount) {2537 return this.subBalanceGroup.getLocked(address);2538 }25392540 /**2541 * Get frozen balances2542 * @param address substrate address2543 * @returns frozen balances with id via api.query.balances.freezes2544 */2545 getFrozen(address: TSubstrateAccount) {2546 return this.subBalanceGroup.getFrozen(address);2547 }25482549 /**2550 * Get ethereum address balance2551 * @param address ethereum address2552 * @example getEthereum("0x9F0583DbB855d...")2553 * @returns amount of tokens on address2554 */2555 getEthereum(address: TEthereumAccount): Promise<bigint> {2556 return this.ethBalanceGroup.getEthereum(address);2557 }25582559 async setBalanceSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint) {2560 await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceSetBalance', [address, amount], true);2561 }25622563 /**2564 * Transfer tokens to substrate address2565 * @param signer keyring of signer2566 * @param address substrate address of a recipient2567 * @param amount amount of tokens to be transfered2568 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2569 * @returns ```true``` if extrinsic success, otherwise ```false```2570 */2571 transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2572 return this.subBalanceGroup.transferToSubstrate(signer, address, amount);2573 }25742575 async forceTransferToSubstrate(signer: TSigner, from: TSubstrateAccount, to: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2576 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceTransfer', [from, to, amount], true);25772578 let transfer = {from: null, to: null, amount: 0n} as any;2579 result.result.events.forEach(({event: {data, method, section}}) => {2580 if((section === 'balances') && (method === 'Transfer')) {2581 transfer = {2582 from: this.helper.address.normalizeSubstrate(data[0]),2583 to: this.helper.address.normalizeSubstrate(data[1]),2584 amount: BigInt(data[2]),2585 };2586 }2587 });2588 let isSuccess = this.helper.address.normalizeSubstrate(from) === transfer.from;2589 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(to) === transfer.to;2590 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2591 return isSuccess;2592 }25932594 /**2595 * Transfer tokens with the unlock period2596 * @param signer signers Keyring2597 * @param address Substrate address of recipient2598 * @param schedule Schedule params2599 * @example vestedTransfer(signer, recepient.address, 20000, 100, 10, 50 * nominal); // total amount of vested tokens will be 100 * 50 = 50002600 */2601 async vestedTransfer(signer: TSigner, address: TSubstrateAccount, schedule: { start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint }): Promise<void> {2602 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.vestedTransfer', [address, schedule]);2603 const event = result.result.events2604 .find(e => e.event.section === 'vesting' &&2605 e.event.method === 'VestingScheduleAdded' &&2606 e.event.data[0].toHuman() === signer.address);2607 if(!event) throw Error('Cannot find transfer in events');2608 }26092610 /**2611 * Get schedule for recepient of vested transfer2612 * @param address Substrate address of recipient2613 * @returns2614 */2615 async getVestingSchedules(address: TSubstrateAccount): Promise<{ start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint }[]> {2616 const schedule = (await this.helper.callRpc('api.query.vesting.vestingSchedules', [address])).toJSON();2617 return schedule.map((schedule: any) => ({2618 start: BigInt(schedule.start),2619 period: BigInt(schedule.period),2620 periodCount: BigInt(schedule.periodCount),2621 perPeriod: BigInt(schedule.perPeriod),2622 }));2623 }26242625 /**2626 * Claim vested tokens2627 * @param signer signers Keyring2628 */2629 async claim(signer: TSigner) {2630 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.claim', []);2631 const event = result.result.events2632 .find(e => e.event.section === 'vesting' &&2633 e.event.method === 'Claimed' &&2634 e.event.data[0].toHuman() === signer.address);2635 if(!event) throw Error('Cannot find claim in events');2636 }2637}26382639class AddressGroup extends HelperGroup<ChainHelperBase> {2640 /**2641 * Normalizes the address to the specified ss58 format, by default ```42```.2642 * @param address substrate address2643 * @param ss58Format format for address conversion, by default ```42```2644 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2645 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2646 */2647 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2648 return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2649 }26502651 /**2652 * Get address in the connected chain format2653 * @param address substrate address2654 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2655 * @returns address in chain format2656 */2657 normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2658 return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2659 }26602661 /**2662 * Get substrate mirror of an ethereum address2663 * @param ethAddress ethereum address2664 * @param toChainFormat false for normalized account2665 * @example ethToSubstrate('0x9F0583DbB855d...')2666 * @returns substrate mirror of a provided ethereum address2667 */2668 ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat = false): TSubstrateAccount {2669 return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2670 }26712672 /**2673 * Get ethereum mirror of a substrate address2674 * @param subAddress substrate account2675 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2676 * @returns ethereum mirror of a provided substrate address2677 */2678 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2679 return CrossAccountId.translateSubToEth(subAddress);2680 }26812682 /**2683 * Encode key to substrate address2684 * @param key key for encoding address2685 * @param ss58Format prefix for encoding to the address of the corresponding network2686 * @returns encoded substrate address2687 */2688 encodeSubstrateAddress(key: Uint8Array | string | bigint, ss58Format = 42): string {2689 const u8a: Uint8Array = typeof key === 'string'2690 ? hexToU8a(key)2691 : typeof key === 'bigint'2692 ? hexToU8a(key.toString(16))2693 : key;26942695 if(ss58Format < 0 || ss58Format > 16383 || [46, 47].includes(ss58Format)) {2696 throw new Error(`ss58Format is not valid, received ${typeofss58Format} "${ss58Format}"`);2697 }26982699 const allowedDecodedLengths = [1, 2, 4, 8, 32, 33];2700 if(!allowedDecodedLengths.includes(u8a.length)) {2701 throw new Error(`key length is not valid, received ${u8a.length}, valid values are ${allowedDecodedLengths.join(', ')}`);2702 }27032704 const u8aPrefix = ss58Format < 642705 ? new Uint8Array([ss58Format])2706 : new Uint8Array([2707 ((ss58Format & 0xfc) >> 2) | 0x40,2708 (ss58Format >> 8) | ((ss58Format & 0x03) << 6),2709 ]);27102711 const input = u8aConcat(u8aPrefix, u8a);27122713 return base58Encode(u8aConcat(2714 input,2715 blake2AsU8a(input).subarray(0, [32, 33].includes(u8a.length) ? 2 : 1),2716 ));2717 }27182719 /**2720 * Restore substrate address from bigint representation2721 * @param number decimal representation of substrate address2722 * @returns substrate address2723 */2724 restoreCrossAccountFromBigInt(number: bigint): TSubstrateAccount {2725 if(this.helper.api === null) {2726 throw 'Not connected';2727 }2728 const res = this.helper.api.registry.createType('AccountId', '0x' + number.toString(16).padStart(64, '0')).toJSON();2729 if(res === undefined || res === null) {2730 throw 'Restore address error';2731 }2732 return res.toString();2733 }27342735 /**2736 * Convert etherium cross account id to substrate cross account id2737 * @param ethCrossAccount etherium cross account2738 * @returns substrate cross account id2739 */2740 convertCrossAccountFromEthCrossAccount(ethCrossAccount: IEthCrossAccountId): ICrossAccountId {2741 if(ethCrossAccount.sub === '0') {2742 return {Ethereum: ethCrossAccount.eth.toLocaleLowerCase()};2743 }27442745 const ss58 = this.restoreCrossAccountFromBigInt(BigInt(ethCrossAccount.sub));2746 return {Substrate: ss58};2747 }27482749 paraSiblingSovereignAccount(paraid: number) {2750 // We are getting a *sibling* parachain sovereign account,2751 // so we need a sibling prefix: encoded(b"sibl") == 0x7369626c2752 const siblingPrefix = '0x7369626c';27532754 const encodedParaId = this.helper.getApi().createType('u32', paraid).toHex(true).substring(2);2755 const suffix = '000000000000000000000000000000000000000000000000';27562757 return siblingPrefix + encodedParaId + suffix;2758 }2759}27602761class StakingGroup extends HelperGroup<UniqueHelper> {2762 /**2763 * Stake tokens for App Promotion2764 * @param signer keyring of signer2765 * @param amountToStake amount of tokens to stake2766 * @param label extra label for log2767 * @returns2768 */2769 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2770 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2771 const _stakeResult = await this.helper.executeExtrinsic(2772 signer, 'api.tx.appPromotion.stake',2773 [amountToStake], true,2774 );2775 // TODO extract info from stakeResult2776 return true;2777 }27782779 /**2780 * Unstake all staked tokens2781 * @param signer keyring of signer2782 * @param amountToUnstake amount of tokens to unstake2783 * @param label extra label for log2784 * @returns block hash where unstake happened2785 */2786 async unstakeAll(signer: TSigner, label?: string): Promise<string> {2787 if(typeof label === 'undefined') label = `${signer.address}`;2788 const unstakeResult = await this.helper.executeExtrinsic(2789 signer, 'api.tx.appPromotion.unstakeAll',2790 [], true,2791 );2792 return unstakeResult.blockHash;2793 }27942795 /**2796 * Unstake the part of a staked tokens2797 * @param signer keyring of signer2798 * @param amount amount of tokens to unstake2799 * @param label extra label for log2800 * @returns block hash where unstake happened2801 */2802 async unstakePartial(signer: TSigner, amount: bigint, label?: string): Promise<string> {2803 if(typeof label === 'undefined') label = `${signer.address}`;2804 const unstakeResult = await this.helper.executeExtrinsic(2805 signer, 'api.tx.appPromotion.unstakePartial',2806 [amount], true,2807 );2808 return unstakeResult.blockHash;2809 }28102811 /**2812 * Get total number of active stakes2813 * @param address substrate address2814 * @returns {number}2815 */2816 async getStakesNumber(address: ICrossAccountId): Promise<number> {2817 if('Ethereum' in address) throw Error('only substrate address');2818 return (await this.helper.callRpc('api.query.appPromotion.stakesPerAccount', [address.Substrate])).toNumber();2819 }28202821 /**2822 * Get total staked amount for address2823 * @param address substrate or ethereum address2824 * @returns total staked amount2825 */2826 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2827 if(address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2828 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2829 }28302831 /**2832 * Get total staked per block2833 * @param address substrate or ethereum address2834 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2835 */2836 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2837 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2838 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => ({2839 block: block.toBigInt(),2840 amount: amount.toBigInt(),2841 }));2842 }28432844 /**2845 * Get total pending unstake amount for address2846 * @param address substrate or ethereum address2847 * @returns total pending unstake amount2848 */2849 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2850 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2851 }28522853 /**2854 * Get pending unstake amount per block for address2855 * @param address substrate or ethereum address2856 * @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 block2857 */2858 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2859 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2860 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => ({2861 block: block.toBigInt(),2862 amount: amount.toBigInt(),2863 }));2864 return result;2865 }2866}28672868class SchedulerGroup extends HelperGroup<UniqueHelper> {2869 constructor(helper: UniqueHelper) {2870 super(helper);2871 }28722873 cancelScheduled(signer: TSigner, scheduledId: string) {2874 return this.helper.executeExtrinsic(2875 signer,2876 'api.tx.scheduler.cancelNamed',2877 [scheduledId],2878 true,2879 );2880 }28812882 changePriority(signer: TSigner, scheduledId: string, priority: number) {2883 return this.helper.executeExtrinsic(2884 signer,2885 'api.tx.scheduler.changeNamedPriority',2886 [scheduledId, priority],2887 true,2888 );2889 }28902891 scheduleAt<T extends UniqueHelper>(2892 executionBlockNumber: number,2893 options: ISchedulerOptions = {},2894 ) {2895 return this.schedule<T>('schedule', executionBlockNumber, options);2896 }28972898 scheduleAfter<T extends UniqueHelper>(2899 blocksBeforeExecution: number,2900 options: ISchedulerOptions = {},2901 ) {2902 return this.schedule<T>('scheduleAfter', blocksBeforeExecution, options);2903 }29042905 schedule<T extends UniqueHelper>(2906 scheduleFn: 'schedule' | 'scheduleAfter',2907 blocksNum: number,2908 options: ISchedulerOptions = {},2909 ) {2910 // eslint-disable-next-line @typescript-eslint/naming-convention2911 const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2912 return this.helper.clone(ScheduledHelperType, {2913 scheduleFn,2914 blocksNum,2915 options,2916 }) as T;2917 }2918}29192920class CollatorSelectionGroup extends HelperGroup<UniqueHelper> {2921 //todo:collator documentation2922 addInvulnerable(signer: TSigner, address: string) {2923 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.addInvulnerable', [address]);2924 }29252926 removeInvulnerable(signer: TSigner, address: string) {2927 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.removeInvulnerable', [address]);2928 }29292930 async getInvulnerables(): Promise<string[]> {2931 return (await this.helper.callRpc('api.query.collatorSelection.invulnerables')).map((x: any) => x.toHuman());2932 }29332934 /** and also total max invulnerables */2935 maxCollators(): number {2936 return (this.helper.getApi().consts.configuration.defaultCollatorSelectionMaxCollators.toJSON() as number);2937 }29382939 async getDesiredCollators(): Promise<number> {2940 return (await this.helper.callRpc('api.query.configuration.collatorSelectionDesiredCollatorsOverride')).toNumber();2941 }29422943 setLicenseBond(signer: TSigner, amount: bigint) {2944 return this.helper.executeExtrinsic(signer, 'api.tx.configuration.setCollatorSelectionLicenseBond', [amount]);2945 }29462947 async getLicenseBond(): Promise<bigint> {2948 return (await this.helper.callRpc('api.query.configuration.collatorSelectionLicenseBondOverride')).toBigInt();2949 }29502951 obtainLicense(signer: TSigner) {2952 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.getLicense', []);2953 }29542955 releaseLicense(signer: TSigner) {2956 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.releaseLicense', []);2957 }29582959 forceReleaseLicense(signer: TSigner, released: string) {2960 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.forceReleaseLicense', [released]);2961 }29622963 async hasLicense(address: string): Promise<bigint> {2964 return (await this.helper.callRpc('api.query.collatorSelection.licenseDepositOf', [address])).toBigInt();2965 }29662967 onboard(signer: TSigner) {2968 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.onboard', []);2969 }29702971 offboard(signer: TSigner) {2972 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.offboard', []);2973 }29742975 async getCandidates(): Promise<string[]> {2976 return (await this.helper.callRpc('api.query.collatorSelection.candidates')).map((x: any) => x.toHuman());2977 }2978}29792980class CollectiveGroup extends HelperGroup<UniqueHelper> {2981 /**2982 * Pallet name to make an API call to. Examples: 'council', 'technicalCommittee'2983 */2984 private collective: string;29852986 constructor(helper: UniqueHelper, collective: string) {2987 super(helper);2988 this.collective = collective;2989 }29902991 /**2992 * Check the result of a proposal execution for the success of the underlying proposed extrinsic.2993 * @param events events of the proposal execution2994 * @returns proposal hash2995 */2996 private checkExecutedEvent(events: IPhasicEvent[]): string {2997 const executionEvents = events.filter(x =>2998 x.event.section === this.collective && (x.event.method === 'Executed' || x.event.method === 'MemberExecuted'));29993000 if(executionEvents.length != 1) {3001 if(events.filter(x => x.event.section === this.collective && x.event.method === 'Disapproved').length > 0)3002 throw new Error(`Disapproved by ${this.collective}`);3003 else3004 throw new Error(`Expected one 'Executed' or 'MemberExecuted' event for ${this.collective}`);3005 }30063007 const result = (executionEvents[0].event.data as any).result;30083009 if(result.isErr) {3010 if(result.asErr.isModule) {3011 const error = result.asErr.asModule;3012 const metaError = this.helper.getApi()?.registry.findMetaError(error);3013 throw new Error(`Proposal execution failed with ${metaError.section}.${metaError.name}`);3014 } else {3015 throw new Error('Proposal execution failed with ' + result.asErr.toHuman());3016 }3017 }30183019 return (executionEvents[0].event.data as any).proposalHash;3020 }30213022 /**3023 * Returns an array of members' addresses.3024 */3025 async getMembers() {3026 return (await this.helper.callRpc(`api.query.${this.collective}.members`, [])).toHuman();3027 }30283029 /**3030 * Returns the optional address of the prime member of the collective.3031 */3032 async getPrimeMember() {3033 return (await this.helper.callRpc(`api.query.${this.collective}.prime`, [])).toHuman();3034 }30353036 /**3037 * Returns an array of proposal hashes that are currently active for this collective.3038 */3039 async getProposals() {3040 return (await this.helper.callRpc(`api.query.${this.collective}.proposals`, [])).toHuman();3041 }30423043 /**3044 * Returns the call originally encoded under the specified hash.3045 * @param hash h256-encoded proposal3046 * @returns the optional call that the proposal hash stands for.3047 */3048 async getProposalCallOf(hash: string) {3049 return (await this.helper.callRpc(`api.query.${this.collective}.proposalOf`, [hash])).toHuman();3050 }30513052 /**3053 * Returns the total number of proposals so far.3054 */3055 async getTotalProposalsCount() {3056 return (await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, [])).toNumber();3057 }30583059 /**3060 * Creates a new proposal up for voting. If the threshold is set to 1, the proposal will be executed immediately.3061 * @param signer keyring of the proposer3062 * @param proposal constructed call to be executed if the proposal is successful3063 * @param voteThreshold minimal number of votes for the proposal to be verified and executed3064 * @param lengthBound byte length of the encoded call3065 * @returns promise of extrinsic execution and its result3066 */3067 async propose(signer: TSigner, proposal: any, voteThreshold: number, lengthBound = 10000) {3068 return await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [voteThreshold, proposal, lengthBound]);3069 }30703071 /**3072 * Casts a vote to either approve or reject a proposal.3073 * @param signer keyring of the voter3074 * @param proposalHash hash of the proposal to be voted for3075 * @param proposalIndex absolute index of the proposal used for absolutely nothing but throwing pointless errors3076 * @param approve aye or nay3077 * @returns promise of extrinsic execution and its result3078 */3079 vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {3080 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve]);3081 }30823083 /**3084 * Executes a call immediately as a member of the collective. Needed for the Member origin.3085 * @param signer keyring of the executor member3086 * @param proposal constructed call to be executed by the member3087 * @param lengthBound byte length of the encoded call3088 * @returns promise of extrinsic execution3089 */3090 async execute(signer: TSigner, proposal: any, lengthBound = 10000) {3091 const result = await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.execute`, [proposal, lengthBound]);3092 this.checkExecutedEvent(result.result.events);3093 return result;3094 }30953096 /**3097 * Attempt to close and execute a proposal. Note that there must already be enough votes to meet the threshold set when proposing.3098 * @param signer keyring of the executor. Can be absolutely anyone.3099 * @param proposalHash hash of the proposal to close3100 * @param proposalIndex index of the proposal generated on its creation3101 * @param weightBound weight of the proposed call. Can be obtained by calling `paymentInfo()` on the call.3102 * @param lengthBound byte length of the encoded call3103 * @returns promise of extrinsic execution and its result3104 */3105 async close(3106 signer: TSigner,3107 proposalHash: string,3108 proposalIndex: number,3109 weightBound: [number, number] | any = [20_000_000_000, 1000_000],3110 lengthBound = 10_000,3111 ) {3112 const result = await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [3113 proposalHash,3114 proposalIndex,3115 weightBound,3116 lengthBound,3117 ]);3118 this.checkExecutedEvent(result.result.events);3119 return result;3120 }31213122 /**3123 * Shut down a proposal, regardless of its current state.3124 * @param signer keyring of the disapprover. Must be root3125 * @param proposalHash hash of the proposal to close3126 * @returns promise of extrinsic execution and its result3127 */3128 disapproveProposal(signer: TSigner, proposalHash: string) {3129 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.disapproveProposal`, [proposalHash]);3130 }3131}31323133class CollectiveMembershipGroup extends HelperGroup<UniqueHelper> {3134 /**3135 * Pallet name to make an API call to. Examples: 'councilMembership', 'technicalCommitteeMembership'3136 */3137 private membership: string;31383139 constructor(helper: UniqueHelper, membership: string) {3140 super(helper);3141 this.membership = membership;3142 }31433144 /**3145 * Returns an array of members' addresses according to the membership pallet's perception.3146 * Note that it does not recognize the original pallet's members set with `setMembers()`.3147 */3148 async getMembers() {3149 return (await this.helper.callRpc(`api.query.${this.membership}.members`, [])).toHuman();3150 }31513152 /**3153 * Returns the optional address of the prime member of the collective.3154 */3155 async getPrimeMember() {3156 return (await this.helper.callRpc(`api.query.${this.membership}.prime`, [])).toHuman();3157 }31583159 /**3160 * Add a member to the collective.3161 * @param signer keyring of the setter. Must be root3162 * @param member address of the member to add3163 * @returns promise of extrinsic execution and its result3164 */3165 addMember(signer: TSigner, member: string) {3166 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.addMember`, [member]);3167 }31683169 addMemberCall(member: string) {3170 return this.helper.constructApiCall(`api.tx.${this.membership}.addMember`, [member]);3171 }31723173 /**3174 * Remove a member from the collective.3175 * @param signer keyring of the setter. Must be root3176 * @param member address of the member to remove3177 * @returns promise of extrinsic execution and its result3178 */3179 removeMember(signer: TSigner, member: string) {3180 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.removeMember`, [member]);3181 }31823183 removeMemberCall(member: string) {3184 return this.helper.constructApiCall(`api.tx.${this.membership}.removeMember`, [member]);3185 }31863187 /**3188 * Set members of the collective to the given list of addresses.3189 * @param signer keyring of the setter. Must be root (for the direct call, bypassing a public motion)3190 * @param members addresses of the members to set3191 * @returns promise of extrinsic execution and its result3192 */3193 resetMembers(signer: TSigner, members: string[]) {3194 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.resetMembers`, [members]);3195 }31963197 /**3198 * Set the collective's prime member to the given address.3199 * @param signer keyring of the setter. Must be root (for the direct call, bypassing a public motion)3200 * @param prime address of the prime member of the collective3201 * @returns promise of extrinsic execution and its result3202 */3203 setPrime(signer: TSigner, prime: string) {3204 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.setPrime`, [prime]);3205 }32063207 setPrimeCall(member: string) {3208 return this.helper.constructApiCall(`api.tx.${this.membership}.setPrime`, [member]);3209 }32103211 /**3212 * Remove the collective's prime member.3213 * @param signer keyring of the setter. Must be root (for the direct call, bypassing a public motion)3214 * @returns promise of extrinsic execution and its result3215 */3216 clearPrime(signer: TSigner) {3217 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.clearPrime`, []);3218 }32193220 clearPrimeCall() {3221 return this.helper.constructApiCall(`api.tx.${this.membership}.clearPrime`, []);3222 }3223}32243225class RankedCollectiveGroup extends HelperGroup<UniqueHelper> {3226 /**3227 * Pallet name to make an API call to. Examples: 'FellowshipCollective'3228 */3229 private collective: string;32303231 constructor(helper: UniqueHelper, collective: string) {3232 super(helper);3233 this.collective = collective;3234 }32353236 addMember(signer: TSigner, newMember: string) {3237 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.addMember`, [newMember]);3238 }32393240 addMemberCall(newMember: string) {3241 return this.helper.constructApiCall(`api.tx.${this.collective}.addMember`, [newMember]);3242 }32433244 removeMember(signer: TSigner, member: string, minRank: number) {3245 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.removeMember`, [member, minRank]);3246 }32473248 removeMemberCall(newMember: string, minRank: number) {3249 return this.helper.constructApiCall(`api.tx.${this.collective}.removeMember`, [newMember, minRank]);3250 }32513252 promote(signer: TSigner, member: string) {3253 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.promoteMember`, [member]);3254 }32553256 promoteCall(newMember: string) {3257 return this.helper.constructApiCall(`api.tx.${this.collective}.promoteMember`, [newMember]);3258 }32593260 demote(signer: TSigner, member: string) {3261 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.demoteMember`, [member]);3262 }32633264 demoteCall(newMember: string) {3265 return this.helper.constructApiCall(`api.tx.${this.collective}.demoteMember`, [newMember]);3266 }32673268 vote(signer: TSigner, pollIndex: number, aye: boolean) {3269 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [pollIndex, aye]);3270 }32713272 async getMembers() {3273 return (await this.helper.getApi().query.fellowshipCollective.members.keys())3274 .map((key) => key.args[0].toString());3275 }3276}32773278class ReferendaGroup extends HelperGroup<UniqueHelper> {3279 /**3280 * Pallet name to make an API call to. Examples: 'FellowshipReferenda'3281 */3282 private referenda: string;32833284 constructor(helper: UniqueHelper, referenda: string) {3285 super(helper);3286 this.referenda = referenda;3287 }32883289 submit(3290 signer: TSigner,3291 proposalOrigin: string,3292 proposal: any,3293 enactmentMoment: any,3294 ) {3295 return this.helper.executeExtrinsic(signer, `api.tx.${this.referenda}.submit`, [3296 {Origins: proposalOrigin},3297 proposal,3298 enactmentMoment,3299 ]);3300 }33013302 placeDecisionDeposit(signer: TSigner, referendumIndex: number) {3303 return this.helper.executeExtrinsic(signer, `api.tx.${this.referenda}.placeDecisionDeposit`, [referendumIndex]);3304 }33053306 cancel(signer: TSigner, referendumIndex: number) {3307 return this.helper.executeExtrinsic(signer, `api.tx.${this.referenda}.cancel`, [referendumIndex]);3308 }33093310 cancelCall(referendumIndex: number) {3311 return this.helper.constructApiCall(`api.tx.${this.referenda}.cancel`, [referendumIndex]);3312 }33133314 async referendumInfo(referendumIndex: number) {3315 return (await this.helper.callRpc(`api.query.${this.referenda}.referendumInfoFor`, [referendumIndex])).toJSON();3316 }33173318 async enactmentEventId(referendumIndex: number) {3319 const api = await this.helper.getApi();33203321 const bytes = api.createType('([u8;8], Text, u32)', ['assembly', 'enactment', referendumIndex]).toU8a();3322 return blake2AsHex(bytes, 256);3323 }3324}33253326export interface IFellowshipGroup {3327 collective: RankedCollectiveGroup;3328 referenda: ReferendaGroup;3329}33303331export interface ICollectiveGroup {3332 collective: CollectiveGroup;3333 membership: CollectiveMembershipGroup;3334}33353336class DemocracyGroup extends HelperGroup<UniqueHelper> {3337 // todo displace proposal into types?3338 propose(signer: TSigner, call: any, deposit: bigint) {3339 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.propose', [{Inline: call.method.toHex()}, deposit]);3340 }33413342 proposeWithPreimage(signer: TSigner, preimage: string, deposit: bigint) {3343 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.propose', [{Legacy: preimage}, deposit]);3344 }33453346 proposeCall(call: any, deposit: bigint) {3347 return this.helper.constructApiCall('api.tx.democracy.propose', [{Inline: call.method.toHex()}, deposit]);3348 }33493350 second(signer: TSigner, proposalIndex: number) {3351 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.second', [proposalIndex]);3352 }33533354 externalPropose(signer: TSigner, proposalCall: any) {3355 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalPropose', [{Inline: proposalCall.method.toHex()}]);3356 }33573358 externalProposeMajority(signer: TSigner, proposalCall: any) {3359 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalProposeMajority', [{Inline: proposalCall.method.toHex()}]);3360 }33613362 externalProposeDefault(signer: TSigner, proposalCall: any) {3363 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalProposeDefault', [{Inline: proposalCall.method.toHex()}]);3364 }33653366 externalProposeDefaultWithPreimage(signer: TSigner, preimage: string) {3367 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalProposeDefault', [{Legacy: preimage}]);3368 }33693370 externalProposeCall(proposalCall: any) {3371 return this.helper.constructApiCall('api.tx.democracy.externalPropose', [{Inline: proposalCall.method.toHex()}]);3372 }33733374 externalProposeMajorityCall(proposalCall: any) {3375 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [{Inline: proposalCall.method.toHex()}]);3376 }33773378 externalProposeDefaultCall(proposalCall: any) {3379 return this.helper.constructApiCall('api.tx.democracy.externalProposeDefault', [{Inline: proposalCall.method.toHex()}]);3380 }33813382 // ... and blacklist external proposal hash.3383 vetoExternal(signer: TSigner, proposalHash: string) {3384 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.vetoExternal', [proposalHash]);3385 }33863387 vetoExternalCall(proposalHash: string) {3388 return this.helper.constructApiCall('api.tx.democracy.vetoExternal', [proposalHash]);3389 }33903391 blacklist(signer: TSigner, proposalHash: string, referendumIndex: number | null = null) {3392 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.blacklist', [proposalHash, referendumIndex]);3393 }33943395 blacklistCall(proposalHash: string, referendumIndex: number | null = null) {3396 return this.helper.constructApiCall('api.tx.democracy.blacklist', [proposalHash, referendumIndex]);3397 }33983399 // proposal. CancelProposalOrigin (root or all techcom)3400 cancelProposal(signer: TSigner, proposalIndex: number) {3401 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.cancelProposal', [proposalIndex]);3402 }34033404 cancelProposalCall(proposalIndex: number) {3405 return this.helper.constructApiCall('api.tx.democracy.cancelProposal', [proposalIndex]);3406 }34073408 clearPublicProposals(signer: TSigner) {3409 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.clearPublicProposals', []);3410 }34113412 fastTrack(signer: TSigner, proposalHash: string, votingPeriod: number, delayPeriod: number) {3413 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);3414 }34153416 fastTrackCall(proposalHash: string, votingPeriod: number, delayPeriod: number) {3417 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);3418 }34193420 // referendum. CancellationOrigin (TechCom member)3421 emergencyCancel(signer: TSigner, referendumIndex: number) {3422 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.emergencyCancel', [referendumIndex]);3423 }34243425 emergencyCancelCall(referendumIndex: number) {3426 return this.helper.constructApiCall('api.tx.democracy.emergencyCancel', [referendumIndex]);3427 }34283429 vote(signer: TSigner, referendumIndex: number, vote: any) {3430 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, vote]);3431 }34323433 removeVote(signer: TSigner, referendumIndex: number, targetAccount?: string) {3434 if(targetAccount) {3435 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.removeOtherVote', [targetAccount, referendumIndex]);3436 } else {3437 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.removeVote', [referendumIndex]);3438 }3439 }34403441 unlock(signer: TSigner, targetAccount: string) {3442 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.unlock', [targetAccount]);3443 }34443445 delegate(signer: TSigner, toAccount: string, conviction: PalletDemocracyConviction, balance: bigint) {3446 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.delegate', [toAccount, conviction, balance]);3447 }34483449 undelegate(signer: TSigner) {3450 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.undelegate', []);3451 }34523453 async referendumInfo(referendumIndex: number) {3454 return (await this.helper.callRpc('api.query.democracy.referendumInfoOf', [referendumIndex])).toJSON();3455 }34563457 async publicProposals() {3458 return (await this.helper.callRpc('api.query.democracy.publicProps', [])).toJSON();3459 }34603461 async findPublicProposal(proposalIndex: number) {3462 const proposalInfo = (await this.publicProposals()).find((proposalInfo: any[]) => proposalInfo[0] == proposalIndex);34633464 return proposalInfo ? proposalInfo[1] : null;3465 }34663467 async expectPublicProposal(proposalIndex: number) {3468 const proposal = await this.findPublicProposal(proposalIndex);34693470 if(proposal) {3471 return proposal;3472 } else {3473 throw Error(`Proposal #${proposalIndex} is expected to exist`);3474 }3475 }34763477 async getExternalProposal() {3478 return (await this.helper.callRpc('api.query.democracy.nextExternal', []));3479 }34803481 async expectExternalProposal() {3482 const proposal = await this.getExternalProposal();34833484 if(proposal) {3485 return proposal;3486 } else {3487 throw Error('An external proposal is expected to exist');3488 }3489 }34903491 /* setMetadata? */34923493 /* todo?3494 referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {3495 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);3496 }*/3497}34983499class PreimageGroup extends HelperGroup<UniqueHelper> {3500 async getPreimageInfo(h256: string) {3501 return (await this.helper.callRpc('api.query.preimage.statusFor', [h256])).toJSON();3502 }35033504 /**3505 * Create a preimage from an API call.3506 * @param signer keyring of the signer.3507 * @param call an extrinsic call3508 * @example await notePreimageFromCall(preimageMaker,3509 * helper.constructApiCall('api.tx.identity.forceInsertIdentities', [identitiesToAdd])3510 * );3511 * @returns promise of extrinsic execution.3512 */3513 notePreimageFromCall(signer: TSigner, call: any, returnPreimageHash = false) {3514 return this.notePreimage(signer, call.method.toHex(), returnPreimageHash);3515 }35163517 /**3518 * Create a preimage with a hex or a byte array.3519 * @param signer keyring of the signer.3520 * @param bytes preimage encoded in hex or a byte array, e.g. an extrinsic call.3521 * @example await notePreimage(preimageMaker,3522 * helper.constructApiCall('api.tx.identity.forceInsertIdentities', [identitiesToAdd]).method.toHex()3523 * );3524 * @returns promise of extrinsic execution.3525 */3526 async notePreimage(signer: TSigner, bytes: string | Uint8Array, returnPreimageHash = false) {3527 const promise = this.helper.executeExtrinsic(signer, 'api.tx.preimage.notePreimage', [bytes]);3528 if(returnPreimageHash) {3529 const result = await promise;3530 const events = result.result.events.filter(x => x.event.method === 'Noted' && x.event.section === 'preimage');3531 const preimageHash = events[0].event.data[0].toHuman();3532 return preimageHash;3533 }3534 return promise;3535 }35363537 /**3538 * Delete an existing preimage and return the deposit.3539 * @param signer keyring of the signer - either the owner or the preimage manager (sudo).3540 * @param h256 hash of the preimage.3541 * @returns promise of extrinsic execution.3542 */3543 unnotePreimage(signer: TSigner, h256: string) {3544 return this.helper.executeExtrinsic(signer, 'api.tx.preimage.unnotePreimage', [h256]);3545 }35463547 /**3548 * Request a preimage be uploaded to the chain without paying any fees or deposits.3549 * @param signer keyring of the signer - either the owner or the preimage manager (sudo).3550 * @param h256 hash of the preimage.3551 * @returns promise of extrinsic execution.3552 */3553 requestPreimage(signer: TSigner, h256: string) {3554 return this.helper.executeExtrinsic(signer, 'api.tx.preimage.requestPreimage', [h256]);3555 }35563557 /**3558 * Clear a previously made request for a preimage.3559 * @param signer keyring of the signer - either the owner or the preimage manager (sudo).3560 * @param h256 hash of the preimage.3561 * @returns promise of extrinsic execution.3562 */3563 unrequestPreimage(signer: TSigner, h256: string) {3564 return this.helper.executeExtrinsic(signer, 'api.tx.preimage.unrequestPreimage', [h256]);3565 }3566}35673568class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {3569 async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {3570 await this.helper.executeExtrinsic(3571 signer,3572 'api.tx.foreignAssets.registerForeignAsset',3573 [ownerAddress, location, metadata],3574 true,3575 );3576 }35773578 async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {3579 await this.helper.executeExtrinsic(3580 signer,3581 'api.tx.foreignAssets.updateForeignAsset',3582 [foreignAssetId, location, metadata],3583 true,3584 );3585 }3586}35873588class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {3589 palletName: string;35903591 constructor(helper: T, palletName: string) {3592 super(helper);35933594 this.palletName = palletName;3595 }35963597 async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: any) {3598 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, weightLimit], true);3599 }36003601 async setSafeXcmVersion(signer: TSigner, version: number) {3602 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.forceDefaultXcmVersion`, [version], true);3603 }36043605 async teleportAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number) {3606 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.teleportAssets`, [destination, beneficiary, assets, feeAssetItem], true);3607 }36083609 async teleportNativeAsset(signer: TSigner, destinationParaId: number, targetAccount: Uint8Array, amount: bigint, xcmVersion = 3) {3610 const destinationContent = {3611 parents: 0,3612 interior: {3613 X1: {3614 Parachain: destinationParaId,3615 },3616 },3617 };36183619 const beneficiaryContent = {3620 parents: 0,3621 interior: {3622 X1: {3623 AccountId32: {3624 network: 'Any',3625 id: targetAccount,3626 },3627 },3628 },3629 };36303631 const assetsContent = [3632 {3633 id: {3634 Concrete: {3635 parents: 0,3636 interior: 'Here',3637 },3638 },3639 fun: {3640 Fungible: amount,3641 },3642 },3643 ];36443645 let destination;3646 let beneficiary;3647 let assets;36483649 if(xcmVersion == 2) {3650 destination = {V1: destinationContent};3651 beneficiary = {V1: beneficiaryContent};3652 assets = {V1: assetsContent};36533654 } else if(xcmVersion == 3) {3655 destination = {V2: destinationContent};3656 beneficiary = {V2: beneficiaryContent};3657 assets = {V2: assetsContent};36583659 } else {3660 throw Error('Unknown XCM version: ' + xcmVersion);3661 }36623663 const feeAssetItem = 0;36643665 await this.teleportAssets(signer, destination, beneficiary, assets, feeAssetItem);3666 }36673668 async send(signer: IKeyringPair, destination: any, message: any) {3669 await this.helper.executeExtrinsic(3670 signer,3671 `api.tx.${this.palletName}.send`,3672 [3673 destination,3674 message,3675 ],3676 true,3677 );3678 }3679}36803681class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {3682 async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: any) {3683 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);3684 }36853686 async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: any) {3687 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);3688 }36893690 async transferMulticurrencies(signer: TSigner, currencies: any[], feeItem: number, destLocation: any, destWeight: any) {3691 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMulticurrencies', [currencies, feeItem, destLocation, destWeight], true);3692 }3693}36943695class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {3696 async accounts(address: string, currencyId: any) {3697 const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;3698 return BigInt(free);3699 }3700}37013702class AssetsGroup<T extends ChainHelperBase> extends HelperGroup<T> {3703 async create(signer: TSigner, assetId: number, admin: string, minimalBalance: bigint) {3704 await this.helper.executeExtrinsic(signer, 'api.tx.assets.create', [assetId, admin, minimalBalance], true);3705 }37063707 async setMetadata(signer: TSigner, assetId: number, name: string, symbol: string, decimals: number) {3708 await this.helper.executeExtrinsic(signer, 'api.tx.assets.setMetadata', [assetId, name, symbol, decimals], true);3709 }37103711 async mint(signer: TSigner, assetId: number, beneficiary: string, amount: bigint) {3712 await this.helper.executeExtrinsic(signer, 'api.tx.assets.mint', [assetId, beneficiary, amount], true);3713 }37143715 async account(assetId: string | number, address: string) {3716 const accountAsset = (3717 await this.helper.callRpc('api.query.assets.account', [assetId, address])3718 ).toJSON()! as any;37193720 if(accountAsset !== null) {3721 return BigInt(accountAsset['balance']);3722 } else {3723 return null;3724 }3725 }3726}37273728class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {3729 async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {3730 await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);3731 }3732}37333734class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {3735 makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {3736 const apiPrefix = 'api.tx.assetManager.';37373738 const registerTx = this.helper.constructApiCall(3739 apiPrefix + 'registerForeignAsset',3740 [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],3741 );37423743 const setUnitsTx = this.helper.constructApiCall(3744 apiPrefix + 'setAssetUnitsPerSecond',3745 [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],3746 );37473748 const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);3749 const encodedProposal = batchCall?.method.toHex() || '';3750 return encodedProposal;3751 }37523753 async assetTypeId(location: any) {3754 return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);3755 }3756}37573758class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {3759 notePreimagePallet: string;37603761 constructor(helper: MoonbeamHelper, options: { [key: string]: any } = {}) {3762 super(helper);3763 this.notePreimagePallet = options.notePreimagePallet;3764 }37653766 async notePreimage(signer: TSigner, encodedProposal: string) {3767 await this.helper.executeExtrinsic(signer, `api.tx.${this.notePreimagePallet}.notePreimage`, [encodedProposal], true);3768 }37693770 externalProposeMajority(proposal: any) {3771 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposal]);3772 }37733774 fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {3775 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);3776 }37773778 async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {3779 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);3780 }3781}37823783class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {3784 collective: string;37853786 constructor(helper: MoonbeamHelper, collective: string) {3787 super(helper);37883789 this.collective = collective;3790 }37913792 async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {3793 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);3794 }37953796 async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {3797 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);3798 }37993800 async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: any, lengthBound: number) {3801 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);3802 }38033804 async proposalCount() {3805 return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));3806 }3807}38083809export type ChainHelperBaseConstructor = new (...args: any[]) => ChainHelperBase;3810export type UniqueHelperConstructor = new (...args: any[]) => UniqueHelper;38113812export class UniqueHelper extends ChainHelperBase {3813 balance: BalanceGroup<UniqueHelper>;3814 collection: CollectionGroup;3815 nft: NFTGroup;3816 rft: RFTGroup;3817 ft: FTGroup;3818 staking: StakingGroup;3819 scheduler: SchedulerGroup;3820 collatorSelection: CollatorSelectionGroup;3821 council: ICollectiveGroup;3822 technicalCommittee: ICollectiveGroup;3823 fellowship: IFellowshipGroup;3824 democracy: DemocracyGroup;3825 preimage: PreimageGroup;3826 foreignAssets: ForeignAssetsGroup;3827 xcm: XcmGroup<UniqueHelper>;3828 xTokens: XTokensGroup<UniqueHelper>;3829 tokens: TokensGroup<UniqueHelper>;38303831 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3832 super(logger, options.helperBase ?? UniqueHelper);38333834 this.balance = new BalanceGroup(this);3835 this.collection = new CollectionGroup(this);3836 this.nft = new NFTGroup(this);3837 this.rft = new RFTGroup(this);3838 this.ft = new FTGroup(this);3839 this.staking = new StakingGroup(this);3840 this.scheduler = new SchedulerGroup(this);3841 this.collatorSelection = new CollatorSelectionGroup(this);3842 this.council = {3843 collective: new CollectiveGroup(this, 'council'),3844 membership: new CollectiveMembershipGroup(this, 'councilMembership'),3845 };3846 this.technicalCommittee = {3847 collective: new CollectiveGroup(this, 'technicalCommittee'),3848 membership: new CollectiveMembershipGroup(this, 'technicalCommitteeMembership'),3849 };3850 this.fellowship = {3851 collective: new RankedCollectiveGroup(this, 'fellowshipCollective'),3852 referenda: new ReferendaGroup(this, 'fellowshipReferenda'),3853 };3854 this.democracy = new DemocracyGroup(this);3855 this.preimage = new PreimageGroup(this);3856 this.foreignAssets = new ForeignAssetsGroup(this);3857 this.xcm = new XcmGroup(this, 'polkadotXcm');3858 this.xTokens = new XTokensGroup(this);3859 this.tokens = new TokensGroup(this);3860 }38613862 getSudo<T extends UniqueHelper>() {3863 // eslint-disable-next-line @typescript-eslint/naming-convention3864 const SudoHelperType = SudoHelper(this.helperBase);3865 return this.clone(SudoHelperType) as T;3866 }3867}38683869export class XcmChainHelper extends ChainHelperBase {3870 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {3871 const wsProvider = new WsProvider(wsEndpoint);3872 this.api = new ApiPromise({3873 provider: wsProvider,3874 });3875 await this.api.isReadyOrError;3876 this.network = await UniqueHelper.detectNetwork(this.api);3877 }3878}38793880export class RelayHelper extends XcmChainHelper {3881 balance: SubstrateBalanceGroup<RelayHelper>;3882 xcm: XcmGroup<RelayHelper>;38833884 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3885 super(logger, options.helperBase ?? RelayHelper);38863887 this.balance = new SubstrateBalanceGroup(this);3888 this.xcm = new XcmGroup(this, 'xcmPallet');3889 }3890}38913892export class WestmintHelper extends XcmChainHelper {3893 balance: SubstrateBalanceGroup<WestmintHelper>;3894 xcm: XcmGroup<WestmintHelper>;3895 assets: AssetsGroup<WestmintHelper>;3896 xTokens: XTokensGroup<WestmintHelper>;38973898 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3899 super(logger, options.helperBase ?? WestmintHelper);39003901 this.balance = new SubstrateBalanceGroup(this);3902 this.xcm = new XcmGroup(this, 'polkadotXcm');3903 this.assets = new AssetsGroup(this);3904 this.xTokens = new XTokensGroup(this);3905 }3906}39073908export class MoonbeamHelper extends XcmChainHelper {3909 balance: EthereumBalanceGroup<MoonbeamHelper>;3910 assetManager: MoonbeamAssetManagerGroup;3911 assets: AssetsGroup<MoonbeamHelper>;3912 xTokens: XTokensGroup<MoonbeamHelper>;3913 democracy: MoonbeamDemocracyGroup;3914 collective: {3915 council: MoonbeamCollectiveGroup,3916 techCommittee: MoonbeamCollectiveGroup,3917 };39183919 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3920 super(logger, options.helperBase ?? MoonbeamHelper);39213922 this.balance = new EthereumBalanceGroup(this);3923 this.assetManager = new MoonbeamAssetManagerGroup(this);3924 this.assets = new AssetsGroup(this);3925 this.xTokens = new XTokensGroup(this);3926 this.democracy = new MoonbeamDemocracyGroup(this, options);3927 this.collective = {3928 council: new MoonbeamCollectiveGroup(this, 'councilCollective'),3929 techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),3930 };3931 }3932}39333934export class AstarHelper extends XcmChainHelper {3935 balance: SubstrateBalanceGroup<AstarHelper>;3936 assets: AssetsGroup<AstarHelper>;3937 xcm: XcmGroup<AstarHelper>;39383939 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3940 super(logger, options.helperBase ?? AstarHelper);39413942 this.balance = new SubstrateBalanceGroup(this);3943 this.assets = new AssetsGroup(this);3944 this.xcm = new XcmGroup(this, 'polkadotXcm');3945 }39463947 getSudo<T extends UniqueHelper>() {3948 // eslint-disable-next-line @typescript-eslint/naming-convention3949 const SudoHelperType = SudoHelper(this.helperBase);3950 return this.clone(SudoHelperType) as T;3951 }3952}39533954export class AcalaHelper extends XcmChainHelper {3955 balance: SubstrateBalanceGroup<AcalaHelper>;3956 assetRegistry: AcalaAssetRegistryGroup;3957 xTokens: XTokensGroup<AcalaHelper>;3958 tokens: TokensGroup<AcalaHelper>;3959 xcm: XcmGroup<AcalaHelper>;39603961 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3962 super(logger, options.helperBase ?? AcalaHelper);39633964 this.balance = new SubstrateBalanceGroup(this);3965 this.assetRegistry = new AcalaAssetRegistryGroup(this);3966 this.xTokens = new XTokensGroup(this);3967 this.tokens = new TokensGroup(this);3968 this.xcm = new XcmGroup(this, 'polkadotXcm');3969 }39703971 getSudo<T extends AcalaHelper>() {3972 // eslint-disable-next-line @typescript-eslint/naming-convention3973 const SudoHelperType = SudoHelper(this.helperBase);3974 return this.clone(SudoHelperType) as T;3975 }3976}39773978// eslint-disable-next-line @typescript-eslint/naming-convention3979function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {3980 return class extends Base {3981 scheduleFn: 'schedule' | 'scheduleAfter';3982 blocksNum: number;3983 options: ISchedulerOptions;39843985 constructor(...args: any[]) {3986 const logger = args[0] as ILogger;3987 const options = args[1] as {3988 scheduleFn: 'schedule' | 'scheduleAfter',3989 blocksNum: number,3990 options: ISchedulerOptions3991 };39923993 super(logger);39943995 this.scheduleFn = options.scheduleFn;3996 this.blocksNum = options.blocksNum;3997 this.options = options.options;3998 }39994000 executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {4001 const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);40024003 const mandatorySchedArgs = [4004 this.blocksNum,4005 this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,4006 this.options.priority ?? null,4007 scheduledTx,4008 ];40094010 let schedArgs;4011 let scheduleFn;40124013 if(this.options.scheduledId) {4014 schedArgs = [this.options.scheduledId!, ...mandatorySchedArgs];40154016 if(this.scheduleFn == 'schedule') {4017 scheduleFn = 'scheduleNamed';4018 } else if(this.scheduleFn == 'scheduleAfter') {4019 scheduleFn = 'scheduleNamedAfter';4020 }4021 } else {4022 schedArgs = mandatorySchedArgs;4023 scheduleFn = this.scheduleFn;4024 }40254026 const extrinsic = 'api.tx.scheduler.' + scheduleFn;40274028 return super.executeExtrinsic(4029 sender,4030 extrinsic as any,4031 schedArgs,4032 expectSuccess,4033 );4034 }4035 };4036}40374038// eslint-disable-next-line @typescript-eslint/naming-convention4039function SudoHelper<T extends ChainHelperBaseConstructor>(Base: T) {4040 return class extends Base {4041 constructor(...args: any[]) {4042 super(...args);4043 }40444045 async executeExtrinsic(4046 sender: IKeyringPair,4047 extrinsic: string,4048 params: any[],4049 expectSuccess?: boolean,4050 options: Partial<SignerOptions> | null = null,4051 ): Promise<ITransactionResult> {4052 const call = this.constructApiCall(extrinsic, params);4053 const result = await super.executeExtrinsic(4054 sender,4055 'api.tx.sudo.sudo',4056 [call],4057 expectSuccess,4058 options,4059 );40604061 if(result.status === 'Fail') return result;40624063 const data = (result.result.events.find(x => x.event.section == 'sudo' && x.event.method == 'Sudid')?.event.data as any).sudoResult;4064 if(data.isErr) {4065 if(data.asErr.isModule) {4066 const error = (result.result.events[1].event.data as any).sudoResult.asErr.asModule;4067 const metaError = super.getApi()?.registry.findMetaError(error);4068 throw new Error(`${metaError.section}.${metaError.name}`);4069 } else if(data.asErr.isToken) {4070 throw new Error(`Token: ${data.asErr.asToken}`);4071 }4072 // May be [object Object] in case of unhandled non-unit enum4073 throw new Error(`Misc: ${data.asErr.toHuman()}`);4074 }4075 return result;4076 }4077 async executeExtrinsicUncheckedWeight(4078 sender: IKeyringPair,4079 extrinsic: string,4080 params: any[],4081 expectSuccess?: boolean,4082 options: Partial<SignerOptions> | null = null,4083 ): Promise<ITransactionResult> {4084 const call = this.constructApiCall(extrinsic, params);4085 const result = await super.executeExtrinsic(4086 sender,4087 'api.tx.sudo.sudoUncheckedWeight',4088 [call, {refTime: 0, proofSize: 0}],4089 expectSuccess,4090 options,4091 );40924093 if(result.status === 'Fail') return result;40944095 const data = (result.result.events.find(x => x.event.section == 'sudo' && x.event.method == 'Sudid')?.event.data as any).sudoResult;4096 if(data.isErr) {4097 if(data.asErr.isModule) {4098 const error = (result.result.events[1].event.data as any).sudoResult.asErr.asModule;4099 const metaError = super.getApi()?.registry.findMetaError(error);4100 throw new Error(`${metaError.section}.${metaError.name}`);4101 } else if(data.asErr.isToken) {4102 throw new Error(`Token: ${data.asErr.asToken}`);4103 }4104 // May be [object Object] in case of unhandled non-unit enum4105 throw new Error(`Misc: ${data.asErr.toHuman()}`);4106 }4107 return result;4108 }4109 };4110}41114112export class UniqueBaseCollection {4113 helper: UniqueHelper;4114 collectionId: number;41154116 constructor(collectionId: number, uniqueHelper: UniqueHelper) {4117 this.collectionId = collectionId;4118 this.helper = uniqueHelper;4119 }41204121 async getData() {4122 return await this.helper.collection.getData(this.collectionId);4123 }41244125 async getLastTokenId() {4126 return await this.helper.collection.getLastTokenId(this.collectionId);4127 }41284129 async doesTokenExist(tokenId: number) {4130 return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);4131 }41324133 async getAdmins() {4134 return await this.helper.collection.getAdmins(this.collectionId);4135 }41364137 async getAllowList() {4138 return await this.helper.collection.getAllowList(this.collectionId);4139 }41404141 async getEffectiveLimits() {4142 return await this.helper.collection.getEffectiveLimits(this.collectionId);4143 }41444145 async getProperties(propertyKeys?: string[] | null) {4146 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);4147 }41484149 async getPropertiesConsumedSpace() {4150 return await this.helper.collection.getPropertiesConsumedSpace(this.collectionId);4151 }41524153 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {4154 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);4155 }41564157 async getOptions() {4158 return await this.helper.collection.getCollectionOptions(this.collectionId);4159 }41604161 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {4162 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);4163 }41644165 async confirmSponsorship(signer: TSigner) {4166 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);4167 }41684169 async removeSponsor(signer: TSigner) {4170 return await this.helper.collection.removeSponsor(signer, this.collectionId);4171 }41724173 async setLimits(signer: TSigner, limits: ICollectionLimits) {4174 return await this.helper.collection.setLimits(signer, this.collectionId, limits);4175 }41764177 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {4178 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);4179 }41804181 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {4182 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);4183 }41844185 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {4186 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);4187 }41884189 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {4190 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);4191 }41924193 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {4194 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);4195 }41964197 async setProperties(signer: TSigner, properties: IProperty[]) {4198 return await this.helper.collection.setProperties(signer, this.collectionId, properties);4199 }42004201 async deleteProperties(signer: TSigner, propertyKeys: string[]) {4202 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);4203 }42044205 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {4206 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);4207 }42084209 async enableNesting(signer: TSigner, permissions: INestingPermissions) {4210 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);4211 }42124213 async disableNesting(signer: TSigner) {4214 return await this.helper.collection.disableNesting(signer, this.collectionId);4215 }42164217 async burn(signer: TSigner) {4218 return await this.helper.collection.burn(signer, this.collectionId);4219 }42204221 scheduleAt<T extends UniqueHelper>(4222 executionBlockNumber: number,4223 options: ISchedulerOptions = {},4224 ) {4225 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4226 return new UniqueBaseCollection(this.collectionId, scheduledHelper);4227 }42284229 scheduleAfter<T extends UniqueHelper>(4230 blocksBeforeExecution: number,4231 options: ISchedulerOptions = {},4232 ) {4233 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4234 return new UniqueBaseCollection(this.collectionId, scheduledHelper);4235 }42364237 getSudo<T extends UniqueHelper>() {4238 return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());4239 }4240}424142424243export class UniqueNFTCollection extends UniqueBaseCollection {4244 getTokenObject(tokenId: number) {4245 return new UniqueNFToken(tokenId, this);4246 }42474248 async getTokensByAddress(addressObj: ICrossAccountId) {4249 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);4250 }42514252 async getToken(tokenId: number, blockHashAt?: string) {4253 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);4254 }42554256 async getTokenOwner(tokenId: number, blockHashAt?: string) {4257 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);4258 }42594260 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {4261 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);4262 }42634264 async getTokenChildren(tokenId: number, blockHashAt?: string) {4265 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);4266 }42674268 async getPropertyPermissions(propertyKeys: string[] | null = null) {4269 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);4270 }42714272 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {4273 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);4274 }42754276 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {4277 const api = this.helper.getApi();4278 const props = (await api.query.nonfungible.tokenProperties(this.collectionId, tokenId)).toJSON();42794280 return (props! as any).consumedSpace;4281 }42824283 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {4284 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);4285 }42864287 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4288 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);4289 }42904291 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {4292 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);4293 }42944295 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {4296 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);4297 }42984299 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {4300 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});4301 }43024303 async mintMultipleTokens(signer: TSigner, tokens: { owner: ICrossAccountId, properties?: IProperty[] }[]) {4304 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);4305 }43064307 async burnToken(signer: TSigner, tokenId: number) {4308 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);4309 }43104311 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {4312 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);4313 }43144315 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {4316 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);4317 }43184319 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {4320 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);4321 }43224323 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {4324 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);4325 }43264327 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {4328 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);4329 }43304331 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4332 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);4333 }43344335 scheduleAt<T extends UniqueHelper>(4336 executionBlockNumber: number,4337 options: ISchedulerOptions = {},4338 ) {4339 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4340 return new UniqueNFTCollection(this.collectionId, scheduledHelper);4341 }43424343 scheduleAfter<T extends UniqueHelper>(4344 blocksBeforeExecution: number,4345 options: ISchedulerOptions = {},4346 ) {4347 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4348 return new UniqueNFTCollection(this.collectionId, scheduledHelper);4349 }43504351 getSudo<T extends UniqueHelper>() {4352 return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());4353 }4354}435543564357export class UniqueRFTCollection extends UniqueBaseCollection {4358 getTokenObject(tokenId: number) {4359 return new UniqueRFToken(tokenId, this);4360 }43614362 async getToken(tokenId: number, blockHashAt?: string) {4363 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);4364 }43654366 async getTokenOwner(tokenId: number, blockHashAt?: string) {4367 return await this.helper.rft.getTokenOwner(this.collectionId, tokenId, blockHashAt);4368 }43694370 async getTokensByAddress(addressObj: ICrossAccountId) {4371 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);4372 }43734374 async getTop10TokenOwners(tokenId: number) {4375 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);4376 }43774378 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {4379 return await this.helper.rft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);4380 }43814382 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {4383 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);4384 }43854386 async getTokenTotalPieces(tokenId: number) {4387 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);4388 }43894390 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4391 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);4392 }43934394 async getPropertyPermissions(propertyKeys: string[] | null = null) {4395 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);4396 }43974398 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {4399 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);4400 }44014402 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {4403 const api = this.helper.getApi();4404 const props = (await api.query.refungible.tokenProperties(this.collectionId, tokenId)).toJSON();44054406 return (props! as any).consumedSpace;4407 }44084409 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount = 1n) {4410 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);4411 }44124413 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {4414 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);4415 }44164417 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {4418 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);4419 }44204421 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {4422 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);4423 }44244425 async mintToken(signer: TSigner, pieces = 1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {4426 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});4427 }44284429 async mintMultipleTokens(signer: TSigner, tokens: { pieces: bigint, owner: ICrossAccountId, properties?: IProperty[] }[]) {4430 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);4431 }44324433 async burnToken(signer: TSigner, tokenId: number, amount = 1n) {4434 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);4435 }44364437 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount = 1n) {4438 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);4439 }44404441 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {4442 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);4443 }44444445 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {4446 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);4447 }44484449 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {4450 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);4451 }44524453 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {4454 return await this.helper.rft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);4455 }44564457 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4458 return await this.helper.rft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);4459 }44604461 scheduleAt<T extends UniqueHelper>(4462 executionBlockNumber: number,4463 options: ISchedulerOptions = {},4464 ) {4465 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4466 return new UniqueRFTCollection(this.collectionId, scheduledHelper);4467 }44684469 scheduleAfter<T extends UniqueHelper>(4470 blocksBeforeExecution: number,4471 options: ISchedulerOptions = {},4472 ) {4473 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4474 return new UniqueRFTCollection(this.collectionId, scheduledHelper);4475 }44764477 getSudo<T extends UniqueHelper>() {4478 return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());4479 }4480}448144824483export class UniqueFTCollection extends UniqueBaseCollection {4484 async getBalance(addressObj: ICrossAccountId) {4485 return await this.helper.ft.getBalance(this.collectionId, addressObj);4486 }44874488 async getTotalPieces() {4489 return await this.helper.ft.getTotalPieces(this.collectionId);4490 }44914492 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4493 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);4494 }44954496 async getTop10Owners() {4497 return await this.helper.ft.getTop10Owners(this.collectionId);4498 }44994500 async mint(signer: TSigner, amount = 1n, owner: ICrossAccountId = {Substrate: signer.address}) {4501 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);4502 }45034504 async mintWithOneOwner(signer: TSigner, tokens: { value: bigint }[], owner: ICrossAccountId = {Substrate: signer.address}) {4505 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);4506 }45074508 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount = 1n) {4509 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);4510 }45114512 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {4513 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);4514 }45154516 async burnTokens(signer: TSigner, amount = 1n) {4517 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);4518 }45194520 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount = 1n) {4521 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);4522 }45234524 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount = 1n) {4525 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);4526 }45274528 scheduleAt<T extends UniqueHelper>(4529 executionBlockNumber: number,4530 options: ISchedulerOptions = {},4531 ) {4532 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4533 return new UniqueFTCollection(this.collectionId, scheduledHelper);4534 }45354536 scheduleAfter<T extends UniqueHelper>(4537 blocksBeforeExecution: number,4538 options: ISchedulerOptions = {},4539 ) {4540 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4541 return new UniqueFTCollection(this.collectionId, scheduledHelper);4542 }45434544 getSudo<T extends UniqueHelper>() {4545 return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());4546 }4547}454845494550export class UniqueBaseToken {4551 collection: UniqueNFTCollection | UniqueRFTCollection;4552 collectionId: number;4553 tokenId: number;45544555 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {4556 this.collection = collection;4557 this.collectionId = collection.collectionId;4558 this.tokenId = tokenId;4559 }45604561 async getNextSponsored(addressObj: ICrossAccountId) {4562 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);4563 }45644565 async getProperties(propertyKeys?: string[] | null) {4566 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);4567 }45684569 async getTokenPropertiesConsumedSpace() {4570 return await this.collection.getTokenPropertiesConsumedSpace(this.tokenId);4571 }45724573 async setProperties(signer: TSigner, properties: IProperty[]) {4574 return await this.collection.setTokenProperties(signer, this.tokenId, properties);4575 }45764577 async deleteProperties(signer: TSigner, propertyKeys: string[]) {4578 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);4579 }45804581 async doesExist() {4582 return await this.collection.doesTokenExist(this.tokenId);4583 }45844585 nestingAccount() {4586 return this.collection.helper.util.getTokenAccount(this);4587 }45884589 scheduleAt<T extends UniqueHelper>(4590 executionBlockNumber: number,4591 options: ISchedulerOptions = {},4592 ) {4593 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);4594 return new UniqueBaseToken(this.tokenId, scheduledCollection);4595 }45964597 scheduleAfter<T extends UniqueHelper>(4598 blocksBeforeExecution: number,4599 options: ISchedulerOptions = {},4600 ) {4601 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);4602 return new UniqueBaseToken(this.tokenId, scheduledCollection);4603 }46044605 getSudo<T extends UniqueHelper>() {4606 return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());4607 }4608}460946104611export class UniqueNFToken extends UniqueBaseToken {4612 collection: UniqueNFTCollection;46134614 constructor(tokenId: number, collection: UniqueNFTCollection) {4615 super(tokenId, collection);4616 this.collection = collection;4617 }46184619 async getData(blockHashAt?: string) {4620 return await this.collection.getToken(this.tokenId, blockHashAt);4621 }46224623 async getOwner(blockHashAt?: string) {4624 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);4625 }46264627 async getTopmostOwner(blockHashAt?: string) {4628 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);4629 }46304631 async getChildren(blockHashAt?: string) {4632 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);4633 }46344635 async nest(signer: TSigner, toTokenObj: IToken) {4636 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);4637 }46384639 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4640 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);4641 }46424643 async transfer(signer: TSigner, addressObj: ICrossAccountId) {4644 return await this.collection.transferToken(signer, this.tokenId, addressObj);4645 }46464647 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4648 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);4649 }46504651 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {4652 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);4653 }46544655 async isApproved(toAddressObj: ICrossAccountId) {4656 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);4657 }46584659 async burn(signer: TSigner) {4660 return await this.collection.burnToken(signer, this.tokenId);4661 }46624663 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {4664 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);4665 }46664667 scheduleAt<T extends UniqueHelper>(4668 executionBlockNumber: number,4669 options: ISchedulerOptions = {},4670 ) {4671 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);4672 return new UniqueNFToken(this.tokenId, scheduledCollection);4673 }46744675 scheduleAfter<T extends UniqueHelper>(4676 blocksBeforeExecution: number,4677 options: ISchedulerOptions = {},4678 ) {4679 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);4680 return new UniqueNFToken(this.tokenId, scheduledCollection);4681 }46824683 getSudo<T extends UniqueHelper>() {4684 return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());4685 }4686}46874688export class UniqueRFToken extends UniqueBaseToken {4689 collection: UniqueRFTCollection;46904691 constructor(tokenId: number, collection: UniqueRFTCollection) {4692 super(tokenId, collection);4693 this.collection = collection;4694 }46954696 async getData(blockHashAt?: string) {4697 return await this.collection.getToken(this.tokenId, blockHashAt);4698 }46994700 async getOwner(blockHashAt?: string) {4701 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);4702 }47034704 async getTop10Owners() {4705 return await this.collection.getTop10TokenOwners(this.tokenId);4706 }47074708 async getTopmostOwner(blockHashAt?: string) {4709 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);4710 }47114712 async nest(signer: TSigner, toTokenObj: IToken) {4713 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);4714 }47154716 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4717 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);4718 }47194720 async getBalance(addressObj: ICrossAccountId) {4721 return await this.collection.getTokenBalance(this.tokenId, addressObj);4722 }47234724 async getTotalPieces() {4725 return await this.collection.getTokenTotalPieces(this.tokenId);4726 }47274728 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {4729 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);4730 }47314732 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount = 1n) {4733 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);4734 }47354736 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {4737 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);4738 }47394740 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount = 1n) {4741 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);4742 }47434744 async repartition(signer: TSigner, amount: bigint) {4745 return await this.collection.repartitionToken(signer, this.tokenId, amount);4746 }47474748 async burn(signer: TSigner, amount = 1n) {4749 return await this.collection.burnToken(signer, this.tokenId, amount);4750 }47514752 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount = 1n) {4753 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);4754 }47554756 scheduleAt<T extends UniqueHelper>(4757 executionBlockNumber: number,4758 options: ISchedulerOptions = {},4759 ) {4760 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);4761 return new UniqueRFToken(this.tokenId, scheduledCollection);4762 }47634764 scheduleAfter<T extends UniqueHelper>(4765 blocksBeforeExecution: number,4766 options: ISchedulerOptions = {},4767 ) {4768 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);4769 return new UniqueRFToken(this.tokenId, scheduledCollection);4770 }47714772 getSudo<T extends UniqueHelper>() {4773 return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());4774 }4775}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 {SignerOptions} from '@polkadot/api/types/submittable';10import '../../interfaces/augment-api';11import {AugmentedSubmittables} from '@polkadot/api-base/types/submittable';12import {ApiInterfaceEvents} from '@polkadot/api/types';13import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm, base58Encode, blake2AsU8a, blake2AsHex} from '@polkadot/util-crypto';14import {IKeyringPair} from '@polkadot/types/types';15import {hexToU8a} from '@polkadot/util/hex';16import {u8aConcat} from '@polkadot/util/u8a';17import {18 IApiListeners,19 IBlock,20 IEvent,21 IChainProperties,22 ICollectionCreationOptions,23 ICollectionLimits,24 ICollectionPermissions,25 ICrossAccountId,26 ICrossAccountIdLower,27 ILogger,28 INestingPermissions,29 IProperty,30 IStakingInfo,31 ISchedulerOptions,32 ISubstrateBalance,33 IToken,34 ITokenPropertyPermission,35 ITransactionResult,36 IUniqueHelperLog,37 TApiAllowedListeners,38 TEthereumAccount,39 TSigner,40 TSubstrateAccount,41 TNetworks,42 IForeignAssetMetadata,43 AcalaAssetMetadata,44 MoonbeamAssetInfo,45 DemocracyStandardAccountVote,46 IEthCrossAccountId,47 IPhasicEvent,48} from './types';49import {RuntimeDispatchInfo} from '@polkadot/types/interfaces';50import type {Vec} from '@polkadot/types-codec';51import {FrameSystemEventRecord, PalletDemocracyConviction} from '@polkadot/types/lookup';5253export class CrossAccountId {54 Substrate!: TSubstrateAccount;55 Ethereum!: TEthereumAccount;5657 constructor(account: ICrossAccountId) {58 if('Substrate' in account) this.Substrate = account.Substrate;59 else this.Ethereum = account.Ethereum;60 }6162 static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {63 switch (domain) {64 case 'Substrate': return new CrossAccountId({Substrate: account.address});65 case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();66 }67 }6869 static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {70 if('substrate' in address) return new CrossAccountId({Substrate: address.substrate});71 else return new CrossAccountId({Ethereum: address.ethereum});72 }7374 static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {75 return encodeAddress(decodeAddress(address), ss58Format);76 }7778 static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {79 return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});80 }8182 withNormalizedSubstrate(ss58Format = 42): CrossAccountId {83 if(this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);84 return this;85 }8687 static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {88 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));89 }9091 toEthereum(): CrossAccountId {92 if(this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});93 return this;94 }9596 static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {97 return evmToAddress(address, ss58Format);98 }99100 toSubstrate(ss58Format?: number): CrossAccountId {101 if(this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});102 return this;103 }104105 toLowerCase(): CrossAccountId {106 if(this.Substrate) this.Substrate = this.Substrate.toLowerCase();107 if(this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();108 return this;109 }110}111112const nesting = {113 toChecksumAddress(address: string): string {114 if(typeof address === 'undefined') return '';115116 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);117118 address = address.toLowerCase().replace(/^0x/i, '');119 const addressHash = keccakAsHex(address).replace(/^0x/i, '');120 const checksumAddress = ['0x'];121122 for(let i = 0; i < address.length; i++) {123 // If ith character is 8 to f then make it uppercase124 if(parseInt(addressHash[i], 16) > 7) {125 checksumAddress.push(address[i].toUpperCase());126 } else {127 checksumAddress.push(address[i]);128 }129 }130 return checksumAddress.join('');131 },132 tokenIdToAddress(collectionId: number, tokenId: number) {133 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);134 },135};136137class UniqueUtil {138 static transactionStatus = {139 NOT_READY: 'NotReady',140 FAIL: 'Fail',141 SUCCESS: 'Success',142 };143144 static chainLogType = {145 EXTRINSIC: 'extrinsic',146 RPC: 'rpc',147 };148149 static getTokenAccount(token: IToken): CrossAccountId {150 return new CrossAccountId({Ethereum: this.getTokenAddress(token)});151 }152153 static getTokenAddress(token: IToken): string {154 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);155 }156157 static getDefaultLogger(): ILogger {158 return {159 log(msg: any, level = 'INFO') {160 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));161 },162 level: {163 ERROR: 'ERROR',164 WARNING: 'WARNING',165 INFO: 'INFO',166 },167 };168 }169170 static vec2str(arr: string[] | number[]) {171 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');172 }173174 static str2vec(string: string) {175 if(typeof string !== 'string') return string;176 return Array.from(string).map(x => x.charCodeAt(0));177 }178179 static fromSeed(seed: string, ss58Format = 42) {180 const keyring = new Keyring({type: 'sr25519', ss58Format});181 return keyring.addFromUri(seed);182 }183184 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {185 if(creationResult.status !== this.transactionStatus.SUCCESS) {186 throw Error('Unable to create collection!');187 }188189 let collectionId = null;190 creationResult.result.events.forEach(({event: {data, method, section}}) => {191 if((section === 'common') && (method === 'CollectionCreated')) {192 collectionId = parseInt(data[0].toString(), 10);193 }194 });195196 if(collectionId === null) {197 throw Error('No CollectionCreated event was found!');198 }199200 return collectionId;201 }202203 static extractTokensFromCreationResult(creationResult: ITransactionResult): {204 success: boolean,205 tokens: { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[],206 } {207 if(creationResult.status !== this.transactionStatus.SUCCESS) {208 throw Error('Unable to create tokens!');209 }210 let success = false;211 const tokens = [] as { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[];212 creationResult.result.events.forEach(({event: {data, method, section}}) => {213 if(method === 'ExtrinsicSuccess') {214 success = true;215 } else if((section === 'common') && (method === 'ItemCreated')) {216 tokens.push({217 collectionId: parseInt(data[0].toString(), 10),218 tokenId: parseInt(data[1].toString(), 10),219 owner: data[2].toHuman(),220 amount: data[3].toBigInt(),221 });222 }223 });224 return {success, tokens};225 }226227 static extractTokensFromBurnResult(burnResult: ITransactionResult): {228 success: boolean,229 tokens: { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[],230 } {231 if(burnResult.status !== this.transactionStatus.SUCCESS) {232 throw Error('Unable to burn tokens!');233 }234 let success = false;235 const tokens = [] as { collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint }[];236 burnResult.result.events.forEach(({event: {data, method, section}}) => {237 if(method === 'ExtrinsicSuccess') {238 success = true;239 } else if((section === 'common') && (method === 'ItemDestroyed')) {240 tokens.push({241 collectionId: parseInt(data[0].toString(), 10),242 tokenId: parseInt(data[1].toString(), 10),243 owner: data[2].toHuman(),244 amount: data[3].toBigInt(),245 });246 }247 });248 return {success, tokens};249 }250251 static findCollectionInEvents(events: { event: IEvent }[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {252 let eventId = null;253 events.forEach(({event: {data, method, section}}) => {254 if((section === expectedSection) && (method === expectedMethod)) {255 eventId = parseInt(data[0].toString(), 10);256 }257 });258259 if(eventId === null) {260 throw Error(`No ${expectedMethod} event was found!`);261 }262 return eventId === collectionId;263 }264265 static isTokenTransferSuccess(events: { event: IEvent }[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {266 const normalizeAddress = (address: string | ICrossAccountId) => {267 if(typeof address === 'string') return address;268 const obj = {} as any;269 Object.keys(address).forEach(k => {270 obj[k.toLocaleLowerCase()] = (address as any)[k];271 });272 if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);273 if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();274 return address;275 };276 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;277 events.forEach(({event: {data, method, section}}) => {278 if((section === 'common') && (method === 'Transfer')) {279 const hData = (data as any).toJSON();280 transfer = {281 collectionId: hData[0],282 tokenId: hData[1],283 from: normalizeAddress(hData[2]),284 to: normalizeAddress(hData[3]),285 amount: BigInt(hData[4]),286 };287 }288 });289 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;290 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);291 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);292 isSuccess = isSuccess && amount === transfer.amount;293 return isSuccess;294 }295296 static bigIntToDecimals(number: bigint, decimals = 18) {297 const numberStr = number.toString();298 const dotPos = numberStr.length - decimals;299300 if(dotPos <= 0) {301 return '0.' + '0'.repeat(Math.abs(dotPos)) + numberStr;302 } else {303 const intPart = numberStr.substring(0, dotPos);304 const fractPart = numberStr.substring(dotPos);305 return intPart + '.' + fractPart;306 }307 }308}309310class UniqueEventHelper {311 private static extractIndex(index: any): [number, number] | string {312 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];313 return index.toJSON();314 }315316 private static extractSub(data: any, subTypes: any): { [key: string]: any } {317 let obj: any = {};318 let index = 0;319320 if(data.entries) {321 for(const [key, value] of data.entries()) {322 obj[key] = this.extractData(value, subTypes[index]);323 index++;324 }325 } else obj = data.toJSON();326327 return obj;328 }329330 private static toHuman(data: any) {331 return data && data.toHuman ? data.toHuman() : `${data}`;332 }333334 private static extractData(data: any, type: any): any {335 if(!type) return this.toHuman(data);336 if(['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();337 if(['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();338 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);339 return this.toHuman(data);340 }341342 public static extractEvents(events: { event: any, phase: any }[]): IEvent[] {343 const parsedEvents: IEvent[] = [];344345 events.forEach((record) => {346 const {event, phase} = record;347 const types = event.typeDef;348349 const eventData: IEvent = {350 section: event.section.toString(),351 method: event.method.toString(),352 index: this.extractIndex(event.index),353 data: [],354 phase: phase.toJSON(),355 };356357 event.data.forEach((val: any, index: number) => {358 eventData.data.push(this.extractData(val, types[index]));359 });360361 parsedEvents.push(eventData);362 });363364 return parsedEvents;365 }366}367const InvalidTypeSymbol = Symbol('Invalid type');368// eslint-disable-next-line @typescript-eslint/no-unused-vars369export type Invalid<ErrorMessage> =370 | ((371 invalidType: typeof InvalidTypeSymbol,372 ..._: typeof InvalidTypeSymbol[]373 ) => typeof InvalidTypeSymbol)374 | null375 | undefined;376// Has slightly better error messages than Get377type Get2<T, P extends string, E> =378 P extends `${infer Key}.${infer Key2}` ? Key extends keyof T ? Key2 extends keyof T[Key] ? T[Key][Key2] : E : E : E;379type ForceFunction<T> = T extends (...args: any) => any ? T : (...args: any) => Invalid<'not a function'>;380381export class ChainHelperBase {382 helperBase: any;383384 transactionStatus = UniqueUtil.transactionStatus;385 chainLogType = UniqueUtil.chainLogType;386 util: typeof UniqueUtil;387 eventHelper: typeof UniqueEventHelper;388 logger: ILogger;389 api: ApiPromise | null;390 forcedNetwork: TNetworks | null;391 network: TNetworks | null;392 wsEndpoint: string | null;393 chainLog: IUniqueHelperLog[];394 children: ChainHelperBase[];395 address: AddressGroup;396 chain: ChainGroup;397398 constructor(logger?: ILogger, helperBase?: any) {399 this.helperBase = helperBase;400401 this.util = UniqueUtil;402 this.eventHelper = UniqueEventHelper;403 if(typeof logger == 'undefined') logger = this.util.getDefaultLogger();404 this.logger = logger;405 this.api = null;406 this.forcedNetwork = null;407 this.network = null;408 this.wsEndpoint = null;409 this.chainLog = [];410 this.children = [];411 this.address = new AddressGroup(this);412 this.chain = new ChainGroup(this);413 }414415 clone(helperCls: ChainHelperBaseConstructor, options: { [key: string]: any } = {}) {416 Object.setPrototypeOf(helperCls.prototype, this);417 const newHelper = new helperCls(this.logger, options);418419 newHelper.api = this.api;420 newHelper.network = this.network;421 newHelper.forceNetwork = this.forceNetwork;422423 this.children.push(newHelper);424425 return newHelper;426 }427428 getEndpoint(): string {429 if(this.wsEndpoint === null) throw Error('No connection was established');430 return this.wsEndpoint;431 }432433 getApi(): ApiPromise {434 if(this.api === null) throw Error('API not initialized');435 return this.api;436 }437438 async subscribeEvents(expectedEvents: { section: string, names: string[] }[]) {439 const collectedEvents: IEvent[] = [];440 const unsubscribe = await this.getApi().query.system.events((events: Vec<FrameSystemEventRecord>) => {441 const ievents = this.eventHelper.extractEvents(events);442 ievents.forEach((event) => {443 expectedEvents.forEach((e => {444 if(event.section === e.section && e.names.includes(event.method)) {445 collectedEvents.push(event);446 }447 }));448 });449 });450 return {unsubscribe: unsubscribe as any, collectedEvents};451 }452453 clearChainLog(): void {454 this.chainLog = [];455 }456457 forceNetwork(value: TNetworks): void {458 this.forcedNetwork = value;459 }460461 async connect(wsEndpoint: string, listeners?: IApiListeners) {462 if(this.api !== null) throw Error('Already connected');463 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);464 this.wsEndpoint = wsEndpoint;465 this.api = api;466 this.network = network;467 }468469 async disconnect() {470 for(const child of this.children) {471 child.clearApi();472 }473474 if(this.api === null) return;475 await this.api.disconnect();476 this.clearApi();477 }478479 clearApi() {480 this.api = null;481 this.network = null;482 }483484 static async detectNetwork(api: ApiPromise): Promise<TNetworks> {485 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;486 const xcmChains = ['rococo', 'westend', 'westmint', 'acala', 'karura', 'moonbeam', 'moonriver'];487488 if(xcmChains.indexOf(spec.specName) > -1) return spec.specName;489490 if(['quartz', 'unique', 'sapphire'].indexOf(spec.specName) > -1) return spec.specName;491 return 'opal';492 }493494 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TNetworks> {495 if(!wsEndpoint) throw new Error('wsEndpoint was not set');496 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});497 await api.isReady;498499 const network = await this.detectNetwork(api);500501 await api.disconnect();502503 return network;504 }505506 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TNetworks | null): Promise<{507 api: ApiPromise;508 network: TNetworks;509 }> {510 if(typeof network === 'undefined' || network === null) network = 'opal';511 if(!wsEndpoint) throw new Error('wsEndpoint was not set');512 const supportedRPC = {513 opal: {514 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,515 },516 quartz: {517 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,518 },519 unique: {520 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,521 },522 rococo: {},523 westend: {},524 moonbeam: {},525 moonriver: {},526 acala: {},527 karura: {},528 westmint: {},529 };530 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);531 const rpc = supportedRPC[network];532533 // TODO: investigate how to replace rpc in runtime534 // api._rpcCore.addUserInterfaces(rpc);535536 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});537538 await api.isReadyOrError;539540 if(typeof listeners === 'undefined') listeners = {};541 for(const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {542 if(!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;543 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);544 }545546 return {api, network};547 }548549 getTransactionStatus(data: { events: { event: IEvent }[], status: any }) {550 const {events, status} = data;551 if(status.isReady) {552 return this.transactionStatus.NOT_READY;553 }554 if(status.isBroadcast) {555 return this.transactionStatus.NOT_READY;556 }557 if(status.isInBlock || status.isFinalized) {558 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');559 if(errors.length > 0) {560 return this.transactionStatus.FAIL;561 }562 if(events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {563 return this.transactionStatus.SUCCESS;564 }565 }566567 return this.transactionStatus.FAIL;568 }569570 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {571 const sign = (callback: any) => {572 if(options !== null) return transaction.signAndSend(sender, options, callback);573 return transaction.signAndSend(sender, callback);574 };575 // eslint-disable-next-line no-async-promise-executor576 return new Promise(async (resolve, reject) => {577 try {578 const unsub = await sign((result: any) => {579 const status = this.getTransactionStatus(result);580581 if(status === this.transactionStatus.SUCCESS) {582 this.logger.log(`${label} successful`);583 unsub();584 resolve({result, status, blockHash: result.status.asInBlock.toHuman()});585 } else if(status === this.transactionStatus.FAIL) {586 let moduleError = null;587588 if(result.hasOwnProperty('dispatchError')) {589 const dispatchError = result['dispatchError'];590591 if(dispatchError) {592 if(dispatchError.isModule) {593 const modErr = dispatchError.asModule;594 const errorMeta = dispatchError.registry.findMetaError(modErr);595596 moduleError = `${errorMeta.section}.${errorMeta.name}`;597 } else if(dispatchError.isToken) {598 moduleError = `Token: ${dispatchError.asToken}`;599 } else {600 // May be [object Object] in case of unhandled non-unit enum601 moduleError = `Misc: ${dispatchError.toHuman()}`;602 }603 } else {604 this.logger.log(result, this.logger.level.ERROR);605 }606 }607608 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);609 unsub();610 reject({status, moduleError, result});611 }612 });613 } catch (e) {614 this.logger.log(e, this.logger.level.ERROR);615 reject(e);616 }617 });618 }619620 async signTransactionWithoutSending(signer: TSigner, tx: any) {621 const api = this.getApi();622 const signingInfo = await api.derive.tx.signingInfo(signer.address);623624 tx.sign(signer, {625 blockHash: api.genesisHash,626 genesisHash: api.genesisHash,627 runtimeVersion: api.runtimeVersion,628 nonce: signingInfo.nonce,629 });630631 return tx.toHex();632 }633634 async getPaymentInfo(signer: TSigner, tx: any, len: number | null) {635 const api = this.getApi();636 const signingInfo = await api.derive.tx.signingInfo(signer.address);637638 // We need to sign the tx because639 // unsigned transactions does not have an inclusion fee640 tx.sign(signer, {641 blockHash: api.genesisHash,642 genesisHash: api.genesisHash,643 runtimeVersion: api.runtimeVersion,644 nonce: signingInfo.nonce,645 });646647 if(len === null) {648 return (await this.callRpc('api.rpc.payment.queryInfo', [tx.toHex()])) as RuntimeDispatchInfo;649 } else {650 return (await api.call.transactionPaymentApi.queryInfo(tx, len)) as RuntimeDispatchInfo;651 }652 }653654 constructApiCall(apiCall: string, params: any[]) {655 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);656 let call = this.getApi() as any;657 for(const part of apiCall.slice(4).split('.')) {658 call = call[part];659 if(!call) {660 const advice = part.includes('_') ? ' Looks like it needs to be converted to camel case.' : '';661 throw Error(`Function ${part} of api call ${apiCall} not found.${advice}`);662 }663 }664 return call(...params);665 }666667 encodeApiCall(apiCall: string, params: any[]) {668 return this.constructApiCall(apiCall, params).method.toHex();669 }670671 async executeExtrinsic<672 E extends string,673 V extends (674 ...args: any) => any = ForceFunction<675 Get2<676 AugmentedSubmittables<'promise'>,677 E, (...args: any) => Invalid<'not found'>678 >679 >680 >(681 sender: TSigner,682 extrinsic: `api.tx.${E}`,683 params: Parameters<V>,684 expectSuccess = true,685 options: Partial<SignerOptions> | null = null,/*, failureMessage='expected success'*/686 ): Promise<ITransactionResult> {687 if(this.api === null) throw Error('API not initialized');688689 const startTime = (new Date()).getTime();690 let result: ITransactionResult;691 let events: IEvent[] = [];692 try {693 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;694 events = this.eventHelper.extractEvents(result.result.events);695 const errorEvent = events.find((event) => event.method == 'ExecutedFailed' || event.method == 'CreatedFailed');696 if(errorEvent)697 throw Error(errorEvent.method + ': ' + extrinsic);698 }699 catch (e) {700 if(!(e as object).hasOwnProperty('status')) throw e;701 result = e as ITransactionResult;702 }703704 const endTime = (new Date()).getTime();705706 const log = {707 executedAt: endTime,708 executionTime: endTime - startTime,709 type: this.chainLogType.EXTRINSIC,710 status: result.status,711 call: extrinsic,712 signer: this.getSignerAddress(sender),713 params,714 } as IUniqueHelperLog;715716 let errorMessage = '';717718 if(result.status !== this.transactionStatus.SUCCESS) {719 if(result.moduleError) {720 errorMessage = typeof result.moduleError === 'string'721 ? result.moduleError722 : `${Object.keys(result.moduleError)[0]}: ${Object.values(result.moduleError)[0]}`;723 log.moduleError = errorMessage;724 }725 else if(result.result.dispatchError) log.dispatchError = result.result.dispatchError;726 }727 if(events.length > 0) log.events = events;728729 this.chainLog.push(log);730731 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {732 if(result.moduleError) throw Error(`${errorMessage}`);733 else if(result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));734 }735 return result as any;736 }737 executeExtrinsicUncheckedWeight<738 E extends string,739 V extends (740 ...args: any) => any = ForceFunction<741 Get2<742 AugmentedSubmittables<'promise'>,743 E, (...args: any) => Invalid<'not found'>744 >745 >746 >(747 sender: TSigner,748 extrinsic: `api.tx.${E}`,749 params: Parameters<V>,750 expectSuccess = true,751 options: Partial<SignerOptions> | null = null,/*, failureMessage='expected success'*/752 ): Promise<ITransactionResult> {753 throw new Error('executeExtrinsicUncheckedWeight only supported in sudo');754 }755756 async callRpc757 // TODO: make it strongly typed, or use api.query/api.rpc directly758 // <759 // K extends 'rpc' | 'query',760 // E extends string,761 // V extends (...args: any) => any = ForceFunction<762 // Get2<763 // K extends 'rpc' ? DecoratedRpc<'promise', RpcInterface> : QueryableStorage<'promise'>,764 // E, (...args: any) => Invalid<'not found'>765 // >766 // >,767 // P = Parameters<V>,768 // >769 (rpc: string, params?: any[]): Promise<any> {770771 if(typeof params === 'undefined') params = [] as any;772 if(this.api === null) throw Error('API not initialized');773 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);774775 const startTime = (new Date()).getTime();776 let result;777 let error = null;778 const log = {779 type: this.chainLogType.RPC,780 call: rpc,781 params,782 } as any as IUniqueHelperLog;783784 try {785 result = await this.constructApiCall(rpc, params as any);786 }787 catch (e) {788 error = e;789 }790791 const endTime = (new Date()).getTime();792793 log.executedAt = endTime;794 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';795 log.executionTime = endTime - startTime;796797 this.chainLog.push(log);798799 if(error !== null) throw error;800801 return result;802 }803804 getSignerAddress(signer: IKeyringPair | string): string {805 if(typeof signer === 'string') return signer;806 return signer.address;807 }808809 fetchAllPalletNames(): string[] {810 if(this.api === null) throw Error('API not initialized');811 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase()).sort();812 }813814 fetchMissingPalletNames(requiredPallets: readonly string[]): string[] {815 const palletNames = this.fetchAllPalletNames();816 return requiredPallets.filter(p => !palletNames.includes(p));817 }818}819820821class HelperGroup<T extends ChainHelperBase> {822 helper: T;823824 constructor(uniqueHelper: T) {825 this.helper = uniqueHelper;826 }827}828829830class CollectionGroup extends HelperGroup<UniqueHelper> {831 /**832 * Get number of blocks when sponsored transaction is available.833 *834 * @param collectionId ID of collection835 * @param tokenId ID of token836 * @param addressObj address for which the sponsorship is checked837 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});838 * @returns number of blocks or null if sponsorship hasn't been set839 */840 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {841 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();842 }843844 /**845 * Get the number of created collections.846 *847 * @returns number of created collections848 */849 async getTotalCount(): Promise<number> {850 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();851 }852853 /**854 * Get information about the collection with additional data,855 * including the number of tokens it contains, its administrators,856 * the normalized address of the collection's owner, and decoded name and description.857 *858 * @param collectionId ID of collection859 * @example await getData(2)860 * @returns collection information object861 */862 async getData(collectionId: number): Promise<{863 id: number;864 name: string;865 description: string;866 tokensCount: number;867 admins: CrossAccountId[];868 normalizedOwner: TSubstrateAccount;869 raw: any870 } | null> {871 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);872 const humanCollection = collection.toHuman(), collectionData = {873 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],874 raw: humanCollection,875 } as any, jsonCollection = collection.toJSON();876 if(humanCollection === null) return null;877 collectionData.raw.limits = jsonCollection.limits;878 collectionData.raw.permissions = jsonCollection.permissions;879 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);880 for(const key of ['name', 'description']) {881 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);882 }883884 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))885 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)886 : 0;887 collectionData.admins = await this.getAdmins(collectionId);888889 return collectionData;890 }891892 /**893 * Get the addresses of the collection's administrators, optionally normalized.894 *895 * @param collectionId ID of collection896 * @param normalize whether to normalize the addresses to the default ss58 format897 * @example await getAdmins(1)898 * @returns array of administrators899 */900 async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {901 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();902903 return normalize904 ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())905 : admins;906 }907908 /**909 * Get the addresses added to the collection allow-list, optionally normalized.910 * @param collectionId ID of collection911 * @param normalize whether to normalize the addresses to the default ss58 format912 * @example await getAllowList(1)913 * @returns array of allow-listed addresses914 */915 async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {916 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();917 return normalize918 ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())919 : allowListed;920 }921922 /**923 * Get the effective limits of the collection instead of null for default values924 *925 * @param collectionId ID of collection926 * @example await getEffectiveLimits(2)927 * @returns object of collection limits928 */929 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {930 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();931 }932933 /**934 * Burns the collection if the signer has sufficient permissions and collection is empty.935 *936 * @param signer keyring of signer937 * @param collectionId ID of collection938 * @example await helper.collection.burn(aliceKeyring, 3);939 * @returns ```true``` if extrinsic success, otherwise ```false```940 */941 async burn(signer: TSigner, collectionId: number): Promise<boolean> {942 const result = await this.helper.executeExtrinsic(943 signer,944 'api.tx.unique.destroyCollection', [collectionId],945 true,946 );947948 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');949 }950951 /**952 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.953 *954 * @param signer keyring of signer955 * @param collectionId ID of collection956 * @param sponsorAddress Sponsor substrate address957 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")958 * @returns ```true``` if extrinsic success, otherwise ```false```959 */960 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {961 const result = await this.helper.executeExtrinsic(962 signer,963 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],964 true,965 );966967 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorSet');968 }969970 /**971 * Confirms consent to sponsor the collection on behalf of the signer.972 *973 * @param signer keyring of signer974 * @param collectionId ID of collection975 * @example confirmSponsorship(aliceKeyring, 10)976 * @returns ```true``` if extrinsic success, otherwise ```false```977 */978 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {979 const result = await this.helper.executeExtrinsic(980 signer,981 'api.tx.unique.confirmSponsorship', [collectionId],982 true,983 );984985 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'SponsorshipConfirmed');986 }987988 /**989 * Removes the sponsor of a collection, regardless if it consented or not.990 *991 * @param signer keyring of signer992 * @param collectionId ID of collection993 * @example removeSponsor(aliceKeyring, 10)994 * @returns ```true``` if extrinsic success, otherwise ```false```995 */996 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {997 const result = await this.helper.executeExtrinsic(998 signer,999 'api.tx.unique.removeCollectionSponsor', [collectionId],1000 true,1001 );10021003 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorRemoved');1004 }10051006 /**1007 * Sets the limits of the collection. At least one limit must be specified for a correct call.1008 *1009 * @param signer keyring of signer1010 * @param collectionId ID of collection1011 * @param limits collection limits object1012 * @example1013 * await setLimits(1014 * aliceKeyring,1015 * 10,1016 * {1017 * sponsorTransferTimeout: 0,1018 * ownerCanDestroy: false1019 * }1020 * )1021 * @returns ```true``` if extrinsic success, otherwise ```false```1022 */1023 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {1024 const result = await this.helper.executeExtrinsic(1025 signer,1026 'api.tx.unique.setCollectionLimits', [collectionId, limits],1027 true,1028 );10291030 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionLimitSet');1031 }10321033 /**1034 * Changes the owner of the collection to the new Substrate address.1035 *1036 * @param signer keyring of signer1037 * @param collectionId ID of collection1038 * @param ownerAddress substrate address of new owner1039 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")1040 * @returns ```true``` if extrinsic success, otherwise ```false```1041 */1042 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {1043 const result = await this.helper.executeExtrinsic(1044 signer,1045 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],1046 true,1047 );10481049 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionOwnerChanged');1050 }10511052 /**1053 * Adds a collection administrator.1054 *1055 * @param signer keyring of signer1056 * @param collectionId ID of collection1057 * @param adminAddressObj Administrator address (substrate or ethereum)1058 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})1059 * @returns ```true``` if extrinsic success, otherwise ```false```1060 */1061 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {1062 const result = await this.helper.executeExtrinsic(1063 signer,1064 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],1065 true,1066 );10671068 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminAdded');1069 }10701071 /**1072 * Removes a collection administrator.1073 *1074 * @param signer keyring of signer1075 * @param collectionId ID of collection1076 * @param adminAddressObj Administrator address (substrate or ethereum)1077 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})1078 * @returns ```true``` if extrinsic success, otherwise ```false```1079 */1080 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {1081 const result = await this.helper.executeExtrinsic(1082 signer,1083 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],1084 true,1085 );10861087 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminRemoved');1088 }10891090 /**1091 * Check if user is in allow list.1092 *1093 * @param collectionId ID of collection1094 * @param user Account to check1095 * @example await getAdmins(1)1096 * @returns is user in allow list1097 */1098 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {1099 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();1100 }11011102 /**1103 * Adds an address to allow list1104 * @param signer keyring of signer1105 * @param collectionId ID of collection1106 * @param addressObj address to add to the allow list1107 * @returns ```true``` if extrinsic success, otherwise ```false```1108 */1109 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1110 const result = await this.helper.executeExtrinsic(1111 signer,1112 'api.tx.unique.addToAllowList', [collectionId, addressObj],1113 true,1114 );11151116 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressAdded');1117 }11181119 /**1120 * Removes an address from allow list1121 *1122 * @param signer keyring of signer1123 * @param collectionId ID of collection1124 * @param addressObj address to remove from the allow list1125 * @returns ```true``` if extrinsic success, otherwise ```false```1126 */1127 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1128 const result = await this.helper.executeExtrinsic(1129 signer,1130 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],1131 true,1132 );11331134 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressRemoved');1135 }11361137 /**1138 * Sets onchain permissions for selected collection.1139 *1140 * @param signer keyring of signer1141 * @param collectionId ID of collection1142 * @param permissions collection permissions object1143 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});1144 * @returns ```true``` if extrinsic success, otherwise ```false```1145 */1146 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {1147 const result = await this.helper.executeExtrinsic(1148 signer,1149 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],1150 true,1151 );11521153 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPermissionSet');1154 }11551156 /**1157 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.1158 *1159 * @param signer keyring of signer1160 * @param collectionId ID of collection1161 * @param permissions nesting permissions object1162 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});1163 * @returns ```true``` if extrinsic success, otherwise ```false```1164 */1165 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {1166 return await this.setPermissions(signer, collectionId, {nesting: permissions});1167 }11681169 /**1170 * Disables nesting for selected collection.1171 *1172 * @param signer keyring of signer1173 * @param collectionId ID of collection1174 * @example disableNesting(aliceKeyring, 10);1175 * @returns ```true``` if extrinsic success, otherwise ```false```1176 */1177 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {1178 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});1179 }11801181 /**1182 * Sets onchain properties to the collection.1183 *1184 * @param signer keyring of signer1185 * @param collectionId ID of collection1186 * @param properties array of property objects1187 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);1188 * @returns ```true``` if extrinsic success, otherwise ```false```1189 */1190 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {1191 const result = await this.helper.executeExtrinsic(1192 signer,1193 'api.tx.unique.setCollectionProperties', [collectionId, properties],1194 true,1195 );11961197 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');1198 }11991200 /**1201 * Get collection properties.1202 *1203 * @param collectionId ID of collection1204 * @param propertyKeys optionally filter the returned properties to only these keys1205 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);1206 * @returns array of key-value pairs1207 */1208 async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1209 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();1210 }12111212 async getPropertiesConsumedSpace(collectionId: number): Promise<number> {1213 const api = this.helper.getApi();1214 const props = (await api.query.common.collectionProperties(collectionId)).toJSON();12151216 return (props! as any).consumedSpace;1217 }12181219 async getCollectionOptions(collectionId: number) {1220 return (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1221 }12221223 /**1224 * Deletes onchain properties from the collection.1225 *1226 * @param signer keyring of signer1227 * @param collectionId ID of collection1228 * @param propertyKeys array of property keys to delete1229 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);1230 * @returns ```true``` if extrinsic success, otherwise ```false```1231 */1232 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {1233 const result = await this.helper.executeExtrinsic(1234 signer,1235 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],1236 true,1237 );12381239 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1240 }12411242 /**1243 * Changes the owner of the token.1244 *1245 * @param signer keyring of signer1246 * @param collectionId ID of collection1247 * @param tokenId ID of token1248 * @param addressObj address of a new owner1249 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1250 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1251 * @returns true if the token success, otherwise false1252 */1253 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1254 const result = await this.helper.executeExtrinsic(1255 signer,1256 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1257 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1258 );12591260 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1261 }12621263 /**1264 *1265 * Change ownership of a token(s) on behalf of the owner.1266 *1267 * @param signer keyring of signer1268 * @param collectionId ID of collection1269 * @param tokenId ID of token1270 * @param fromAddressObj address on behalf of which the token will be sent1271 * @param toAddressObj new token owner1272 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1273 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1274 * @returns true if the token success, otherwise false1275 */1276 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1277 const result = await this.helper.executeExtrinsic(1278 signer,1279 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1280 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1281 );1282 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1283 }12841285 /**1286 *1287 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1288 *1289 * @param signer keyring of signer1290 * @param collectionId ID of collection1291 * @param tokenId ID of token1292 * @param amount amount of tokens to be burned. For NFT must be set to 1n1293 * @example burnToken(aliceKeyring, 10, 5);1294 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1295 */1296 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount = 1n): Promise<boolean> {1297 const burnResult = await this.helper.executeExtrinsic(1298 signer,1299 'api.tx.unique.burnItem', [collectionId, tokenId, amount],1300 true, // `Unable to burn token for ${label}`,1301 );1302 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1303 if(burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1304 return burnedTokens.success;1305 }13061307 /**1308 * Destroys a concrete instance of NFT on behalf of the owner1309 *1310 * @param signer keyring of signer1311 * @param collectionId ID of collection1312 * @param tokenId ID of token1313 * @param fromAddressObj address on behalf of which the token will be burnt1314 * @param amount amount of tokens to be burned. For NFT must be set to 1n1315 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1316 * @returns ```true``` if extrinsic success, otherwise ```false```1317 */1318 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1319 const burnResult = await this.helper.executeExtrinsic(1320 signer,1321 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1322 true, // `Unable to burn token from for ${label}`,1323 );1324 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1325 return burnedTokens.success && burnedTokens.tokens.length > 0;1326 }13271328 /**1329 * Set, change, or remove approved address to transfer the ownership of the NFT.1330 *1331 * @param signer keyring of signer1332 * @param collectionId ID of collection1333 * @param tokenId ID of token1334 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1335 * @param amount amount of token to be approved. For NFT must be set to 1n1336 * @returns ```true``` if extrinsic success, otherwise ```false```1337 */1338 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {1339 const approveResult = await this.helper.executeExtrinsic(1340 signer,1341 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1342 true, // `Unable to approve token for ${label}`,1343 );13441345 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1346 }13471348 /**1349 * Set, change, or remove approved address to transfer the ownership of the NFT from eth mirror.1350 *1351 * @param signer keyring of signer1352 * @param collectionId ID of collection1353 * @param tokenId ID of token1354 * @param fromAddressObj Signer's Ethereum address containing her tokens1355 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1356 * @param amount amount of token to be approved. For NFT must be set to 1n1357 * @returns ```true``` if extrinsic success, otherwise ```false```1358 */1359 async approveTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {1360 const approveResult = await this.helper.executeExtrinsic(1361 signer,1362 'api.tx.unique.approveFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1363 true, // `Unable to approve token for ${label}`,1364 );13651366 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1367 }13681369 /**1370 * Set, change, or remove approved address to transfer the ownership of the NFT from eth mirror.1371 *1372 * @param signer keyring of signer1373 * @param collectionId ID of collection1374 * @param tokenId ID of token1375 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1376 * @param amount amount of token to be approved. For NFT must be set to 1n1377 * @returns ```true``` if extrinsic success, otherwise ```false```1378 */1379 async approveTokenFromEth(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {1380 const ethMirror = CrossAccountId.fromKeyring(signer).toEthereum();1381 return await this.approveTokenFrom(signer, collectionId, tokenId, ethMirror, toAddressObj, amount);1382 }13831384 /**1385 * Get the amount of token pieces approved to transfer or burn. Normally 0.1386 *1387 * @param collectionId ID of collection1388 * @param tokenId ID of token1389 * @param toAccountObj address which is approved to use token pieces1390 * @param fromAccountObj address which may have allowed the use of its owned tokens1391 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1392 * @returns number of approved to transfer pieces1393 */1394 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1395 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1396 }13971398 /**1399 * Get the last created token ID in a collection1400 *1401 * @param collectionId ID of collection1402 * @example getLastTokenId(10);1403 * @returns id of the last created token1404 */1405 async getLastTokenId(collectionId: number): Promise<number> {1406 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1407 }14081409 /**1410 * Check if token exists1411 *1412 * @param collectionId ID of collection1413 * @param tokenId ID of token1414 * @example doesTokenExist(10, 20);1415 * @returns true if the token exists, otherwise false1416 */1417 async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1418 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1419 }1420}14211422class NFTnRFT extends CollectionGroup {1423 /**1424 * Get tokens owned by account1425 *1426 * @param collectionId ID of collection1427 * @param addressObj tokens owner1428 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1429 * @returns array of token ids owned by account1430 */1431 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1432 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1433 }14341435 /**1436 * Get token data1437 *1438 * @param collectionId ID of collection1439 * @param tokenId ID of token1440 * @param propertyKeys optionally filter the token properties to only these keys1441 * @param blockHashAt optionally query the data at some block with this hash1442 * @example getToken(10, 5);1443 * @returns human readable token data1444 */1445 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1446 properties: IProperty[];1447 owner: CrossAccountId;1448 normalizedOwner: CrossAccountId;1449 } | null> {1450 let tokenData;1451 if(typeof blockHashAt === 'undefined') {1452 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1453 }1454 else {1455 if(propertyKeys.length == 0) {1456 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1457 if(!collection) return null;1458 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1459 }1460 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1461 }1462 tokenData = tokenData.toHuman();1463 if(tokenData === null || tokenData.owner === null) return null;1464 const owner = {} as any;1465 for(const key of Object.keys(tokenData.owner)) {1466 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate'1467 ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key])1468 : tokenData.owner[key];1469 }1470 tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1471 return tokenData;1472 }14731474 /**1475 * Get token's owner1476 * @param collectionId ID of collection1477 * @param tokenId ID of token1478 * @param blockHashAt optionally query the data at the block with this hash1479 * @example getTokenOwner(10, 5);1480 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1481 */1482 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1483 let owner;1484 if(typeof blockHashAt === 'undefined') {1485 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1486 } else {1487 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1488 }1489 return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1490 }14911492 /**1493 * Recursively find the address that owns the token1494 * @param collectionId ID of collection1495 * @param tokenId ID of token1496 * @param blockHashAt1497 * @example getTokenTopmostOwner(10, 5);1498 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1499 */1500 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1501 let owner;1502 if(typeof blockHashAt === 'undefined') {1503 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1504 } else {1505 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1506 }15071508 if(owner === null) return null;15091510 return owner.toHuman();1511 }15121513 /**1514 * Nest one token into another1515 * @param signer keyring of signer1516 * @param tokenObj token to be nested1517 * @param rootTokenObj token to be parent1518 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1519 * @returns ```true``` if extrinsic success, otherwise ```false```1520 */1521 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1522 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1523 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1524 if(!result) {1525 throw Error('Unable to nest token!');1526 }1527 return result;1528 }15291530 /**1531 * Remove token from nested state1532 * @param signer keyring of signer1533 * @param tokenObj token to unnest1534 * @param rootTokenObj parent of a token1535 * @param toAddressObj address of a new token owner1536 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1537 * @returns ```true``` if extrinsic success, otherwise ```false```1538 */1539 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1540 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1541 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1542 if(!result) {1543 throw Error('Unable to unnest token!');1544 }1545 return result;1546 }15471548 /**1549 * Set permissions to change token properties1550 *1551 * @param signer keyring of signer1552 * @param collectionId ID of collection1553 * @param permissions permissions to change a property by the collection admin or token owner1554 * @example setTokenPropertyPermissions(1555 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1556 * )1557 * @returns true if extrinsic success otherwise false1558 */1559 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1560 const result = await this.helper.executeExtrinsic(1561 signer,1562 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1563 true,1564 );15651566 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1567 }15681569 /**1570 * Get token property permissions.1571 *1572 * @param collectionId ID of collection1573 * @param propertyKeys optionally filter the returned property permissions to only these keys1574 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1575 * @returns array of key-permission pairs1576 */1577 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1578 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1579 }15801581 /**1582 * Set token properties1583 *1584 * @param signer keyring of signer1585 * @param collectionId ID of collection1586 * @param tokenId ID of token1587 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1588 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1589 * @returns ```true``` if extrinsic success, otherwise ```false```1590 */1591 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1592 const result = await this.helper.executeExtrinsic(1593 signer,1594 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1595 true,1596 );15971598 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1599 }16001601 /**1602 * Get properties, metadata assigned to a token.1603 *1604 * @param collectionId ID of collection1605 * @param tokenId ID of token1606 * @param propertyKeys optionally filter the returned properties to only these keys1607 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1608 * @returns array of key-value pairs1609 */1610 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1611 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1612 }16131614 /**1615 * Delete the provided properties of a token1616 * @param signer keyring of signer1617 * @param collectionId ID of collection1618 * @param tokenId ID of token1619 * @param propertyKeys property keys to be deleted1620 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1621 * @returns ```true``` if extrinsic success, otherwise ```false```1622 */1623 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1624 const result = await this.helper.executeExtrinsic(1625 signer,1626 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1627 true,1628 );16291630 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1631 }16321633 /**1634 * Mint new collection1635 *1636 * @param signer keyring of signer1637 * @param collectionOptions basic collection options and properties1638 * @param mode NFT or RFT type of a collection1639 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1640 * @returns object of the created collection1641 */1642 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1643 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1644 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1645 for(const key of ['name', 'description', 'tokenPrefix']) {1646 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);1647 }16481649 let flags = 0;1650 // convert CollectionFlags to number and join them in one number1651 if(collectionOptions.flags) {1652 for(let i = 0; i < collectionOptions.flags.length; i++){1653 const flag = collectionOptions.flags[i];1654 flags = flags | flag;1655 }1656 }1657 collectionOptions.flags = [flags];16581659 const creationResult = await this.helper.executeExtrinsic(1660 signer,1661 'api.tx.unique.createCollectionEx', [collectionOptions],1662 true, // errorLabel,1663 );1664 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1665 }16661667 getCollectionObject(_collectionId: number): any {1668 return null;1669 }16701671 getTokenObject(_collectionId: number, _tokenId: number): any {1672 return null;1673 }16741675 /**1676 * Tells whether the given `owner` approves the `operator`.1677 * @param collectionId ID of collection1678 * @param owner owner address1679 * @param operator operator addrees1680 * @returns true if operator is enabled1681 */1682 async allowanceForAll(collectionId: number, owner: ICrossAccountId, operator: ICrossAccountId): Promise<boolean> {1683 return (await this.helper.callRpc('api.rpc.unique.allowanceForAll', [collectionId, owner, operator])).toJSON();1684 }16851686 /** Sets or unsets the approval of a given operator.1687 * The `operator` is allowed to transfer all tokens of the `caller` on their behalf.1688 * @param operator Operator1689 * @param approved Should operator status be granted or revoked?1690 * @returns ```true``` if extrinsic success, otherwise ```false```1691 */1692 async setAllowanceForAll(signer: TSigner, collectionId: number, operator: ICrossAccountId, approved: boolean): Promise<boolean> {1693 const result = await this.helper.executeExtrinsic(1694 signer,1695 'api.tx.unique.setAllowanceForAll', [collectionId, operator, approved],1696 true,1697 );1698 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'ApprovedForAll');1699 }1700}170117021703class NFTGroup extends NFTnRFT {1704 /**1705 * Get collection object1706 * @param collectionId ID of collection1707 * @example getCollectionObject(2);1708 * @returns instance of UniqueNFTCollection1709 */1710 getCollectionObject(collectionId: number): UniqueNFTCollection {1711 return new UniqueNFTCollection(collectionId, this.helper);1712 }17131714 /**1715 * Get token object1716 * @param collectionId ID of collection1717 * @param tokenId ID of token1718 * @example getTokenObject(10, 5);1719 * @returns instance of UniqueNFTToken1720 */1721 getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1722 return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1723 }17241725 /**1726 * Is token approved to transfer1727 * @param collectionId ID of collection1728 * @param tokenId ID of token1729 * @param toAccountObj address to be approved1730 * @returns ```true``` if extrinsic success, otherwise ```false```1731 */1732 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1733 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1734 }17351736 /**1737 * Changes the owner of the token.1738 *1739 * @param signer keyring of signer1740 * @param collectionId ID of collection1741 * @param tokenId ID of token1742 * @param addressObj address of a new owner1743 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1744 * @returns ```true``` if extrinsic success, otherwise ```false```1745 */1746 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1747 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1748 }17491750 /**1751 *1752 * Change ownership of a NFT on behalf of the owner.1753 *1754 * @param signer keyring of signer1755 * @param collectionId ID of collection1756 * @param tokenId ID of token1757 * @param fromAddressObj address on behalf of which the token will be sent1758 * @param toAddressObj new token owner1759 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1760 * @returns ```true``` if extrinsic success, otherwise ```false```1761 */1762 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1763 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1764 }17651766 /**1767 * Get tokens nested in the provided token1768 * @param collectionId ID of collection1769 * @param tokenId ID of token1770 * @param blockHashAt optionally query the data at the block with this hash1771 * @example getTokenChildren(10, 5);1772 * @returns tokens whose depth of nesting is <= 51773 */1774 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1775 let children;1776 if(typeof blockHashAt === 'undefined') {1777 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1778 } else {1779 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1780 }17811782 return children.toJSON().map((x: any) => ({collectionId: x.collection, tokenId: x.token}));1783 }17841785 /**1786 * Mint new collection1787 * @param signer keyring of signer1788 * @param collectionOptions Collection options1789 * @example1790 * mintCollection(aliceKeyring, {1791 * name: 'New',1792 * description: 'New collection',1793 * tokenPrefix: 'NEW',1794 * })1795 * @returns object of the created collection1796 */1797 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1798 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1799 }18001801 /**1802 * Mint new token1803 * @param signer keyring of signer1804 * @param data token data1805 * @returns created token object1806 */1807 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1808 const creationResult = await this.helper.executeExtrinsic(1809 signer,1810 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1811 NFT: {1812 properties: data.properties,1813 },1814 }],1815 true,1816 );1817 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1818 if(createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1819 if(createdTokens.tokens.length < 1) throw Error('No tokens minted');1820 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1821 }18221823 /**1824 * Mint multiple NFT tokens1825 * @param signer keyring of signer1826 * @param collectionId ID of collection1827 * @param tokens array of tokens with owner and properties1828 * @example1829 * mintMultipleTokens(aliceKeyring, 10, [{1830 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1831 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1832 * },{1833 * owner: {Ethereum: "0x9F0583DbB855d..."},1834 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1835 * }]);1836 * @returns ```true``` if extrinsic success, otherwise ```false```1837 */1838 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: { owner: ICrossAccountId, properties?: IProperty[] }[]): Promise<UniqueNFToken[]> {1839 const creationResult = await this.helper.executeExtrinsic(1840 signer,1841 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1842 true,1843 );1844 const collection = this.getCollectionObject(collectionId);1845 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1846 }18471848 /**1849 * Mint multiple NFT tokens with one owner1850 * @param signer keyring of signer1851 * @param collectionId ID of collection1852 * @param owner tokens owner1853 * @param tokens array of tokens with owner and properties1854 * @example1855 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1856 * properties: [{1857 * key: "gender",1858 * value: "female",1859 * },{1860 * key: "age",1861 * value: "33",1862 * }],1863 * }]);1864 * @returns array of newly created tokens1865 */1866 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: { properties?: IProperty[] }[]): Promise<UniqueNFToken[]> {1867 const rawTokens = [];1868 for(const token of tokens) {1869 const raw = {NFT: {properties: token.properties}};1870 rawTokens.push(raw);1871 }1872 const creationResult = await this.helper.executeExtrinsic(1873 signer,1874 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1875 true,1876 );1877 const collection = this.getCollectionObject(collectionId);1878 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1879 }18801881 /**1882 * Set, change, or remove approved address to transfer the ownership of the NFT.1883 *1884 * @param signer keyring of signer1885 * @param collectionId ID of collection1886 * @param tokenId ID of token1887 * @param toAddressObj address to approve1888 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1889 * @returns ```true``` if extrinsic success, otherwise ```false```1890 */1891 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {1892 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1893 }1894}189518961897class RFTGroup extends NFTnRFT {1898 /**1899 * Get collection object1900 * @param collectionId ID of collection1901 * @example getCollectionObject(2);1902 * @returns instance of UniqueRFTCollection1903 */1904 getCollectionObject(collectionId: number): UniqueRFTCollection {1905 return new UniqueRFTCollection(collectionId, this.helper);1906 }19071908 /**1909 * Get token object1910 * @param collectionId ID of collection1911 * @param tokenId ID of token1912 * @example getTokenObject(10, 5);1913 * @returns instance of UniqueNFTToken1914 */1915 getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1916 return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1917 }19181919 /**1920 * Get top 10 token owners with the largest number of pieces1921 * @param collectionId ID of collection1922 * @param tokenId ID of token1923 * @example getTokenTop10Owners(10, 5);1924 * @returns array of top 10 owners1925 */1926 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1927 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1928 }19291930 /**1931 * Get number of pieces owned by address1932 * @param collectionId ID of collection1933 * @param tokenId ID of token1934 * @param addressObj address token owner1935 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1936 * @returns number of pieces ownerd by address1937 */1938 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1939 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1940 }19411942 /**1943 * Transfer pieces of token to another address1944 * @param signer keyring of signer1945 * @param collectionId ID of collection1946 * @param tokenId ID of token1947 * @param addressObj address of a new owner1948 * @param amount number of pieces to be transfered1949 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1950 * @returns ```true``` if extrinsic success, otherwise ```false```1951 */1952 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1953 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1954 }19551956 /**1957 * Change ownership of some pieces of RFT on behalf of the owner.1958 * @param signer keyring of signer1959 * @param collectionId ID of collection1960 * @param tokenId ID of token1961 * @param fromAddressObj address on behalf of which the token will be sent1962 * @param toAddressObj new token owner1963 * @param amount number of pieces to be transfered1964 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1965 * @returns ```true``` if extrinsic success, otherwise ```false```1966 */1967 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {1968 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1969 }19701971 /**1972 * Mint new collection1973 * @param signer keyring of signer1974 * @param collectionOptions Collection options1975 * @example1976 * mintCollection(aliceKeyring, {1977 * name: 'New',1978 * description: 'New collection',1979 * tokenPrefix: 'NEW',1980 * })1981 * @returns object of the created collection1982 */1983 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1984 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1985 }19861987 /**1988 * Mint new token1989 * @param signer keyring of signer1990 * @param data token data1991 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1992 * @returns created token object1993 */1994 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1995 const creationResult = await this.helper.executeExtrinsic(1996 signer,1997 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1998 ReFungible: {1999 pieces: data.pieces,2000 properties: data.properties,2001 },2002 }],2003 true,2004 );2005 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);2006 if(createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');2007 if(createdTokens.tokens.length < 1) throw Error('No tokens minted');2008 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);2009 }20102011 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: { owner: ICrossAccountId, pieces: bigint, properties?: IProperty[] }[]): Promise<UniqueRFToken[]> {2012 throw Error('Not implemented');2013 const creationResult = await this.helper.executeExtrinsic(2014 signer,2015 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],2016 true, // `Unable to mint RFT tokens for ${label}`,2017 );2018 const collection = this.getCollectionObject(collectionId);2019 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));2020 }20212022 /**2023 * Mint multiple RFT tokens with one owner2024 * @param signer keyring of signer2025 * @param collectionId ID of collection2026 * @param owner tokens owner2027 * @param tokens array of tokens with properties and pieces2028 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);2029 * @returns array of newly created RFT tokens2030 */2031 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: { pieces: bigint, properties?: IProperty[] }[]): Promise<UniqueRFToken[]> {2032 const rawTokens = [];2033 for(const token of tokens) {2034 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};2035 rawTokens.push(raw);2036 }2037 const creationResult = await this.helper.executeExtrinsic(2038 signer,2039 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2040 true,2041 );2042 const collection = this.getCollectionObject(collectionId);2043 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));2044 }20452046 /**2047 * Destroys a concrete instance of RFT.2048 * @param signer keyring of signer2049 * @param collectionId ID of collection2050 * @param tokenId ID of token2051 * @param amount number of pieces to be burnt2052 * @example burnToken(aliceKeyring, 10, 5);2053 * @returns ```true``` if the extrinsic is successful, otherwise ```false```2054 */2055 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount = 1n): Promise<boolean> {2056 return await super.burnToken(signer, collectionId, tokenId, amount);2057 }20582059 /**2060 * Destroys a concrete instance of RFT on behalf of the owner.2061 * @param signer keyring of signer2062 * @param collectionId ID of collection2063 * @param tokenId ID of token2064 * @param fromAddressObj address on behalf of which the token will be burnt2065 * @param amount number of pieces to be burnt2066 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)2067 * @returns ```true``` if extrinsic success, otherwise ```false```2068 */2069 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {2070 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);2071 }20722073 /**2074 * Set, change, or remove approved address to transfer the ownership of the RFT.2075 *2076 * @param signer keyring of signer2077 * @param collectionId ID of collection2078 * @param tokenId ID of token2079 * @param toAddressObj address to approve2080 * @param amount number of pieces to be approved2081 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);2082 * @returns true if the token success, otherwise false2083 */2084 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {2085 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);2086 }20872088 /**2089 * Get total number of pieces2090 * @param collectionId ID of collection2091 * @param tokenId ID of token2092 * @example getTokenTotalPieces(10, 5);2093 * @returns number of pieces2094 */2095 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {2096 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();2097 }20982099 /**2100 * Change number of token pieces. Signer must be the owner of all token pieces.2101 * @param signer keyring of signer2102 * @param collectionId ID of collection2103 * @param tokenId ID of token2104 * @param amount new number of pieces2105 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);2106 * @returns true if the repartion was success, otherwise false2107 */2108 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {2109 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);2110 const repartitionResult = await this.helper.executeExtrinsic(2111 signer,2112 'api.tx.unique.repartition', [collectionId, tokenId, amount],2113 true,2114 );2115 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');2116 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');2117 }2118}211921202121class FTGroup extends CollectionGroup {2122 /**2123 * Get collection object2124 * @param collectionId ID of collection2125 * @example getCollectionObject(2);2126 * @returns instance of UniqueFTCollection2127 */2128 getCollectionObject(collectionId: number): UniqueFTCollection {2129 return new UniqueFTCollection(collectionId, this.helper);2130 }21312132 /**2133 * Mint new fungible collection2134 * @param signer keyring of signer2135 * @param collectionOptions Collection options2136 * @param decimalPoints number of token decimals2137 * @example2138 * mintCollection(aliceKeyring, {2139 * name: 'New',2140 * description: 'New collection',2141 * tokenPrefix: 'NEW',2142 * }, 18)2143 * @returns newly created fungible collection2144 */2145 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {2146 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object2147 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');2148 collectionOptions.mode = {fungible: decimalPoints};2149 for(const key of ['name', 'description', 'tokenPrefix']) {2150 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);2151 }2152 const creationResult = await this.helper.executeExtrinsic(2153 signer,2154 'api.tx.unique.createCollectionEx', [collectionOptions],2155 true,2156 );2157 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));2158 }21592160 /**2161 * Mint tokens2162 * @param signer keyring of signer2163 * @param collectionId ID of collection2164 * @param owner address owner of new tokens2165 * @param amount amount of tokens to be meanted2166 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);2167 * @returns ```true``` if extrinsic success, otherwise ```false```2168 */2169 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {2170 const creationResult = await this.helper.executeExtrinsic(2171 signer,2172 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {2173 Fungible: {2174 value: amount,2175 },2176 }],2177 true, // `Unable to mint fungible tokens for ${label}`,2178 );2179 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2180 }21812182 /**2183 * Mint multiple Fungible tokens with one owner2184 * @param signer keyring of signer2185 * @param collectionId ID of collection2186 * @param owner tokens owner2187 * @param tokens array of tokens with properties and pieces2188 * @returns ```true``` if extrinsic success, otherwise ```false```2189 */2190 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: { value: bigint }[], owner: ICrossAccountId): Promise<boolean> {2191 const rawTokens = [];2192 for(const token of tokens) {2193 const raw = {Fungible: {Value: token.value}};2194 rawTokens.push(raw);2195 }2196 const creationResult = await this.helper.executeExtrinsic(2197 signer,2198 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2199 true,2200 );2201 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2202 }22032204 /**2205 * Get the top 10 owners with the largest balance for the Fungible collection2206 * @param collectionId ID of collection2207 * @example getTop10Owners(10);2208 * @returns array of ```ICrossAccountId```2209 */2210 async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {2211 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);2212 }22132214 /**2215 * Get account balance2216 * @param collectionId ID of collection2217 * @param addressObj address of owner2218 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})2219 * @returns amount of fungible tokens owned by address2220 */2221 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {2222 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();2223 }22242225 /**2226 * Transfer tokens to address2227 * @param signer keyring of signer2228 * @param collectionId ID of collection2229 * @param toAddressObj address recipient2230 * @param amount amount of tokens to be sent2231 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2232 * @returns ```true``` if extrinsic success, otherwise ```false```2233 */2234 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount = 1n) {2235 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);2236 }22372238 /**2239 * Transfer some tokens on behalf of the owner.2240 * @param signer keyring of signer2241 * @param collectionId ID of collection2242 * @param fromAddressObj address on behalf of which tokens will be sent2243 * @param toAddressObj address where token to be sent2244 * @param amount number of tokens to be sent2245 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);2246 * @returns ```true``` if extrinsic success, otherwise ```false```2247 */2248 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {2249 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);2250 }22512252 /**2253 * Destroy some amount of tokens2254 * @param signer keyring of signer2255 * @param collectionId ID of collection2256 * @param amount amount of tokens to be destroyed2257 * @example burnTokens(aliceKeyring, 10, 1000n);2258 * @returns ```true``` if extrinsic success, otherwise ```false```2259 */2260 async burnTokens(signer: IKeyringPair, collectionId: number, amount = 1n): Promise<boolean> {2261 return await super.burnToken(signer, collectionId, 0, amount);2262 }22632264 /**2265 * Burn some tokens on behalf of the owner.2266 * @param signer keyring of signer2267 * @param collectionId ID of collection2268 * @param fromAddressObj address on behalf of which tokens will be burnt2269 * @param amount amount of tokens to be burnt2270 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2271 * @returns ```true``` if extrinsic success, otherwise ```false```2272 */2273 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount = 1n): Promise<boolean> {2274 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);2275 }22762277 /**2278 * Get total collection supply2279 * @param collectionId2280 * @returns2281 */2282 async getTotalPieces(collectionId: number): Promise<bigint> {2283 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();2284 }22852286 /**2287 * Set, change, or remove approved address to transfer tokens.2288 *2289 * @param signer keyring of signer2290 * @param collectionId ID of collection2291 * @param toAddressObj address to be approved2292 * @param amount amount of tokens to be approved2293 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)2294 * @returns ```true``` if extrinsic success, otherwise ```false```2295 */2296 approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount = 1n) {2297 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);2298 }22992300 /**2301 * Get amount of fungible tokens approved to transfer2302 * @param collectionId ID of collection2303 * @param fromAddressObj owner of tokens2304 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner2305 * @returns number of tokens approved for the transfer2306 */2307 getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2308 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2309 }2310}231123122313class ChainGroup extends HelperGroup<ChainHelperBase> {2314 /**2315 * Get system properties of a chain2316 * @example getChainProperties();2317 * @returns ss58Format, token decimals, and token symbol2318 */2319 getChainProperties(): IChainProperties {2320 const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2321 return {2322 ss58Format: properties.ss58Format.toJSON(),2323 tokenDecimals: properties.tokenDecimals.toJSON(),2324 tokenSymbol: properties.tokenSymbol.toJSON(),2325 };2326 }23272328 /**2329 * Get chain header2330 * @example getLatestBlockNumber();2331 * @returns the number of the last block2332 */2333 async getLatestBlockNumber(): Promise<number> {2334 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2335 }23362337 /**2338 * Get block hash by block number2339 * @param blockNumber number of block2340 * @example getBlockHashByNumber(12345);2341 * @returns hash of a block2342 */2343 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2344 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2345 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2346 return blockHash;2347 }23482349 // TODO add docs2350 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2351 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2352 if(!blockHash) return null;2353 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2354 }23552356 /**2357 * Get latest relay block2358 * @returns {number} relay block2359 */2360 async getRelayBlockNumber(): Promise<bigint> {2361 const blockNumber = (await this.helper.callRpc('api.query.parachainSystem.validationData')).toJSON().relayParentNumber;2362 return BigInt(blockNumber);2363 }23642365 /**2366 * Get account nonce2367 * @param address substrate address2368 * @example getNonce("5GrwvaEF5zXb26Fz...");2369 * @returns number, account's nonce2370 */2371 async getNonce(address: TSubstrateAccount): Promise<number> {2372 return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2373 }2374}23752376class SubstrateBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2377 /**2378 * Get substrate address balance2379 * @param address substrate address2380 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2381 * @returns amount of tokens on address2382 */2383 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2384 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2385 }23862387 /**2388 * Transfer tokens to substrate address2389 * @param signer keyring of signer2390 * @param address substrate address of a recipient2391 * @param amount amount of tokens to be transfered2392 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2393 * @returns ```true``` if extrinsic success, otherwise ```false```2394 */2395 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2396 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}`*/);23972398 let transfer = {from: null, to: null, amount: 0n} as any;2399 result.result.events.forEach(({event: {data, method, section}}) => {2400 if((section === 'balances') && (method === 'Transfer')) {2401 transfer = {2402 from: this.helper.address.normalizeSubstrate(data[0]),2403 to: this.helper.address.normalizeSubstrate(data[1]),2404 amount: BigInt(data[2]),2405 };2406 }2407 });2408 const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from2409 && this.helper.address.normalizeSubstrate(address) === transfer.to2410 && BigInt(amount) === transfer.amount;2411 return isSuccess;2412 }24132414 /**2415 * Get full substrate balance including free, frozen, and reserved2416 * @param address substrate address2417 * @returns2418 */2419 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2420 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2421 return {free: accountInfo.free.toBigInt(), frozen: accountInfo.frozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2422 }24232424 /**2425 * Get total issuance2426 * @returns2427 */2428 async getTotalIssuance(): Promise<bigint> {2429 const total = (await this.helper.callRpc('api.query.balances.totalIssuance', []));2430 return total.toBigInt();2431 }24322433 async getLocked(address: TSubstrateAccount): Promise<{ id: string, amount: bigint, reason: string }[]> {2434 const locks = (await this.helper.callRpc('api.query.balances.locks', [address])).toHuman();2435 return locks.map((lock: any) => ({id: lock.id, amount: BigInt(lock.amount.replace(/,/g, '')), reasons: lock.reasons}));2436 }2437 async getFrozen(address: TSubstrateAccount): Promise<{ id: string, amount: bigint }[]> {2438 const locks = (await this.helper.api!.query.balances.freezes(address)) as unknown as Array<any>;2439 return locks.map(lock => ({id: lock.id.toUtf8(), amount: lock.amount.toBigInt()}));2440 }2441}24422443class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2444 /**2445 * Get ethereum address balance2446 * @param address ethereum address2447 * @example getEthereum("0x9F0583DbB855d...")2448 * @returns amount of tokens on address2449 */2450 async getEthereum(address: TEthereumAccount): Promise<bigint> {2451 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2452 }24532454 /**2455 * Transfer tokens to address2456 * @param signer keyring of signer2457 * @param address Ethereum address of a recipient2458 * @param amount amount of tokens to be transfered2459 * @example transferToEthereum(alithKeyring, "0x9F0583DbB855d...", 100_000_000_000n);2460 * @returns ```true``` if extrinsic success, otherwise ```false```2461 */2462 async transferToEthereum(signer: TSigner, address: TEthereumAccount, amount: bigint | string): Promise<boolean> {2463 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true);24642465 let transfer = {from: null, to: null, amount: 0n} as any;2466 result.result.events.forEach(({event: {data, method, section}}) => {2467 if((section === 'balances') && (method === 'Transfer')) {2468 transfer = {2469 from: data[0].toString(),2470 to: data[1].toString(),2471 amount: BigInt(data[2]),2472 };2473 }2474 });2475 const isSuccess = (typeof signer === 'string' ? signer : signer.address) === transfer.from2476 && address === transfer.to2477 && BigInt(amount) === transfer.amount;2478 return isSuccess;2479 }2480}24812482class BalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2483 subBalanceGroup: SubstrateBalanceGroup<T>;2484 ethBalanceGroup: EthereumBalanceGroup<T>;24852486 constructor(helper: T) {2487 super(helper);2488 this.subBalanceGroup = new SubstrateBalanceGroup(helper);2489 this.ethBalanceGroup = new EthereumBalanceGroup(helper);2490 }24912492 getCollectionCreationPrice(): bigint {2493 return 2n * this.getOneTokenNominal();2494 }2495 /**2496 * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2497 * @example getOneTokenNominal()2498 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2499 */2500 getOneTokenNominal(): bigint {2501 const chainProperties = this.helper.chain.getChainProperties();2502 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2503 }25042505 /**2506 * Get substrate address balance2507 * @param address substrate address2508 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2509 * @returns amount of tokens on address2510 */2511 getSubstrate(address: TSubstrateAccount): Promise<bigint> {2512 return this.subBalanceGroup.getSubstrate(address);2513 }25142515 /**2516 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2517 * @param address substrate address2518 * @returns2519 */2520 getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2521 return this.subBalanceGroup.getSubstrateFull(address);2522 }25232524 /**2525 * Get total issuance2526 * @returns2527 */2528 getTotalIssuance(): Promise<bigint> {2529 return this.subBalanceGroup.getTotalIssuance();2530 }25312532 /**2533 * Get locked balances2534 * @param address substrate address2535 * @returns locked balances with reason via api.query.balances.locks2536 * @deprecated all the methods should switch to getFrozen2537 */2538 getLocked(address: TSubstrateAccount) {2539 return this.subBalanceGroup.getLocked(address);2540 }25412542 /**2543 * Get frozen balances2544 * @param address substrate address2545 * @returns frozen balances with id via api.query.balances.freezes2546 */2547 getFrozen(address: TSubstrateAccount) {2548 return this.subBalanceGroup.getFrozen(address);2549 }25502551 /**2552 * Get ethereum address balance2553 * @param address ethereum address2554 * @example getEthereum("0x9F0583DbB855d...")2555 * @returns amount of tokens on address2556 */2557 getEthereum(address: TEthereumAccount): Promise<bigint> {2558 return this.ethBalanceGroup.getEthereum(address);2559 }25602561 async setBalanceSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint) {2562 await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceSetBalance', [address, amount], true);2563 }25642565 /**2566 * Transfer tokens to substrate address2567 * @param signer keyring of signer2568 * @param address substrate address of a recipient2569 * @param amount amount of tokens to be transfered2570 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2571 * @returns ```true``` if extrinsic success, otherwise ```false```2572 */2573 transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2574 return this.subBalanceGroup.transferToSubstrate(signer, address, amount);2575 }25762577 async forceTransferToSubstrate(signer: TSigner, from: TSubstrateAccount, to: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2578 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceTransfer', [from, to, amount], true);25792580 let transfer = {from: null, to: null, amount: 0n} as any;2581 result.result.events.forEach(({event: {data, method, section}}) => {2582 if((section === 'balances') && (method === 'Transfer')) {2583 transfer = {2584 from: this.helper.address.normalizeSubstrate(data[0]),2585 to: this.helper.address.normalizeSubstrate(data[1]),2586 amount: BigInt(data[2]),2587 };2588 }2589 });2590 let isSuccess = this.helper.address.normalizeSubstrate(from) === transfer.from;2591 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(to) === transfer.to;2592 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2593 return isSuccess;2594 }25952596 /**2597 * Transfer tokens with the unlock period2598 * @param signer signers Keyring2599 * @param address Substrate address of recipient2600 * @param schedule Schedule params2601 * @example vestedTransfer(signer, recepient.address, 20000, 100, 10, 50 * nominal); // total amount of vested tokens will be 100 * 50 = 50002602 */2603 async vestedTransfer(signer: TSigner, address: TSubstrateAccount, schedule: { start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint }): Promise<void> {2604 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.vestedTransfer', [address, schedule]);2605 const event = result.result.events2606 .find(e => e.event.section === 'vesting' &&2607 e.event.method === 'VestingScheduleAdded' &&2608 e.event.data[0].toHuman() === signer.address);2609 if(!event) throw Error('Cannot find transfer in events');2610 }26112612 /**2613 * Get schedule for recepient of vested transfer2614 * @param address Substrate address of recipient2615 * @returns2616 */2617 async getVestingSchedules(address: TSubstrateAccount): Promise<{ start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint }[]> {2618 const schedule = (await this.helper.callRpc('api.query.vesting.vestingSchedules', [address])).toJSON();2619 return schedule.map((schedule: any) => ({2620 start: BigInt(schedule.start),2621 period: BigInt(schedule.period),2622 periodCount: BigInt(schedule.periodCount),2623 perPeriod: BigInt(schedule.perPeriod),2624 }));2625 }26262627 /**2628 * Claim vested tokens2629 * @param signer signers Keyring2630 */2631 async claim(signer: TSigner) {2632 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.claim', []);2633 const event = result.result.events2634 .find(e => e.event.section === 'vesting' &&2635 e.event.method === 'Claimed' &&2636 e.event.data[0].toHuman() === signer.address);2637 if(!event) throw Error('Cannot find claim in events');2638 }2639}26402641class AddressGroup extends HelperGroup<ChainHelperBase> {2642 /**2643 * Normalizes the address to the specified ss58 format, by default ```42```.2644 * @param address substrate address2645 * @param ss58Format format for address conversion, by default ```42```2646 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2647 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2648 */2649 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2650 return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2651 }26522653 /**2654 * Get address in the connected chain format2655 * @param address substrate address2656 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2657 * @returns address in chain format2658 */2659 normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2660 return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2661 }26622663 /**2664 * Get substrate mirror of an ethereum address2665 * @param ethAddress ethereum address2666 * @param toChainFormat false for normalized account2667 * @example ethToSubstrate('0x9F0583DbB855d...')2668 * @returns substrate mirror of a provided ethereum address2669 */2670 ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat = false): TSubstrateAccount {2671 return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2672 }26732674 /**2675 * Get ethereum mirror of a substrate address2676 * @param subAddress substrate account2677 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2678 * @returns ethereum mirror of a provided substrate address2679 */2680 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2681 return CrossAccountId.translateSubToEth(subAddress);2682 }26832684 /**2685 * Encode key to substrate address2686 * @param key key for encoding address2687 * @param ss58Format prefix for encoding to the address of the corresponding network2688 * @returns encoded substrate address2689 */2690 encodeSubstrateAddress(key: Uint8Array | string | bigint, ss58Format = 42): string {2691 const u8a: Uint8Array = typeof key === 'string'2692 ? hexToU8a(key)2693 : typeof key === 'bigint'2694 ? hexToU8a(key.toString(16))2695 : key;26962697 if(ss58Format < 0 || ss58Format > 16383 || [46, 47].includes(ss58Format)) {2698 throw new Error(`ss58Format is not valid, received ${typeofss58Format} "${ss58Format}"`);2699 }27002701 const allowedDecodedLengths = [1, 2, 4, 8, 32, 33];2702 if(!allowedDecodedLengths.includes(u8a.length)) {2703 throw new Error(`key length is not valid, received ${u8a.length}, valid values are ${allowedDecodedLengths.join(', ')}`);2704 }27052706 const u8aPrefix = ss58Format < 642707 ? new Uint8Array([ss58Format])2708 : new Uint8Array([2709 ((ss58Format & 0xfc) >> 2) | 0x40,2710 (ss58Format >> 8) | ((ss58Format & 0x03) << 6),2711 ]);27122713 const input = u8aConcat(u8aPrefix, u8a);27142715 return base58Encode(u8aConcat(2716 input,2717 blake2AsU8a(input).subarray(0, [32, 33].includes(u8a.length) ? 2 : 1),2718 ));2719 }27202721 /**2722 * Restore substrate address from bigint representation2723 * @param number decimal representation of substrate address2724 * @returns substrate address2725 */2726 restoreCrossAccountFromBigInt(number: bigint): TSubstrateAccount {2727 if(this.helper.api === null) {2728 throw 'Not connected';2729 }2730 const res = this.helper.api.registry.createType('AccountId', '0x' + number.toString(16).padStart(64, '0')).toJSON();2731 if(res === undefined || res === null) {2732 throw 'Restore address error';2733 }2734 return res.toString();2735 }27362737 /**2738 * Convert etherium cross account id to substrate cross account id2739 * @param ethCrossAccount etherium cross account2740 * @returns substrate cross account id2741 */2742 convertCrossAccountFromEthCrossAccount(ethCrossAccount: IEthCrossAccountId): ICrossAccountId {2743 if(ethCrossAccount.sub === '0') {2744 return {Ethereum: ethCrossAccount.eth.toLocaleLowerCase()};2745 }27462747 const ss58 = this.restoreCrossAccountFromBigInt(BigInt(ethCrossAccount.sub));2748 return {Substrate: ss58};2749 }27502751 paraSiblingSovereignAccount(paraid: number) {2752 // We are getting a *sibling* parachain sovereign account,2753 // so we need a sibling prefix: encoded(b"sibl") == 0x7369626c2754 const siblingPrefix = '0x7369626c';27552756 const encodedParaId = this.helper.getApi().createType('u32', paraid).toHex(true).substring(2);2757 const suffix = '000000000000000000000000000000000000000000000000';27582759 return siblingPrefix + encodedParaId + suffix;2760 }2761}27622763class StakingGroup extends HelperGroup<UniqueHelper> {2764 /**2765 * Stake tokens for App Promotion2766 * @param signer keyring of signer2767 * @param amountToStake amount of tokens to stake2768 * @param label extra label for log2769 * @returns2770 */2771 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2772 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2773 const _stakeResult = await this.helper.executeExtrinsic(2774 signer, 'api.tx.appPromotion.stake',2775 [amountToStake], true,2776 );2777 // TODO extract info from stakeResult2778 return true;2779 }27802781 /**2782 * Unstake all staked tokens2783 * @param signer keyring of signer2784 * @param amountToUnstake amount of tokens to unstake2785 * @param label extra label for log2786 * @returns block hash where unstake happened2787 */2788 async unstakeAll(signer: TSigner, label?: string): Promise<string> {2789 if(typeof label === 'undefined') label = `${signer.address}`;2790 const unstakeResult = await this.helper.executeExtrinsic(2791 signer, 'api.tx.appPromotion.unstakeAll',2792 [], true,2793 );2794 return unstakeResult.blockHash;2795 }27962797 /**2798 * Unstake the part of a staked tokens2799 * @param signer keyring of signer2800 * @param amount amount of tokens to unstake2801 * @param label extra label for log2802 * @returns block hash where unstake happened2803 */2804 async unstakePartial(signer: TSigner, amount: bigint, label?: string): Promise<string> {2805 if(typeof label === 'undefined') label = `${signer.address}`;2806 const unstakeResult = await this.helper.executeExtrinsic(2807 signer, 'api.tx.appPromotion.unstakePartial',2808 [amount], true,2809 );2810 return unstakeResult.blockHash;2811 }28122813 /**2814 * Get total number of active stakes2815 * @param address substrate address2816 * @returns {number}2817 */2818 async getStakesNumber(address: ICrossAccountId): Promise<number> {2819 if('Ethereum' in address) throw Error('only substrate address');2820 return (await this.helper.callRpc('api.query.appPromotion.stakesPerAccount', [address.Substrate])).toNumber();2821 }28222823 /**2824 * Get total staked amount for address2825 * @param address substrate or ethereum address2826 * @returns total staked amount2827 */2828 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2829 if(address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2830 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2831 }28322833 /**2834 * Get total staked per block2835 * @param address substrate or ethereum address2836 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2837 */2838 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2839 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2840 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => ({2841 block: block.toBigInt(),2842 amount: amount.toBigInt(),2843 }));2844 }28452846 /**2847 * Get total pending unstake amount for address2848 * @param address substrate or ethereum address2849 * @returns total pending unstake amount2850 */2851 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2852 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2853 }28542855 /**2856 * Get pending unstake amount per block for address2857 * @param address substrate or ethereum address2858 * @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 block2859 */2860 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2861 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2862 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => ({2863 block: block.toBigInt(),2864 amount: amount.toBigInt(),2865 }));2866 return result;2867 }2868}28692870class SchedulerGroup extends HelperGroup<UniqueHelper> {2871 constructor(helper: UniqueHelper) {2872 super(helper);2873 }28742875 cancelScheduled(signer: TSigner, scheduledId: string) {2876 return this.helper.executeExtrinsic(2877 signer,2878 'api.tx.scheduler.cancelNamed',2879 [scheduledId],2880 true,2881 );2882 }28832884 changePriority(signer: TSigner, scheduledId: string, priority: number) {2885 return this.helper.executeExtrinsic(2886 signer,2887 'api.tx.scheduler.changeNamedPriority',2888 [scheduledId, priority],2889 true,2890 );2891 }28922893 scheduleAt<T extends UniqueHelper>(2894 executionBlockNumber: number,2895 options: ISchedulerOptions = {},2896 ) {2897 return this.schedule<T>('schedule', executionBlockNumber, options);2898 }28992900 scheduleAfter<T extends UniqueHelper>(2901 blocksBeforeExecution: number,2902 options: ISchedulerOptions = {},2903 ) {2904 return this.schedule<T>('scheduleAfter', blocksBeforeExecution, options);2905 }29062907 schedule<T extends UniqueHelper>(2908 scheduleFn: 'schedule' | 'scheduleAfter',2909 blocksNum: number,2910 options: ISchedulerOptions = {},2911 ) {2912 // eslint-disable-next-line @typescript-eslint/naming-convention2913 const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2914 return this.helper.clone(ScheduledHelperType, {2915 scheduleFn,2916 blocksNum,2917 options,2918 }) as T;2919 }2920}29212922class CollatorSelectionGroup extends HelperGroup<UniqueHelper> {2923 //todo:collator documentation2924 addInvulnerable(signer: TSigner, address: string) {2925 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.addInvulnerable', [address]);2926 }29272928 removeInvulnerable(signer: TSigner, address: string) {2929 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.removeInvulnerable', [address]);2930 }29312932 async getInvulnerables(): Promise<string[]> {2933 return (await this.helper.callRpc('api.query.collatorSelection.invulnerables')).map((x: any) => x.toHuman());2934 }29352936 /** and also total max invulnerables */2937 maxCollators(): number {2938 return (this.helper.getApi().consts.configuration.defaultCollatorSelectionMaxCollators.toJSON() as number);2939 }29402941 async getDesiredCollators(): Promise<number> {2942 return (await this.helper.callRpc('api.query.configuration.collatorSelectionDesiredCollatorsOverride')).toNumber();2943 }29442945 setLicenseBond(signer: TSigner, amount: bigint) {2946 return this.helper.executeExtrinsic(signer, 'api.tx.configuration.setCollatorSelectionLicenseBond', [amount]);2947 }29482949 async getLicenseBond(): Promise<bigint> {2950 return (await this.helper.callRpc('api.query.configuration.collatorSelectionLicenseBondOverride')).toBigInt();2951 }29522953 obtainLicense(signer: TSigner) {2954 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.getLicense', []);2955 }29562957 releaseLicense(signer: TSigner) {2958 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.releaseLicense', []);2959 }29602961 forceReleaseLicense(signer: TSigner, released: string) {2962 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.forceReleaseLicense', [released]);2963 }29642965 async hasLicense(address: string): Promise<bigint> {2966 return (await this.helper.callRpc('api.query.collatorSelection.licenseDepositOf', [address])).toBigInt();2967 }29682969 onboard(signer: TSigner) {2970 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.onboard', []);2971 }29722973 offboard(signer: TSigner) {2974 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.offboard', []);2975 }29762977 async getCandidates(): Promise<string[]> {2978 return (await this.helper.callRpc('api.query.collatorSelection.candidates')).map((x: any) => x.toHuman());2979 }2980}29812982class CollectiveGroup extends HelperGroup<UniqueHelper> {2983 /**2984 * Pallet name to make an API call to. Examples: 'council', 'technicalCommittee'2985 */2986 private collective: string;29872988 constructor(helper: UniqueHelper, collective: string) {2989 super(helper);2990 this.collective = collective;2991 }29922993 /**2994 * Check the result of a proposal execution for the success of the underlying proposed extrinsic.2995 * @param events events of the proposal execution2996 * @returns proposal hash2997 */2998 private checkExecutedEvent(events: IPhasicEvent[]): string {2999 const executionEvents = events.filter(x =>3000 x.event.section === this.collective && (x.event.method === 'Executed' || x.event.method === 'MemberExecuted'));30013002 if(executionEvents.length != 1) {3003 if(events.filter(x => x.event.section === this.collective && x.event.method === 'Disapproved').length > 0)3004 throw new Error(`Disapproved by ${this.collective}`);3005 else3006 throw new Error(`Expected one 'Executed' or 'MemberExecuted' event for ${this.collective}`);3007 }30083009 const result = (executionEvents[0].event.data as any).result;30103011 if(result.isErr) {3012 if(result.asErr.isModule) {3013 const error = result.asErr.asModule;3014 const metaError = this.helper.getApi()?.registry.findMetaError(error);3015 throw new Error(`Proposal execution failed with ${metaError.section}.${metaError.name}`);3016 } else {3017 throw new Error('Proposal execution failed with ' + result.asErr.toHuman());3018 }3019 }30203021 return (executionEvents[0].event.data as any).proposalHash;3022 }30233024 /**3025 * Returns an array of members' addresses.3026 */3027 async getMembers() {3028 return (await this.helper.callRpc(`api.query.${this.collective}.members`, [])).toHuman();3029 }30303031 /**3032 * Returns the optional address of the prime member of the collective.3033 */3034 async getPrimeMember() {3035 return (await this.helper.callRpc(`api.query.${this.collective}.prime`, [])).toHuman();3036 }30373038 /**3039 * Returns an array of proposal hashes that are currently active for this collective.3040 */3041 async getProposals() {3042 return (await this.helper.callRpc(`api.query.${this.collective}.proposals`, [])).toHuman();3043 }30443045 /**3046 * Returns the call originally encoded under the specified hash.3047 * @param hash h256-encoded proposal3048 * @returns the optional call that the proposal hash stands for.3049 */3050 async getProposalCallOf(hash: string) {3051 return (await this.helper.callRpc(`api.query.${this.collective}.proposalOf`, [hash])).toHuman();3052 }30533054 /**3055 * Returns the total number of proposals so far.3056 */3057 async getTotalProposalsCount() {3058 return (await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, [])).toNumber();3059 }30603061 /**3062 * Creates a new proposal up for voting. If the threshold is set to 1, the proposal will be executed immediately.3063 * @param signer keyring of the proposer3064 * @param proposal constructed call to be executed if the proposal is successful3065 * @param voteThreshold minimal number of votes for the proposal to be verified and executed3066 * @param lengthBound byte length of the encoded call3067 * @returns promise of extrinsic execution and its result3068 */3069 async propose(signer: TSigner, proposal: any, voteThreshold: number, lengthBound = 10000) {3070 return await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [voteThreshold, proposal, lengthBound]);3071 }30723073 /**3074 * Casts a vote to either approve or reject a proposal.3075 * @param signer keyring of the voter3076 * @param proposalHash hash of the proposal to be voted for3077 * @param proposalIndex absolute index of the proposal used for absolutely nothing but throwing pointless errors3078 * @param approve aye or nay3079 * @returns promise of extrinsic execution and its result3080 */3081 vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {3082 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve]);3083 }30843085 /**3086 * Executes a call immediately as a member of the collective. Needed for the Member origin.3087 * @param signer keyring of the executor member3088 * @param proposal constructed call to be executed by the member3089 * @param lengthBound byte length of the encoded call3090 * @returns promise of extrinsic execution3091 */3092 async execute(signer: TSigner, proposal: any, lengthBound = 10000) {3093 const result = await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.execute`, [proposal, lengthBound]);3094 this.checkExecutedEvent(result.result.events);3095 return result;3096 }30973098 /**3099 * Attempt to close and execute a proposal. Note that there must already be enough votes to meet the threshold set when proposing.3100 * @param signer keyring of the executor. Can be absolutely anyone.3101 * @param proposalHash hash of the proposal to close3102 * @param proposalIndex index of the proposal generated on its creation3103 * @param weightBound weight of the proposed call. Can be obtained by calling `paymentInfo()` on the call.3104 * @param lengthBound byte length of the encoded call3105 * @returns promise of extrinsic execution and its result3106 */3107 async close(3108 signer: TSigner,3109 proposalHash: string,3110 proposalIndex: number,3111 weightBound: [number, number] | any = [20_000_000_000, 1000_000],3112 lengthBound = 10_000,3113 ) {3114 const result = await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [3115 proposalHash,3116 proposalIndex,3117 weightBound,3118 lengthBound,3119 ]);3120 this.checkExecutedEvent(result.result.events);3121 return result;3122 }31233124 /**3125 * Shut down a proposal, regardless of its current state.3126 * @param signer keyring of the disapprover. Must be root3127 * @param proposalHash hash of the proposal to close3128 * @returns promise of extrinsic execution and its result3129 */3130 disapproveProposal(signer: TSigner, proposalHash: string) {3131 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.disapproveProposal`, [proposalHash]);3132 }3133}31343135class CollectiveMembershipGroup extends HelperGroup<UniqueHelper> {3136 /**3137 * Pallet name to make an API call to. Examples: 'councilMembership', 'technicalCommitteeMembership'3138 */3139 private membership: string;31403141 constructor(helper: UniqueHelper, membership: string) {3142 super(helper);3143 this.membership = membership;3144 }31453146 /**3147 * Returns an array of members' addresses according to the membership pallet's perception.3148 * Note that it does not recognize the original pallet's members set with `setMembers()`.3149 */3150 async getMembers() {3151 return (await this.helper.callRpc(`api.query.${this.membership}.members`, [])).toHuman();3152 }31533154 /**3155 * Returns the optional address of the prime member of the collective.3156 */3157 async getPrimeMember() {3158 return (await this.helper.callRpc(`api.query.${this.membership}.prime`, [])).toHuman();3159 }31603161 /**3162 * Add a member to the collective.3163 * @param signer keyring of the setter. Must be root3164 * @param member address of the member to add3165 * @returns promise of extrinsic execution and its result3166 */3167 addMember(signer: TSigner, member: string) {3168 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.addMember`, [member]);3169 }31703171 addMemberCall(member: string) {3172 return this.helper.constructApiCall(`api.tx.${this.membership}.addMember`, [member]);3173 }31743175 /**3176 * Remove a member from the collective.3177 * @param signer keyring of the setter. Must be root3178 * @param member address of the member to remove3179 * @returns promise of extrinsic execution and its result3180 */3181 removeMember(signer: TSigner, member: string) {3182 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.removeMember`, [member]);3183 }31843185 removeMemberCall(member: string) {3186 return this.helper.constructApiCall(`api.tx.${this.membership}.removeMember`, [member]);3187 }31883189 /**3190 * Set members of the collective to the given list of addresses.3191 * @param signer keyring of the setter. Must be root (for the direct call, bypassing a public motion)3192 * @param members addresses of the members to set3193 * @returns promise of extrinsic execution and its result3194 */3195 resetMembers(signer: TSigner, members: string[]) {3196 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.resetMembers`, [members]);3197 }31983199 /**3200 * Set the collective's prime member to the given address.3201 * @param signer keyring of the setter. Must be root (for the direct call, bypassing a public motion)3202 * @param prime address of the prime member of the collective3203 * @returns promise of extrinsic execution and its result3204 */3205 setPrime(signer: TSigner, prime: string) {3206 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.setPrime`, [prime]);3207 }32083209 setPrimeCall(member: string) {3210 return this.helper.constructApiCall(`api.tx.${this.membership}.setPrime`, [member]);3211 }32123213 /**3214 * Remove the collective's prime member.3215 * @param signer keyring of the setter. Must be root (for the direct call, bypassing a public motion)3216 * @returns promise of extrinsic execution and its result3217 */3218 clearPrime(signer: TSigner) {3219 return this.helper.executeExtrinsic(signer, `api.tx.${this.membership}.clearPrime`, []);3220 }32213222 clearPrimeCall() {3223 return this.helper.constructApiCall(`api.tx.${this.membership}.clearPrime`, []);3224 }3225}32263227class RankedCollectiveGroup extends HelperGroup<UniqueHelper> {3228 /**3229 * Pallet name to make an API call to. Examples: 'FellowshipCollective'3230 */3231 private collective: string;32323233 constructor(helper: UniqueHelper, collective: string) {3234 super(helper);3235 this.collective = collective;3236 }32373238 addMember(signer: TSigner, newMember: string) {3239 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.addMember`, [newMember]);3240 }32413242 addMemberCall(newMember: string) {3243 return this.helper.constructApiCall(`api.tx.${this.collective}.addMember`, [newMember]);3244 }32453246 removeMember(signer: TSigner, member: string, minRank: number) {3247 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.removeMember`, [member, minRank]);3248 }32493250 removeMemberCall(newMember: string, minRank: number) {3251 return this.helper.constructApiCall(`api.tx.${this.collective}.removeMember`, [newMember, minRank]);3252 }32533254 promote(signer: TSigner, member: string) {3255 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.promoteMember`, [member]);3256 }32573258 promoteCall(newMember: string) {3259 return this.helper.constructApiCall(`api.tx.${this.collective}.promoteMember`, [newMember]);3260 }32613262 demote(signer: TSigner, member: string) {3263 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.demoteMember`, [member]);3264 }32653266 demoteCall(newMember: string) {3267 return this.helper.constructApiCall(`api.tx.${this.collective}.demoteMember`, [newMember]);3268 }32693270 vote(signer: TSigner, pollIndex: number, aye: boolean) {3271 return this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [pollIndex, aye]);3272 }32733274 async getMembers() {3275 return (await this.helper.getApi().query.fellowshipCollective.members.keys())3276 .map((key) => key.args[0].toString());3277 }3278}32793280class ReferendaGroup extends HelperGroup<UniqueHelper> {3281 /**3282 * Pallet name to make an API call to. Examples: 'FellowshipReferenda'3283 */3284 private referenda: string;32853286 constructor(helper: UniqueHelper, referenda: string) {3287 super(helper);3288 this.referenda = referenda;3289 }32903291 submit(3292 signer: TSigner,3293 proposalOrigin: string,3294 proposal: any,3295 enactmentMoment: any,3296 ) {3297 return this.helper.executeExtrinsic(signer, `api.tx.${this.referenda}.submit`, [3298 {Origins: proposalOrigin},3299 proposal,3300 enactmentMoment,3301 ]);3302 }33033304 placeDecisionDeposit(signer: TSigner, referendumIndex: number) {3305 return this.helper.executeExtrinsic(signer, `api.tx.${this.referenda}.placeDecisionDeposit`, [referendumIndex]);3306 }33073308 cancel(signer: TSigner, referendumIndex: number) {3309 return this.helper.executeExtrinsic(signer, `api.tx.${this.referenda}.cancel`, [referendumIndex]);3310 }33113312 cancelCall(referendumIndex: number) {3313 return this.helper.constructApiCall(`api.tx.${this.referenda}.cancel`, [referendumIndex]);3314 }33153316 async referendumInfo(referendumIndex: number) {3317 return (await this.helper.callRpc(`api.query.${this.referenda}.referendumInfoFor`, [referendumIndex])).toJSON();3318 }33193320 async enactmentEventId(referendumIndex: number) {3321 const api = await this.helper.getApi();33223323 const bytes = api.createType('([u8;8], Text, u32)', ['assembly', 'enactment', referendumIndex]).toU8a();3324 return blake2AsHex(bytes, 256);3325 }3326}33273328export interface IFellowshipGroup {3329 collective: RankedCollectiveGroup;3330 referenda: ReferendaGroup;3331}33323333export interface ICollectiveGroup {3334 collective: CollectiveGroup;3335 membership: CollectiveMembershipGroup;3336}33373338class DemocracyGroup extends HelperGroup<UniqueHelper> {3339 // todo displace proposal into types?3340 propose(signer: TSigner, call: any, deposit: bigint) {3341 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.propose', [{Inline: call.method.toHex()}, deposit]);3342 }33433344 proposeWithPreimage(signer: TSigner, preimage: string, deposit: bigint) {3345 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.propose', [{Legacy: preimage}, deposit]);3346 }33473348 proposeCall(call: any, deposit: bigint) {3349 return this.helper.constructApiCall('api.tx.democracy.propose', [{Inline: call.method.toHex()}, deposit]);3350 }33513352 second(signer: TSigner, proposalIndex: number) {3353 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.second', [proposalIndex]);3354 }33553356 externalPropose(signer: TSigner, proposalCall: any) {3357 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalPropose', [{Inline: proposalCall.method.toHex()}]);3358 }33593360 externalProposeMajority(signer: TSigner, proposalCall: any) {3361 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalProposeMajority', [{Inline: proposalCall.method.toHex()}]);3362 }33633364 externalProposeDefault(signer: TSigner, proposalCall: any) {3365 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalProposeDefault', [{Inline: proposalCall.method.toHex()}]);3366 }33673368 externalProposeDefaultWithPreimage(signer: TSigner, preimage: string) {3369 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.externalProposeDefault', [{Legacy: preimage}]);3370 }33713372 externalProposeCall(proposalCall: any) {3373 return this.helper.constructApiCall('api.tx.democracy.externalPropose', [{Inline: proposalCall.method.toHex()}]);3374 }33753376 externalProposeMajorityCall(proposalCall: any) {3377 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [{Inline: proposalCall.method.toHex()}]);3378 }33793380 externalProposeDefaultCall(proposalCall: any) {3381 return this.helper.constructApiCall('api.tx.democracy.externalProposeDefault', [{Inline: proposalCall.method.toHex()}]);3382 }33833384 // ... and blacklist external proposal hash.3385 vetoExternal(signer: TSigner, proposalHash: string) {3386 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.vetoExternal', [proposalHash]);3387 }33883389 vetoExternalCall(proposalHash: string) {3390 return this.helper.constructApiCall('api.tx.democracy.vetoExternal', [proposalHash]);3391 }33923393 blacklist(signer: TSigner, proposalHash: string, referendumIndex: number | null = null) {3394 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.blacklist', [proposalHash, referendumIndex]);3395 }33963397 blacklistCall(proposalHash: string, referendumIndex: number | null = null) {3398 return this.helper.constructApiCall('api.tx.democracy.blacklist', [proposalHash, referendumIndex]);3399 }34003401 // proposal. CancelProposalOrigin (root or all techcom)3402 cancelProposal(signer: TSigner, proposalIndex: number) {3403 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.cancelProposal', [proposalIndex]);3404 }34053406 cancelProposalCall(proposalIndex: number) {3407 return this.helper.constructApiCall('api.tx.democracy.cancelProposal', [proposalIndex]);3408 }34093410 clearPublicProposals(signer: TSigner) {3411 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.clearPublicProposals', []);3412 }34133414 fastTrack(signer: TSigner, proposalHash: string, votingPeriod: number, delayPeriod: number) {3415 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);3416 }34173418 fastTrackCall(proposalHash: string, votingPeriod: number, delayPeriod: number) {3419 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);3420 }34213422 // referendum. CancellationOrigin (TechCom member)3423 emergencyCancel(signer: TSigner, referendumIndex: number) {3424 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.emergencyCancel', [referendumIndex]);3425 }34263427 emergencyCancelCall(referendumIndex: number) {3428 return this.helper.constructApiCall('api.tx.democracy.emergencyCancel', [referendumIndex]);3429 }34303431 vote(signer: TSigner, referendumIndex: number, vote: any) {3432 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, vote]);3433 }34343435 removeVote(signer: TSigner, referendumIndex: number, targetAccount?: string) {3436 if(targetAccount) {3437 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.removeOtherVote', [targetAccount, referendumIndex]);3438 } else {3439 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.removeVote', [referendumIndex]);3440 }3441 }34423443 unlock(signer: TSigner, targetAccount: string) {3444 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.unlock', [targetAccount]);3445 }34463447 delegate(signer: TSigner, toAccount: string, conviction: PalletDemocracyConviction, balance: bigint) {3448 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.delegate', [toAccount, conviction, balance]);3449 }34503451 undelegate(signer: TSigner) {3452 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.undelegate', []);3453 }34543455 async referendumInfo(referendumIndex: number) {3456 return (await this.helper.callRpc('api.query.democracy.referendumInfoOf', [referendumIndex])).toJSON();3457 }34583459 async publicProposals() {3460 return (await this.helper.callRpc('api.query.democracy.publicProps', [])).toJSON();3461 }34623463 async findPublicProposal(proposalIndex: number) {3464 const proposalInfo = (await this.publicProposals()).find((proposalInfo: any[]) => proposalInfo[0] == proposalIndex);34653466 return proposalInfo ? proposalInfo[1] : null;3467 }34683469 async expectPublicProposal(proposalIndex: number) {3470 const proposal = await this.findPublicProposal(proposalIndex);34713472 if(proposal) {3473 return proposal;3474 } else {3475 throw Error(`Proposal #${proposalIndex} is expected to exist`);3476 }3477 }34783479 async getExternalProposal() {3480 return (await this.helper.callRpc('api.query.democracy.nextExternal', []));3481 }34823483 async expectExternalProposal() {3484 const proposal = await this.getExternalProposal();34853486 if(proposal) {3487 return proposal;3488 } else {3489 throw Error('An external proposal is expected to exist');3490 }3491 }34923493 /* setMetadata? */34943495 /* todo?3496 referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {3497 return this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);3498 }*/3499}35003501class PreimageGroup extends HelperGroup<UniqueHelper> {3502 async getPreimageInfo(h256: string) {3503 return (await this.helper.callRpc('api.query.preimage.statusFor', [h256])).toJSON();3504 }35053506 /**3507 * Create a preimage from an API call.3508 * @param signer keyring of the signer.3509 * @param call an extrinsic call3510 * @example await notePreimageFromCall(preimageMaker,3511 * helper.constructApiCall('api.tx.identity.forceInsertIdentities', [identitiesToAdd])3512 * );3513 * @returns promise of extrinsic execution.3514 */3515 notePreimageFromCall(signer: TSigner, call: any, returnPreimageHash = false) {3516 return this.notePreimage(signer, call.method.toHex(), returnPreimageHash);3517 }35183519 /**3520 * Create a preimage with a hex or a byte array.3521 * @param signer keyring of the signer.3522 * @param bytes preimage encoded in hex or a byte array, e.g. an extrinsic call.3523 * @example await notePreimage(preimageMaker,3524 * helper.constructApiCall('api.tx.identity.forceInsertIdentities', [identitiesToAdd]).method.toHex()3525 * );3526 * @returns promise of extrinsic execution.3527 */3528 async notePreimage(signer: TSigner, bytes: string | Uint8Array, returnPreimageHash = false) {3529 const promise = this.helper.executeExtrinsic(signer, 'api.tx.preimage.notePreimage', [bytes]);3530 if(returnPreimageHash) {3531 const result = await promise;3532 const events = result.result.events.filter(x => x.event.method === 'Noted' && x.event.section === 'preimage');3533 const preimageHash = events[0].event.data[0].toHuman();3534 return preimageHash;3535 }3536 return promise;3537 }35383539 /**3540 * Delete an existing preimage and return the deposit.3541 * @param signer keyring of the signer - either the owner or the preimage manager (sudo).3542 * @param h256 hash of the preimage.3543 * @returns promise of extrinsic execution.3544 */3545 unnotePreimage(signer: TSigner, h256: string) {3546 return this.helper.executeExtrinsic(signer, 'api.tx.preimage.unnotePreimage', [h256]);3547 }35483549 /**3550 * Request a preimage be uploaded to the chain without paying any fees or deposits.3551 * @param signer keyring of the signer - either the owner or the preimage manager (sudo).3552 * @param h256 hash of the preimage.3553 * @returns promise of extrinsic execution.3554 */3555 requestPreimage(signer: TSigner, h256: string) {3556 return this.helper.executeExtrinsic(signer, 'api.tx.preimage.requestPreimage', [h256]);3557 }35583559 /**3560 * Clear a previously made request for a preimage.3561 * @param signer keyring of the signer - either the owner or the preimage manager (sudo).3562 * @param h256 hash of the preimage.3563 * @returns promise of extrinsic execution.3564 */3565 unrequestPreimage(signer: TSigner, h256: string) {3566 return this.helper.executeExtrinsic(signer, 'api.tx.preimage.unrequestPreimage', [h256]);3567 }3568}35693570class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {3571 async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {3572 await this.helper.executeExtrinsic(3573 signer,3574 'api.tx.foreignAssets.registerForeignAsset',3575 [ownerAddress, location, metadata],3576 true,3577 );3578 }35793580 async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {3581 await this.helper.executeExtrinsic(3582 signer,3583 'api.tx.foreignAssets.updateForeignAsset',3584 [foreignAssetId, location, metadata],3585 true,3586 );3587 }3588}35893590class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {3591 palletName: string;35923593 constructor(helper: T, palletName: string) {3594 super(helper);35953596 this.palletName = palletName;3597 }35983599 async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: any) {3600 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, weightLimit], true);3601 }36023603 async setSafeXcmVersion(signer: TSigner, version: number) {3604 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.forceDefaultXcmVersion`, [version], true);3605 }36063607 async teleportAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number) {3608 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.teleportAssets`, [destination, beneficiary, assets, feeAssetItem], true);3609 }36103611 async teleportNativeAsset(signer: TSigner, destinationParaId: number, targetAccount: Uint8Array, amount: bigint, xcmVersion = 3) {3612 const destinationContent = {3613 parents: 0,3614 interior: {3615 X1: {3616 Parachain: destinationParaId,3617 },3618 },3619 };36203621 const beneficiaryContent = {3622 parents: 0,3623 interior: {3624 X1: {3625 AccountId32: {3626 network: 'Any',3627 id: targetAccount,3628 },3629 },3630 },3631 };36323633 const assetsContent = [3634 {3635 id: {3636 Concrete: {3637 parents: 0,3638 interior: 'Here',3639 },3640 },3641 fun: {3642 Fungible: amount,3643 },3644 },3645 ];36463647 let destination;3648 let beneficiary;3649 let assets;36503651 if(xcmVersion == 2) {3652 destination = {V1: destinationContent};3653 beneficiary = {V1: beneficiaryContent};3654 assets = {V1: assetsContent};36553656 } else if(xcmVersion == 3) {3657 destination = {V2: destinationContent};3658 beneficiary = {V2: beneficiaryContent};3659 assets = {V2: assetsContent};36603661 } else {3662 throw Error('Unknown XCM version: ' + xcmVersion);3663 }36643665 const feeAssetItem = 0;36663667 await this.teleportAssets(signer, destination, beneficiary, assets, feeAssetItem);3668 }36693670 async send(signer: IKeyringPair, destination: any, message: any) {3671 await this.helper.executeExtrinsic(3672 signer,3673 `api.tx.${this.palletName}.send`,3674 [3675 destination,3676 message,3677 ],3678 true,3679 );3680 }3681}36823683class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {3684 async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: any) {3685 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);3686 }36873688 async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: any) {3689 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);3690 }36913692 async transferMulticurrencies(signer: TSigner, currencies: any[], feeItem: number, destLocation: any, destWeight: any) {3693 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMulticurrencies', [currencies, feeItem, destLocation, destWeight], true);3694 }3695}36963697class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {3698 async accounts(address: string, currencyId: any) {3699 const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;3700 return BigInt(free);3701 }3702}37033704class AssetsGroup<T extends ChainHelperBase> extends HelperGroup<T> {3705 async create(signer: TSigner, assetId: number, admin: string, minimalBalance: bigint) {3706 await this.helper.executeExtrinsic(signer, 'api.tx.assets.create', [assetId, admin, minimalBalance], true);3707 }37083709 async setMetadata(signer: TSigner, assetId: number, name: string, symbol: string, decimals: number) {3710 await this.helper.executeExtrinsic(signer, 'api.tx.assets.setMetadata', [assetId, name, symbol, decimals], true);3711 }37123713 async mint(signer: TSigner, assetId: number, beneficiary: string, amount: bigint) {3714 await this.helper.executeExtrinsic(signer, 'api.tx.assets.mint', [assetId, beneficiary, amount], true);3715 }37163717 async account(assetId: string | number, address: string) {3718 const accountAsset = (3719 await this.helper.callRpc('api.query.assets.account', [assetId, address])3720 ).toJSON()! as any;37213722 if(accountAsset !== null) {3723 return BigInt(accountAsset['balance']);3724 } else {3725 return null;3726 }3727 }3728}37293730class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {3731 async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {3732 await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);3733 }3734}37353736class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {3737 makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {3738 const apiPrefix = 'api.tx.assetManager.';37393740 const registerTx = this.helper.constructApiCall(3741 apiPrefix + 'registerForeignAsset',3742 [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],3743 );37443745 const setUnitsTx = this.helper.constructApiCall(3746 apiPrefix + 'setAssetUnitsPerSecond',3747 [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],3748 );37493750 const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);3751 const encodedProposal = batchCall?.method.toHex() || '';3752 return encodedProposal;3753 }37543755 async assetTypeId(location: any) {3756 return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);3757 }3758}37593760class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {3761 notePreimagePallet: string;37623763 constructor(helper: MoonbeamHelper, options: { [key: string]: any } = {}) {3764 super(helper);3765 this.notePreimagePallet = options.notePreimagePallet;3766 }37673768 async notePreimage(signer: TSigner, encodedProposal: string) {3769 await this.helper.executeExtrinsic(signer, `api.tx.${this.notePreimagePallet}.notePreimage`, [encodedProposal], true);3770 }37713772 externalProposeMajority(proposal: any) {3773 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposal]);3774 }37753776 fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {3777 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);3778 }37793780 async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {3781 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);3782 }3783}37843785class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {3786 collective: string;37873788 constructor(helper: MoonbeamHelper, collective: string) {3789 super(helper);37903791 this.collective = collective;3792 }37933794 async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {3795 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);3796 }37973798 async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {3799 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);3800 }38013802 async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: any, lengthBound: number) {3803 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);3804 }38053806 async proposalCount() {3807 return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));3808 }3809}38103811export type ChainHelperBaseConstructor = new (...args: any[]) => ChainHelperBase;3812export type UniqueHelperConstructor = new (...args: any[]) => UniqueHelper;38133814export class UniqueHelper extends ChainHelperBase {3815 balance: BalanceGroup<UniqueHelper>;3816 collection: CollectionGroup;3817 nft: NFTGroup;3818 rft: RFTGroup;3819 ft: FTGroup;3820 staking: StakingGroup;3821 scheduler: SchedulerGroup;3822 collatorSelection: CollatorSelectionGroup;3823 council: ICollectiveGroup;3824 technicalCommittee: ICollectiveGroup;3825 fellowship: IFellowshipGroup;3826 democracy: DemocracyGroup;3827 preimage: PreimageGroup;3828 foreignAssets: ForeignAssetsGroup;3829 xcm: XcmGroup<UniqueHelper>;3830 xTokens: XTokensGroup<UniqueHelper>;3831 tokens: TokensGroup<UniqueHelper>;38323833 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3834 super(logger, options.helperBase ?? UniqueHelper);38353836 this.balance = new BalanceGroup(this);3837 this.collection = new CollectionGroup(this);3838 this.nft = new NFTGroup(this);3839 this.rft = new RFTGroup(this);3840 this.ft = new FTGroup(this);3841 this.staking = new StakingGroup(this);3842 this.scheduler = new SchedulerGroup(this);3843 this.collatorSelection = new CollatorSelectionGroup(this);3844 this.council = {3845 collective: new CollectiveGroup(this, 'council'),3846 membership: new CollectiveMembershipGroup(this, 'councilMembership'),3847 };3848 this.technicalCommittee = {3849 collective: new CollectiveGroup(this, 'technicalCommittee'),3850 membership: new CollectiveMembershipGroup(this, 'technicalCommitteeMembership'),3851 };3852 this.fellowship = {3853 collective: new RankedCollectiveGroup(this, 'fellowshipCollective'),3854 referenda: new ReferendaGroup(this, 'fellowshipReferenda'),3855 };3856 this.democracy = new DemocracyGroup(this);3857 this.preimage = new PreimageGroup(this);3858 this.foreignAssets = new ForeignAssetsGroup(this);3859 this.xcm = new XcmGroup(this, 'polkadotXcm');3860 this.xTokens = new XTokensGroup(this);3861 this.tokens = new TokensGroup(this);3862 }38633864 getSudo<T extends UniqueHelper>() {3865 // eslint-disable-next-line @typescript-eslint/naming-convention3866 const SudoHelperType = SudoHelper(this.helperBase);3867 return this.clone(SudoHelperType) as T;3868 }3869}38703871export class XcmChainHelper extends ChainHelperBase {3872 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {3873 const wsProvider = new WsProvider(wsEndpoint);3874 this.api = new ApiPromise({3875 provider: wsProvider,3876 });3877 await this.api.isReadyOrError;3878 this.network = await UniqueHelper.detectNetwork(this.api);3879 }3880}38813882export class RelayHelper extends XcmChainHelper {3883 balance: SubstrateBalanceGroup<RelayHelper>;3884 xcm: XcmGroup<RelayHelper>;38853886 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3887 super(logger, options.helperBase ?? RelayHelper);38883889 this.balance = new SubstrateBalanceGroup(this);3890 this.xcm = new XcmGroup(this, 'xcmPallet');3891 }3892}38933894export class WestmintHelper extends XcmChainHelper {3895 balance: SubstrateBalanceGroup<WestmintHelper>;3896 xcm: XcmGroup<WestmintHelper>;3897 assets: AssetsGroup<WestmintHelper>;3898 xTokens: XTokensGroup<WestmintHelper>;38993900 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3901 super(logger, options.helperBase ?? WestmintHelper);39023903 this.balance = new SubstrateBalanceGroup(this);3904 this.xcm = new XcmGroup(this, 'polkadotXcm');3905 this.assets = new AssetsGroup(this);3906 this.xTokens = new XTokensGroup(this);3907 }3908}39093910export class MoonbeamHelper extends XcmChainHelper {3911 balance: EthereumBalanceGroup<MoonbeamHelper>;3912 assetManager: MoonbeamAssetManagerGroup;3913 assets: AssetsGroup<MoonbeamHelper>;3914 xTokens: XTokensGroup<MoonbeamHelper>;3915 democracy: MoonbeamDemocracyGroup;3916 collective: {3917 council: MoonbeamCollectiveGroup,3918 techCommittee: MoonbeamCollectiveGroup,3919 };39203921 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3922 super(logger, options.helperBase ?? MoonbeamHelper);39233924 this.balance = new EthereumBalanceGroup(this);3925 this.assetManager = new MoonbeamAssetManagerGroup(this);3926 this.assets = new AssetsGroup(this);3927 this.xTokens = new XTokensGroup(this);3928 this.democracy = new MoonbeamDemocracyGroup(this, options);3929 this.collective = {3930 council: new MoonbeamCollectiveGroup(this, 'councilCollective'),3931 techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),3932 };3933 }3934}39353936export class AstarHelper extends XcmChainHelper {3937 balance: SubstrateBalanceGroup<AstarHelper>;3938 assets: AssetsGroup<AstarHelper>;3939 xcm: XcmGroup<AstarHelper>;39403941 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3942 super(logger, options.helperBase ?? AstarHelper);39433944 this.balance = new SubstrateBalanceGroup(this);3945 this.assets = new AssetsGroup(this);3946 this.xcm = new XcmGroup(this, 'polkadotXcm');3947 }39483949 getSudo<T extends UniqueHelper>() {3950 // eslint-disable-next-line @typescript-eslint/naming-convention3951 const SudoHelperType = SudoHelper(this.helperBase);3952 return this.clone(SudoHelperType) as T;3953 }3954}39553956export class AcalaHelper extends XcmChainHelper {3957 balance: SubstrateBalanceGroup<AcalaHelper>;3958 assetRegistry: AcalaAssetRegistryGroup;3959 xTokens: XTokensGroup<AcalaHelper>;3960 tokens: TokensGroup<AcalaHelper>;3961 xcm: XcmGroup<AcalaHelper>;39623963 constructor(logger?: ILogger, options: { [key: string]: any } = {}) {3964 super(logger, options.helperBase ?? AcalaHelper);39653966 this.balance = new SubstrateBalanceGroup(this);3967 this.assetRegistry = new AcalaAssetRegistryGroup(this);3968 this.xTokens = new XTokensGroup(this);3969 this.tokens = new TokensGroup(this);3970 this.xcm = new XcmGroup(this, 'polkadotXcm');3971 }39723973 getSudo<T extends AcalaHelper>() {3974 // eslint-disable-next-line @typescript-eslint/naming-convention3975 const SudoHelperType = SudoHelper(this.helperBase);3976 return this.clone(SudoHelperType) as T;3977 }3978}39793980// eslint-disable-next-line @typescript-eslint/naming-convention3981function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {3982 return class extends Base {3983 scheduleFn: 'schedule' | 'scheduleAfter';3984 blocksNum: number;3985 options: ISchedulerOptions;39863987 constructor(...args: any[]) {3988 const logger = args[0] as ILogger;3989 const options = args[1] as {3990 scheduleFn: 'schedule' | 'scheduleAfter',3991 blocksNum: number,3992 options: ISchedulerOptions3993 };39943995 super(logger);39963997 this.scheduleFn = options.scheduleFn;3998 this.blocksNum = options.blocksNum;3999 this.options = options.options;4000 }40014002 executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {4003 const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);40044005 const mandatorySchedArgs = [4006 this.blocksNum,4007 this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,4008 this.options.priority ?? null,4009 scheduledTx,4010 ];40114012 let schedArgs;4013 let scheduleFn;40144015 if(this.options.scheduledId) {4016 schedArgs = [this.options.scheduledId!, ...mandatorySchedArgs];40174018 if(this.scheduleFn == 'schedule') {4019 scheduleFn = 'scheduleNamed';4020 } else if(this.scheduleFn == 'scheduleAfter') {4021 scheduleFn = 'scheduleNamedAfter';4022 }4023 } else {4024 schedArgs = mandatorySchedArgs;4025 scheduleFn = this.scheduleFn;4026 }40274028 const extrinsic = 'api.tx.scheduler.' + scheduleFn;40294030 return super.executeExtrinsic(4031 sender,4032 extrinsic as any,4033 schedArgs,4034 expectSuccess,4035 );4036 }4037 };4038}40394040// eslint-disable-next-line @typescript-eslint/naming-convention4041function SudoHelper<T extends ChainHelperBaseConstructor>(Base: T) {4042 return class extends Base {4043 constructor(...args: any[]) {4044 super(...args);4045 }40464047 async executeExtrinsic(4048 sender: IKeyringPair,4049 extrinsic: string,4050 params: any[],4051 expectSuccess?: boolean,4052 options: Partial<SignerOptions> | null = null,4053 ): Promise<ITransactionResult> {4054 const call = this.constructApiCall(extrinsic, params);4055 const result = await super.executeExtrinsic(4056 sender,4057 'api.tx.sudo.sudo',4058 [call],4059 expectSuccess,4060 options,4061 );40624063 if(result.status === 'Fail') return result;40644065 const data = (result.result.events.find(x => x.event.section == 'sudo' && x.event.method == 'Sudid')?.event.data as any).sudoResult;4066 if(data.isErr) {4067 if(data.asErr.isModule) {4068 const error = (result.result.events[1].event.data as any).sudoResult.asErr.asModule;4069 const metaError = super.getApi()?.registry.findMetaError(error);4070 throw new Error(`${metaError.section}.${metaError.name}`);4071 } else if(data.asErr.isToken) {4072 throw new Error(`Token: ${data.asErr.asToken}`);4073 }4074 // May be [object Object] in case of unhandled non-unit enum4075 throw new Error(`Misc: ${data.asErr.toHuman()}`);4076 }4077 return result;4078 }4079 async executeExtrinsicUncheckedWeight(4080 sender: IKeyringPair,4081 extrinsic: string,4082 params: any[],4083 expectSuccess?: boolean,4084 options: Partial<SignerOptions> | null = null,4085 ): Promise<ITransactionResult> {4086 const call = this.constructApiCall(extrinsic, params);4087 const result = await super.executeExtrinsic(4088 sender,4089 'api.tx.sudo.sudoUncheckedWeight',4090 [call, {refTime: 0, proofSize: 0}],4091 expectSuccess,4092 options,4093 );40944095 if(result.status === 'Fail') return result;40964097 const data = (result.result.events.find(x => x.event.section == 'sudo' && x.event.method == 'Sudid')?.event.data as any).sudoResult;4098 if(data.isErr) {4099 if(data.asErr.isModule) {4100 const error = (result.result.events[1].event.data as any).sudoResult.asErr.asModule;4101 const metaError = super.getApi()?.registry.findMetaError(error);4102 throw new Error(`${metaError.section}.${metaError.name}`);4103 } else if(data.asErr.isToken) {4104 throw new Error(`Token: ${data.asErr.asToken}`);4105 }4106 // May be [object Object] in case of unhandled non-unit enum4107 throw new Error(`Misc: ${data.asErr.toHuman()}`);4108 }4109 return result;4110 }4111 };4112}41134114export class UniqueBaseCollection {4115 helper: UniqueHelper;4116 collectionId: number;41174118 constructor(collectionId: number, uniqueHelper: UniqueHelper) {4119 this.collectionId = collectionId;4120 this.helper = uniqueHelper;4121 }41224123 async getData() {4124 return await this.helper.collection.getData(this.collectionId);4125 }41264127 async getLastTokenId() {4128 return await this.helper.collection.getLastTokenId(this.collectionId);4129 }41304131 async doesTokenExist(tokenId: number) {4132 return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);4133 }41344135 async getAdmins() {4136 return await this.helper.collection.getAdmins(this.collectionId);4137 }41384139 async getAllowList() {4140 return await this.helper.collection.getAllowList(this.collectionId);4141 }41424143 async getEffectiveLimits() {4144 return await this.helper.collection.getEffectiveLimits(this.collectionId);4145 }41464147 async getProperties(propertyKeys?: string[] | null) {4148 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);4149 }41504151 async getPropertiesConsumedSpace() {4152 return await this.helper.collection.getPropertiesConsumedSpace(this.collectionId);4153 }41544155 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {4156 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);4157 }41584159 async getOptions() {4160 return await this.helper.collection.getCollectionOptions(this.collectionId);4161 }41624163 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {4164 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);4165 }41664167 async confirmSponsorship(signer: TSigner) {4168 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);4169 }41704171 async removeSponsor(signer: TSigner) {4172 return await this.helper.collection.removeSponsor(signer, this.collectionId);4173 }41744175 async setLimits(signer: TSigner, limits: ICollectionLimits) {4176 return await this.helper.collection.setLimits(signer, this.collectionId, limits);4177 }41784179 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {4180 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);4181 }41824183 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {4184 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);4185 }41864187 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {4188 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);4189 }41904191 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {4192 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);4193 }41944195 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {4196 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);4197 }41984199 async setProperties(signer: TSigner, properties: IProperty[]) {4200 return await this.helper.collection.setProperties(signer, this.collectionId, properties);4201 }42024203 async deleteProperties(signer: TSigner, propertyKeys: string[]) {4204 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);4205 }42064207 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {4208 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);4209 }42104211 async enableNesting(signer: TSigner, permissions: INestingPermissions) {4212 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);4213 }42144215 async disableNesting(signer: TSigner) {4216 return await this.helper.collection.disableNesting(signer, this.collectionId);4217 }42184219 async burn(signer: TSigner) {4220 return await this.helper.collection.burn(signer, this.collectionId);4221 }42224223 scheduleAt<T extends UniqueHelper>(4224 executionBlockNumber: number,4225 options: ISchedulerOptions = {},4226 ) {4227 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4228 return new UniqueBaseCollection(this.collectionId, scheduledHelper);4229 }42304231 scheduleAfter<T extends UniqueHelper>(4232 blocksBeforeExecution: number,4233 options: ISchedulerOptions = {},4234 ) {4235 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4236 return new UniqueBaseCollection(this.collectionId, scheduledHelper);4237 }42384239 getSudo<T extends UniqueHelper>() {4240 return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());4241 }4242}424342444245export class UniqueNFTCollection extends UniqueBaseCollection {4246 getTokenObject(tokenId: number) {4247 return new UniqueNFToken(tokenId, this);4248 }42494250 async getTokensByAddress(addressObj: ICrossAccountId) {4251 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);4252 }42534254 async getToken(tokenId: number, blockHashAt?: string) {4255 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);4256 }42574258 async getTokenOwner(tokenId: number, blockHashAt?: string) {4259 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);4260 }42614262 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {4263 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);4264 }42654266 async getTokenChildren(tokenId: number, blockHashAt?: string) {4267 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);4268 }42694270 async getPropertyPermissions(propertyKeys: string[] | null = null) {4271 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);4272 }42734274 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {4275 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);4276 }42774278 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {4279 const api = this.helper.getApi();4280 const props = (await api.query.nonfungible.tokenProperties(this.collectionId, tokenId)).toJSON();42814282 return (props! as any).consumedSpace;4283 }42844285 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {4286 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);4287 }42884289 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4290 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);4291 }42924293 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {4294 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);4295 }42964297 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {4298 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);4299 }43004301 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {4302 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});4303 }43044305 async mintMultipleTokens(signer: TSigner, tokens: { owner: ICrossAccountId, properties?: IProperty[] }[]) {4306 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);4307 }43084309 async burnToken(signer: TSigner, tokenId: number) {4310 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);4311 }43124313 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {4314 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);4315 }43164317 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {4318 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);4319 }43204321 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {4322 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);4323 }43244325 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {4326 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);4327 }43284329 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {4330 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);4331 }43324333 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4334 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);4335 }43364337 scheduleAt<T extends UniqueHelper>(4338 executionBlockNumber: number,4339 options: ISchedulerOptions = {},4340 ) {4341 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4342 return new UniqueNFTCollection(this.collectionId, scheduledHelper);4343 }43444345 scheduleAfter<T extends UniqueHelper>(4346 blocksBeforeExecution: number,4347 options: ISchedulerOptions = {},4348 ) {4349 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4350 return new UniqueNFTCollection(this.collectionId, scheduledHelper);4351 }43524353 getSudo<T extends UniqueHelper>() {4354 return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());4355 }4356}435743584359export class UniqueRFTCollection extends UniqueBaseCollection {4360 getTokenObject(tokenId: number) {4361 return new UniqueRFToken(tokenId, this);4362 }43634364 async getToken(tokenId: number, blockHashAt?: string) {4365 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);4366 }43674368 async getTokenOwner(tokenId: number, blockHashAt?: string) {4369 return await this.helper.rft.getTokenOwner(this.collectionId, tokenId, blockHashAt);4370 }43714372 async getTokensByAddress(addressObj: ICrossAccountId) {4373 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);4374 }43754376 async getTop10TokenOwners(tokenId: number) {4377 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);4378 }43794380 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {4381 return await this.helper.rft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);4382 }43834384 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {4385 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);4386 }43874388 async getTokenTotalPieces(tokenId: number) {4389 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);4390 }43914392 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4393 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);4394 }43954396 async getPropertyPermissions(propertyKeys: string[] | null = null) {4397 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);4398 }43994400 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {4401 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);4402 }44034404 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {4405 const api = this.helper.getApi();4406 const props = (await api.query.refungible.tokenProperties(this.collectionId, tokenId)).toJSON();44074408 return (props! as any).consumedSpace;4409 }44104411 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount = 1n) {4412 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);4413 }44144415 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {4416 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);4417 }44184419 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount = 1n) {4420 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);4421 }44224423 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {4424 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);4425 }44264427 async mintToken(signer: TSigner, pieces = 1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {4428 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});4429 }44304431 async mintMultipleTokens(signer: TSigner, tokens: { pieces: bigint, owner: ICrossAccountId, properties?: IProperty[] }[]) {4432 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);4433 }44344435 async burnToken(signer: TSigner, tokenId: number, amount = 1n) {4436 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);4437 }44384439 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount = 1n) {4440 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);4441 }44424443 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {4444 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);4445 }44464447 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {4448 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);4449 }44504451 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {4452 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);4453 }44544455 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {4456 return await this.helper.rft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);4457 }44584459 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4460 return await this.helper.rft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);4461 }44624463 scheduleAt<T extends UniqueHelper>(4464 executionBlockNumber: number,4465 options: ISchedulerOptions = {},4466 ) {4467 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4468 return new UniqueRFTCollection(this.collectionId, scheduledHelper);4469 }44704471 scheduleAfter<T extends UniqueHelper>(4472 blocksBeforeExecution: number,4473 options: ISchedulerOptions = {},4474 ) {4475 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4476 return new UniqueRFTCollection(this.collectionId, scheduledHelper);4477 }44784479 getSudo<T extends UniqueHelper>() {4480 return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());4481 }4482}448344844485export class UniqueFTCollection extends UniqueBaseCollection {4486 async getBalance(addressObj: ICrossAccountId) {4487 return await this.helper.ft.getBalance(this.collectionId, addressObj);4488 }44894490 async getTotalPieces() {4491 return await this.helper.ft.getTotalPieces(this.collectionId);4492 }44934494 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4495 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);4496 }44974498 async getTop10Owners() {4499 return await this.helper.ft.getTop10Owners(this.collectionId);4500 }45014502 async mint(signer: TSigner, amount = 1n, owner: ICrossAccountId = {Substrate: signer.address}) {4503 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);4504 }45054506 async mintWithOneOwner(signer: TSigner, tokens: { value: bigint }[], owner: ICrossAccountId = {Substrate: signer.address}) {4507 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);4508 }45094510 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount = 1n) {4511 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);4512 }45134514 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {4515 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);4516 }45174518 async burnTokens(signer: TSigner, amount = 1n) {4519 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);4520 }45214522 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount = 1n) {4523 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);4524 }45254526 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount = 1n) {4527 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);4528 }45294530 scheduleAt<T extends UniqueHelper>(4531 executionBlockNumber: number,4532 options: ISchedulerOptions = {},4533 ) {4534 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);4535 return new UniqueFTCollection(this.collectionId, scheduledHelper);4536 }45374538 scheduleAfter<T extends UniqueHelper>(4539 blocksBeforeExecution: number,4540 options: ISchedulerOptions = {},4541 ) {4542 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);4543 return new UniqueFTCollection(this.collectionId, scheduledHelper);4544 }45454546 getSudo<T extends UniqueHelper>() {4547 return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());4548 }4549}455045514552export class UniqueBaseToken {4553 collection: UniqueNFTCollection | UniqueRFTCollection;4554 collectionId: number;4555 tokenId: number;45564557 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {4558 this.collection = collection;4559 this.collectionId = collection.collectionId;4560 this.tokenId = tokenId;4561 }45624563 async getNextSponsored(addressObj: ICrossAccountId) {4564 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);4565 }45664567 async getProperties(propertyKeys?: string[] | null) {4568 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);4569 }45704571 async getTokenPropertiesConsumedSpace() {4572 return await this.collection.getTokenPropertiesConsumedSpace(this.tokenId);4573 }45744575 async setProperties(signer: TSigner, properties: IProperty[]) {4576 return await this.collection.setTokenProperties(signer, this.tokenId, properties);4577 }45784579 async deleteProperties(signer: TSigner, propertyKeys: string[]) {4580 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);4581 }45824583 async doesExist() {4584 return await this.collection.doesTokenExist(this.tokenId);4585 }45864587 nestingAccount() {4588 return this.collection.helper.util.getTokenAccount(this);4589 }45904591 scheduleAt<T extends UniqueHelper>(4592 executionBlockNumber: number,4593 options: ISchedulerOptions = {},4594 ) {4595 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);4596 return new UniqueBaseToken(this.tokenId, scheduledCollection);4597 }45984599 scheduleAfter<T extends UniqueHelper>(4600 blocksBeforeExecution: number,4601 options: ISchedulerOptions = {},4602 ) {4603 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);4604 return new UniqueBaseToken(this.tokenId, scheduledCollection);4605 }46064607 getSudo<T extends UniqueHelper>() {4608 return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());4609 }4610}461146124613export class UniqueNFToken extends UniqueBaseToken {4614 collection: UniqueNFTCollection;46154616 constructor(tokenId: number, collection: UniqueNFTCollection) {4617 super(tokenId, collection);4618 this.collection = collection;4619 }46204621 async getData(blockHashAt?: string) {4622 return await this.collection.getToken(this.tokenId, blockHashAt);4623 }46244625 async getOwner(blockHashAt?: string) {4626 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);4627 }46284629 async getTopmostOwner(blockHashAt?: string) {4630 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);4631 }46324633 async getChildren(blockHashAt?: string) {4634 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);4635 }46364637 async nest(signer: TSigner, toTokenObj: IToken) {4638 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);4639 }46404641 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4642 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);4643 }46444645 async transfer(signer: TSigner, addressObj: ICrossAccountId) {4646 return await this.collection.transferToken(signer, this.tokenId, addressObj);4647 }46484649 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {4650 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);4651 }46524653 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {4654 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);4655 }46564657 async isApproved(toAddressObj: ICrossAccountId) {4658 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);4659 }46604661 async burn(signer: TSigner) {4662 return await this.collection.burnToken(signer, this.tokenId);4663 }46644665 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {4666 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);4667 }46684669 scheduleAt<T extends UniqueHelper>(4670 executionBlockNumber: number,4671 options: ISchedulerOptions = {},4672 ) {4673 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);4674 return new UniqueNFToken(this.tokenId, scheduledCollection);4675 }46764677 scheduleAfter<T extends UniqueHelper>(4678 blocksBeforeExecution: number,4679 options: ISchedulerOptions = {},4680 ) {4681 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);4682 return new UniqueNFToken(this.tokenId, scheduledCollection);4683 }46844685 getSudo<T extends UniqueHelper>() {4686 return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());4687 }4688}46894690export class UniqueRFToken extends UniqueBaseToken {4691 collection: UniqueRFTCollection;46924693 constructor(tokenId: number, collection: UniqueRFTCollection) {4694 super(tokenId, collection);4695 this.collection = collection;4696 }46974698 async getData(blockHashAt?: string) {4699 return await this.collection.getToken(this.tokenId, blockHashAt);4700 }47014702 async getOwner(blockHashAt?: string) {4703 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);4704 }47054706 async getTop10Owners() {4707 return await this.collection.getTop10TokenOwners(this.tokenId);4708 }47094710 async getTopmostOwner(blockHashAt?: string) {4711 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);4712 }47134714 async nest(signer: TSigner, toTokenObj: IToken) {4715 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);4716 }47174718 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {4719 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);4720 }47214722 async getBalance(addressObj: ICrossAccountId) {4723 return await this.collection.getTokenBalance(this.tokenId, addressObj);4724 }47254726 async getTotalPieces() {4727 return await this.collection.getTokenTotalPieces(this.tokenId);4728 }47294730 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {4731 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);4732 }47334734 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount = 1n) {4735 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);4736 }47374738 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount = 1n) {4739 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);4740 }47414742 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount = 1n) {4743 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);4744 }47454746 async repartition(signer: TSigner, amount: bigint) {4747 return await this.collection.repartitionToken(signer, this.tokenId, amount);4748 }47494750 async burn(signer: TSigner, amount = 1n) {4751 return await this.collection.burnToken(signer, this.tokenId, amount);4752 }47534754 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount = 1n) {4755 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);4756 }47574758 scheduleAt<T extends UniqueHelper>(4759 executionBlockNumber: number,4760 options: ISchedulerOptions = {},4761 ) {4762 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);4763 return new UniqueRFToken(this.tokenId, scheduledCollection);4764 }47654766 scheduleAfter<T extends UniqueHelper>(4767 blocksBeforeExecution: number,4768 options: ISchedulerOptions = {},4769 ) {4770 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);4771 return new UniqueRFToken(this.tokenId, scheduledCollection);4772 }47734774 getSudo<T extends UniqueHelper>() {4775 return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());4776 }4777}