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

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import '../interfaces/augment-api-rpc';18import '../interfaces/augment-api-query';19import {ApiPromise, Keyring} from '@polkadot/api';20import type {AccountId, EventRecord, Event, BlockNumber} from '@polkadot/types/interfaces';21import type {GenericEventData} from '@polkadot/types';22import {AnyTuple, IEvent, IKeyringPair} from '@polkadot/types/types';23import {evmToAddress} from '@polkadot/util-crypto';24import {AnyNumber} from '@polkadot/types-codec/types';25import BN from 'bn.js';26import chai from 'chai';27import chaiAsPromised from 'chai-as-promised';28import {default as usingApi, executeTransaction, submitTransactionAsync, submitTransactionExpectFailAsync} from '../substrate/substrate-api';29import {hexToStr, strToUTF16, utf16ToStr} from './util';30import {UpDataStructsRpcCollection, UpDataStructsCreateItemData, UpDataStructsProperty} from '@polkadot/types/lookup';31import {UpDataStructsTokenChild} from '../interfaces';32import {Context} from 'mocha';3334chai.use(chaiAsPromised);35const expect = chai.expect;3637export type CrossAccountId = {38  Substrate: string,39} | {40  Ethereum: string,41};424344export enum Pallets {45  Inflation = 'inflation',46  RmrkCore = 'rmrkcore',47  RmrkEquip = 'rmrkequip',48  ReFungible = 'refungible',49  Fungible = 'fungible',50  NFT = 'nonfungible',51  Scheduler = 'scheduler',52  AppPromotion = 'apppromotion',53}5455export async function isUnique(): Promise<boolean> {56  return usingApi(async api => {57    const chain = await api.rpc.system.chain();5859    return chain.eq('UNIQUE');60  });61}6263export async function isQuartz(): Promise<boolean> {64  return usingApi(async api => {65    const chain = await api.rpc.system.chain();6667    return chain.eq('QUARTZ');68  });69}7071let modulesNames: any;72export function getModuleNames(api: ApiPromise): string[] {73  if (typeof modulesNames === 'undefined')74    modulesNames = api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());75  return modulesNames;76}7778export async function missingRequiredPallets(requiredPallets: string[]): Promise<string[]> {79  return await usingApi(async api => {80    const pallets = getModuleNames(api);8182    return requiredPallets.filter(p => !pallets.includes(p));83  });84}8586export async function checkPalletsPresence(requiredPallets: string[]): Promise<boolean> {87  return (await missingRequiredPallets(requiredPallets)).length == 0;88}8990export async function requirePallets(mocha: Context, requiredPallets: string[]) {91  const missingPallets = await missingRequiredPallets(requiredPallets);9293  if (missingPallets.length > 0) {94    const skippingTestMsg = `\tSkipping test "${mocha.test?.title}".`;95    const missingPalletsMsg = `\tThe following pallets are missing:\n\t- ${missingPallets.join('\n\t- ')}`;96    const skipMsg = `${skippingTestMsg}\n${missingPalletsMsg}`;9798    console.error('\x1b[38:5:208m%s\x1b[0m', skipMsg);99100    mocha.skip();101  }102}103104export function bigIntToSub(api: ApiPromise, number: bigint) {105  return api.registry.createType('AccountId', '0x' + number.toString(16).padStart(64, '0')).toJSON();106}107108export function bigIntToDecimals(number: bigint, decimals = 18): string {109  const numberStr = number.toString();110  const dotPos = numberStr.length - decimals;111112  if (dotPos <= 0) {113    return '0.' + '0'.repeat(Math.abs(dotPos)) + numberStr;114  } else {115    const intPart = numberStr.substring(0, dotPos);116    const fractPart = numberStr.substring(dotPos);117    return intPart + '.' + fractPart;118  }119}120121export function normalizeAccountId(input: string | AccountId | CrossAccountId | IKeyringPair): CrossAccountId {122  if (typeof input === 'string') {123    if (input.length >= 47) {124      return {Substrate: input};125    } else if (input.length === 42 && input.startsWith('0x')) {126      return {Ethereum: input.toLowerCase()};127    } else if (input.length === 40 && !input.startsWith('0x')) {128      return {Ethereum: '0x' + input.toLowerCase()};129    } else {130      throw new Error(`Unknown address format: "${input}"`);131    }132  }133  if ('address' in input) {134    return {Substrate: input.address};135  }136  if ('Ethereum' in input) {137    return {138      Ethereum: input.Ethereum.toLowerCase(),139    };140  } else if ('ethereum' in input) {141    return {142      Ethereum: (input as any).ethereum.toLowerCase(),143    };144  } else if ('Substrate' in input) {145    return input;146  } else if ('substrate' in input) {147    return {148      Substrate: (input as any).substrate,149    };150  }151152  // AccountId153  return {Substrate: input.toString()};154}155export function toSubstrateAddress(input: string | CrossAccountId | IKeyringPair): string {156  input = normalizeAccountId(input);157  if ('Substrate' in input) {158    return input.Substrate;159  } else {160    return evmToAddress(input.Ethereum);161  }162}163164export const U128_MAX = (1n << 128n) - 1n;165166const MICROUNIQUE = 1_000_000_000_000n;167const MILLIUNIQUE = 1_000n * MICROUNIQUE;168const CENTIUNIQUE = 10n * MILLIUNIQUE;169export const UNIQUE = 100n * CENTIUNIQUE;170171interface GenericResult<T> {172  success: boolean;173  data: T | null;174}175176interface CreateCollectionResult {177  success: boolean;178  collectionId: number;179}180181interface CreateItemResult {182  success: boolean;183  collectionId: number;184  itemId: number;185  recipient?: CrossAccountId;186  amount?: number;187}188189interface DestroyItemResult {190  success: boolean;191  collectionId: number;192  itemId: number;193  owner: CrossAccountId;194  amount: number;195}196197interface TransferResult {198  collectionId: number;199  itemId: number;200  sender?: CrossAccountId;201  recipient?: CrossAccountId;202  value: bigint;203}204205interface IReFungibleOwner {206  fraction: BN;207  owner: number[];208}209210interface IGetMessage {211  checkMsgUnqMethod: string;212  checkMsgTrsMethod: string;213  checkMsgSysMethod: string;214}215216export interface IFungibleTokenDataType {217  value: number;218}219220export interface IChainLimits {221  collectionNumbersLimit: number;222  accountTokenOwnershipLimit: number;223  collectionsAdminsLimit: number;224  customDataLimit: number;225  nftSponsorTransferTimeout: number;226  fungibleSponsorTransferTimeout: number;227  refungibleSponsorTransferTimeout: number;228  //offchainSchemaLimit: number;229  //constOnChainSchemaLimit: number;230}231232export interface IReFungibleTokenDataType {233  owner: IReFungibleOwner[];234}235236export function uniqueEventMessage(events: EventRecord[]): IGetMessage {237  let checkMsgUnqMethod = '';238  let checkMsgTrsMethod = '';239  let checkMsgSysMethod = '';240  events.forEach(({event: {method, section}}) => {241    if (section === 'common') {242      checkMsgUnqMethod = method;243    } else if (section === 'treasury') {244      checkMsgTrsMethod = method;245    } else if (section === 'system') {246      checkMsgSysMethod = method;247    } else { return null; }248  });249  const result: IGetMessage = {250    checkMsgUnqMethod,251    checkMsgTrsMethod,252    checkMsgSysMethod,253  };254  return result;255}256257export function getEvent<T extends Event>(events: EventRecord[], check: (event: IEvent<AnyTuple>) => event is T): T | undefined {258  const event = events.find(r => check(r.event));259  if (!event) return;260  return event.event as T;261}262263export function getGenericResult<T>(events: EventRecord[]): GenericResult<T>;264export function getGenericResult<T>(265  events: EventRecord[],266  expectSection: string,267  expectMethod: string,268  extractAction: (data: GenericEventData) => T269): GenericResult<T>;270271export function getGenericResult<T>(272  events: EventRecord[],273  expectSection?: string,274  expectMethod?: string,275  extractAction?: (data: GenericEventData) => T,276): GenericResult<T> {277  let success = false;278  let successData = null;279280  events.forEach(({event: {data, method, section}}) => {281    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);282    if (method === 'ExtrinsicSuccess') {283      success = true;284    } else if ((expectSection == section) && (expectMethod == method)) {285      successData = extractAction!(data as any);286    }287  });288289  const result: GenericResult<T> = {290    success,291    data: successData,292  };293  return result;294}295296export function getCreateCollectionResult(events: EventRecord[]): CreateCollectionResult {297  const genericResult = getGenericResult(events, 'common', 'CollectionCreated', (data) => parseInt(data[0].toString(), 10));298  const result: CreateCollectionResult = {299    success: genericResult.success,300    collectionId: genericResult.data ?? 0,301  };302  return result;303}304305export function getCreateItemsResult(events: EventRecord[]): CreateItemResult[] {306  const results: CreateItemResult[] = [];307308  const genericResult = getGenericResult<CreateItemResult[]>(events, 'common', 'ItemCreated', (data) => {309    const collectionId = parseInt(data[0].toString(), 10);310    const itemId = parseInt(data[1].toString(), 10);311    const recipient = normalizeAccountId(data[2].toJSON() as any);312    const amount = parseInt(data[3].toString(), 10);313314    const itemRes: CreateItemResult = {315      success: true,316      collectionId,317      itemId,318      recipient,319      amount,320    };321322    results.push(itemRes);323    return results;324  });325326  if (!genericResult.success) return [];327  return results;328}329330export function getCreateItemResult(events: EventRecord[]): CreateItemResult {331  const genericResult = getGenericResult(events, 'common', 'ItemCreated', (data) => data.map(function(value) { return value.toJSON(); }));332333  if (genericResult.data == null)334    return {335      success: genericResult.success,336      collectionId: 0,337      itemId: 0,338      amount: 0,339    };340  else341    return {342      success: genericResult.success,343      collectionId: genericResult.data[0] as number,344      itemId: genericResult.data[1] as number,345      recipient: normalizeAccountId(genericResult.data![2] as any),346      amount: genericResult.data[3] as number,347    };348}349350export function getDestroyItemsResult(events: EventRecord[]): DestroyItemResult[] {351  const results: DestroyItemResult[] = [];352353  const genericResult = getGenericResult<DestroyItemResult[]>(events, 'common', 'ItemDestroyed', (data) => {354    const collectionId = parseInt(data[0].toString(), 10);355    const itemId = parseInt(data[1].toString(), 10);356    const owner = normalizeAccountId(data[2].toJSON() as any);357    const amount = parseInt(data[3].toString(), 10);358359    const itemRes: DestroyItemResult = {360      success: true,361      collectionId,362      itemId,363      owner,364      amount,365    };366367    results.push(itemRes);368    return results;369  });370371  if (!genericResult.success) return [];372  return results;373}374375export function getTransferResult(api: ApiPromise, events: EventRecord[]): TransferResult {376  for (const {event} of events) {377    if (api.events.common.Transfer.is(event)) {378      const [collection, token, sender, recipient, value] = event.data;379      return {380        collectionId: collection.toNumber(),381        itemId: token.toNumber(),382        sender: normalizeAccountId(sender.toJSON() as any),383        recipient: normalizeAccountId(recipient.toJSON() as any),384        value: value.toBigInt(),385      };386    }387  }388  throw new Error('no transfer event');389}390391interface Nft {392  type: 'NFT';393}394395interface Fungible {396  type: 'Fungible';397  decimalPoints: number;398}399400interface ReFungible {401  type: 'ReFungible';402}403404export type CollectionMode = Nft | Fungible | ReFungible;405406export type Property = {407  key: any,408  value: any,409};410411type Permission = {412  mutable: boolean;413  collectionAdmin: boolean;414  tokenOwner: boolean;415}416417type PropertyPermission = {418  key: any;419  permission: Permission;420}421422export type CreateCollectionParams = {423  mode: CollectionMode,424  name: string,425  description: string,426  tokenPrefix: string,427  properties?: Array<Property>,428  propPerm?: Array<PropertyPermission>429};430431const defaultCreateCollectionParams: CreateCollectionParams = {432  description: 'description',433  mode: {type: 'NFT'},434  name: 'name',435  tokenPrefix: 'prefix',436};437438export async function439createCollection(440  api: ApiPromise,441  sender: IKeyringPair,442  params: Partial<CreateCollectionParams> = {},443): Promise<CreateCollectionResult> {444  const {name, description, mode, tokenPrefix, properties} = {...defaultCreateCollectionParams, ...params};445446  let modeprm = {};447  if (mode.type === 'NFT') {448    modeprm = {nft: null};449  } else if (mode.type === 'Fungible') {450    modeprm = {fungible: mode.decimalPoints};451  } else if (mode.type === 'ReFungible') {452    modeprm = {refungible: null};453  }454455  const tx = api.tx.unique.createCollectionEx({456    name: strToUTF16(name),457    description: strToUTF16(description),458    tokenPrefix: strToUTF16(tokenPrefix),459    mode: modeprm as any,460    properties,461  });462  const events = await executeTransaction(api, sender, tx);463  return getCreateCollectionResult(events);464}465466export async function createCollectionExpectSuccess(params: Partial<CreateCollectionParams> = {}): Promise<number> {467  const {name, description, mode, tokenPrefix} = {...defaultCreateCollectionParams, ...params};468469  let collectionId = 0;470  await usingApi(async (api, privateKeyWrapper) => {471    // Get number of collections before the transaction472    const collectionCountBefore = await getCreatedCollectionCount(api);473474    // Run the CreateCollection transaction475    const alicePrivateKey = privateKeyWrapper('//Alice');476477    const result = await createCollection(api, alicePrivateKey, params);478479    // Get number of collections after the transaction480    const collectionCountAfter = await getCreatedCollectionCount(api);481482    // Get the collection483    const collection = await queryCollectionExpectSuccess(api, result.collectionId);484485    // What to expect486    // tslint:disable-next-line:no-unused-expression487    expect(result.success).to.be.true;488    expect(result.collectionId).to.be.equal(collectionCountAfter);489    // tslint:disable-next-line:no-unused-expression490    expect(collection).to.be.not.null;491    expect(collectionCountAfter).to.be.equal(collectionCountBefore + 1, 'Error: NFT collection NOT created.');492    expect(collection.owner.toString()).to.be.equal(toSubstrateAddress(alicePrivateKey));493    expect(utf16ToStr(collection.name.toJSON() as any)).to.be.equal(name);494    expect(utf16ToStr(collection.description.toJSON() as any)).to.be.equal(description);495    expect(hexToStr(collection.tokenPrefix.toJSON())).to.be.equal(tokenPrefix);496497    collectionId = result.collectionId;498  });499500  return collectionId;501}502503export async function createCollectionWithPropsExpectSuccess(params: Partial<CreateCollectionParams> = {}): Promise<number> {504  const {name, description, mode, tokenPrefix} = {...defaultCreateCollectionParams, ...params};505506  let collectionId = 0;507  await usingApi(async (api, privateKeyWrapper) => {508    // Get number of collections before the transaction509    const collectionCountBefore = await getCreatedCollectionCount(api);510511    // Run the CreateCollection transaction512    const alicePrivateKey = privateKeyWrapper('//Alice');513514    let modeprm = {};515    if (mode.type === 'NFT') {516      modeprm = {nft: null};517    } else if (mode.type === 'Fungible') {518      modeprm = {fungible: mode.decimalPoints};519    } else if (mode.type === 'ReFungible') {520      modeprm = {refungible: null};521    }522523    const tx = api.tx.unique.createCollectionEx({name: strToUTF16(name), description: strToUTF16(description), tokenPrefix: strToUTF16(tokenPrefix), mode: modeprm as any, properties: params.properties, tokenPropertyPermissions: params.propPerm});524    const events = await submitTransactionAsync(alicePrivateKey, tx);525    const result = getCreateCollectionResult(events);526527    // Get number of collections after the transaction528    const collectionCountAfter = await getCreatedCollectionCount(api);529530    // Get the collection531    const collection = await queryCollectionExpectSuccess(api, result.collectionId);532533    // What to expect534    // tslint:disable-next-line:no-unused-expression535    expect(result.success).to.be.true;536    expect(result.collectionId).to.be.equal(collectionCountAfter);537    // tslint:disable-next-line:no-unused-expression538    expect(collection).to.be.not.null;539    expect(collectionCountAfter).to.be.equal(collectionCountBefore + 1, 'Error: NFT collection NOT created.');540    expect(collection.owner.toString()).to.be.equal(toSubstrateAddress(alicePrivateKey));541    expect(utf16ToStr(collection.name.toJSON() as any)).to.be.equal(name);542    expect(utf16ToStr(collection.description.toJSON() as any)).to.be.equal(description);543    expect(hexToStr(collection.tokenPrefix.toJSON())).to.be.equal(tokenPrefix);544545546    collectionId = result.collectionId;547  });548549  return collectionId;550}551552export async function createCollectionWithPropsExpectFailure(params: Partial<CreateCollectionParams> = {}) {553  const {name, description, mode, tokenPrefix} = {...defaultCreateCollectionParams, ...params};554555  await usingApi(async (api, privateKeyWrapper) => {556    // Get number of collections before the transaction557    const collectionCountBefore = await getCreatedCollectionCount(api);558559    // Run the CreateCollection transaction560    const alicePrivateKey = privateKeyWrapper('//Alice');561562    let modeprm = {};563    if (mode.type === 'NFT') {564      modeprm = {nft: null};565    } else if (mode.type === 'Fungible') {566      modeprm = {fungible: mode.decimalPoints};567    } else if (mode.type === 'ReFungible') {568      modeprm = {refungible: null};569    }570571    const tx = api.tx.unique.createCollectionEx({name: strToUTF16(name), description: strToUTF16(description), tokenPrefix: strToUTF16(tokenPrefix), mode: modeprm as any, properties: params.properties, tokenPropertyPermissions: params.propPerm});572    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;573574575    // Get number of collections after the transaction576    const collectionCountAfter = await getCreatedCollectionCount(api);577578    expect(collectionCountAfter).to.be.equal(collectionCountBefore, 'Error: Collection with incorrect data created.');579  });580}581582export async function createCollectionExpectFailure(params: Partial<CreateCollectionParams> = {}) {583  const {name, description, mode, tokenPrefix} = {...defaultCreateCollectionParams, ...params};584585  let modeprm = {};586  if (mode.type === 'NFT') {587    modeprm = {nft: null};588  } else if (mode.type === 'Fungible') {589    modeprm = {fungible: mode.decimalPoints};590  } else if (mode.type === 'ReFungible') {591    modeprm = {refungible: null};592  }593594  await usingApi(async (api, privateKeyWrapper) => {595    // Get number of collections before the transaction596    const collectionCountBefore = await getCreatedCollectionCount(api);597598    // Run the CreateCollection transaction599    const alicePrivateKey = privateKeyWrapper('//Alice');600    const tx = api.tx.unique.createCollectionEx({name: strToUTF16(name), description: strToUTF16(description), tokenPrefix: strToUTF16(tokenPrefix), mode: modeprm as any});601    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;602603    // Get number of collections after the transaction604    const collectionCountAfter = await getCreatedCollectionCount(api);605606    // What to expect607    expect(collectionCountAfter).to.be.equal(collectionCountBefore, 'Error: Collection with incorrect data created.');608  });609}610611export async function findUnusedAddress(api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair, seedAddition = ''): Promise<IKeyringPair> {612  let bal = 0n;613  let unused;614  do {615    const randomSeed = 'seed' + Math.floor(Math.random() * Math.floor(10000)) + seedAddition;616    unused = privateKeyWrapper(`//${randomSeed}`);617    bal = (await api.query.system.account(unused.address)).data.free.toBigInt();618  } while (bal !== 0n);619  return unused;620}621622export async function getAllowance(api: ApiPromise, collectionId: number, owner: CrossAccountId | string | IKeyringPair, approved: CrossAccountId | string | IKeyringPair, tokenId: number) {623  return (await api.rpc.unique.allowance(collectionId, normalizeAccountId(owner), normalizeAccountId(approved), tokenId)).toBigInt();624}625626export function findUnusedAddresses(api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair, amount: number): Promise<IKeyringPair[]> {627  return Promise.all(new Array(amount).fill(null).map(() => findUnusedAddress(api, privateKeyWrapper, '_' + Date.now())));628}629630export async function findNotExistingCollection(api: ApiPromise): Promise<number> {631  const totalNumber = await getCreatedCollectionCount(api);632  const newCollection: number = totalNumber + 1;633  return newCollection;634}635636function getDestroyResult(events: EventRecord[]): boolean {637  let success = false;638  events.forEach(({event: {method}}) => {639    if (method == 'ExtrinsicSuccess') {640      success = true;641    }642  });643  return success;644}645646export async function destroyCollectionExpectFailure(collectionId: number, senderSeed = '//Alice') {647  await usingApi(async (api, privateKeyWrapper) => {648    // Run the DestroyCollection transaction649    const alicePrivateKey = privateKeyWrapper(senderSeed);650    const tx = api.tx.unique.destroyCollection(collectionId);651    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;652  });653}654655export async function destroyCollectionExpectSuccess(collectionId: number, senderSeed = '//Alice') {656  await usingApi(async (api, privateKeyWrapper) => {657    // Run the DestroyCollection transaction658    const alicePrivateKey = privateKeyWrapper(senderSeed);659    const tx = api.tx.unique.destroyCollection(collectionId);660    const events = await submitTransactionAsync(alicePrivateKey, tx);661    const result = getDestroyResult(events);662    expect(result).to.be.true;663664    // What to expect665    expect(await getDetailedCollectionInfo(api, collectionId)).to.be.null;666  });667}668669export async function setCollectionLimitsExpectSuccess(sender: IKeyringPair, collectionId: number, limits: any) {670  await usingApi(async (api) => {671    const tx = api.tx.unique.setCollectionLimits(collectionId, limits);672    const events = await submitTransactionAsync(sender, tx);673    const result = getGenericResult(events);674675    expect(result.success).to.be.true;676  });677}678679export const setCollectionPermissionsExpectSuccess = async (sender: IKeyringPair, collectionId: number, permissions: any) => {680  await usingApi(async(api) => {681    const tx = api.tx.unique.setCollectionPermissions(collectionId, permissions);682    const events = await submitTransactionAsync(sender, tx);683    const result = getGenericResult(events);684685    expect(result.success).to.be.true;686  });687};688689export async function setCollectionLimitsExpectFailure(sender: IKeyringPair, collectionId: number, limits: any) {690  await usingApi(async (api) => {691    const tx = api.tx.unique.setCollectionLimits(collectionId, limits);692    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;693    const result = getGenericResult(events);694695    expect(result.success).to.be.false;696  });697}698699export async function setCollectionSponsorExpectSuccess(collectionId: number, sponsor: string, sender = '//Alice') {700  await usingApi(async (api, privateKeyWrapper) => {701702    // Run the transaction703    const senderPrivateKey = privateKeyWrapper(sender);704    const tx = api.tx.unique.setCollectionSponsor(collectionId, sponsor);705    const events = await submitTransactionAsync(senderPrivateKey, tx);706    const result = getGenericResult(events);707708    // Get the collection709    const collection = await queryCollectionExpectSuccess(api, collectionId);710711    // What to expect712    expect(result.success).to.be.true;713    expect(collection.sponsorship.toJSON()).to.deep.equal({714      unconfirmed: sponsor,715    });716  });717}718719export async function removeCollectionSponsorExpectSuccess(collectionId: number, sender = '//Alice') {720  await usingApi(async (api, privateKeyWrapper) => {721722    // Run the transaction723    const alicePrivateKey = privateKeyWrapper(sender);724    const tx = api.tx.unique.removeCollectionSponsor(collectionId);725    const events = await submitTransactionAsync(alicePrivateKey, tx);726    const result = getGenericResult(events);727728    // Get the collection729    const collection = await queryCollectionExpectSuccess(api, collectionId);730731    // What to expect732    expect(result.success).to.be.true;733    expect(collection.sponsorship.toJSON()).to.be.deep.equal({disabled: null});734  });735}736737export async function removeCollectionSponsorExpectFailure(collectionId: number, senderSeed = '//Alice') {738  await usingApi(async (api, privateKeyWrapper) => {739740    // Run the transaction741    const alicePrivateKey = privateKeyWrapper(senderSeed);742    const tx = api.tx.unique.removeCollectionSponsor(collectionId);743    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;744  });745}746747export async function setCollectionSponsorExpectFailure(collectionId: number, sponsor: string, senderSeed = '//Alice') {748  await usingApi(async (api, privateKeyWrapper) => {749750    // Run the transaction751    const alicePrivateKey = privateKeyWrapper(senderSeed);752    const tx = api.tx.unique.setCollectionSponsor(collectionId, sponsor);753    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;754  });755}756757export async function confirmSponsorshipExpectSuccess(collectionId: number, senderSeed = '//Alice') {758  await usingApi(async (api, privateKeyWrapper) => {759760    // Run the transaction761    const sender = privateKeyWrapper(senderSeed);762    await confirmSponsorshipByKeyExpectSuccess(collectionId, sender);763  });764}765766export async function confirmSponsorshipByKeyExpectSuccess(collectionId: number, sender: IKeyringPair) {767  await usingApi(async (api, privateKeyWrapper) => {768769    // Run the transaction770    const tx = api.tx.unique.confirmSponsorship(collectionId);771    const events = await submitTransactionAsync(sender, tx);772    const result = getGenericResult(events);773774    // Get the collection775    const collection = await queryCollectionExpectSuccess(api, collectionId);776777    // What to expect778    expect(result.success).to.be.true;779    expect(collection.sponsorship.toJSON()).to.be.deep.equal({780      confirmed: sender.address,781    });782  });783}784785786export async function confirmSponsorshipExpectFailure(collectionId: number, senderSeed = '//Alice') {787  await usingApi(async (api, privateKeyWrapper) => {788789    // Run the transaction790    const sender = privateKeyWrapper(senderSeed);791    const tx = api.tx.unique.confirmSponsorship(collectionId);792    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;793  });794}795796export async function enableContractSponsoringExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {797  await usingApi(async (api) => {798    const tx = api.tx.unique.enableContractSponsoring(contractAddress, enable);799    const events = await submitTransactionAsync(sender, tx);800    const result = getGenericResult(events);801802    expect(result.success).to.be.true;803  });804}805806export async function enableContractSponsoringExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {807  await usingApi(async (api) => {808    const tx = api.tx.unique.enableContractSponsoring(contractAddress, enable);809    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;810    const result = getGenericResult(events);811812    expect(result.success).to.be.false;813  });814}815816export async function setTransferFlagExpectSuccess(sender: IKeyringPair, collectionId: number, enabled: boolean) {817818  await usingApi(async (api) => {819820    const tx = api.tx.unique.setTransfersEnabledFlag(collectionId, enabled);821    const events = await submitTransactionAsync(sender, tx);822    const result = getGenericResult(events);823824    expect(result.success).to.be.true;825  });826}827828export async function setTransferFlagExpectFailure(sender: IKeyringPair, collectionId: number, enabled: boolean) {829830  await usingApi(async (api) => {831832    const tx = api.tx.unique.setTransfersEnabledFlag(collectionId, enabled);833    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;834    const result = getGenericResult(events);835836    expect(result.success).to.be.false;837  });838}839840export async function setContractSponsoringRateLimitExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {841  await usingApi(async (api) => {842    const tx = api.tx.unique.setContractSponsoringRateLimit(contractAddress, rateLimit);843    const events = await submitTransactionAsync(sender, tx);844    const result = getGenericResult(events);845846    expect(result.success).to.be.true;847  });848}849850export async function setContractSponsoringRateLimitExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {851  await usingApi(async (api) => {852    const tx = api.tx.unique.setContractSponsoringRateLimit(contractAddress, rateLimit);853    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;854    const result = getGenericResult(events);855856    expect(result.success).to.be.false;857  });858}859860export async function getNextSponsored(861  api: ApiPromise,862  collectionId: number,863  account: string | CrossAccountId,864  tokenId: number,865): Promise<number> {866  return Number((await api.rpc.unique.nextSponsored(collectionId, account, tokenId)).unwrapOr(-1));867}868869export async function toggleContractAllowlistExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, value = true) {870  await usingApi(async (api) => {871    const tx = api.tx.unique.toggleContractAllowList(contractAddress, value);872    const events = await submitTransactionAsync(sender, tx);873    const result = getGenericResult(events);874875    expect(result.success).to.be.true;876  });877}878879export async function isAllowlistedInContract(contractAddress: AccountId | string, user: string) {880  let allowlisted = false;881  await usingApi(async (api) => {882    allowlisted = (await api.query.unique.contractAllowList(contractAddress, user)).toJSON() as boolean;883  });884  return allowlisted;885}886887export async function addToContractAllowListExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {888  await usingApi(async (api) => {889    const tx = api.tx.unique.addToContractAllowList(contractAddress.toString(), user.toString());890    const events = await submitTransactionAsync(sender, tx);891    const result = getGenericResult(events);892893    expect(result.success).to.be.true;894  });895}896897export async function removeFromContractAllowListExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {898  await usingApi(async (api) => {899    const tx = api.tx.unique.removeFromContractAllowList(contractAddress.toString(), user.toString());900    const events = await submitTransactionAsync(sender, tx);901    const result = getGenericResult(events);902903    expect(result.success).to.be.true;904  });905}906907export async function removeFromContractAllowListExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {908  await usingApi(async (api) => {909    const tx = api.tx.unique.removeFromContractAllowList(contractAddress.toString(), user.toString());910    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;911    const result = getGenericResult(events);912913    expect(result.success).to.be.false;914  });915}916917export interface CreateFungibleData {918  readonly Value: bigint;919}920921export interface CreateReFungibleData { }922export interface CreateNftData { }923924export type CreateItemData = {925  NFT: CreateNftData;926} | {927  Fungible: CreateFungibleData;928} | {929  ReFungible: CreateReFungibleData;930};931932export async function burnItem(api: ApiPromise, sender: IKeyringPair, collectionId: number, tokenId: number, value: number | bigint) : Promise<boolean> {933  const tx = api.tx.unique.burnItem(collectionId, tokenId, value);934  const events = await submitTransactionAsync(sender, tx);935  return getGenericResult(events).success;936}937938export async function burnItemExpectSuccess(sender: IKeyringPair, collectionId: number, tokenId: number, value: number | bigint = 1) {939  await usingApi(async (api) => {940    const balanceBefore = await getBalance(api, collectionId, normalizeAccountId(sender), tokenId);941    // if burning token by admin - use adminButnItemExpectSuccess942    expect(balanceBefore >= BigInt(value)).to.be.true;943944    expect(await burnItem(api, sender, collectionId, tokenId, value)).to.be.true;945946    const balanceAfter = await getBalance(api, collectionId, normalizeAccountId(sender), tokenId);947    expect(balanceAfter + BigInt(value)).to.be.equal(balanceBefore);948  });949}950951export async function burnItemExpectFailure(sender: IKeyringPair, collectionId: number, tokenId: number, value: number | bigint = 1) {952  await usingApi(async (api) => {953    const tx = api.tx.unique.burnItem(collectionId, tokenId, value);954955    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;956    const result = getCreateCollectionResult(events);957    // tslint:disable-next-line:no-unused-expression958    expect(result.success).to.be.false;959  });960}961962export async function burnFromExpectSuccess(sender: IKeyringPair, from: IKeyringPair | CrossAccountId, collectionId: number, tokenId: number, value: number | bigint = 1) {963  await usingApi(async (api) => {964    const tx = api.tx.unique.burnFrom(collectionId, normalizeAccountId(from), tokenId, value);965    const events = await submitTransactionAsync(sender, tx);966    return getGenericResult(events).success;967  });968}969970export async function971approve(972  api: ApiPromise,973  collectionId: number,974  tokenId: number, owner: IKeyringPair, approved: CrossAccountId | string | IKeyringPair, amount: number | bigint,975) {976  const approveUniqueTx = api.tx.unique.approve(normalizeAccountId(approved), collectionId, tokenId, amount);977  const events = await submitTransactionAsync(owner, approveUniqueTx);978  return getGenericResult(events).success;979}980981export async function982approveExpectSuccess(983  collectionId: number,984  tokenId: number, owner: IKeyringPair, approved: CrossAccountId | string, amount: number | bigint = 1,985) {986  await usingApi(async (api: ApiPromise) => {987    const result = await approve(api, collectionId, tokenId, owner, approved, amount);988    expect(result).to.be.true;989990    expect(await getAllowance(api, collectionId, owner, approved, tokenId)).to.be.equal(BigInt(amount));991  });992}993994export async function adminApproveFromExpectSuccess(995  collectionId: number,996  tokenId: number, admin: IKeyringPair, owner: CrossAccountId | string, approved: CrossAccountId | string, amount: number | bigint = 1,997) {998  await usingApi(async (api: ApiPromise) => {999    const approveUniqueTx = api.tx.unique.approve(normalizeAccountId(approved), collectionId, tokenId, amount);1000    const events = await submitTransactionAsync(admin, approveUniqueTx);1001    const result = getGenericResult(events);1002    expect(result.success).to.be.true;10031004    expect(await getAllowance(api, collectionId, owner, approved, tokenId)).to.be.equal(BigInt(amount));1005  });1006}10071008export async function1009transferFrom(1010  api: ApiPromise,1011  collectionId: number,1012  tokenId: number,1013  accountApproved: IKeyringPair,1014  accountFrom: IKeyringPair | CrossAccountId,1015  accountTo: IKeyringPair | CrossAccountId,1016  value: number | bigint,1017) {1018  const from = normalizeAccountId(accountFrom);1019  const to = normalizeAccountId(accountTo);1020  const transferFromTx = api.tx.unique.transferFrom(from, to, collectionId, tokenId, value);1021  const events = await submitTransactionAsync(accountApproved, transferFromTx);1022  return getGenericResult(events).success;1023}10241025export async function1026transferFromExpectSuccess(1027  collectionId: number,1028  tokenId: number,1029  accountApproved: IKeyringPair,1030  accountFrom: IKeyringPair | CrossAccountId,1031  accountTo: IKeyringPair | CrossAccountId,1032  value: number | bigint = 1,1033  type = 'NFT',1034) {1035  await usingApi(async (api: ApiPromise) => {1036    const from = normalizeAccountId(accountFrom);1037    const to = normalizeAccountId(accountTo);1038    let balanceBefore = 0n;1039    if (type === 'Fungible' || type === 'ReFungible') {1040      balanceBefore = await getBalance(api, collectionId, to, tokenId);1041    }1042    expect(await transferFrom(api, collectionId, tokenId, accountApproved, accountFrom, accountTo, value)).to.be.true;1043    if (type === 'NFT') {1044      expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(to);1045    }1046    if (type === 'Fungible') {1047      const balanceAfter = await getBalance(api, collectionId, to, tokenId);1048      if (JSON.stringify(to) !== JSON.stringify(from)) {1049        expect(balanceAfter - balanceBefore).to.be.equal(BigInt(value));1050      } else {1051        expect(balanceAfter).to.be.equal(balanceBefore);1052      }1053    }1054    if (type === 'ReFungible') {1055      expect(await getBalance(api, collectionId, to, tokenId)).to.be.equal(balanceBefore + BigInt(value));1056    }1057  });1058}10591060export async function1061transferFromExpectFail(1062  collectionId: number,1063  tokenId: number,1064  accountApproved: IKeyringPair,1065  accountFrom: IKeyringPair,1066  accountTo: IKeyringPair,1067  value: number | bigint = 1,1068) {1069  await usingApi(async (api: ApiPromise) => {1070    const transferFromTx = api.tx.unique.transferFrom(normalizeAccountId(accountFrom.address), normalizeAccountId(accountTo.address), collectionId, tokenId, value);1071    const events = await expect(submitTransactionExpectFailAsync(accountApproved, transferFromTx)).to.be.rejected;1072    const result = getCreateCollectionResult(events);1073    // tslint:disable-next-line:no-unused-expression1074    expect(result.success).to.be.false;1075  });1076}10771078/* eslint no-async-promise-executor: "off" */1079export async function getBlockNumber(api: ApiPromise): Promise<number> {1080  return new Promise<number>(async (resolve) => {1081    const unsubscribe = await api.rpc.chain.subscribeNewHeads((head) => {1082      unsubscribe();1083      resolve(head.number.toNumber());1084    });1085  });1086}10871088export async function addCollectionAdminExpectSuccess(sender: IKeyringPair, collectionId: number, address: string | CrossAccountId) {1089  await usingApi(async (api) => {1090    const changeAdminTx = api.tx.unique.addCollectionAdmin(collectionId, normalizeAccountId(address));1091    const events = await submitTransactionAsync(sender, changeAdminTx);1092    const result = getCreateCollectionResult(events);1093    expect(result.success).to.be.true;1094  });1095}10961097export async function adminApproveFromExpectFail(1098  collectionId: number,1099  tokenId: number, admin: IKeyringPair, owner: CrossAccountId | string, approved: CrossAccountId | string, amount: number | bigint = 1,1100) {1101  await usingApi(async (api: ApiPromise) => {1102    const approveUniqueTx = api.tx.unique.approve(normalizeAccountId(approved), collectionId, tokenId, amount);1103    const events = await expect(submitTransactionAsync(admin, approveUniqueTx)).to.be.rejected;1104    const result = getGenericResult(events);1105    expect(result.success).to.be.false;1106  });1107}11081109export async function1110getFreeBalance(account: IKeyringPair): Promise<bigint> {1111  let balance = 0n;1112  await usingApi(async (api) => {1113    balance = BigInt((await api.query.system.account(account.address)).data.free.toString());1114  });11151116  return balance;1117}11181119export async function paraSiblingSovereignAccount(paraid: number): Promise<string> {1120  return usingApi(async api => {1121    // We are getting a *sibling* parachain sovereign account,1122    // so we need a sibling prefix: encoded(b"sibl") == 0x7369626c1123    const siblingPrefix = '0x7369626c';11241125    const encodedParaId = api.createType('u32', paraid).toHex(true).substring(2);1126    const suffix = '000000000000000000000000000000000000000000000000';11271128    return siblingPrefix + encodedParaId + suffix;1129  });1130}11311132export async function transferBalanceTo(api: ApiPromise, source: IKeyringPair, target: string, amount = 1000n * UNIQUE) {1133  const tx = api.tx.balances.transfer(target, amount);1134  const events = await submitTransactionAsync(source, tx);1135  const result = getGenericResult(events);1136  expect(result.success).to.be.true;1137}11381139export async function1140scheduleExpectSuccess(1141  operationTx: any,1142  sender: IKeyringPair,1143  blockSchedule: number,1144  scheduledId: string,1145  period = 1,1146  repetitions = 1,1147) {1148  await usingApi(async (api: ApiPromise) => {1149    const blockNumber: number | undefined = await getBlockNumber(api);1150    const expectedBlockNumber = blockNumber + blockSchedule;11511152    expect(blockNumber).to.be.greaterThan(0);1153    const scheduleTx = api.tx.scheduler.scheduleNamed( // schedule1154      scheduledId,1155      expectedBlockNumber,1156      repetitions > 1 ? [period, repetitions] : null,1157      0,1158      {Value: operationTx as any},1159    );11601161    const events = await submitTransactionAsync(sender, scheduleTx);1162    expect(getGenericResult(events).success).to.be.true;1163  });1164}11651166export async function1167scheduleExpectFailure(1168  operationTx: any,1169  sender: IKeyringPair,1170  blockSchedule: number,1171  scheduledId: string,1172  period = 1,1173  repetitions = 1,1174) {1175  await usingApi(async (api: ApiPromise) => {1176    const blockNumber: number | undefined = await getBlockNumber(api);1177    const expectedBlockNumber = blockNumber + blockSchedule;11781179    expect(blockNumber).to.be.greaterThan(0);1180    const scheduleTx = api.tx.scheduler.scheduleNamed( // schedule1181      scheduledId,1182      expectedBlockNumber,1183      repetitions <= 1 ? null : [period, repetitions],1184      0,1185      {Value: operationTx as any},1186    );11871188    //const events =1189    await expect(submitTransactionExpectFailAsync(sender, scheduleTx)).to.be.rejected;1190    //expect(getGenericResult(events).success).to.be.false;1191  });1192}11931194export async function1195scheduleTransferAndWaitExpectSuccess(1196  collectionId: number,1197  tokenId: number,1198  sender: IKeyringPair,1199  recipient: IKeyringPair,1200  value: number | bigint = 1,1201  blockSchedule: number,1202  scheduledId: string,1203) {1204  await usingApi(async (api: ApiPromise) => {1205    await scheduleTransferExpectSuccess(collectionId, tokenId, sender, recipient, value, blockSchedule, scheduledId);12061207    const recipientBalanceBefore = (await api.query.system.account(recipient.address)).data.free.toBigInt();12081209    // sleep for n + 1 blocks1210    await waitNewBlocks(blockSchedule + 1);12111212    const recipientBalanceAfter = (await api.query.system.account(recipient.address)).data.free.toBigInt();12131214    expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(normalizeAccountId(recipient.address));1215    expect(recipientBalanceAfter).to.be.equal(recipientBalanceBefore);1216  });1217}12181219export async function1220scheduleTransferExpectSuccess(1221  collectionId: number,1222  tokenId: number,1223  sender: IKeyringPair,1224  recipient: IKeyringPair,1225  value: number | bigint = 1,1226  blockSchedule: number,1227  scheduledId: string,1228) {1229  await usingApi(async (api: ApiPromise) => {1230    const transferTx = api.tx.unique.transfer(normalizeAccountId(recipient.address), collectionId, tokenId, value);12311232    await scheduleExpectSuccess(transferTx, sender, blockSchedule, scheduledId);12331234    expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(normalizeAccountId(sender.address));1235  });1236}12371238export async function1239scheduleTransferFundsPeriodicExpectSuccess(1240  amount: bigint,1241  sender: IKeyringPair,1242  recipient: IKeyringPair,1243  blockSchedule: number,1244  scheduledId: string,1245  period: number,1246  repetitions: number,1247) {1248  await usingApi(async (api: ApiPromise) => {1249    const transferTx = api.tx.balances.transfer(recipient.address, amount);12501251    const balanceBefore = await getFreeBalance(recipient);12521253    await scheduleExpectSuccess(transferTx, sender, blockSchedule, scheduledId, period, repetitions);12541255    expect(await getFreeBalance(recipient)).to.be.equal(balanceBefore);1256  });1257}12581259export async function1260transfer(1261  api: ApiPromise,1262  collectionId: number,1263  tokenId: number,1264  sender: IKeyringPair,1265  recipient: IKeyringPair | CrossAccountId,1266  value: number | bigint,1267) : Promise<boolean> {1268  const transferTx = api.tx.unique.transfer(normalizeAccountId(recipient), collectionId, tokenId, value);1269  const events = await executeTransaction(api, sender, transferTx);1270  return getGenericResult(events).success;1271}12721273export async function1274transferExpectSuccess(1275  collectionId: number,1276  tokenId: number,1277  sender: IKeyringPair,1278  recipient: IKeyringPair | CrossAccountId,1279  value: number | bigint = 1,1280  type = 'NFT',1281) {1282  await usingApi(async (api: ApiPromise) => {1283    const from = normalizeAccountId(sender);1284    const to = normalizeAccountId(recipient);12851286    let balanceBefore = 0n;1287    if (type === 'Fungible' || type === 'ReFungible') {1288      balanceBefore = await getBalance(api, collectionId, to, tokenId);1289    }12901291    const transferTx = api.tx.unique.transfer(normalizeAccountId(recipient), collectionId, tokenId, value);1292    const events = await executeTransaction(api, sender, transferTx);1293    const result = getTransferResult(api, events);12941295    expect(result.collectionId).to.be.equal(collectionId);1296    expect(result.itemId).to.be.equal(tokenId);1297    expect(result.sender).to.be.deep.equal(normalizeAccountId(sender.address));1298    expect(result.recipient).to.be.deep.equal(to);1299    expect(result.value).to.be.equal(BigInt(value));13001301    if (type === 'NFT') {1302      expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(to);1303    }1304    if (type === 'Fungible' || type === 'ReFungible') {1305      const balanceAfter = await getBalance(api, collectionId, to, tokenId);1306      if (JSON.stringify(to) !== JSON.stringify(from)) {1307        expect(balanceAfter - balanceBefore).to.be.equal(BigInt(value));1308      } else {1309        expect(balanceAfter).to.be.equal(balanceBefore);1310      }1311    }1312  });1313}13141315export async function1316transferExpectFailure(1317  collectionId: number,1318  tokenId: number,1319  sender: IKeyringPair,1320  recipient: IKeyringPair | CrossAccountId,1321  value: number | bigint = 1,1322) {1323  await usingApi(async (api: ApiPromise) => {1324    const transferTx = api.tx.unique.transfer(normalizeAccountId(recipient), collectionId, tokenId, value);1325    const events = await expect(submitTransactionExpectFailAsync(sender, transferTx)).to.be.rejected;1326    const result = getGenericResult(events);1327    // if (events && Array.isArray(events)) {1328    //   const result = getCreateCollectionResult(events);1329    // tslint:disable-next-line:no-unused-expression1330    expect(result.success).to.be.false;1331    //}1332  });1333}13341335export async function1336approveExpectFail(1337  collectionId: number,1338  tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number | bigint = 1,1339) {1340  await usingApi(async (api: ApiPromise) => {1341    const approveUniqueTx = api.tx.unique.approve(normalizeAccountId(approved.address), collectionId, tokenId, amount);1342    const events = await expect(submitTransactionExpectFailAsync(owner, approveUniqueTx)).to.be.rejected;1343    const result = getCreateCollectionResult(events);1344    // tslint:disable-next-line:no-unused-expression1345    expect(result.success).to.be.false;1346  });1347}13481349export async function getBalance(1350  api: ApiPromise,1351  collectionId: number,1352  owner: string | CrossAccountId | IKeyringPair,1353  token: number,1354): Promise<bigint> {1355  return (await api.rpc.unique.balance(collectionId, normalizeAccountId(owner), token)).toBigInt();1356}1357export async function getTokenOwner(1358  api: ApiPromise,1359  collectionId: number,1360  token: number,1361): Promise<CrossAccountId> {1362  const owner = (await api.rpc.unique.tokenOwner(collectionId, token)).toJSON() as any;1363  if (owner == null) throw new Error('owner == null');1364  return normalizeAccountId(owner);1365}1366export async function getTopmostTokenOwner(1367  api: ApiPromise,1368  collectionId: number,1369  token: number,1370): Promise<CrossAccountId> {1371  const owner = (await api.rpc.unique.topmostTokenOwner(collectionId, token)).toJSON() as any;1372  if (owner == null) throw new Error('owner == null');1373  return normalizeAccountId(owner);1374}1375export async function getTokenChildren(1376  api: ApiPromise,1377  collectionId: number,1378  tokenId: number,1379): Promise<UpDataStructsTokenChild[]> {1380  return (await api.rpc.unique.tokenChildren(collectionId, tokenId)).toJSON() as any;1381}1382export async function isTokenExists(1383  api: ApiPromise,1384  collectionId: number,1385  token: number,1386): Promise<boolean> {1387  return (await api.rpc.unique.tokenExists(collectionId, token)).toJSON();1388}1389export async function getLastTokenId(1390  api: ApiPromise,1391  collectionId: number,1392): Promise<number> {1393  return (await api.rpc.unique.lastTokenId(collectionId)).toJSON();1394}1395export async function getAdminList(1396  api: ApiPromise,1397  collectionId: number,1398): Promise<string[]> {1399  return (await api.rpc.unique.adminlist(collectionId)).toHuman() as any;1400}1401export async function getTokenProperties(1402  api: ApiPromise,1403  collectionId: number,1404  tokenId: number,1405  propertyKeys: string[],1406): Promise<UpDataStructsProperty[]> {1407  return (await api.rpc.unique.tokenProperties(collectionId, tokenId, propertyKeys)).toHuman() as any;1408}14091410export async function createFungibleItemExpectSuccess(1411  sender: IKeyringPair,1412  collectionId: number,1413  data: CreateFungibleData,1414  owner: CrossAccountId | string = sender.address,1415) {1416  return await usingApi(async (api) => {1417    const tx = api.tx.unique.createItem(collectionId, normalizeAccountId(owner), {Fungible: data});14181419    const events = await submitTransactionAsync(sender, tx);1420    const result = getCreateItemResult(events);14211422    expect(result.success).to.be.true;1423    return result.itemId;1424  });1425}14261427export async function createMultipleItemsExpectSuccess(sender: IKeyringPair, collectionId: number, itemsData: any, owner: CrossAccountId | string = sender.address) {1428  await usingApi(async (api) => {1429    const to = normalizeAccountId(owner);1430    const tx = api.tx.unique.createMultipleItems(collectionId, to, itemsData);14311432    const events = await submitTransactionAsync(sender, tx);1433    expect(getGenericResult(events).success).to.be.true;1434  });1435}14361437export async function createMultipleItemsWithPropsExpectSuccess(sender: IKeyringPair, collectionId: number, itemsData: any, owner: CrossAccountId | string = sender.address) {1438  await usingApi(async (api) => {1439    const to = normalizeAccountId(owner);1440    const tx = api.tx.unique.createMultipleItems(collectionId, to, itemsData);14411442    const events = await submitTransactionAsync(sender, tx);1443    const result = getCreateItemsResult(events);14441445    for (const res of result) {1446      expect(await api.rpc.unique.tokenProperties(collectionId, res.itemId)).not.to.be.empty;1447    }1448  });1449}14501451export async function createMultipleItemsExWithPropsExpectSuccess(sender: IKeyringPair, collectionId: number, itemsData: any) {1452  await usingApi(async (api) => {1453    const tx = api.tx.unique.createMultipleItemsEx(collectionId, itemsData);14541455    const events = await submitTransactionAsync(sender, tx);1456    const result = getCreateItemsResult(events);14571458    for (const res of result) {1459      expect(await api.rpc.unique.tokenProperties(collectionId, res.itemId)).not.to.be.empty;1460    }1461  });1462}14631464export async function createItemWithPropsExpectSuccess(sender: IKeyringPair, collectionId: number, createMode: string, props:  Array<Property>, owner: CrossAccountId | string = sender.address) {1465  let newItemId = 0;1466  await usingApi(async (api) => {1467    const to = normalizeAccountId(owner);1468    const itemCountBefore = await getLastTokenId(api, collectionId);1469    const itemBalanceBefore = await getBalance(api, collectionId, to, newItemId);14701471    let tx;1472    if (createMode === 'Fungible') {1473      const createData = {fungible: {value: 10}};1474      tx = api.tx.unique.createItem(collectionId, to, createData as any);1475    } else if (createMode === 'ReFungible') {1476      const createData = {refungible: {pieces: 100}};1477      tx = api.tx.unique.createItem(collectionId, to, createData as any);1478    } else {1479      const data = api.createType('UpDataStructsCreateItemData', {NFT: {properties: props}});1480      tx = api.tx.unique.createItem(collectionId, to, data as UpDataStructsCreateItemData);1481    }14821483    const events = await submitTransactionAsync(sender, tx);1484    const result = getCreateItemResult(events);14851486    const itemCountAfter = await getLastTokenId(api, collectionId);1487    const itemBalanceAfter = await getBalance(api, collectionId, to, newItemId);14881489    if (createMode === 'NFT') {1490      expect(await api.rpc.unique.tokenProperties(collectionId, result.itemId)).not.to.be.empty;1491    }14921493    // What to expect1494    // tslint:disable-next-line:no-unused-expression1495    expect(result.success).to.be.true;1496    if (createMode === 'Fungible') {1497      expect(itemBalanceAfter - itemBalanceBefore).to.be.equal(10n);1498    } else {1499      expect(itemCountAfter).to.be.equal(itemCountBefore + 1);1500    }1501    expect(collectionId).to.be.equal(result.collectionId);1502    expect(itemCountAfter.toString()).to.be.equal(result.itemId.toString());1503    expect(to).to.be.deep.equal(result.recipient);1504    newItemId = result.itemId;1505  });1506  return newItemId;1507}15081509export async function createItemWithPropsExpectFailure(sender: IKeyringPair, collectionId: number, createMode: string, props: Array<Property>, owner: CrossAccountId | string = sender.address) {1510  await usingApi(async (api) => {15111512    let tx;1513    if (createMode === 'NFT') {1514      const data = api.createType('UpDataStructsCreateItemData', {NFT: {properties: props}}) as UpDataStructsCreateItemData;1515      tx = api.tx.unique.createItem(collectionId, normalizeAccountId(owner), data);1516    } else {1517      tx = api.tx.unique.createItem(collectionId, normalizeAccountId(owner), createMode);1518    }151915201521    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1522    if(events.message && events.message.toString().indexOf('1002: Verification Error') > -1) return;1523    const result = getCreateItemResult(events);15241525    expect(result.success).to.be.false;1526  });1527}15281529export async function createItemExpectSuccess(sender: IKeyringPair, collectionId: number, createMode: string, owner: CrossAccountId | string = sender.address) {1530  let newItemId = 0;1531  await usingApi(async (api) => {1532    const to = normalizeAccountId(owner);1533    const itemCountBefore = await getLastTokenId(api, collectionId);1534    const itemBalanceBefore = await getBalance(api, collectionId, to, newItemId);15351536    let tx;1537    if (createMode === 'Fungible') {1538      const createData = {fungible: {value: 10}};1539      tx = api.tx.unique.createItem(collectionId, to, createData as any);1540    } else if (createMode === 'ReFungible') {1541      const createData = {refungible: {pieces: 100}};1542      tx = api.tx.unique.createItem(collectionId, to, createData as any);1543    } else {1544      const createData = {nft: {}};1545      tx = api.tx.unique.createItem(collectionId, to, createData as any);1546    }15471548    const events = await executeTransaction(api, sender, tx);1549    const result = getCreateItemResult(events);15501551    const itemCountAfter = await getLastTokenId(api, collectionId);1552    const itemBalanceAfter = await getBalance(api, collectionId, to, newItemId);15531554    // What to expect1555    // tslint:disable-next-line:no-unused-expression1556    expect(result.success).to.be.true;1557    if (createMode === 'Fungible') {1558      expect(itemBalanceAfter - itemBalanceBefore).to.be.equal(10n);1559    } else {1560      expect(itemCountAfter).to.be.equal(itemCountBefore + 1);1561    }1562    expect(collectionId).to.be.equal(result.collectionId);1563    expect(itemCountAfter.toString()).to.be.equal(result.itemId.toString());1564    expect(to).to.be.deep.equal(result.recipient);1565    newItemId = result.itemId;1566  });1567  return newItemId;1568}15691570export async function createRefungibleToken(api: ApiPromise, sender: IKeyringPair, collectionId: number, amount: bigint, owner: CrossAccountId | IKeyringPair | string = sender.address) : Promise<CreateItemResult> {1571  const createData = {refungible: {pieces: amount}};1572  const tx = api.tx.unique.createItem(collectionId, normalizeAccountId(owner), createData as any);15731574  const events = await submitTransactionAsync(sender, tx);1575  return  getCreateItemResult(events);1576}15771578export async function createItemExpectFailure(sender: IKeyringPair, collectionId: number, createMode: string, owner: CrossAccountId | string = sender.address) {1579  await usingApi(async (api) => {1580    const tx = api.tx.unique.createItem(collectionId, normalizeAccountId(owner), createMode);15811582    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1583    const result = getCreateItemResult(events);15841585    expect(result.success).to.be.false;1586  });1587}15881589export async function setPublicAccessModeExpectSuccess(1590  sender: IKeyringPair, collectionId: number,1591  accessMode: 'Normal' | 'AllowList',1592) {1593  await usingApi(async (api) => {15941595    // Run the transaction1596    const tx = api.tx.unique.setCollectionPermissions(collectionId, {access: accessMode});1597    const events = await submitTransactionAsync(sender, tx);1598    const result = getGenericResult(events);15991600    // Get the collection1601    const collection = await queryCollectionExpectSuccess(api, collectionId);16021603    // What to expect1604    // tslint:disable-next-line:no-unused-expression1605    expect(result.success).to.be.true;1606    expect(collection.permissions.access.toHuman()).to.be.equal(accessMode);1607  });1608}16091610export async function setPublicAccessModeExpectFail(1611  sender: IKeyringPair, collectionId: number,1612  accessMode: 'Normal' | 'AllowList',1613) {1614  await usingApi(async (api) => {16151616    // Run the transaction1617    const tx = api.tx.unique.setCollectionPermissions(collectionId, {access: accessMode});1618    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1619    const result = getGenericResult(events);16201621    // What to expect1622    // tslint:disable-next-line:no-unused-expression1623    expect(result.success).to.be.false;1624  });1625}16261627export async function enableAllowListExpectSuccess(sender: IKeyringPair, collectionId: number) {1628  await setPublicAccessModeExpectSuccess(sender, collectionId, 'AllowList');1629}16301631export async function enableAllowListExpectFail(sender: IKeyringPair, collectionId: number) {1632  await setPublicAccessModeExpectFail(sender, collectionId, 'AllowList');1633}16341635export async function disableAllowListExpectSuccess(sender: IKeyringPair, collectionId: number) {1636  await setPublicAccessModeExpectSuccess(sender, collectionId, 'Normal');1637}16381639export async function setMintPermissionExpectSuccess(sender: IKeyringPair, collectionId: number, enabled: boolean) {1640  await usingApi(async (api) => {16411642    // Run the transaction1643    const tx = api.tx.unique.setCollectionPermissions(collectionId, {mintMode: enabled});1644    const events = await submitTransactionAsync(sender, tx);1645    const result = getGenericResult(events);1646    expect(result.success).to.be.true;16471648    // Get the collection1649    const collection = await queryCollectionExpectSuccess(api, collectionId);16501651    expect(collection.permissions.mintMode.toHuman()).to.be.equal(enabled);1652  });1653}16541655export async function enablePublicMintingExpectSuccess(sender: IKeyringPair, collectionId: number) {1656  await setMintPermissionExpectSuccess(sender, collectionId, true);1657}16581659export async function setMintPermissionExpectFailure(sender: IKeyringPair, collectionId: number, enabled: boolean) {1660  await usingApi(async (api) => {1661    // Run the transaction1662    const tx = api.tx.unique.setCollectionPermissions(collectionId, {mintMode: enabled});1663    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1664    const result = getCreateCollectionResult(events);1665    // tslint:disable-next-line:no-unused-expression1666    expect(result.success).to.be.false;1667  });1668}16691670export async function setChainLimitsExpectFailure(sender: IKeyringPair, limits: IChainLimits) {1671  await usingApi(async (api) => {1672    // Run the transaction1673    const tx = api.tx.unique.setChainLimits(limits);1674    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1675    const result = getCreateCollectionResult(events);1676    // tslint:disable-next-line:no-unused-expression1677    expect(result.success).to.be.false;1678  });1679}16801681export async function isAllowlisted(api: ApiPromise, collectionId: number, address: string | CrossAccountId | IKeyringPair) {1682  return (await api.rpc.unique.allowed(collectionId, normalizeAccountId(address))).toJSON();1683}16841685export async function addToAllowListExpectSuccess(sender: IKeyringPair, collectionId: number, address: string | AccountId | CrossAccountId) {1686  await usingApi(async (api) => {1687    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.false;16881689    // Run the transaction1690    const tx = api.tx.unique.addToAllowList(collectionId, normalizeAccountId(address));1691    const events = await submitTransactionAsync(sender, tx);1692    const result = getGenericResult(events);1693    expect(result.success).to.be.true;16941695    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.true;1696  });1697}16981699export async function addToAllowListAgainExpectSuccess(sender: IKeyringPair, collectionId: number, address: string | AccountId) {1700  await usingApi(async (api) => {17011702    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.true;17031704    // Run the transaction1705    const tx = api.tx.unique.addToAllowList(collectionId, normalizeAccountId(address));1706    const events = await submitTransactionAsync(sender, tx);1707    const result = getGenericResult(events);1708    expect(result.success).to.be.true;17091710    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.true;1711  });1712}17131714export async function addToAllowListExpectFail(sender: IKeyringPair, collectionId: number, address: string | AccountId) {1715  await usingApi(async (api) => {17161717    // Run the transaction1718    const tx = api.tx.unique.addToAllowList(collectionId, normalizeAccountId(address));1719    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1720    const result = getGenericResult(events);17211722    // What to expect1723    // tslint:disable-next-line:no-unused-expression1724    expect(result.success).to.be.false;1725  });1726}17271728export async function removeFromAllowListExpectSuccess(sender: IKeyringPair, collectionId: number, address: CrossAccountId) {1729  await usingApi(async (api) => {1730    // Run the transaction1731    const tx = api.tx.unique.removeFromAllowList(collectionId, normalizeAccountId(address));1732    const events = await submitTransactionAsync(sender, tx);1733    const result = getGenericResult(events);17341735    // What to expect1736    // tslint:disable-next-line:no-unused-expression1737    expect(result.success).to.be.true;1738  });1739}17401741export async function removeFromAllowListExpectFailure(sender: IKeyringPair, collectionId: number, address: CrossAccountId) {1742  await usingApi(async (api) => {1743    // Run the transaction1744    const tx = api.tx.unique.removeFromAllowList(collectionId, normalizeAccountId(address));1745    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1746    const result = getGenericResult(events);17471748    // What to expect1749    // tslint:disable-next-line:no-unused-expression1750    expect(result.success).to.be.false;1751  });1752}17531754export const getDetailedCollectionInfo = async (api: ApiPromise, collectionId: number)1755  : Promise<UpDataStructsRpcCollection | null> => {1756  return (await api.rpc.unique.collectionById(collectionId)).unwrapOr(null);1757};17581759export const getCreatedCollectionCount = async (api: ApiPromise): Promise<number> => {1760  // set global object - collectionsCount1761  return (await api.rpc.unique.collectionStats()).created.toNumber();1762};17631764export async function queryCollectionExpectSuccess(api: ApiPromise, collectionId: number): Promise<UpDataStructsRpcCollection> {1765  return (await api.rpc.unique.collectionById(collectionId)).unwrap();1766}17671768export const describe_xcm = (1769  process.env.RUN_XCM_TESTS1770    ? describe1771    : describe.skip1772);17731774export async function waitNewBlocks(blocksCount = 1): Promise<void> {1775  await usingApi(async (api) => {1776    const promise = new Promise<void>(async (resolve) => {1777      const unsubscribe = await api.rpc.chain.subscribeNewHeads(() => {1778        if (blocksCount > 0) {1779          blocksCount--;1780        } else {1781          unsubscribe();1782          resolve();1783        }1784      });1785    });1786    return promise;1787  });1788}17891790export async function waitEvent(1791  api: ApiPromise,1792  maxBlocksToWait: number,1793  eventSection: string,1794  eventMethod: string,1795): Promise<EventRecord | null> {17961797  const promise = new Promise<EventRecord | null>(async (resolve) => {1798    const unsubscribe = await api.rpc.chain.subscribeNewHeads(async header => {1799      const blockNumber = header.number.toHuman();1800      const blockHash = header.hash;1801      const eventIdStr = `${eventSection}.${eventMethod}`;1802      const waitLimitStr = `wait blocks remaining: ${maxBlocksToWait}`;18031804      console.log(`[Block #${blockNumber}] Waiting for event \`${eventIdStr}\` (${waitLimitStr})`);18051806      const apiAt = await api.at(blockHash);1807      const eventRecords = await apiAt.query.system.events();18081809      const neededEvent = eventRecords.find(r => {1810        return r.event.section == eventSection && r.event.method == eventMethod;1811      });18121813      if (neededEvent) {1814        unsubscribe();1815        resolve(neededEvent);1816      } else if (maxBlocksToWait > 0) {1817        maxBlocksToWait--;1818      } else {1819        console.log(`Event \`${eventIdStr}\` is NOT found`);18201821        unsubscribe();1822        resolve(null);1823      }1824    });1825  });1826  return promise;1827}18281829export async function repartitionRFT(1830  api: ApiPromise,1831  collectionId: number,1832  sender: IKeyringPair,1833  tokenId: number,1834  amount: bigint,1835): Promise<boolean> {1836  const tx = api.tx.unique.repartition(collectionId, tokenId, amount);1837  const events = await submitTransactionAsync(sender, tx);1838  const result = getGenericResult(events);18391840  return result.success;1841}18421843export async function itApi(name: string, cb: (apis: { api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair }) => any, opts: { only?: boolean, skip?: boolean } = {}) {1844  let i: any = it;1845  if (opts.only) i = i.only;1846  else if (opts.skip) i = i.skip;1847  i(name, async () => {1848    await usingApi(async (api, privateKeyWrapper) => {1849      await cb({api, privateKeyWrapper});1850    });1851  });1852}18531854itApi.only = (name: string, cb: (apis: { api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair }) => any) => itApi(name, cb, {only: true});1855itApi.skip = (name: string, cb: (apis: { api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair }) => any) => itApi(name, cb, {skip: true});18561857let accountSeed = 10000;1858export function generateKeyringPair(keyring: Keyring) {1859  const privateKey = `0xDEADBEEF${(Date.now() + (accountSeed++)).toString(16).padStart(64 - 8, '0')}`;1860  return keyring.addFromUri(privateKey);1861}18621863export async function expectSubstrateEventsAtBlock(api: ApiPromise, blockNumber: AnyNumber | BlockNumber, section: string, methods: string[], dryRun = false) {1864  const blockHash = await api.rpc.chain.getBlockHash(blockNumber);1865  const subEvents = (await api.query.system.events.at(blockHash))1866    .filter(x => x.event.section === section)1867    .map((x) => x.toHuman());1868  const events = methods.map((m) => {1869    return {1870      event: {1871        method: m,1872        section,1873      },1874    };1875  });1876  if (!dryRun) {1877    expect(subEvents).to.be.like(events);1878  }1879  return subEvents;1880}