git.delta.rocks / unique-network / refs/commits / 518c0da3fdd3

1//2// This file is subject to the terms and conditions defined in3// file 'LICENSE', which is part of this source code package.4//56import { ApiPromise, Keyring } from '@polkadot/api';7import type { AccountId, EventRecord } from '@polkadot/types/interfaces';8import { IKeyringPair } from '@polkadot/types/types';9import { evmToAddress } from '@polkadot/util-crypto';10import { BigNumber } from 'bignumber.js';11import BN from 'bn.js';12import chai from 'chai';13import chaiAsPromised from 'chai-as-promised';14import { alicesPublicKey } from '../accounts';15import privateKey from '../substrate/privateKey';16import { default as usingApi, submitTransactionAsync, submitTransactionExpectFailAsync } from '../substrate/substrate-api';17import { ICollectionInterface } from '../types';18import { hexToStr, strToUTF16, utf16ToStr } from './util';1920chai.use(chaiAsPromised);21const expect = chai.expect;2223export type CrossAccountId = {24  substrate: string,25} | {26  ethereum: string,27};28export function normalizeAccountId(input: string | AccountId | CrossAccountId | IKeyringPair): CrossAccountId {29  if (typeof input === 'string')30    return { substrate: input };31  if ('address' in input) {32    return { substrate: input.address };33  }34  if ('ethereum' in input) {35    input.ethereum = input.ethereum.toLowerCase();36    return input;37  }38  if ('substrate' in input) {39    return input;40  }4142  // AccountId43  return {substrate: input.toString()};44}45export function toSubstrateAddress(input: string | CrossAccountId | IKeyringPair): string {46  input = normalizeAccountId(input);47  if ('substrate' in input) {48    return input.substrate;49  } else {50    return evmToAddress(input.ethereum);51  }52}5354export const U128_MAX = (1n << 128n) - 1n;5556const MICROUNIQUE = 1_000_000_000n;57const MILLIUNIQUE = 1_000n * MICROUNIQUE;58const CENTIUNIQUE = 10n * MILLIUNIQUE;59export const UNIQUE = 100n * CENTIUNIQUE;6061type GenericResult = {62  success: boolean,63};6465interface CreateCollectionResult {66  success: boolean;67  collectionId: number;68}6970interface CreateItemResult {71  success: boolean;72  collectionId: number;73  itemId: number;74  recipient?: CrossAccountId;75}7677interface TransferResult {78  success: boolean;79  collectionId: number;80  itemId: number;81  sender?: CrossAccountId;82  recipient?: CrossAccountId;83  value: bigint;84}8586interface IReFungibleOwner {87  Fraction: BN;88  Owner: number[];89}9091interface ITokenDataType {92  Owner: IKeyringPair;93  ConstData: number[];94  VariableData: number[];95}9697interface IGetMessage {98  checkMsgNftMethod: string;99  checkMsgTrsMethod: string;100  checkMsgSysMethod: string;101}102103export interface IFungibleTokenDataType {104  Value: number;105}106107export interface IChainLimits {108  CollectionNumbersLimit: number;109	AccountTokenOwnershipLimit: number;110	CollectionsAdminsLimit: number;111	CustomDataLimit: number;112	NftSponsorTransferTimeout: number;113	FungibleSponsorTransferTimeout: number;114	RefungibleSponsorTransferTimeout: number;115	OffchainSchemaLimit: number;116	VariableOnChainSchemaLimit: number;117	ConstOnChainSchemaLimit: number;118}119120export interface IReFungibleTokenDataType {121  Owner: IReFungibleOwner[];122  ConstData: number[];123  VariableData: number[];124}125126export function nftEventMessage(events: EventRecord[]): IGetMessage {127  let checkMsgNftMethod = '';128  let checkMsgTrsMethod = '';129  let checkMsgSysMethod = '';130  events.forEach(({ event: { method, section } }) => {131    if (section === 'nft') {132      checkMsgNftMethod = method;133    } else if (section === 'treasury') {134      checkMsgTrsMethod = method;135    } else if (section === 'system') {136      checkMsgSysMethod = method;137    } else { return null; }138  });139  const result: IGetMessage = {140    checkMsgNftMethod,141    checkMsgTrsMethod,142    checkMsgSysMethod,143  };144  return result;145}146147export function getGenericResult(events: EventRecord[]): GenericResult {148  const result: GenericResult = {149    success: false,150  };151  events.forEach(({ event: { method } }) => {152    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);153    if (method === 'ExtrinsicSuccess') {154      result.success = true;155    }156  });157  return result;158}159160161162export function getCreateCollectionResult(events: EventRecord[]): CreateCollectionResult {163  let success = false;164  let collectionId = 0;165  events.forEach(({ event: { data, method, section } }) => {166    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);167    if (method == 'ExtrinsicSuccess') {168      success = true;169    } else if ((section == 'nft') && (method == 'CollectionCreated')) {170      collectionId = parseInt(data[0].toString());171    }172  });173  const result: CreateCollectionResult = {174    success,175    collectionId,176  };177  return result;178}179180export function getCreateItemResult(events: EventRecord[]): CreateItemResult {181  let success = false;182  let collectionId = 0;183  let itemId = 0;184  let recipient;185  events.forEach(({ event: { data, method, section } }) => {186    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);187    if (method == 'ExtrinsicSuccess') {188      success = true;189    } else if ((section == 'nft') && (method == 'ItemCreated')) {190      collectionId = parseInt(data[0].toString());191      itemId = parseInt(data[1].toString());192      recipient = data[2].toJSON();193    }194  });195  const result: CreateItemResult = {196    success,197    collectionId,198    itemId,199    recipient,200  };201  return result;202}203204export function getTransferResult(events: EventRecord[]): TransferResult {205  const result: TransferResult = {206    success: false,207    collectionId: 0,208    itemId: 0,209    value: 0n,210  };211212  events.forEach(({ event: { data, method, section } }) => {213    if (method === 'ExtrinsicSuccess') {214      result.success = true;215    } else if (section === 'nft' && method === 'Transfer') {216      result.collectionId = +data[0].toString();217      result.itemId = +data[1].toString();218      result.sender = data[2].toJSON() as CrossAccountId;219      result.recipient = data[3].toJSON() as CrossAccountId;220      result.value = BigInt(data[4].toString());221    }222  });223224  return result;225}226227interface Invalid {228  type: 'Invalid';229}230231interface Nft {232  type: 'NFT';233}234235interface Fungible {236  type: 'Fungible';237  decimalPoints: number;238}239240interface ReFungible {241  type: 'ReFungible';242}243244type CollectionMode = Nft | Fungible | ReFungible | Invalid;245246export type CreateCollectionParams = {247  mode: CollectionMode,248  name: string,249  description: string,250  tokenPrefix: string,251};252253const defaultCreateCollectionParams: CreateCollectionParams = {254  description: 'description',255  mode: { type: 'NFT' },256  name: 'name',257  tokenPrefix: 'prefix',258};259260export async function createCollectionExpectSuccess(params: Partial<CreateCollectionParams> = {}): Promise<number> {261  const { name, description, mode, tokenPrefix } = { ...defaultCreateCollectionParams, ...params };262263  let collectionId = 0;264  await usingApi(async (api) => {265    // Get number of collections before the transaction266    const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10);267268    // Run the CreateCollection transaction269    const alicePrivateKey = privateKey('//Alice');270271    let modeprm = {};272    if (mode.type === 'NFT') {273      modeprm = { nft: null };274    } else if (mode.type === 'Fungible') {275      modeprm = { fungible: mode.decimalPoints };276    } else if (mode.type === 'ReFungible') {277      modeprm = { refungible: null };278    } else if (mode.type === 'Invalid') {279      modeprm = { invalid: null };280    }281282    const tx = api.tx.nft.createCollection(strToUTF16(name), strToUTF16(description), strToUTF16(tokenPrefix), modeprm);283    const events = await submitTransactionAsync(alicePrivateKey, tx);284    const result = getCreateCollectionResult(events);285286    // Get number of collections after the transaction287    const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10);288289    // Get the collection290    const collection: any = (await api.query.nft.collectionById(result.collectionId) as any).toJSON();291292    // What to expect293    // tslint:disable-next-line:no-unused-expression294    expect(result.success).to.be.true;295    expect(result.collectionId).to.be.equal(BcollectionCount);296    // tslint:disable-next-line:no-unused-expression297    expect(collection).to.be.not.null;298    expect(BcollectionCount).to.be.equal(AcollectionCount + 1, 'Error: NFT collection NOT created.');299    expect(collection.Owner).to.be.equal(toSubstrateAddress(alicesPublicKey));300    expect(utf16ToStr(collection.Name)).to.be.equal(name);301    expect(utf16ToStr(collection.Description)).to.be.equal(description);302    expect(hexToStr(collection.TokenPrefix)).to.be.equal(tokenPrefix);303304    collectionId = result.collectionId;305  });306307  return collectionId;308}309310export async function createCollectionExpectFailure(params: Partial<CreateCollectionParams> = {}) {311  const { name, description, mode, tokenPrefix } = { ...defaultCreateCollectionParams, ...params };312313  let modeprm = {};314  if (mode.type === 'NFT') {315    modeprm = { nft: null };316  } else if (mode.type === 'Fungible') {317    modeprm = { fungible: mode.decimalPoints };318  } else if (mode.type === 'ReFungible') {319    modeprm = { refungible: null };320  } else if (mode.type === 'Invalid') {321    modeprm = { invalid: null };322  }323324  await usingApi(async (api) => {325    // Get number of collections before the transaction326    const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());327328    // Run the CreateCollection transaction329    const alicePrivateKey = privateKey('//Alice');330    const tx = api.tx.nft.createCollection(strToUTF16(name), strToUTF16(description), strToUTF16(tokenPrefix), modeprm);331    const events = await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;332    const result = getCreateCollectionResult(events);333334    // Get number of collections after the transaction335    const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());336337    // What to expect338    // tslint:disable-next-line:no-unused-expression339    expect(result.success).to.be.false;340    expect(BcollectionCount).to.be.equal(AcollectionCount, 'Error: Collection with incorrect data created.');341  });342}343344export async function findUnusedAddress(api: ApiPromise, seedAddition = ''): Promise<IKeyringPair> {345  let bal = new BigNumber(0);346  let unused;347  do {348    const randomSeed = 'seed' + Math.floor(Math.random() * Math.floor(10000)) + seedAddition;349    const keyring = new Keyring({ type: 'sr25519' });350    unused = keyring.addFromUri(`//${randomSeed}`);351    bal = new BigNumber((await api.query.system.account(unused.address)).data.free.toString());352  } while (bal.toFixed() != '0');353  return unused;354}355356export async function getAllowance(collectionId: number, tokenId: number, owner: string, approved: string) {357  return await usingApi(async (api) => {358    const bn = await api.query.nft.allowances(collectionId, [tokenId, owner, approved]) as unknown as BN;359    return BigInt(bn.toString());360  });361}362363export function findUnusedAddresses(api: ApiPromise, amount: number): Promise<IKeyringPair[]> {364  return Promise.all(new Array(amount).fill(null).map(() => findUnusedAddress(api, '_' + Date.now())));365}366367export async function findNotExistingCollection(api: ApiPromise): Promise<number> {368  const totalNumber = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10) as unknown as number;369  const newCollection: number = totalNumber + 1;370  return newCollection;371}372373function getDestroyResult(events: EventRecord[]): boolean {374  let success = false;375  events.forEach(({ event: { method } }) => {376    if (method == 'ExtrinsicSuccess') {377      success = true;378    }379  });380  return success;381}382383export async function destroyCollectionExpectFailure(collectionId: number, senderSeed = '//Alice') {384  await usingApi(async (api) => {385    // Run the DestroyCollection transaction386    const alicePrivateKey = privateKey(senderSeed);387    const tx = api.tx.nft.destroyCollection(collectionId);388    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;389  });390}391392export async function destroyCollectionExpectSuccess(collectionId: number, senderSeed = '//Alice') {393  await usingApi(async (api) => {394    // Run the DestroyCollection transaction395    const alicePrivateKey = privateKey(senderSeed);396    const tx = api.tx.nft.destroyCollection(collectionId);397    const events = await submitTransactionAsync(alicePrivateKey, tx);398    const result = getDestroyResult(events);399400    // Get the collection401    const collection: any = (await api.query.nft.collectionById(collectionId)).toJSON();402403    // What to expect404    expect(result).to.be.true;405    expect(collection).to.be.null;406  });407}408409export async function queryCollectionLimits(collectionId: number) {410  return await usingApi(async (api) => {411    return ((await api.query.nft.collectionById(collectionId)).toJSON() as any).Limits;412  });413}414415export async function setCollectionLimitsExpectSuccess(sender: IKeyringPair, collectionId: number, limits: any) {416  await usingApi(async (api) => {417    const oldLimits = await queryCollectionLimits(collectionId);418    const newLimits = { ...oldLimits as any, ...limits };419    const tx = api.tx.nft.setCollectionLimits(collectionId, newLimits);420    const events = await submitTransactionAsync(sender, tx);421    const result = getGenericResult(events);422423    expect(result.success).to.be.true;424  });425}426427export async function setCollectionLimitsExpectFailure(sender: IKeyringPair, collectionId: number, limits: any) {428  await usingApi(async (api) => {429    const oldLimits = await queryCollectionLimits(collectionId);430    const newLimits = { ...oldLimits as any, ...limits };431    const tx = api.tx.nft.setCollectionLimits(collectionId, newLimits);432    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;433    const result = getGenericResult(events);434435    expect(result.success).to.be.false;436  });437}438439export async function setCollectionSponsorExpectSuccess(collectionId: number, sponsor: string, sender = '//Alice') {440  await usingApi(async (api) => {441442    // Run the transaction443    const senderPrivateKey = privateKey(sender);444    const tx = api.tx.nft.setCollectionSponsor(collectionId, sponsor);445    const events = await submitTransactionAsync(senderPrivateKey, tx);446    const result = getGenericResult(events);447448    // Get the collection449    const collection: any = (await api.query.nft.collectionById(collectionId)).toJSON();450451    // What to expect452    expect(result.success).to.be.true;453    expect(collection.Sponsorship).to.deep.equal({454      unconfirmed: sponsor,455    });456  });457}458459export async function removeCollectionSponsorExpectSuccess(collectionId: number, sender = '//Alice') {460  await usingApi(async (api) => {461462    // Run the transaction463    const alicePrivateKey = privateKey(sender);464    const tx = api.tx.nft.removeCollectionSponsor(collectionId);465    const events = await submitTransactionAsync(alicePrivateKey, tx);466    const result = getGenericResult(events);467468    // Get the collection469    const collection: any = (await api.query.nft.collectionById(collectionId)).toJSON();470471    // What to expect472    expect(result.success).to.be.true;473    expect(collection.Sponsorship).to.be.deep.equal({ disabled: null });474  });475}476477export async function removeCollectionSponsorExpectFailure(collectionId: number, senderSeed = '//Alice') {478  await usingApi(async (api) => {479480    // Run the transaction481    const alicePrivateKey = privateKey(senderSeed);482    const tx = api.tx.nft.removeCollectionSponsor(collectionId);483    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;484  });485}486487export async function setCollectionSponsorExpectFailure(collectionId: number, sponsor: string, senderSeed = '//Alice') {488  await usingApi(async (api) => {489490    // Run the transaction491    const alicePrivateKey = privateKey(senderSeed);492    const tx = api.tx.nft.setCollectionSponsor(collectionId, sponsor);493    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;494  });495}496497export async function confirmSponsorshipExpectSuccess(collectionId: number, senderSeed = '//Alice') {498  await usingApi(async (api) => {499500    // Run the transaction501    const sender = privateKey(senderSeed);502    const tx = api.tx.nft.confirmSponsorship(collectionId);503    const events = await submitTransactionAsync(sender, tx);504    const result = getGenericResult(events);505506    // Get the collection507    const collection: any = (await api.query.nft.collectionById(collectionId)).toJSON();508509    // What to expect510    expect(result.success).to.be.true;511    expect(collection.Sponsorship).to.be.deep.equal({512      confirmed: sender.address,513    });514  });515}516517518export async function confirmSponsorshipExpectFailure(collectionId: number, senderSeed = '//Alice') {519  await usingApi(async (api) => {520521    // Run the transaction522    const sender = privateKey(senderSeed);523    const tx = api.tx.nft.confirmSponsorship(collectionId);524    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;525  });526}527528export async function setMetadataUpdatePermissionFlagExpectSuccess(sender: IKeyringPair, collectionId: number, flag: string) {529530  await usingApi(async (api) => {531    const tx = api.tx.nft.setMetaUpdatePermissionFlag(collectionId, flag); 532    const events = await submitTransactionAsync(sender, tx);533    const result = getGenericResult(events);534535    expect(result.success).to.be.true;536  }); 537}538539export async function setMetadataUpdatePermissionFlagExpectFailure(sender: IKeyringPair, collectionId: number, flag: string) {540541  await usingApi(async (api) => {542    const tx = api.tx.nft.setMetaUpdatePermissionFlag(collectionId, flag); 543    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;544    const result = getGenericResult(events);545546    expect(result.success).to.be.false;547  }); 548}549550export async function enableContractSponsoringExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {551  await usingApi(async (api) => {552    const tx = api.tx.nft.enableContractSponsoring(contractAddress, enable);553    const events = await submitTransactionAsync(sender, tx);554    const result = getGenericResult(events);555556    expect(result.success).to.be.true;557  });558}559560export async function enableContractSponsoringExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {561  await usingApi(async (api) => {562    const tx = api.tx.nft.enableContractSponsoring(contractAddress, enable);563    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;564    const result = getGenericResult(events);565566    expect(result.success).to.be.false;567  });568}569570export async function setTransferFlagExpectSuccess(sender: IKeyringPair, collectionId: number, enabled: boolean) {571572  await usingApi(async (api) => {573574    const tx = api.tx.nft.setTransfersEnabledFlag (collectionId, enabled);575    const events = await submitTransactionAsync(sender, tx);576    const result = getGenericResult(events);577578    expect(result.success).to.be.true;579  }); 580}581582export async function setTransferFlagExpectFailure(sender: IKeyringPair, collectionId: number, enabled: boolean) {583584  await usingApi(async (api) => {585586    const tx = api.tx.nft.setTransfersEnabledFlag (collectionId, enabled);587    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;588    const result = getGenericResult(events);589590    expect(result.success).to.be.false;591  }); 592}593594export async function setContractSponsoringRateLimitExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {595  await usingApi(async (api) => {596    const tx = api.tx.nft.setContractSponsoringRateLimit(contractAddress, rateLimit);597    const events = await submitTransactionAsync(sender, tx);598    const result = getGenericResult(events);599600    expect(result.success).to.be.true;601  });602}603604export async function setContractSponsoringRateLimitExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {605  await usingApi(async (api) => {606    const tx = api.tx.nft.setContractSponsoringRateLimit(contractAddress, rateLimit);607    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;608    const result = getGenericResult(events);609610    expect(result.success).to.be.false;611  });612}613614export async function toggleContractWhitelistExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, value = true) {615  await usingApi(async (api) => {616    const tx = api.tx.nft.toggleContractWhiteList(contractAddress, value);617    const events = await submitTransactionAsync(sender, tx);618    const result = getGenericResult(events);619620    expect(result.success).to.be.true;621  });622}623624export async function isWhitelistedInContract(contractAddress: AccountId | string, user: string) {625  let whitelisted = false;626  await usingApi(async (api) => {627    whitelisted = (await api.query.nft.contractWhiteList(contractAddress, user)).toJSON() as boolean;628  });629  return whitelisted;630}631632export async function addToContractWhiteListExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {633  await usingApi(async (api) => {634    const tx = api.tx.nft.addToContractWhiteList(contractAddress.toString(), user.toString());635    const events = await submitTransactionAsync(sender, tx);636    const result = getGenericResult(events);637638    expect(result.success).to.be.true;639  });640}641642export async function removeFromContractWhiteListExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {643  await usingApi(async (api) => {644    const tx = api.tx.nft.removeFromContractWhiteList(contractAddress.toString(), user.toString());645    const events = await submitTransactionAsync(sender, tx);646    const result = getGenericResult(events);647648    expect(result.success).to.be.true;649  });650}651652export async function removeFromContractWhiteListExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {653  await usingApi(async (api) => {654    const tx = api.tx.nft.removeFromContractWhiteList(contractAddress.toString(), user.toString());655    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;656    const result = getGenericResult(events);657658    expect(result.success).to.be.false;659  });660}661662export async function setVariableMetaDataExpectSuccess(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {663  await usingApi(async (api) => {664    const tx = api.tx.nft.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));665    const events = await submitTransactionAsync(sender, tx);666    const result = getGenericResult(events);667668    expect(result.success).to.be.true;669  });670}671672export async function setVariableMetaDataExpectFailure(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {673  await usingApi(async (api) => {674    const tx = api.tx.nft.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));675    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;676  });677}678679export async function setOffchainSchemaExpectSuccess(sender: IKeyringPair, collectionId: number, data: number[]) {680  await usingApi(async (api) => {681    const tx = api.tx.nft.setOffchainSchema(collectionId, '0x' + Buffer.from(data).toString('hex'));682    const events = await submitTransactionAsync(sender, tx);683    const result = getGenericResult(events);684685    expect(result.success).to.be.true;686  });687}688689export async function setOffchainSchemaExpectFailure(sender: IKeyringPair, collectionId: number, data: number[]) {690  await usingApi(async (api) => {691    const tx = api.tx.nft.setOffchainSchema(collectionId, '0x' + Buffer.from(data).toString('hex'));692    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;693  });694}695696export interface CreateFungibleData {697  readonly Value: bigint;698}699700export interface CreateReFungibleData { }701export interface CreateNftData { }702703export type CreateItemData = {704  NFT: CreateNftData;705} | {706  Fungible: CreateFungibleData;707} | {708  ReFungible: CreateReFungibleData;709};710711export async function burnItemExpectSuccess(owner: IKeyringPair, collectionId: number, tokenId: number, value = 0) {712  await usingApi(async (api) => {713    const tx = api.tx.nft.burnItem(collectionId, tokenId, value);714    const events = await submitTransactionAsync(owner, tx);715    const result = getGenericResult(events);716    // Get the item717    const item: any = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON();718    // What to expect719    // tslint:disable-next-line:no-unused-expression720    expect(result.success).to.be.true;721    // tslint:disable-next-line:no-unused-expression722    expect(item).to.be.null;723  });724}725726export async function727approveExpectSuccess(728  collectionId: number,729  tokenId: number, owner: IKeyringPair, approved: IKeyringPair | CrossAccountId | string, amount: number | bigint = 1,730) {731  await usingApi(async (api: ApiPromise) => {732    approved = normalizeAccountId(approved);733    const allowanceBefore =734      await api.query.nft.allowances(collectionId, [tokenId, owner.address, toSubstrateAddress(approved)]) as unknown as BN;735    const approveNftTx = api.tx.nft.approve(approved, collectionId, tokenId, amount);736    const events = await submitTransactionAsync(owner, approveNftTx);737    const result = getCreateItemResult(events);738    // tslint:disable-next-line:no-unused-expression739    expect(result.success).to.be.true;740    const allowanceAfter =741      await api.query.nft.allowances(collectionId, [tokenId, owner.address, toSubstrateAddress(approved)]) as unknown as BN;742    expect(allowanceAfter.sub(allowanceBefore).toString()).to.be.equal(amount.toString());743  });744}745746export async function747transferFromExpectSuccess(748  collectionId: number,749  tokenId: number,750  accountApproved: IKeyringPair,751  accountFrom: IKeyringPair | CrossAccountId,752  accountTo: IKeyringPair | CrossAccountId,753  value: number | bigint = 1,754  type = 'NFT',755) {756  await usingApi(async (api: ApiPromise) => {757    const to = normalizeAccountId(accountTo);758    let balanceBefore = new BN(0);759    if (type === 'Fungible') {760      balanceBefore = await api.query.nft.balance(collectionId, toSubstrateAddress(to)) as unknown as BN;761    }762    const transferFromTx = api.tx.nft.transferFrom(normalizeAccountId(accountFrom), to, collectionId, tokenId, value);763    const events = await submitTransactionAsync(accountApproved, transferFromTx);764    const result = getCreateItemResult(events);765    // tslint:disable-next-line:no-unused-expression766    expect(result.success).to.be.true;767    if (type === 'NFT') {768      const nftItemData = (await api.query.nft.nftItemList(collectionId, tokenId) as any).toJSON() as ITokenDataType;769      expect(nftItemData.Owner).to.be.deep.equal(to);770    }771    if (type === 'Fungible') {772      const balanceAfter = (await api.query.nft.fungibleItemList(collectionId, toSubstrateAddress(to)) as any).Value as unknown as BN;773      expect(balanceAfter.sub(balanceBefore).toString()).to.be.equal(value.toString());774    }775    if (type === 'ReFungible') {776      const nftItemData =777        (await api.query.nft.reFungibleItemList(collectionId, tokenId) as any).toJSON() as IReFungibleTokenDataType;778      expect(nftItemData.Owner[0].Owner).to.be.deep.equal(normalizeAccountId(to));779      expect(nftItemData.Owner[0].Fraction).to.be.equal(value);780    }781  });782}783784export async function785transferFromExpectFail(786  collectionId: number,787  tokenId: number,788  accountApproved: IKeyringPair,789  accountFrom: IKeyringPair,790  accountTo: IKeyringPair,791  value: number | bigint = 1,792) {793  await usingApi(async (api: ApiPromise) => {794    const transferFromTx = api.tx.nft.transferFrom(normalizeAccountId(accountFrom.address), normalizeAccountId(accountTo.address), collectionId, tokenId, value);795    const events = await expect(submitTransactionExpectFailAsync(accountApproved, transferFromTx)).to.be.rejected;796    const result = getCreateCollectionResult(events);797    // tslint:disable-next-line:no-unused-expression798    expect(result.success).to.be.false;799  });800}801802/* eslint no-async-promise-executor: "off" */803async function getBlockNumber(api: ApiPromise): Promise<number> {804  return new Promise<number>(async (resolve) => {805    const unsubscribe = await api.rpc.chain.subscribeNewHeads((head) => {806      unsubscribe();807      resolve(head.number.toNumber());808    });809  });810}811812export async function addCollectionAdminExpectSuccess(sender: IKeyringPair, collectionId: number, address: IKeyringPair) {813  await usingApi(async (api) => {814    const changeAdminTx = api.tx.nft.addCollectionAdmin(collectionId, normalizeAccountId(address.address));815    const events = await submitTransactionAsync(sender, changeAdminTx);816    const result = getCreateCollectionResult(events);817    expect(result.success).to.be.true;818  });819}820821export async function822scheduleTransferExpectSuccess(823  collectionId: number,824  tokenId: number,825  sender: IKeyringPair,826  recipient: IKeyringPair,827  value: number | bigint = 1,828  blockTimeMs: number,829  blockSchedule: number,830) {831  await usingApi(async (api: ApiPromise) => {832    const blockNumber: number | undefined = await getBlockNumber(api);833    const expectedBlockNumber = blockNumber + blockSchedule;834835    expect(blockNumber).to.be.greaterThan(0);836    const transferTx = await api.tx.nft.transfer(normalizeAccountId(recipient.address), collectionId, tokenId, value); 837    const scheduleTx = await api.tx.scheduler.schedule(expectedBlockNumber, null, 0, transferTx);838839    await submitTransactionAsync(sender, scheduleTx);840841    const recipientBalanceBefore = new BigNumber((await api.query.system.account(recipient.address)).data.free.toString());842843    const nftItemDataBefore = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON() as any as ITokenDataType;844    expect(toSubstrateAddress(nftItemDataBefore.Owner)).to.be.equal(sender.address);845846    // sleep for 4 blocks847    await new Promise(resolve => setTimeout(resolve, blockTimeMs * (blockSchedule + 1)));848849    const recipientBalanceAfter = new BigNumber((await api.query.system.account(recipient.address)).data.free.toString());850851    const nftItemData = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON() as unknown as ITokenDataType;852    expect(toSubstrateAddress(nftItemData.Owner)).to.be.equal(recipient.address);853    expect(recipientBalanceAfter.toNumber()).to.be.equal(recipientBalanceBefore.toNumber());854  });855}856857858export async function859transferExpectSuccess(860  collectionId: number,861  tokenId: number,862  sender: IKeyringPair,863  recipient: IKeyringPair | CrossAccountId,864  value: number | bigint = 1,865  type = 'NFT',866) {867  await usingApi(async (api: ApiPromise) => {868    const to = normalizeAccountId(recipient);869870    let balanceBefore = new BN(0);871    if (type === 'Fungible') {872      balanceBefore = await api.query.nft.balance(collectionId, toSubstrateAddress(to)) as unknown as BN;873    }874    const transferTx = api.tx.nft.transfer(to, collectionId, tokenId, value);875    const events = await submitTransactionAsync(sender, transferTx);876    const result = getTransferResult(events);877    // tslint:disable-next-line:no-unused-expression878    expect(result.success).to.be.true;879    expect(result.collectionId).to.be.equal(collectionId);880    expect(result.itemId).to.be.equal(tokenId);881    expect(result.sender).to.be.deep.equal(normalizeAccountId(sender.address));882    expect(result.recipient).to.be.deep.equal(to);883    expect(result.value.toString()).to.be.equal(value.toString());884    if (type === 'NFT') {885      const nftItemData = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON() as unknown as ITokenDataType;886      expect(nftItemData.Owner).to.be.deep.equal(to);887    }888    if (type === 'Fungible') {889      const balanceAfter = (await api.query.nft.fungibleItemList(collectionId, toSubstrateAddress(to)) as any).Value as unknown as BN;890      expect(balanceAfter.sub(balanceBefore).toString()).to.be.equal(value.toString());891    }892    if (type === 'ReFungible') {893      const nftItemData =894        (await api.query.nft.reFungibleItemList(collectionId, tokenId)).toJSON() as unknown as IReFungibleTokenDataType;895      expect(nftItemData.Owner[0].Owner).to.be.deep.equal(to);896      expect(nftItemData.Owner[0].Fraction.toString()).to.be.equal(value.toString());897    }898  });899}900901export async function902transferExpectFailure(903  collectionId: number,904  tokenId: number,905  sender: IKeyringPair,906  recipient: IKeyringPair,907  value: number | bigint = 1,908) {909  await usingApi(async (api: ApiPromise) => {910    const transferTx = api.tx.nft.transfer(normalizeAccountId(recipient.address), collectionId, tokenId, value);911    const events = await expect(submitTransactionExpectFailAsync(sender, transferTx)).to.be.rejected;912    if (events && Array.isArray(events)) {913      const result = getCreateCollectionResult(events);914      // tslint:disable-next-line:no-unused-expression915      expect(result.success).to.be.false;916    }917  });918}919920export async function921approveExpectFail(922  collectionId: number,923  tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number | bigint = 1,924) {925  await usingApi(async (api: ApiPromise) => {926    const approveNftTx = api.tx.nft.approve(normalizeAccountId(approved.address), collectionId, tokenId, amount);927    const events = await expect(submitTransactionExpectFailAsync(owner, approveNftTx)).to.be.rejected;928    const result = getCreateCollectionResult(events);929    // tslint:disable-next-line:no-unused-expression930    expect(result.success).to.be.false;931  });932}933934export async function getFungibleBalance(935  collectionId: number,936  owner: string,937) {938  return await usingApi(async (api) => {939    const response = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON() as unknown as { Value: string };940    return BigInt(response.Value);941  });942}943944export async function createFungibleItemExpectSuccess(945  sender: IKeyringPair,946  collectionId: number,947  data: CreateFungibleData,948  owner: CrossAccountId | string = sender.address,949) {950  return await usingApi(async (api) => {951    const tx = api.tx.nft.createItem(collectionId, normalizeAccountId(owner), { Fungible: data });952953    const events = await submitTransactionAsync(sender, tx);954    const result = getCreateItemResult(events);955956    expect(result.success).to.be.true;957    return result.itemId;958  });959}960961export async function createItemExpectSuccess(sender: IKeyringPair, collectionId: number, createMode: string, owner: CrossAccountId | string = sender.address) {962  let newItemId = 0;963  await usingApi(async (api) => {964    const to = normalizeAccountId(owner);965    const AItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString(), 10);966    const Aitem: any = (await api.query.nft.fungibleItemList(collectionId, toSubstrateAddress(to))).toJSON();967    const AItemBalance = new BigNumber(Aitem.Value);968969    let tx;970    if (createMode === 'Fungible') {971      const createData = { fungible: { value: 10 } };972      tx = api.tx.nft.createItem(collectionId, to, createData);973    } else if (createMode === 'ReFungible') {974      const createData = { refungible: { const_data: [], variable_data: [], pieces: 100 } };975      tx = api.tx.nft.createItem(collectionId, to, createData);976    } else {977      const createData = { nft: { const_data: [], variable_data: [] } };978      tx = api.tx.nft.createItem(collectionId, to, createData);979    }980981    const events = await submitTransactionAsync(sender, tx);982    const result = getCreateItemResult(events);983984    const BItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString(), 10);985    const Bitem: any = (await api.query.nft.fungibleItemList(collectionId, toSubstrateAddress(to))).toJSON();986    const BItemBalance = new BigNumber(Bitem.Value);987988    // What to expect989    // tslint:disable-next-line:no-unused-expression990    expect(result.success).to.be.true;991    if (createMode === 'Fungible') {992      expect(BItemBalance.minus(AItemBalance).toNumber()).to.be.equal(10);993    } else {994      expect(BItemCount).to.be.equal(AItemCount + 1);995    }996    expect(collectionId).to.be.equal(result.collectionId);997    expect(BItemCount.toString()).to.be.equal(result.itemId.toString());998    expect(to).to.be.deep.equal(result.recipient);999    newItemId = result.itemId;1000  });1001  return newItemId;1002}10031004export async function createItemExpectFailure(sender: IKeyringPair, collectionId: number, createMode: string, owner: string = sender.address) {1005  await usingApi(async (api) => {1006    const tx = api.tx.nft.createItem(collectionId, normalizeAccountId(owner), createMode);1007    1008    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1009    const result = getCreateItemResult(events);10101011    expect(result.success).to.be.false;1012  });1013}10141015export async function setPublicAccessModeExpectSuccess(1016  sender: IKeyringPair, collectionId: number,1017  accessMode: 'Normal' | 'WhiteList',1018) {1019  await usingApi(async (api) => {10201021    // Run the transaction1022    const tx = api.tx.nft.setPublicAccessMode(collectionId, accessMode);1023    const events = await submitTransactionAsync(sender, tx);1024    const result = getGenericResult(events);10251026    // Get the collection1027    const collection: any = (await api.query.nft.collectionById(collectionId)).toJSON();10281029    // What to expect1030    // tslint:disable-next-line:no-unused-expression1031    expect(result.success).to.be.true;1032    expect(collection.Access).to.be.equal(accessMode);1033  });1034}10351036export async function setPublicAccessModeExpectFail(1037  sender: IKeyringPair, collectionId: number,1038  accessMode: 'Normal' | 'WhiteList',1039) {1040  await usingApi(async (api) => {10411042    // Run the transaction1043    const tx = api.tx.nft.setPublicAccessMode(collectionId, accessMode);1044    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1045    const result = getGenericResult(events);10461047    // What to expect1048    // tslint:disable-next-line:no-unused-expression1049    expect(result.success).to.be.false;1050  });1051}10521053export async function enableWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number) {1054  await setPublicAccessModeExpectSuccess(sender, collectionId, 'WhiteList');1055}10561057export async function enableWhiteListExpectFail(sender: IKeyringPair, collectionId: number) {1058  await setPublicAccessModeExpectFail(sender, collectionId, 'WhiteList');1059}10601061export async function disableWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number) {1062  await setPublicAccessModeExpectSuccess(sender, collectionId, 'Normal');1063}10641065export async function setMintPermissionExpectSuccess(sender: IKeyringPair, collectionId: number, enabled: boolean) {1066  await usingApi(async (api) => {10671068    // Run the transaction1069    const tx = api.tx.nft.setMintPermission(collectionId, enabled);1070    const events = await submitTransactionAsync(sender, tx);1071    const result = getGenericResult(events);10721073    // Get the collection1074    const collection: any = (await api.query.nft.collectionById(collectionId)).toJSON();10751076    // What to expect1077    // tslint:disable-next-line:no-unused-expression1078    expect(result.success).to.be.true;1079    expect(collection.MintMode).to.be.equal(enabled);1080  });1081}10821083export async function enablePublicMintingExpectSuccess(sender: IKeyringPair, collectionId: number) {1084  await setMintPermissionExpectSuccess(sender, collectionId, true);1085}10861087export async function setMintPermissionExpectFailure(sender: IKeyringPair, collectionId: number, enabled: boolean) {1088  await usingApi(async (api) => {1089    // Run the transaction1090    const tx = api.tx.nft.setMintPermission(collectionId, enabled);1091    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1092    const result = getCreateCollectionResult(events);1093    // tslint:disable-next-line:no-unused-expression1094    expect(result.success).to.be.false;1095  });1096}10971098export async function setChainLimitsExpectFailure(sender: IKeyringPair, limits: IChainLimits) {1099  await usingApi(async (api) => {1100    // Run the transaction1101    const tx = api.tx.nft.setChainLimits(limits);1102    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1103    const result = getCreateCollectionResult(events);1104    // tslint:disable-next-line:no-unused-expression1105    expect(result.success).to.be.false;1106  });1107}11081109export async function isWhitelisted(collectionId: number, address: string) {1110  let whitelisted = false;1111  await usingApi(async (api) => {1112    whitelisted = (await api.query.nft.whiteList(collectionId, address)).toJSON() as unknown as boolean;1113  });1114  return whitelisted;1115}11161117export async function addToWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number, address: string | AccountId) {1118  await usingApi(async (api) => {11191120    const whiteListedBefore = (await api.query.nft.whiteList(collectionId, address)).toJSON();11211122    // Run the transaction1123    const tx = api.tx.nft.addToWhiteList(collectionId, normalizeAccountId(address));1124    const events = await submitTransactionAsync(sender, tx);1125    const result = getGenericResult(events);11261127    const whiteListedAfter = (await api.query.nft.whiteList(collectionId, address)).toJSON();11281129    // What to expect1130    // tslint:disable-next-line:no-unused-expression1131    expect(result.success).to.be.true;1132    // tslint:disable-next-line: no-unused-expression1133    expect(whiteListedBefore).to.be.false;1134    // tslint:disable-next-line: no-unused-expression1135    expect(whiteListedAfter).to.be.true;1136  });1137}11381139export async function addToWhiteListExpectFail(sender: IKeyringPair, collectionId: number, address: string | AccountId) {1140  await usingApi(async (api) => {1141    // Run the transaction1142    const tx = api.tx.nft.addToWhiteList(collectionId, normalizeAccountId(address));1143    const events = await expect(submitTransactionAsync(sender, tx)).to.be.rejected;1144    const result = getGenericResult(events);11451146    // What to expect1147    // tslint:disable-next-line:no-unused-expression1148    expect(result.success).to.be.false;1149  });1150}11511152export async function removeFromWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number, address: CrossAccountId) {1153  await usingApi(async (api) => {1154    // Run the transaction1155    const tx = api.tx.nft.removeFromWhiteList(collectionId, normalizeAccountId(address));1156    const events = await submitTransactionAsync(sender, tx);1157    const result = getGenericResult(events);11581159    // What to expect1160    // tslint:disable-next-line:no-unused-expression1161    expect(result.success).to.be.true;1162  });1163}11641165export async function removeFromWhiteListExpectFailure(sender: IKeyringPair, collectionId: number, address: CrossAccountId) {1166  await usingApi(async (api) => {1167    // Run the transaction1168    const tx = api.tx.nft.removeFromWhiteList(collectionId, normalizeAccountId(address));1169    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1170    const result = getGenericResult(events);11711172    // What to expect1173    // tslint:disable-next-line:no-unused-expression1174    expect(result.success).to.be.false;1175  });1176}11771178export const getDetailedCollectionInfo = async (api: ApiPromise, collectionId: number)1179  : Promise<ICollectionInterface | null> => {1180  return (await api.query.nft.collectionById(collectionId)).toJSON() as unknown as ICollectionInterface;1181};11821183export const getCreatedCollectionCount = async (api: ApiPromise): Promise<number> => {1184  // set global object - collectionsCount1185  return (await api.query.nft.createdCollectionCount() as unknown as BN).toNumber();1186};11871188export async function queryCollectionExpectSuccess(collectionId: number): Promise<ICollectionInterface> {1189  return await usingApi(async (api) => {1190    return (await api.query.nft.collectionById(collectionId)).toJSON() as unknown as ICollectionInterface;1191  });1192}11931194export async function queryNftOwner(api: ApiPromise, collectionId: number, tokenId: number): Promise<CrossAccountId> {1195  return normalizeAccountId((await api.query.nft.nftItemList(collectionId, tokenId) as any).toJSON().Owner);1196}11971198export async function waitNewBlocks(blocksCount = 1): Promise<void> {1199  await usingApi(async (api) => {1200    const promise = new Promise<void>(async (resolve) => {12011202      const unsubscribe = await api.rpc.chain.subscribeNewHeads(() => {1203        if (blocksCount > 0) {1204          blocksCount--;1205        } else {1206          unsubscribe();1207          resolve();1208        }1209      });1210    });1211    return promise;1212  });1213}