`dc53bbca9772`

source

tests/src/util/helpers.ts24.3 KiBsource history
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 { Enum, Struct } from '@polkadot/types/codec';8import type { AccountId, EventRecord } from '@polkadot/types/interfaces';9import { u128 } from '@polkadot/types/primitive';10import { IKeyringPair } from '@polkadot/types/types';11import { BigNumber } from 'bignumber.js';12import BN from 'bn.js';13import chai from 'chai';14import chaiAsPromised from 'chai-as-promised';15import { alicesPublicKey, nullPublicKey } from '../accounts';16import privateKey from '../substrate/privateKey';17import { default as usingApi, submitTransactionAsync, submitTransactionExpectFailAsync } from '../substrate/substrate-api';18import { ICollectionInterface } from '../types';19import { hexToStr, strToUTF16, utf16ToStr } from './util';2021chai.use(chaiAsPromised);22const expect = chai.expect;2324type GenericResult = {25  success: boolean,26};2728interface CreateCollectionResult {29  success: boolean;30  collectionId: number;31}3233interface CreateItemResult {34  success: boolean;35  collectionId: number;36  itemId: number;37}3839interface IReFungibleOwner {40  Fraction: BN;41  Owner: number[];42}4344interface ITokenDataType {45  Owner: number[];46  ConstData: number[];47  VariableData: number[];48}4950interface IFungibleTokenDataType {51  Value: BN;52}5354interface IReFungibleTokenDataType {55  Owner: IReFungibleOwner[];56  ConstData: number[];57  VariableData: number[];58}5960export function getGenericResult(events: EventRecord[]): GenericResult {61  const result: GenericResult = {62    success: false,63  };64  events.forEach(({ phase, event: { data, method, section } }) => {65    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);66    if (method === 'ExtrinsicSuccess') {67      result.success = true;68    }69  });70  return result;71}7273export function getCreateCollectionResult(events: EventRecord[]): CreateCollectionResult {74  let success = false;75  let collectionId: number = 0;76  events.forEach(({ phase, event: { data, method, section } }) => {77    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);78    if (method == 'ExtrinsicSuccess') {79      success = true;80    } else if ((section == 'nft') && (method == 'Created')) {81      collectionId = parseInt(data[0].toString());82    }83  });84  const result: CreateCollectionResult = {85    success,86    collectionId,87  };88  return result;89}9091export function getCreateItemResult(events: EventRecord[]): CreateItemResult {92  let success = false;93  let collectionId: number = 0;94  let itemId: number = 0;95  events.forEach(({ phase, event: { data, method, section } }) => {96    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);97    if (method == 'ExtrinsicSuccess') {98      success = true;99    } else if ((section == 'nft') && (method == 'ItemCreated')) {100      collectionId = parseInt(data[0].toString());101      itemId = parseInt(data[1].toString());102    }103  });104  const result: CreateItemResult = {105    success,106    collectionId,107    itemId,108  };109  return result;110}111112interface Invalid {113  type: 'Invalid';114}115116interface Nft {117  type: 'NFT';118}119120interface Fungible {121  type: 'Fungible';122  decimalPoints: number;123}124125interface ReFungible {126  type: 'ReFungible';127  decimalPoints: number;128}129130interface Nft {131  type: 'NFT'132}133134interface Fungible {135  type: 'Fungible',136  decimalPoints: number137}138139interface ReFungible {140  type: 'ReFungible',141  decimalPoints: number142}143144type CollectionMode = Nft | Fungible | ReFungible | Invalid;145146export type CreateCollectionParams = {147  mode: CollectionMode,148  name: string,149  description: string,150  tokenPrefix: string,151};152153const defaultCreateCollectionParams: CreateCollectionParams = {154  description: 'description',155  mode: { type: 'NFT' },156  name: 'name',157  tokenPrefix: 'prefix',158}159160export async function createCollectionExpectSuccess(params: Partial<CreateCollectionParams> = {}): Promise<number> {161  const {name, description, mode, tokenPrefix } = {...defaultCreateCollectionParams, ...params};162163  let collectionId: number = 0;164  await usingApi(async (api) => {165    // Get number of collections before the transaction166    const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10);167168    // Run the CreateCollection transaction169    const alicePrivateKey = privateKey('//Alice');170171    let modeprm = {};172    if (mode.type === 'NFT') {173      modeprm = {nft: null};174    } else if (mode.type === 'Fungible') {175      modeprm = {fungible: mode.decimalPoints};176    } else if (mode.type === 'ReFungible') {177      modeprm = {refungible: mode.decimalPoints};178    } else if (mode.type === 'Invalid') {179      modeprm = {invalid: null};180    }181182    const tx = api.tx.nft.createCollection(strToUTF16(name), strToUTF16(description), strToUTF16(tokenPrefix), modeprm);183    const events = await submitTransactionAsync(alicePrivateKey, tx);184    const result = getCreateCollectionResult(events);185186    // Get number of collections after the transaction187    const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10);188189    // Get the collection190    const collection: any = (await api.query.nft.collection(result.collectionId)).toJSON();191192    // What to expect193    // tslint:disable-next-line:no-unused-expression194    expect(result.success).to.be.true;195    expect(result.collectionId).to.be.equal(BcollectionCount);196    // tslint:disable-next-line:no-unused-expression197    expect(collection).to.be.not.null;198    expect(BcollectionCount).to.be.equal(AcollectionCount + 1, 'Error: NFT collection NOT created.');199    expect(collection.Owner).to.be.equal(alicesPublicKey);200    expect(utf16ToStr(collection.Name)).to.be.equal(name);201    expect(utf16ToStr(collection.Description)).to.be.equal(description);202    expect(hexToStr(collection.TokenPrefix)).to.be.equal(tokenPrefix);203204    collectionId = result.collectionId;205  });206207  return collectionId;208}209210export async function createCollectionExpectFailure(params: Partial<CreateCollectionParams> = {}) {211  const {name, description, mode, tokenPrefix } = {...defaultCreateCollectionParams, ...params};212213  let modeprm = {};214  if (mode.type === 'NFT') {215    modeprm = {nft: null};216  } else if (mode.type === 'Fungible') {217    modeprm = {fungible: mode.decimalPoints};218  } else if (mode.type === 'ReFungible') {219    modeprm = {refungible: mode.decimalPoints};220  } else if (mode.type === 'Invalid') {221    modeprm = {invalid: null};222  }223224  await usingApi(async (api) => {225    // Get number of collections before the transaction226    const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());227228    // Run the CreateCollection transaction229    const alicePrivateKey = privateKey('//Alice');230    const tx = api.tx.nft.createCollection(strToUTF16(name), strToUTF16(description), strToUTF16(tokenPrefix), modeprm);231    const events = await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;232    const result = getCreateCollectionResult(events);233234    // Get number of collections after the transaction235    const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());236237    // What to expect238    // tslint:disable-next-line:no-unused-expression239    expect(result.success).to.be.false;240    expect(BcollectionCount).to.be.equal(AcollectionCount, 'Error: Collection with incorrect data created.');241  });242}243244export async function findUnusedAddress(api: ApiPromise): Promise<IKeyringPair> {245  let bal = new BigNumber(0);246  let unused;247  do {248    const randomSeed = 'seed' +  Math.floor(Math.random() * Math.floor(10000));249    const keyring = new Keyring({ type: 'sr25519' });250    unused = keyring.addFromUri(`//${randomSeed}`);251    bal = new BigNumber((await api.query.system.account(unused.address)).data.free.toString());252  } while (bal.toFixed() != '0');253  return unused;254}255256export async function findNotExistingCollection(api: ApiPromise): Promise<number> {257  const totalNumber = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10) as unknown as number;258  const newCollection: number = totalNumber + 1;259  return newCollection;260}261262function getDestroyResult(events: EventRecord[]): boolean {263  let success: boolean = false;264  events.forEach(({ phase, event: { data, method, section } }) => {265    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);266    if (method == 'ExtrinsicSuccess') {267      success = true;268    }269  });270  return success;271}272273export async function destroyCollectionExpectFailure(collectionId: number, senderSeed: string = '//Alice') {274  await usingApi(async (api) => {275    // Run the DestroyCollection transaction276    const alicePrivateKey = privateKey(senderSeed);277    const tx = api.tx.nft.destroyCollection(collectionId);278    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;279  });280}281282export async function destroyCollectionExpectSuccess(collectionId: number, senderSeed: string = '//Alice') {283  await usingApi(async (api) => {284    // Run the DestroyCollection transaction285    const alicePrivateKey = privateKey(senderSeed);286    const tx = api.tx.nft.destroyCollection(collectionId);287    const events = await submitTransactionAsync(alicePrivateKey, tx);288    const result = getDestroyResult(events);289290    // Get the collection291    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();292293    // What to expect294    expect(result).to.be.true;295    expect(collection).to.be.not.null;296    expect(collection.Owner).to.be.equal(nullPublicKey);297  });298}299300export async function setCollectionSponsorExpectSuccess(collectionId: number, sponsor: string) {301  await usingApi(async (api) => {302303    // Run the transaction304    const alicePrivateKey = privateKey('//Alice');305    const tx = api.tx.nft.setCollectionSponsor(collectionId, sponsor);306    const events = await submitTransactionAsync(alicePrivateKey, tx);307    const result = getGenericResult(events);308309    // Get the collection310    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();311312    // What to expect313    expect(result.success).to.be.true;314    expect(collection.Sponsor.toString()).to.be.equal(sponsor.toString());315    expect(collection.SponsorConfirmed).to.be.false;316  });317}318319export async function removeCollectionSponsorExpectSuccess(collectionId: number) {320  await usingApi(async (api) => {321322    // Run the transaction323    const alicePrivateKey = privateKey('//Alice');324    const tx = api.tx.nft.removeCollectionSponsor(collectionId);325    const events = await submitTransactionAsync(alicePrivateKey, tx);326    const result = getGenericResult(events);327328    // Get the collection329    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();330331    // What to expect332    expect(result.success).to.be.true;333    expect(collection.Sponsor).to.be.equal(nullPublicKey);334    expect(collection.SponsorConfirmed).to.be.false;335  });336}337338export async function removeCollectionSponsorExpectFailure(collectionId: number) {339  await usingApi(async (api) => {340341    // Run the transaction342    const alicePrivateKey = privateKey('//Alice');343    const tx = api.tx.nft.removeCollectionSponsor(collectionId);344    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;345  });346}347348export async function setCollectionSponsorExpectFailure(collectionId: number, sponsor: string, senderSeed: string = '//Alice') {349  await usingApi(async (api) => {350351    // Run the transaction352    const alicePrivateKey = privateKey(senderSeed);353    const tx = api.tx.nft.setCollectionSponsor(collectionId, sponsor);354    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;355  });356}357358export async function confirmSponsorshipExpectSuccess(collectionId: number, senderSeed: string = '//Alice') {359  await usingApi(async (api) => {360361    // Run the transaction362    const sender = privateKey(senderSeed);363    const tx = api.tx.nft.confirmSponsorship(collectionId);364    const events = await submitTransactionAsync(sender, tx);365    const result = getGenericResult(events);366367    // Get the collection368    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();369370    // What to expect371    expect(result.success).to.be.true;372    expect(collection.Sponsor).to.be.equal(sender.address);373    expect(collection.SponsorConfirmed).to.be.true;374  });375}376377export async function confirmSponsorshipExpectFailure(collectionId: number, senderSeed: string = '//Alice') {378  await usingApi(async (api) => {379380    // Run the transaction381    const sender = privateKey(senderSeed);382    const tx = api.tx.nft.confirmSponsorship(collectionId);383    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;384  });385}386387export async function setVariableMetaDataExpectSuccess(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {388  await usingApi(async (api) => {389    const tx = api.tx.nft.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));390    const events = await submitTransactionAsync(sender, tx);391    const result = getGenericResult(events);392393    expect(result.success).to.be.true;394  });395}396397export async function setVariableMetaDataExpectFailure(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {398  await usingApi(async (api) => {399    const tx = api.tx.nft.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));400    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;401  });402}403404export interface CreateFungibleData extends Struct {405  readonly value: u128;406}407408export interface CreateReFungibleData extends Struct {}409export interface CreateNftData extends Struct {}410411export interface CreateItemData extends Enum {412  NFT: CreateNftData;413  Fungible: CreateFungibleData;414  ReFungible: CreateReFungibleData;415}416417export async function burnItemExpectSuccess(owner: IKeyringPair, collectionId: number, tokenId: number, value = 0) {418  await usingApi(async (api) => {419    const tx = api.tx.nft.burnItem(collectionId, tokenId, value);420    const events = await submitTransactionAsync(owner, tx);421    const result = getGenericResult(events);422    // Get the item423    const item: any = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON();424    // What to expect425    // tslint:disable-next-line:no-unused-expression426    expect(result.success).to.be.true;427    // tslint:disable-next-line:no-unused-expression428    expect(item).to.be.not.null;429    expect(item.Owner).to.be.equal(nullPublicKey);430  });431}432433export async function434approveExpectSuccess(collectionId: number,435                     tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number = 1) {436  await usingApi(async (api: ApiPromise) => {437    const allowanceBefore =438      await api.query.nft.allowances(collectionId, [tokenId, owner.address, approved.address]) as unknown as BN;439    const approveNftTx = await api.tx.nft.approve(approved.address, collectionId, tokenId, amount);440    const events = await submitTransactionAsync(owner, approveNftTx);441    const result = getCreateItemResult(events);442    // tslint:disable-next-line:no-unused-expression443    expect(result.success).to.be.true;444    const allowanceAfter =445      await api.query.nft.allowances(collectionId, [tokenId, owner.address, approved.address]) as unknown as BN;446    expect(allowanceAfter.toNumber() - allowanceBefore.toNumber()).to.be.equal(amount);447  });448}449450export async function451transferFromExpectSuccess(collectionId: number,452                          tokenId: number,453                          accountApproved: IKeyringPair,454                          accountFrom: IKeyringPair,455                          accountTo: IKeyringPair,456                          value: number = 1,457                          type: string = 'NFT') {458  await usingApi(async (api: ApiPromise) => {459    let balanceBefore = new BN(0);460    if (type === 'Fungible') {461      balanceBefore = await api.query.nft.balance(collectionId, accountTo.address) as unknown as BN;462    }463    const transferFromTx = await api.tx.nft.transferFrom(464      accountFrom.address, accountTo.address, collectionId, tokenId, value);465    const events = await submitTransactionAsync(accountFrom, transferFromTx);466    const result = getCreateItemResult(events);467    // tslint:disable-next-line:no-unused-expression468    expect(result.success).to.be.true;469    if (type === 'NFT') {470      const nftItemData = await api.query.nft.nftItemList(collectionId, tokenId) as unknown as ITokenDataType;471      expect(nftItemData.Owner.toString()).to.be.equal(accountTo.address);472    }473    if (type === 'Fungible') {474      const balanceAfter = await api.query.nft.balance(collectionId, accountTo.address) as unknown as BN;475      expect(balanceAfter.sub(balanceBefore).toNumber()).to.be.equal(value);476    }477    if (type === 'ReFungible') {478      const nftItemData =479        await api.query.nft.reFungibleItemList(collectionId, tokenId) as unknown as IReFungibleTokenDataType;480      expect(nftItemData.Owner[0].Owner.toString()).to.be.equal(accountTo.address);481      expect(nftItemData.Owner[0].Fraction.toNumber()).to.be.equal(value);482    }483  });484}485486export async function487transferFromExpectFail(collectionId: number,488                       tokenId: number,489                       accountApproved: IKeyringPair,490                       accountFrom: IKeyringPair,491                       accountTo: IKeyringPair,492                       value: number = 1) {493  await usingApi(async (api: ApiPromise) => {494    const transferFromTx = await api.tx.nft.transferFrom(495      accountFrom.address, accountTo.address, collectionId, tokenId, value);496    const events = await expect(submitTransactionExpectFailAsync(accountApproved, transferFromTx)).to.be.rejected;497    const result = getCreateCollectionResult(events);498    // tslint:disable-next-line:no-unused-expression499    expect(result.success).to.be.false;500  });501}502503export async function504transferExpectSuccess(collectionId: number,505                      tokenId: number,506                      sender: IKeyringPair,507                      recipient: IKeyringPair,508                      value: number = 1,509                      type: string = 'NFT') {510  await usingApi(async (api: ApiPromise) => {511    let balanceBefore = new BN(0);512    if (type === 'Fungible') {513      balanceBefore = await api.query.nft.balance(collectionId, recipient.address) as unknown as BN;514    }515    const transferTx = await api.tx.nft.transfer(recipient.address, collectionId, tokenId, value);516    const events = await submitTransactionAsync(sender, transferTx);517    const result = getCreateItemResult(events);518    // tslint:disable-next-line:no-unused-expression519    expect(result.success).to.be.true;520    if (type === 'NFT') {521      const nftItemData = await api.query.nft.nftItemList(collectionId, tokenId) as unknown as ITokenDataType;522      expect(nftItemData.Owner.toString()).to.be.equal(recipient.address);523    }524    if (type === 'Fungible') {525      const balanceAfter = await api.query.nft.balance(collectionId, recipient.address) as unknown as BN;526      expect(balanceAfter.sub(balanceBefore).toNumber()).to.be.equal(value);527    }528    if (type === 'ReFungible') {529      const nftItemData =530        await api.query.nft.reFungibleItemList(collectionId, tokenId) as unknown as IReFungibleTokenDataType;531      expect(nftItemData.Owner[0].Owner.toString()).to.be.equal(recipient.address);532      expect(nftItemData.Owner[0].Fraction.toNumber()).to.be.equal(value);533    }534  });535}536537export async function538transferExpectFail(collectionId: number,539                   tokenId: number,540                   sender: IKeyringPair,541                   recipient: IKeyringPair,542                   value: number = 1,543                   type: string = 'NFT') {544  await usingApi(async (api: ApiPromise) => {545    const transferTx = await api.tx.nft.transfer(recipient.address, collectionId, tokenId, value);546    const events = await expect(submitTransactionExpectFailAsync(sender, transferTx)).to.be.rejected;547    if (events && Array.isArray(events)) {548      const result = getCreateCollectionResult(events);549      // tslint:disable-next-line:no-unused-expression550      expect(result.success).to.be.false;551    }552  });553}554555export async function556approveExpectFail(collectionId: number,557                  tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number = 1) {558  await usingApi(async (api: ApiPromise) => {559    const approveNftTx = await api.tx.nft.approve(approved.address, collectionId, tokenId, amount);560    const events = await expect(submitTransactionExpectFailAsync(owner, approveNftTx)).to.be.rejected;561    const result = getCreateCollectionResult(events);562    // tslint:disable-next-line:no-unused-expression563    expect(result.success).to.be.false;564  });565}566567export async function createItemExpectSuccess(568  sender: IKeyringPair, collectionId: number, createMode: string, owner: string = '') {569  let newItemId: number = 0;570  await usingApi(async (api) => {571    const AItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString(), 10);572    const Aitem: any = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON();573    const AItemBalance = new BigNumber(Aitem.Value);574575    if (owner === '') {576      owner = sender.address;577    }578579    let tx;580    if (createMode === 'Fungible') {581      const createData = {fungible: {value: 10}};582      tx = api.tx.nft.createItem(collectionId, owner, createData);583    } else {584      tx = api.tx.nft.createItem(collectionId, owner, createMode);585    }586    const events = await submitTransactionAsync(sender, tx);587    const result = getCreateItemResult(events);588589    const BItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString(), 10);590    const Bitem: any = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON();591    const BItemBalance = new BigNumber(Bitem.Value);592593    // What to expect594    // tslint:disable-next-line:no-unused-expression595    expect(result.success).to.be.true;596    if (createMode === 'Fungible') {597      expect(BItemBalance.minus(AItemBalance).toNumber()).to.be.equal(10);598    } else {599      expect(BItemCount).to.be.equal(AItemCount + 1);600    }601    expect(collectionId).to.be.equal(result.collectionId);602    expect(BItemCount).to.be.equal(result.itemId);603    newItemId = result.itemId;604  });605  return newItemId;606}607608export async function enableWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number) {609  await usingApi(async (api) => {610611    // Run the transaction612    const tx = api.tx.nft.setPublicAccessMode(collectionId, 'WhiteList');613    const events = await submitTransactionAsync(sender, tx);614    const result = getGenericResult(events);615616    // Get the collection617    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();618619    // What to expect620    // tslint:disable-next-line:no-unused-expression621    expect(result.success).to.be.true;622    expect(collection.Access).to.be.equal('WhiteList');623  });624}625626export async function enablePublicMintingExpectSuccess(sender: IKeyringPair, collectionId: number) {627  await usingApi(async (api) => {628629    // Run the transaction630    const tx = api.tx.nft.setMintPermission(collectionId, true);631    const events = await submitTransactionAsync(sender, tx);632    const result = getGenericResult(events);633634    // Get the collection635    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();636637    // What to expect638    expect(result.success).to.be.true;639    expect(collection.MintMode).to.be.equal(true);640  });641}642643export async function addToWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number, address: string) {644  await usingApi(async (api) => {645646    const whiteListedBefore = (await api.query.nft.whiteList(collectionId, address)).toJSON();647648    // Run the transaction649    const tx = api.tx.nft.addToWhiteList(collectionId, address);650    const events = await submitTransactionAsync(sender, tx);651    const result = getGenericResult(events);652653    const whiteListedAfter = (await api.query.nft.whiteList(collectionId, address)).toJSON();654655    // What to expect656    // tslint:disable-next-line:no-unused-expression657    expect(result.success).to.be.true;658    // tslint:disable-next-line: no-unused-expression659    expect(whiteListedBefore).to.be.false;660    // tslint:disable-next-line: no-unused-expression661    expect(whiteListedAfter).to.be.true;662  });663}664665export const getDetailedCollectionInfo = async (api: ApiPromise, collectionId: number)666  : Promise<ICollectionInterface | null> => {667  return await api.query.nft.collection(collectionId) as unknown as ICollectionInterface;668};669670export const getCreatedCollectionCount = async (api: ApiPromise): Promise<number> => {671  // set global object - collectionsCount672  return (await api.query.nft.createdCollectionCount() as unknown as BN).toNumber();673};