git.delta.rocks / unique-network / refs/commits / 23e7e864f113

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} from '@polkadot/types/interfaces';21import {IKeyringPair} from '@polkadot/types/types';22import {evmToAddress} from '@polkadot/util-crypto';23import BN from 'bn.js';24import chai from 'chai';25import chaiAsPromised from 'chai-as-promised';26import {alicesPublicKey} from '../accounts';27import privateKey from '../substrate/privateKey';28import {default as usingApi, submitTransactionAsync, submitTransactionExpectFailAsync} from '../substrate/substrate-api';29import {hexToStr, strToUTF16, utf16ToStr} from './util';30import {UpDataStructsCollection} from '@polkadot/types/lookup';3132chai.use(chaiAsPromised);33const expect = chai.expect;3435export type CrossAccountId = {36  Substrate: string,37} | {38  Ethereum: string,39};4041export function normalizeAccountId(input: string | AccountId | CrossAccountId | IKeyringPair): CrossAccountId {42  if (typeof input === 'string') {43    if (input.length === 48 || input.length === 47) {44      return {Substrate: input};45    } else if (input.length === 42 && input.startsWith('0x')) {46      return {Ethereum: input.toLowerCase()};47    } else if (input.length === 40 && !input.startsWith('0x')) {48      return {Ethereum: '0x' + input.toLowerCase()};49    } else {50      throw new Error(`Unknown address format: "${input}"`);51    }52  }53  if ('address' in input) {54    return {Substrate: input.address};55  }56  if ('Ethereum' in input) {57    return {58      Ethereum: input.Ethereum.toLowerCase(),59    };60  } else if ('ethereum' in input) {61    return {62      Ethereum: (input as any).ethereum.toLowerCase(),63    };64  } else if ('Substrate' in input) {65    return input;66  } else if ('substrate' in input) {67    return {68      Substrate: (input as any).substrate,69    };70  }7172  // AccountId73  return {Substrate: input.toString()};74}75export function toSubstrateAddress(input: string | CrossAccountId | IKeyringPair): string {76  input = normalizeAccountId(input);77  if ('Substrate' in input) {78    return input.Substrate;79  } else {80    return evmToAddress(input.Ethereum);81  }82}8384export const U128_MAX = (1n << 128n) - 1n;8586const MICROUNIQUE = 1_000_000_000_000n;87const MILLIUNIQUE = 1_000n * MICROUNIQUE;88const CENTIUNIQUE = 10n * MILLIUNIQUE;89export const UNIQUE = 100n * CENTIUNIQUE;9091type GenericResult = {92  success: boolean,93};9495interface CreateCollectionResult {96  success: boolean;97  collectionId: number;98}99100interface CreateItemResult {101  success: boolean;102  collectionId: number;103  itemId: number;104  recipient?: CrossAccountId;105}106107interface TransferResult {108  success: boolean;109  collectionId: number;110  itemId: number;111  sender?: CrossAccountId;112  recipient?: CrossAccountId;113  value: bigint;114}115116interface IReFungibleOwner {117  fraction: BN;118  owner: number[];119}120121interface IGetMessage {122  checkMsgUnqMethod: string;123  checkMsgTrsMethod: string;124  checkMsgSysMethod: string;125}126127export interface IFungibleTokenDataType {128  value: number;129}130131export interface IChainLimits {132  collectionNumbersLimit: number;133  accountTokenOwnershipLimit: number;134  collectionsAdminsLimit: number;135  customDataLimit: number;136  nftSponsorTransferTimeout: number;137  fungibleSponsorTransferTimeout: number;138  refungibleSponsorTransferTimeout: number;139  offchainSchemaLimit: number;140  variableOnChainSchemaLimit: number;141  constOnChainSchemaLimit: number;142}143144export interface IReFungibleTokenDataType {145  owner: IReFungibleOwner[];146  constData: number[];147  variableData: number[];148}149150export function uniqueEventMessage(events: EventRecord[]): IGetMessage {151  let checkMsgUnqMethod = '';152  let checkMsgTrsMethod = '';153  let checkMsgSysMethod = '';154  events.forEach(({event: {method, section}}) => {155    if (section === 'common') {156      checkMsgUnqMethod = method;157    } else if (section === 'treasury') {158      checkMsgTrsMethod = method;159    } else if (section === 'system') {160      checkMsgSysMethod = method;161    } else { return null; }162  });163  const result: IGetMessage = {164    checkMsgUnqMethod,165    checkMsgTrsMethod,166    checkMsgSysMethod,167  };168  return result;169}170171export function getGenericResult(events: EventRecord[]): GenericResult {172  const result: GenericResult = {173    success: false,174  };175  events.forEach(({event: {method}}) => {176    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);177    if (method === 'ExtrinsicSuccess') {178      result.success = true;179    }180  });181  return result;182}183184185186export function getCreateCollectionResult(events: EventRecord[]): CreateCollectionResult {187  let success = false;188  let collectionId = 0;189  events.forEach(({event: {data, method, section}}) => {190    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);191    if (method == 'ExtrinsicSuccess') {192      success = true;193    } else if ((section == 'common') && (method == 'CollectionCreated')) {194      collectionId = parseInt(data[0].toString(), 10);195    }196  });197  const result: CreateCollectionResult = {198    success,199    collectionId,200  };201  return result;202}203204export function getCreateItemResult(events: EventRecord[]): CreateItemResult {205  let success = false;206  let collectionId = 0;207  let itemId = 0;208  let recipient;209  events.forEach(({event: {data, method, section}}) => {210    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);211    if (method == 'ExtrinsicSuccess') {212      success = true;213    } else if ((section == 'common') && (method == 'ItemCreated')) {214      collectionId = parseInt(data[0].toString(), 10);215      itemId = parseInt(data[1].toString(), 10);216      recipient = normalizeAccountId(data[2].toJSON() as any);217    }218  });219  const result: CreateItemResult = {220    success,221    collectionId,222    itemId,223    recipient,224  };225  return result;226}227228export function getTransferResult(events: EventRecord[]): TransferResult {229  const result: TransferResult = {230    success: false,231    collectionId: 0,232    itemId: 0,233    value: 0n,234  };235236  events.forEach(({event: {data, method, section}}) => {237    if (method === 'ExtrinsicSuccess') {238      result.success = true;239    } else if (section === 'common' && method === 'Transfer') {240      result.collectionId = +data[0].toString();241      result.itemId = +data[1].toString();242      result.sender = normalizeAccountId(data[2].toJSON() as any);243      result.recipient = normalizeAccountId(data[3].toJSON() as any);244      result.value = BigInt(data[4].toString());245    }246  });247248  return result;249}250251interface Nft {252  type: 'NFT';253}254255interface Fungible {256  type: 'Fungible';257  decimalPoints: number;258}259260interface ReFungible {261  type: 'ReFungible';262}263264type CollectionMode = Nft | Fungible | ReFungible;265266export type CreateCollectionParams = {267  mode: CollectionMode,268  name: string,269  description: string,270  tokenPrefix: string,271};272273const defaultCreateCollectionParams: CreateCollectionParams = {274  description: 'description',275  mode: {type: 'NFT'},276  name: 'name',277  tokenPrefix: 'prefix',278};279280export async function createCollectionExpectSuccess(params: Partial<CreateCollectionParams> = {}): Promise<number> {281  const {name, description, mode, tokenPrefix} = {...defaultCreateCollectionParams, ...params};282283  let collectionId = 0;284  await usingApi(async (api) => {285    // Get number of collections before the transaction286    const collectionCountBefore = await getCreatedCollectionCount(api);287288    // Run the CreateCollection transaction289    const alicePrivateKey = privateKey('//Alice');290291    let modeprm = {};292    if (mode.type === 'NFT') {293      modeprm = {nft: null};294    } else if (mode.type === 'Fungible') {295      modeprm = {fungible: mode.decimalPoints};296    } else if (mode.type === 'ReFungible') {297      modeprm = {refungible: null};298    }299300    const tx = api.tx.unique.createCollectionEx({name: strToUTF16(name), description: strToUTF16(description), tokenPrefix: strToUTF16(tokenPrefix), mode: modeprm as any});301    const events = await submitTransactionAsync(alicePrivateKey, tx);302    const result = getCreateCollectionResult(events);303304    // Get number of collections after the transaction305    const collectionCountAfter = await getCreatedCollectionCount(api);306307    // Get the collection308    const collection = await queryCollectionExpectSuccess(api, result.collectionId);309310    // What to expect311    // tslint:disable-next-line:no-unused-expression312    expect(result.success).to.be.true;313    expect(result.collectionId).to.be.equal(collectionCountAfter);314    // tslint:disable-next-line:no-unused-expression315    expect(collection).to.be.not.null;316    expect(collectionCountAfter).to.be.equal(collectionCountBefore + 1, 'Error: NFT collection NOT created.');317    expect(collection.owner.toString()).to.be.equal(toSubstrateAddress(alicesPublicKey));318    expect(utf16ToStr(collection.name.toJSON() as any)).to.be.equal(name);319    expect(utf16ToStr(collection.description.toJSON() as any)).to.be.equal(description);320    expect(hexToStr(collection.tokenPrefix.toJSON())).to.be.equal(tokenPrefix);321322    collectionId = result.collectionId;323  });324325  return collectionId;326}327328export async function createCollectionExpectFailure(params: Partial<CreateCollectionParams> = {}) {329  const {name, description, mode, tokenPrefix} = {...defaultCreateCollectionParams, ...params};330331  let modeprm = {};332  if (mode.type === 'NFT') {333    modeprm = {nft: null};334  } else if (mode.type === 'Fungible') {335    modeprm = {fungible: mode.decimalPoints};336  } else if (mode.type === 'ReFungible') {337    modeprm = {refungible: null};338  }339340  await usingApi(async (api) => {341    // Get number of collections before the transaction342    const collectionCountBefore = await getCreatedCollectionCount(api);343344    // Run the CreateCollection transaction345    const alicePrivateKey = privateKey('//Alice');346    const tx = api.tx.unique.createCollectionEx({name: strToUTF16(name), description: strToUTF16(description), tokenPrefix: strToUTF16(tokenPrefix), mode: modeprm as any});347    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;348349    // Get number of collections after the transaction350    const collectionCountAfter = await getCreatedCollectionCount(api);351352    // What to expect353    expect(collectionCountAfter).to.be.equal(collectionCountBefore, 'Error: Collection with incorrect data created.');354  });355}356357export async function findUnusedAddress(api: ApiPromise, seedAddition = ''): Promise<IKeyringPair> {358  let bal = 0n;359  let unused;360  do {361    const randomSeed = 'seed' + Math.floor(Math.random() * Math.floor(10000)) + seedAddition;362    const keyring = new Keyring({type: 'sr25519'});363    unused = keyring.addFromUri(`//${randomSeed}`);364    bal = (await api.query.system.account(unused.address)).data.free.toBigInt();365  } while (bal !== 0n);366  return unused;367}368369export async function getAllowance(api: ApiPromise, collectionId: number, owner: CrossAccountId | string, approved: CrossAccountId | string, tokenId: number) {370  return (await api.rpc.unique.allowance(collectionId, normalizeAccountId(owner), normalizeAccountId(approved), tokenId)).toBigInt();371}372373export function findUnusedAddresses(api: ApiPromise, amount: number): Promise<IKeyringPair[]> {374  return Promise.all(new Array(amount).fill(null).map(() => findUnusedAddress(api, '_' + Date.now())));375}376377export async function findNotExistingCollection(api: ApiPromise): Promise<number> {378  const totalNumber = await getCreatedCollectionCount(api);379  const newCollection: number = totalNumber + 1;380  return newCollection;381}382383function getDestroyResult(events: EventRecord[]): boolean {384  let success = false;385  events.forEach(({event: {method}}) => {386    if (method == 'ExtrinsicSuccess') {387      success = true;388    }389  });390  return success;391}392393export async function destroyCollectionExpectFailure(collectionId: number, senderSeed = '//Alice') {394  await usingApi(async (api) => {395    // Run the DestroyCollection transaction396    const alicePrivateKey = privateKey(senderSeed);397    const tx = api.tx.unique.destroyCollection(collectionId);398    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;399  });400}401402export async function destroyCollectionExpectSuccess(collectionId: number, senderSeed = '//Alice') {403  await usingApi(async (api) => {404    // Run the DestroyCollection transaction405    const alicePrivateKey = privateKey(senderSeed);406    const tx = api.tx.unique.destroyCollection(collectionId);407    const events = await submitTransactionAsync(alicePrivateKey, tx);408    const result = getDestroyResult(events);409    expect(result).to.be.true;410411    // What to expect412    expect(await getDetailedCollectionInfo(api, collectionId)).to.be.null;413  });414}415416export async function setCollectionLimitsExpectSuccess(sender: IKeyringPair, collectionId: number, limits: any) {417  await usingApi(async (api) => {418    const tx = api.tx.unique.setCollectionLimits(collectionId, limits);419    const events = await submitTransactionAsync(sender, tx);420    const result = getGenericResult(events);421422    expect(result.success).to.be.true;423  });424}425426export async function setCollectionLimitsExpectFailure(sender: IKeyringPair, collectionId: number, limits: any) {427  await usingApi(async (api) => {428    const tx = api.tx.unique.setCollectionLimits(collectionId, limits);429    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;430    const result = getGenericResult(events);431432    expect(result.success).to.be.false;433  });434}435436export async function setCollectionSponsorExpectSuccess(collectionId: number, sponsor: string, sender = '//Alice') {437  await usingApi(async (api) => {438439    // Run the transaction440    const senderPrivateKey = privateKey(sender);441    const tx = api.tx.unique.setCollectionSponsor(collectionId, sponsor);442    const events = await submitTransactionAsync(senderPrivateKey, tx);443    const result = getGenericResult(events);444445    // Get the collection446    const collection = await queryCollectionExpectSuccess(api, collectionId);447448    // What to expect449    expect(result.success).to.be.true;450    expect(collection.sponsorship.toJSON()).to.deep.equal({451      unconfirmed: sponsor,452    });453  });454}455456export async function removeCollectionSponsorExpectSuccess(collectionId: number, sender = '//Alice') {457  await usingApi(async (api) => {458459    // Run the transaction460    const alicePrivateKey = privateKey(sender);461    const tx = api.tx.unique.removeCollectionSponsor(collectionId);462    const events = await submitTransactionAsync(alicePrivateKey, tx);463    const result = getGenericResult(events);464465    // Get the collection466    const collection = await queryCollectionExpectSuccess(api, collectionId);467468    // What to expect469    expect(result.success).to.be.true;470    expect(collection.sponsorship.toJSON()).to.be.deep.equal({disabled: null});471  });472}473474export async function removeCollectionSponsorExpectFailure(collectionId: number, senderSeed = '//Alice') {475  await usingApi(async (api) => {476477    // Run the transaction478    const alicePrivateKey = privateKey(senderSeed);479    const tx = api.tx.unique.removeCollectionSponsor(collectionId);480    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;481  });482}483484export async function setCollectionSponsorExpectFailure(collectionId: number, sponsor: string, senderSeed = '//Alice') {485  await usingApi(async (api) => {486487    // Run the transaction488    const alicePrivateKey = privateKey(senderSeed);489    const tx = api.tx.unique.setCollectionSponsor(collectionId, sponsor);490    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;491  });492}493494export async function confirmSponsorshipExpectSuccess(collectionId: number, senderSeed = '//Alice') {495  await usingApi(async (api) => {496497    // Run the transaction498    const sender = privateKey(senderSeed);499    const tx = api.tx.unique.confirmSponsorship(collectionId);500    const events = await submitTransactionAsync(sender, tx);501    const result = getGenericResult(events);502503    // Get the collection504    const collection = await queryCollectionExpectSuccess(api, collectionId);505506    // What to expect507    expect(result.success).to.be.true;508    expect(collection.sponsorship.toJSON()).to.be.deep.equal({509      confirmed: sender.address,510    });511  });512}513514515export async function confirmSponsorshipExpectFailure(collectionId: number, senderSeed = '//Alice') {516  await usingApi(async (api) => {517518    // Run the transaction519    const sender = privateKey(senderSeed);520    const tx = api.tx.unique.confirmSponsorship(collectionId);521    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;522  });523}524525export async function setMetadataUpdatePermissionFlagExpectSuccess(sender: IKeyringPair, collectionId: number, flag: string) {526527  await usingApi(async (api) => {528    const tx = api.tx.unique.setMetaUpdatePermissionFlag(collectionId, flag as any);529    const events = await submitTransactionAsync(sender, tx);530    const result = getGenericResult(events);531532    expect(result.success).to.be.true;533  });534}535536export async function setMetadataUpdatePermissionFlagExpectFailure(sender: IKeyringPair, collectionId: number, flag: string) {537538  await usingApi(async (api) => {539    const tx = api.tx.unique.setMetaUpdatePermissionFlag(collectionId, flag as any);540    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;541    const result = getGenericResult(events);542543    expect(result.success).to.be.false;544  });545}546547export async function enableContractSponsoringExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {548  await usingApi(async (api) => {549    const tx = api.tx.unique.enableContractSponsoring(contractAddress, enable);550    const events = await submitTransactionAsync(sender, tx);551    const result = getGenericResult(events);552553    expect(result.success).to.be.true;554  });555}556557export async function enableContractSponsoringExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {558  await usingApi(async (api) => {559    const tx = api.tx.unique.enableContractSponsoring(contractAddress, enable);560    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;561    const result = getGenericResult(events);562563    expect(result.success).to.be.false;564  });565}566567export async function setTransferFlagExpectSuccess(sender: IKeyringPair, collectionId: number, enabled: boolean) {568569  await usingApi(async (api) => {570571    const tx = api.tx.unique.setTransfersEnabledFlag(collectionId, enabled);572    const events = await submitTransactionAsync(sender, tx);573    const result = getGenericResult(events);574575    expect(result.success).to.be.true;576  });577}578579export async function setTransferFlagExpectFailure(sender: IKeyringPair, collectionId: number, enabled: boolean) {580581  await usingApi(async (api) => {582583    const tx = api.tx.unique.setTransfersEnabledFlag(collectionId, enabled);584    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;585    const result = getGenericResult(events);586587    expect(result.success).to.be.false;588  });589}590591export async function setContractSponsoringRateLimitExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {592  await usingApi(async (api) => {593    const tx = api.tx.unique.setContractSponsoringRateLimit(contractAddress, rateLimit);594    const events = await submitTransactionAsync(sender, tx);595    const result = getGenericResult(events);596597    expect(result.success).to.be.true;598  });599}600601export async function setContractSponsoringRateLimitExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {602  await usingApi(async (api) => {603    const tx = api.tx.unique.setContractSponsoringRateLimit(contractAddress, rateLimit);604    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;605    const result = getGenericResult(events);606607    expect(result.success).to.be.false;608  });609}610611export async function getNextSponsored(612  api: ApiPromise,613  collectionId: number,614  account: string | CrossAccountId,615  tokenId: number,616): Promise<number> {617  return Number((await api.rpc.unique.nextSponsored(collectionId, account, tokenId)).unwrapOr(-1));618}619620export async function toggleContractAllowlistExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, value = true) {621  await usingApi(async (api) => {622    const tx = api.tx.unique.toggleContractAllowList(contractAddress, value);623    const events = await submitTransactionAsync(sender, tx);624    const result = getGenericResult(events);625626    expect(result.success).to.be.true;627  });628}629630export async function isAllowlistedInContract(contractAddress: AccountId | string, user: string) {631  let allowlisted = false;632  await usingApi(async (api) => {633    allowlisted = (await api.query.unique.contractAllowList(contractAddress, user)).toJSON() as boolean;634  });635  return allowlisted;636}637638export async function addToContractAllowListExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {639  await usingApi(async (api) => {640    const tx = api.tx.unique.addToContractAllowList(contractAddress.toString(), user.toString());641    const events = await submitTransactionAsync(sender, tx);642    const result = getGenericResult(events);643644    expect(result.success).to.be.true;645  });646}647648export async function removeFromContractAllowListExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {649  await usingApi(async (api) => {650    const tx = api.tx.unique.removeFromContractAllowList(contractAddress.toString(), user.toString());651    const events = await submitTransactionAsync(sender, tx);652    const result = getGenericResult(events);653654    expect(result.success).to.be.true;655  });656}657658export async function removeFromContractAllowListExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, user: AccountId | string) {659  await usingApi(async (api) => {660    const tx = api.tx.unique.removeFromContractAllowList(contractAddress.toString(), user.toString());661    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;662    const result = getGenericResult(events);663664    expect(result.success).to.be.false;665  });666}667668export async function setVariableMetaDataExpectSuccess(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {669  await usingApi(async (api) => {670    const tx = api.tx.unique.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));671    const events = await submitTransactionAsync(sender, tx);672    const result = getGenericResult(events);673674    expect(result.success).to.be.true;675  });676}677678export async function setVariableMetaDataExpectFailure(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {679  await usingApi(async (api) => {680    const tx = api.tx.unique.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));681    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;682  });683}684685export async function setOffchainSchemaExpectSuccess(sender: IKeyringPair, collectionId: number, data: number[]) {686  await usingApi(async (api) => {687    const tx = api.tx.unique.setOffchainSchema(collectionId, '0x' + Buffer.from(data).toString('hex'));688    const events = await submitTransactionAsync(sender, tx);689    const result = getGenericResult(events);690691    expect(result.success).to.be.true;692  });693}694695export async function setOffchainSchemaExpectFailure(sender: IKeyringPair, collectionId: number, data: number[]) {696  await usingApi(async (api) => {697    const tx = api.tx.unique.setOffchainSchema(collectionId, '0x' + Buffer.from(data).toString('hex'));698    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;699  });700}701702export interface CreateFungibleData {703  readonly Value: bigint;704}705706export interface CreateReFungibleData { }707export interface CreateNftData { }708709export type CreateItemData = {710  NFT: CreateNftData;711} | {712  Fungible: CreateFungibleData;713} | {714  ReFungible: CreateReFungibleData;715};716717export async function burnItemExpectSuccess(sender: IKeyringPair, collectionId: number, tokenId: number, value = 1) {718  await usingApi(async (api) => {719    const balanceBefore = await getBalance(api, collectionId, normalizeAccountId(sender), tokenId);720    // if burning token by admin - use adminButnItemExpectSuccess721    expect(balanceBefore >= BigInt(value)).to.be.true;722723    const tx = api.tx.unique.burnItem(collectionId, tokenId, value);724    const events = await submitTransactionAsync(sender, tx);725    const result = getGenericResult(events);726    expect(result.success).to.be.true;727728    const balanceAfter = await getBalance(api, collectionId, normalizeAccountId(sender), tokenId);729    expect(balanceAfter + BigInt(value)).to.be.equal(balanceBefore);730  });731}732733export async function734approveExpectSuccess(735  collectionId: number,736  tokenId: number, owner: IKeyringPair, approved: CrossAccountId | string, amount: number | bigint = 1,737) {738  await usingApi(async (api: ApiPromise) => {739    const approveUniqueTx = api.tx.unique.approve(normalizeAccountId(approved), collectionId, tokenId, amount);740    const events = await submitTransactionAsync(owner, approveUniqueTx);741    const result = getGenericResult(events);742    expect(result.success).to.be.true;743744    expect(await getAllowance(api, collectionId, owner.address, approved, tokenId)).to.be.equal(BigInt(amount));745  });746}747748export async function adminApproveFromExpectSuccess(749  collectionId: number,750  tokenId: number, admin: IKeyringPair, owner: CrossAccountId | string, approved: CrossAccountId | string, amount: number | bigint = 1,751) {752  await usingApi(async (api: ApiPromise) => {753    const approveUniqueTx = api.tx.unique.approve(normalizeAccountId(approved), collectionId, tokenId, amount);754    const events = await submitTransactionAsync(admin, approveUniqueTx);755    const result = getGenericResult(events);756    expect(result.success).to.be.true;757758    expect(await getAllowance(api, collectionId, owner, approved, tokenId)).to.be.equal(BigInt(amount));759  });760}761762export async function763transferFromExpectSuccess(764  collectionId: number,765  tokenId: number,766  accountApproved: IKeyringPair,767  accountFrom: IKeyringPair | CrossAccountId,768  accountTo: IKeyringPair | CrossAccountId,769  value: number | bigint = 1,770  type = 'NFT',771) {772  await usingApi(async (api: ApiPromise) => {773    const from = normalizeAccountId(accountFrom);774    const to = normalizeAccountId(accountTo);775    let balanceBefore = 0n;776    if (type === 'Fungible') {777      balanceBefore = await getBalance(api, collectionId, to, tokenId);778    }779    const transferFromTx = api.tx.unique.transferFrom(normalizeAccountId(accountFrom), to, collectionId, tokenId, value);780    const events = await submitTransactionAsync(accountApproved, transferFromTx);781    const result = getCreateItemResult(events);782    // tslint:disable-next-line:no-unused-expression783    expect(result.success).to.be.true;784    if (type === 'NFT') {785      expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(to);786    }787    if (type === 'Fungible') {788      const balanceAfter = await getBalance(api, collectionId, to, tokenId);789      if (JSON.stringify(to) !== JSON.stringify(from)) {790        expect(balanceAfter - balanceBefore).to.be.equal(BigInt(value));791      } else {792        expect(balanceAfter).to.be.equal(balanceBefore);793      }794    }795    if (type === 'ReFungible') {796      expect(await getBalance(api, collectionId, to, tokenId)).to.be.equal(BigInt(value));797    }798  });799}800801export async function802transferFromExpectFail(803  collectionId: number,804  tokenId: number,805  accountApproved: IKeyringPair,806  accountFrom: IKeyringPair,807  accountTo: IKeyringPair,808  value: number | bigint = 1,809) {810  await usingApi(async (api: ApiPromise) => {811    const transferFromTx = api.tx.unique.transferFrom(normalizeAccountId(accountFrom.address), normalizeAccountId(accountTo.address), collectionId, tokenId, value);812    const events = await expect(submitTransactionExpectFailAsync(accountApproved, transferFromTx)).to.be.rejected;813    const result = getCreateCollectionResult(events);814    // tslint:disable-next-line:no-unused-expression815    expect(result.success).to.be.false;816  });817}818819/* eslint no-async-promise-executor: "off" */820async function getBlockNumber(api: ApiPromise): Promise<number> {821  return new Promise<number>(async (resolve) => {822    const unsubscribe = await api.rpc.chain.subscribeNewHeads((head) => {823      unsubscribe();824      resolve(head.number.toNumber());825    });826  });827}828829export async function addCollectionAdminExpectSuccess(sender: IKeyringPair, collectionId: number, address: string | CrossAccountId) {830  await usingApi(async (api) => {831    const changeAdminTx = api.tx.unique.addCollectionAdmin(collectionId, normalizeAccountId(address));832    const events = await submitTransactionAsync(sender, changeAdminTx);833    const result = getCreateCollectionResult(events);834    expect(result.success).to.be.true;835  });836}837838export async function839getFreeBalance(account: IKeyringPair): Promise<bigint> {840  let balance = 0n;841  await usingApi(async (api) => {842    balance = BigInt((await api.query.system.account(account.address)).data.free.toString());843  });844845  return balance;846}847848export async function transferBalanceTo(api: ApiPromise, source: IKeyringPair, target: string, amount = 1000n * UNIQUE) {849  const tx = api.tx.balances.transfer(target, amount);850  const events = await submitTransactionAsync(source, tx);851  const result = getGenericResult(events);852  expect(result.success).to.be.true;853}854855export async function856scheduleTransferExpectSuccess(857  collectionId: number,858  tokenId: number,859  sender: IKeyringPair,860  recipient: IKeyringPair,861  value: number | bigint = 1,862  blockSchedule: number,863) {864  await usingApi(async (api: ApiPromise) => {865    const blockNumber: number | undefined = await getBlockNumber(api);866    const expectedBlockNumber = blockNumber + blockSchedule;867868    expect(blockNumber).to.be.greaterThan(0);869    const transferTx = api.tx.unique.transfer(normalizeAccountId(recipient.address), collectionId, tokenId, value);870    const scheduleTx = api.tx.scheduler.schedule(expectedBlockNumber, null, 0, transferTx as any);871872    await submitTransactionAsync(sender, scheduleTx);873874    const recipientBalanceBefore = (await api.query.system.account(recipient.address)).data.free.toBigInt();875876    expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(normalizeAccountId(sender.address));877878    // sleep for 4 blocks879    await waitNewBlocks(blockSchedule + 1);880881    const recipientBalanceAfter = (await api.query.system.account(recipient.address)).data.free.toBigInt();882883    expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(normalizeAccountId(recipient.address));884    expect(recipientBalanceAfter).to.be.equal(recipientBalanceBefore);885  });886}887888889export async function890transferExpectSuccess(891  collectionId: number,892  tokenId: number,893  sender: IKeyringPair,894  recipient: IKeyringPair | CrossAccountId,895  value: number | bigint = 1,896  type = 'NFT',897) {898  await usingApi(async (api: ApiPromise) => {899    const from = normalizeAccountId(sender);900    const to = normalizeAccountId(recipient);901902    let balanceBefore = 0n;903    if (type === 'Fungible') {904      balanceBefore = await getBalance(api, collectionId, to, tokenId);905    }906    const transferTx = api.tx.unique.transfer(to, collectionId, tokenId, value);907    const events = await submitTransactionAsync(sender, transferTx);908    const result = getTransferResult(events);909    // tslint:disable-next-line:no-unused-expression910    expect(result.success).to.be.true;911    expect(result.collectionId).to.be.equal(collectionId);912    expect(result.itemId).to.be.equal(tokenId);913    expect(result.sender).to.be.deep.equal(normalizeAccountId(sender.address));914    expect(result.recipient).to.be.deep.equal(to);915    expect(result.value).to.be.equal(BigInt(value));916    if (type === 'NFT') {917      expect(await getTokenOwner(api, collectionId, tokenId)).to.be.deep.equal(to);918    }919    if (type === 'Fungible') {920      const balanceAfter = await getBalance(api, collectionId, to, tokenId);921      if (JSON.stringify(to) !== JSON.stringify(from)) {922        expect(balanceAfter - balanceBefore).to.be.equal(BigInt(value));923      } else {924        expect(balanceAfter).to.be.equal(balanceBefore);925      }926    }927    if (type === 'ReFungible') {928      expect(await getBalance(api, collectionId, to, tokenId) >= value).to.be.true;929    }930  });931}932933export async function934transferExpectFailure(935  collectionId: number,936  tokenId: number,937  sender: IKeyringPair,938  recipient: IKeyringPair,939  value: number | bigint = 1,940) {941  await usingApi(async (api: ApiPromise) => {942    const transferTx = api.tx.unique.transfer(normalizeAccountId(recipient.address), collectionId, tokenId, value);943    const events = await expect(submitTransactionExpectFailAsync(sender, transferTx)).to.be.rejected;944    const result = getGenericResult(events);945    // if (events && Array.isArray(events)) {946    //   const result = getCreateCollectionResult(events);947    // tslint:disable-next-line:no-unused-expression948    expect(result.success).to.be.false;949    //}950  });951}952953export async function954approveExpectFail(955  collectionId: number,956  tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number | bigint = 1,957) {958  await usingApi(async (api: ApiPromise) => {959    const approveUniqueTx = api.tx.unique.approve(normalizeAccountId(approved.address), collectionId, tokenId, amount);960    const events = await expect(submitTransactionExpectFailAsync(owner, approveUniqueTx)).to.be.rejected;961    const result = getCreateCollectionResult(events);962    // tslint:disable-next-line:no-unused-expression963    expect(result.success).to.be.false;964  });965}966967export async function getBalance(968  api: ApiPromise,969  collectionId: number,970  owner: string | CrossAccountId,971  token: number,972): Promise<bigint> {973  return (await api.rpc.unique.balance(collectionId, normalizeAccountId(owner), token)).toBigInt();974}975export async function getTokenOwner(976  api: ApiPromise,977  collectionId: number,978  token: number,979): Promise<CrossAccountId> {980  return normalizeAccountId((await api.rpc.unique.tokenOwner(collectionId, token)).toJSON() as any);981}982export async function isTokenExists(983  api: ApiPromise,984  collectionId: number,985  token: number,986): Promise<boolean> {987  return (await api.rpc.unique.tokenExists(collectionId, token)).toJSON();988}989export async function getLastTokenId(990  api: ApiPromise,991  collectionId: number,992): Promise<number> {993  return (await api.rpc.unique.lastTokenId(collectionId)).toJSON();994}995export async function getAdminList(996  api: ApiPromise,997  collectionId: number,998): Promise<string[]> {999  return (await api.rpc.unique.adminlist(collectionId)).toHuman() as any;1000}1001export async function getVariableMetadata(1002  api: ApiPromise,1003  collectionId: number,1004  tokenId: number,1005): Promise<number[]> {1006  return [...(await api.rpc.unique.variableMetadata(collectionId, tokenId))];1007}1008export async function getConstMetadata(1009  api: ApiPromise,1010  collectionId: number,1011  tokenId: number,1012): Promise<number[]> {1013  return [...(await api.rpc.unique.constMetadata(collectionId, tokenId))];1014}10151016export async function createFungibleItemExpectSuccess(1017  sender: IKeyringPair,1018  collectionId: number,1019  data: CreateFungibleData,1020  owner: CrossAccountId | string = sender.address,1021) {1022  return await usingApi(async (api) => {1023    const tx = api.tx.unique.createItem(collectionId, normalizeAccountId(owner), {Fungible: data});10241025    const events = await submitTransactionAsync(sender, tx);1026    const result = getCreateItemResult(events);10271028    expect(result.success).to.be.true;1029    return result.itemId;1030  });1031}10321033export async function createItemExpectSuccess(sender: IKeyringPair, collectionId: number, createMode: string, owner: CrossAccountId | string = sender.address) {1034  let newItemId = 0;1035  await usingApi(async (api) => {1036    const to = normalizeAccountId(owner);1037    const itemCountBefore = await getLastTokenId(api, collectionId);1038    const itemBalanceBefore = await getBalance(api, collectionId, to, newItemId);10391040    let tx;1041    if (createMode === 'Fungible') {1042      const createData = {fungible: {value: 10}};1043      tx = api.tx.unique.createItem(collectionId, to, createData as any);1044    } else if (createMode === 'ReFungible') {1045      const createData = {refungible: {const_data: [], variable_data: [], pieces: 100}};1046      tx = api.tx.unique.createItem(collectionId, to, createData as any);1047    } else {1048      const createData = {nft: {const_data: [], variable_data: []}};1049      tx = api.tx.unique.createItem(collectionId, to, createData as any);1050    }10511052    const events = await submitTransactionAsync(sender, tx);1053    const result = getCreateItemResult(events);10541055    const itemCountAfter = await getLastTokenId(api, collectionId);1056    const itemBalanceAfter = await getBalance(api, collectionId, to, newItemId);10571058    // What to expect1059    // tslint:disable-next-line:no-unused-expression1060    expect(result.success).to.be.true;1061    if (createMode === 'Fungible') {1062      expect(itemBalanceAfter - itemBalanceBefore).to.be.equal(10n);1063    } else {1064      expect(itemCountAfter).to.be.equal(itemCountBefore + 1);1065    }1066    expect(collectionId).to.be.equal(result.collectionId);1067    expect(itemCountAfter.toString()).to.be.equal(result.itemId.toString());1068    expect(to).to.be.deep.equal(result.recipient);1069    newItemId = result.itemId;1070  });1071  return newItemId;1072}10731074export async function createItemExpectFailure(sender: IKeyringPair, collectionId: number, createMode: string, owner: string = sender.address) {1075  await usingApi(async (api) => {1076    const tx = api.tx.unique.createItem(collectionId, normalizeAccountId(owner), createMode);10771078    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1079    const result = getCreateItemResult(events);10801081    expect(result.success).to.be.false;1082  });1083}10841085export async function setPublicAccessModeExpectSuccess(1086  sender: IKeyringPair, collectionId: number,1087  accessMode: 'Normal' | 'AllowList',1088) {1089  await usingApi(async (api) => {10901091    // Run the transaction1092    const tx = api.tx.unique.setPublicAccessMode(collectionId, accessMode);1093    const events = await submitTransactionAsync(sender, tx);1094    const result = getGenericResult(events);10951096    // Get the collection1097    const collection = await queryCollectionExpectSuccess(api, collectionId);10981099    // What to expect1100    // tslint:disable-next-line:no-unused-expression1101    expect(result.success).to.be.true;1102    expect(collection.access.toHuman()).to.be.equal(accessMode);1103  });1104}11051106export async function setPublicAccessModeExpectFail(1107  sender: IKeyringPair, collectionId: number,1108  accessMode: 'Normal' | 'AllowList',1109) {1110  await usingApi(async (api) => {11111112    // Run the transaction1113    const tx = api.tx.unique.setPublicAccessMode(collectionId, accessMode);1114    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1115    const result = getGenericResult(events);11161117    // What to expect1118    // tslint:disable-next-line:no-unused-expression1119    expect(result.success).to.be.false;1120  });1121}11221123export async function enableAllowListExpectSuccess(sender: IKeyringPair, collectionId: number) {1124  await setPublicAccessModeExpectSuccess(sender, collectionId, 'AllowList');1125}11261127export async function enableAllowListExpectFail(sender: IKeyringPair, collectionId: number) {1128  await setPublicAccessModeExpectFail(sender, collectionId, 'AllowList');1129}11301131export async function disableAllowListExpectSuccess(sender: IKeyringPair, collectionId: number) {1132  await setPublicAccessModeExpectSuccess(sender, collectionId, 'Normal');1133}11341135export async function setMintPermissionExpectSuccess(sender: IKeyringPair, collectionId: number, enabled: boolean) {1136  await usingApi(async (api) => {11371138    // Run the transaction1139    const tx = api.tx.unique.setMintPermission(collectionId, enabled);1140    const events = await submitTransactionAsync(sender, tx);1141    const result = getGenericResult(events);1142    expect(result.success).to.be.true;11431144    // Get the collection1145    const collection = await queryCollectionExpectSuccess(api, collectionId);11461147    expect(collection.mintMode.toHuman()).to.be.equal(enabled);1148  });1149}11501151export async function enablePublicMintingExpectSuccess(sender: IKeyringPair, collectionId: number) {1152  await setMintPermissionExpectSuccess(sender, collectionId, true);1153}11541155export async function setMintPermissionExpectFailure(sender: IKeyringPair, collectionId: number, enabled: boolean) {1156  await usingApi(async (api) => {1157    // Run the transaction1158    const tx = api.tx.unique.setMintPermission(collectionId, enabled);1159    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1160    const result = getCreateCollectionResult(events);1161    // tslint:disable-next-line:no-unused-expression1162    expect(result.success).to.be.false;1163  });1164}11651166export async function setChainLimitsExpectFailure(sender: IKeyringPair, limits: IChainLimits) {1167  await usingApi(async (api) => {1168    // Run the transaction1169    const tx = api.tx.unique.setChainLimits(limits);1170    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1171    const result = getCreateCollectionResult(events);1172    // tslint:disable-next-line:no-unused-expression1173    expect(result.success).to.be.false;1174  });1175}11761177export async function isAllowlisted(api: ApiPromise, collectionId: number, address: string | CrossAccountId) {1178  return (await api.rpc.unique.allowed(collectionId, normalizeAccountId(address))).toJSON();1179}11801181export async function addToAllowListExpectSuccess(sender: IKeyringPair, collectionId: number, address: string | AccountId | CrossAccountId) {1182  await usingApi(async (api) => {1183    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.false;11841185    // Run the transaction1186    const tx = api.tx.unique.addToAllowList(collectionId, normalizeAccountId(address));1187    const events = await submitTransactionAsync(sender, tx);1188    const result = getGenericResult(events);1189    expect(result.success).to.be.true;11901191    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.true;1192  });1193}11941195export async function addToAllowListAgainExpectSuccess(sender: IKeyringPair, collectionId: number, address: string | AccountId) {1196  await usingApi(async (api) => {11971198    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.true;11991200    // Run the transaction1201    const tx = api.tx.unique.addToAllowList(collectionId, normalizeAccountId(address));1202    const events = await submitTransactionAsync(sender, tx);1203    const result = getGenericResult(events);1204    expect(result.success).to.be.true;12051206    expect(await isAllowlisted(api, collectionId, normalizeAccountId(address))).to.be.true;1207  });1208}12091210export async function addToAllowListExpectFail(sender: IKeyringPair, collectionId: number, address: string | AccountId) {1211  await usingApi(async (api) => {12121213    // Run the transaction1214    const tx = api.tx.unique.addToAllowList(collectionId, normalizeAccountId(address));1215    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1216    const result = getGenericResult(events);12171218    // What to expect1219    // tslint:disable-next-line:no-unused-expression1220    expect(result.success).to.be.false;1221  });1222}12231224export async function removeFromAllowListExpectSuccess(sender: IKeyringPair, collectionId: number, address: CrossAccountId) {1225  await usingApi(async (api) => {1226    // Run the transaction1227    const tx = api.tx.unique.removeFromAllowList(collectionId, normalizeAccountId(address));1228    const events = await submitTransactionAsync(sender, tx);1229    const result = getGenericResult(events);12301231    // What to expect1232    // tslint:disable-next-line:no-unused-expression1233    expect(result.success).to.be.true;1234  });1235}12361237export async function removeFromAllowListExpectFailure(sender: IKeyringPair, collectionId: number, address: CrossAccountId) {1238  await usingApi(async (api) => {1239    // Run the transaction1240    const tx = api.tx.unique.removeFromAllowList(collectionId, normalizeAccountId(address));1241    const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;1242    const result = getGenericResult(events);12431244    // What to expect1245    // tslint:disable-next-line:no-unused-expression1246    expect(result.success).to.be.false;1247  });1248}12491250export const getDetailedCollectionInfo = async (api: ApiPromise, collectionId: number)1251  : Promise<UpDataStructsCollection | null> => {1252  return (await api.rpc.unique.collectionById(collectionId)).unwrapOr(null);1253};12541255export const getCreatedCollectionCount = async (api: ApiPromise): Promise<number> => {1256  // set global object - collectionsCount1257  return (await api.rpc.unique.collectionStats()).created.toNumber();1258};12591260export async function queryCollectionExpectSuccess(api: ApiPromise, collectionId: number): Promise<UpDataStructsCollection> {1261  return (await api.rpc.unique.collectionById(collectionId)).unwrap();1262}12631264export async function waitNewBlocks(blocksCount = 1): Promise<void> {1265  await usingApi(async (api) => {1266    const promise = new Promise<void>(async (resolve) => {1267      const unsubscribe = await api.rpc.chain.subscribeNewHeads(() => {1268        if (blocksCount > 0) {1269          blocksCount--;1270        } else {1271          unsubscribe();1272          resolve();1273        }1274      });1275    });1276    return promise;1277  });1278}