`cb104fa8933b`

source

tests/src/util/helpers.ts14.6 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 chai from 'chai';7import chaiAsPromised from 'chai-as-promised';8import type { AccountId, EventRecord } from '@polkadot/types/interfaces';9import { ApiPromise, Keyring } from "@polkadot/api";10import { default as usingApi, submitTransactionAsync, submitTransactionExpectFailAsync } from "../substrate/substrate-api";11import privateKey from '../substrate/privateKey';12import { alicesPublicKey, nullPublicKey } from "../accounts";13import { strToUTF16, utf16ToStr, hexToStr } from './util';14import { IKeyringPair } from '@polkadot/types/types';15import { BigNumber } from 'bignumber.js';16import { Struct, Enum } from '@polkadot/types/codec';17import { u128 } from '@polkadot/types/primitive';18import { ICollectionInterface } from '../types';19import BN from "bn.js";2021chai.use(chaiAsPromised);22const expect = chai.expect;2324type GenericResult = {25  success: boolean,26};2728type CreateCollectionResult = {29  success: boolean,30  collectionId: number31};3233type CreateItemResult = {34  success: boolean,35  collectionId: number,36  itemId: number37};3839export function getGenericResult(events: EventRecord[]): GenericResult {40  let result: GenericResult = {41    success: false42  }43  events.forEach(({ phase, event: { data, method, section } }) => {44    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);45    if (method == 'ExtrinsicSuccess') {46      result.success = true;47    }48  });49  return result;50}5152export function getCreateCollectionResult(events: EventRecord[]): CreateCollectionResult {53  let success = false;54  let collectionId: number = 0;55  events.forEach(({ phase, event: { data, method, section } }) => {56    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);57    if (method == 'ExtrinsicSuccess') {58      success = true;59    } else if ((section == 'nft') && (method == 'Created')) {60      collectionId = parseInt(data[0].toString());61    }62  });63  let result: CreateCollectionResult = {64    success,65    collectionId66  }67  return result;68}6970export function getCreateItemResult(events: EventRecord[]): CreateItemResult {71  let success = false;72  let collectionId: number = 0;73  let itemId: number = 0;74  events.forEach(({ phase, event: { data, method, section } }) => {75    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);76    if (method == 'ExtrinsicSuccess') {77      success = true;78    } else if ((section == 'nft') && (method == 'ItemCreated')) {79      collectionId = parseInt(data[0].toString());80      itemId = parseInt(data[1].toString());81    }82  });83  let result: CreateItemResult = {84    success,85    collectionId,86    itemId87  }88  return result;89}9091export type CollectionMode = 'NFT' | 'Fungible' | 'ReFungible';92export type CreateCollectionParams = {93  mode: CollectionMode,94  name: string,95  description: string,96  tokenPrefix: string97};9899const defaultCreateCollectionParams: CreateCollectionParams = {100  name: 'name',101  description: 'description',102  mode: 'NFT',103  tokenPrefix: 'prefix'104}105106export async function createCollectionExpectSuccess(params: Partial<CreateCollectionParams> = {}): Promise<number> {107  const {name, description, mode, tokenPrefix } = {...defaultCreateCollectionParams, ...params};108109  let collectionId: number = 0;110  await usingApi(async (api) => {111    // Get number of collections before the transaction112    const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());113114    // Run the CreateCollection transaction115    const alicePrivateKey = privateKey('//Alice');116    const tx = api.tx.nft.createCollection(strToUTF16(name), strToUTF16(description), strToUTF16(tokenPrefix), mode);117    const events = await submitTransactionAsync(alicePrivateKey, tx);118    const result = getCreateCollectionResult(events);119120    // Get number of collections after the transaction121    const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());122123    // Get the collection 124    const collection: any = (await api.query.nft.collection(result.collectionId)).toJSON();125126    // What to expect127    expect(result.success).to.be.true;128    expect(result.collectionId).to.be.equal(BcollectionCount);129    expect(collection).to.be.not.null;130    expect(BcollectionCount).to.be.equal(AcollectionCount+1, 'Error: NFT collection NOT created.');131    expect(collection.Owner).to.be.equal(alicesPublicKey);132    expect(utf16ToStr(collection.Name)).to.be.equal(name);133    expect(utf16ToStr(collection.Description)).to.be.equal(description);134    expect(hexToStr(collection.TokenPrefix)).to.be.equal(tokenPrefix);135136    collectionId = result.collectionId;137  });138139  return collectionId;140}141  142export async function createCollectionExpectFailure(params: Partial<CreateCollectionParams> = {}) {143  const {name, description, mode, tokenPrefix } = {...defaultCreateCollectionParams, ...params};144145  await usingApi(async (api) => {146    // Get number of collections before the transaction147    const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());148149    // Run the CreateCollection transaction150    const alicePrivateKey = privateKey('//Alice');151    const tx = api.tx.nft.createCollection(strToUTF16(name), strToUTF16(description), strToUTF16(tokenPrefix), mode);152    const events = await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;153    const result = getCreateCollectionResult(events);154155    // Get number of collections after the transaction156    const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());157158    // What to expect159    expect(result.success).to.be.false;160    expect(BcollectionCount).to.be.equal(AcollectionCount, 'Error: Collection with incorrect data created.');161  });162}163  164export async function findUnusedAddress(api: ApiPromise): Promise<IKeyringPair> {165  let bal = new BigNumber(0);166  let unused;167  do {168    const randomSeed = 'seed' +  Math.floor(Math.random() * Math.floor(10000));169    const keyring = new Keyring({ type: 'sr25519' });170    unused = keyring.addFromUri(`//${randomSeed}`);171    bal = new BigNumber((await api.query.system.account(unused.address)).data.free.toString());172  } while (bal.toFixed() != '0');173  return unused; 174}175176function getDestroyResult(events: EventRecord[]): boolean {177  let success: boolean = false;178  events.forEach(({ phase, event: { data, method, section } }) => {179    // console.log(`    ${phase}: ${section}.${method}:: ${data}`);180    if (method == 'ExtrinsicSuccess') {181      success = true;182    }183  });184  return success;185}186187export async function destroyCollectionExpectFailure(collectionId: number, senderSeed: string = '//Alice') {188  await usingApi(async (api) => {189    // Run the DestroyCollection transaction190    const alicePrivateKey = privateKey(senderSeed);191    const tx = api.tx.nft.destroyCollection(collectionId);192    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;193  });194}195196export async function destroyCollectionExpectSuccess(collectionId: number, senderSeed: string = '//Alice') {197  await usingApi(async (api) => {198    // Run the DestroyCollection transaction199    const alicePrivateKey = privateKey(senderSeed);200    const tx = api.tx.nft.destroyCollection(collectionId);201    const events = await submitTransactionAsync(alicePrivateKey, tx);202    const result = getDestroyResult(events);203204    // Get the collection 205    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();206207    // What to expect208    expect(result).to.be.true;209    expect(collection).to.be.not.null;210    expect(collection.Owner).to.be.equal(nullPublicKey);211  });212}213214export async function setCollectionSponsorExpectSuccess(collectionId: number, sponsor: string) {215  await usingApi(async (api) => {216217    // Run the transaction218    const alicePrivateKey = privateKey('//Alice');219    const tx = api.tx.nft.setCollectionSponsor(collectionId, sponsor);220    const events = await submitTransactionAsync(alicePrivateKey, tx);221    const result = getGenericResult(events);222223    // Get the collection 224    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();225226    // What to expect227    expect(result.success).to.be.true;228    expect(collection.Sponsor.toString()).to.be.equal(sponsor.toString());229    expect(collection.SponsorConfirmed).to.be.false;230  });231}232233export async function removeCollectionSponsorExpectSuccess(collectionId: number) {234  await usingApi(async (api) => {235236    // Run the transaction237    const alicePrivateKey = privateKey('//Alice');238    const tx = api.tx.nft.removeCollectionSponsor(collectionId);239    const events = await submitTransactionAsync(alicePrivateKey, tx);240    const result = getGenericResult(events);241242    // Get the collection 243    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();244245    // What to expect246    expect(result.success).to.be.true;247    expect(collection.Sponsor).to.be.equal(nullPublicKey);248    expect(collection.SponsorConfirmed).to.be.false;249  });250}251252export async function removeCollectionSponsorExpectFailure(collectionId: number) {253  await usingApi(async (api) => {254255    // Run the transaction256    const alicePrivateKey = privateKey('//Alice');257    const tx = api.tx.nft.removeCollectionSponsor(collectionId);258    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;259  });260}261262export async function setCollectionSponsorExpectFailure(collectionId: number, sponsor: string, senderSeed: string = '//Alice') {263  await usingApi(async (api) => {264265    // Run the transaction266    const alicePrivateKey = privateKey(senderSeed);267    const tx = api.tx.nft.setCollectionSponsor(collectionId, sponsor);268    await expect(submitTransactionExpectFailAsync(alicePrivateKey, tx)).to.be.rejected;269  });270}271272export async function confirmSponsorshipExpectSuccess(collectionId: number, senderSeed: string = '//Alice') {273  await usingApi(async (api) => {274275    // Run the transaction276    const sender = privateKey(senderSeed);277    const tx = api.tx.nft.confirmSponsorship(collectionId);278    const events = await submitTransactionAsync(sender, tx);279    const result = getGenericResult(events);280281    // Get the collection 282    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();283284    // What to expect285    expect(result.success).to.be.true;286    expect(collection.Sponsor).to.be.equal(sender.address);287    expect(collection.SponsorConfirmed).to.be.true;288  });289}290291export async function confirmSponsorshipExpectFailure(collectionId: number, senderSeed: string = '//Alice') {292  await usingApi(async (api) => {293294    // Run the transaction295    const sender = privateKey(senderSeed);296    const tx = api.tx.nft.confirmSponsorship(collectionId);297    await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;298  });299}300301export interface CreateFungibleData extends Struct {302  readonly value: u128;303};304305export interface CreateReFungibleData extends Struct {};306export interface CreateNftData extends Struct {};307308export interface CreateItemData extends Enum {309  NFT: CreateNftData,310  Fungible: CreateFungibleData,311  ReFungible: CreateReFungibleData312};313314export async function createItemExpectSuccess(sender: IKeyringPair, collectionId: number, createMode: string, owner: string = '') {315  let newItemId: number = 0;316  await usingApi(async (api) => {317    const AItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString());318    const Aitem: any = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON();    319    const AItemBalance = new BigNumber(Aitem.Value);320321    if (owner === '') owner = sender.address;322323    let tx;324    if (createMode == 'Fungible') {325      let createData = {fungible: {value: 10}};326      tx = api.tx.nft.createItem(collectionId, owner, createData);327    }328    else {329      tx = api.tx.nft.createItem(collectionId, owner, createMode);330    }331    const events = await submitTransactionAsync(sender, tx);332    const result = getCreateItemResult(events);333334    const BItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString());335    const Bitem: any = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON();    336    const BItemBalance = new BigNumber(Bitem.Value);337338    // What to expect339    expect(result.success).to.be.true;340    if (createMode == 'Fungible') {341      expect(BItemBalance.minus(AItemBalance).toNumber()).to.be.equal(10);342    }343    else {344      expect(BItemCount).to.be.equal(AItemCount+1);345    }346    expect(collectionId).to.be.equal(result.collectionId);347    expect(BItemCount).to.be.equal(result.itemId);348    newItemId = result.itemId;349  });350  return newItemId;351}352353export async function enableWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number) {354  await usingApi(async (api) => {355356    // Run the transaction357    const tx = api.tx.nft.setPublicAccessMode(collectionId, 'WhiteList');358    const events = await submitTransactionAsync(sender, tx);359    const result = getGenericResult(events);360361    // Get the collection 362    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();363364    // What to expect365    expect(result.success).to.be.true;366    expect(collection.Access).to.be.equal('WhiteList');367  });368}369370export async function enablePublicMintingExpectSuccess(sender: IKeyringPair, collectionId: number) {371  await usingApi(async (api) => {372373    // Run the transaction374    const tx = api.tx.nft.setMintPermission(collectionId, true);375    const events = await submitTransactionAsync(sender, tx);376    const result = getGenericResult(events);377378    // Get the collection 379    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();380381    // What to expect382    expect(result.success).to.be.true;383    expect(collection.MintMode).to.be.equal(true);384  });385}386387export async function addToWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number, address: string) {388  await usingApi(async (api) => {389390    // Run the transaction391    const tx = api.tx.nft.addToWhiteList(collectionId, address);392    const events = await submitTransactionAsync(sender, tx);393    const result = getGenericResult(events);394395    // Get the collection 396    const collection: any = (await api.query.nft.collection(collectionId)).toJSON();397398    // What to expect399    expect(result.success).to.be.true;400    expect(collection.MintMode).to.be.equal(true);401  });402}403404export const getDetailedCollectionInfo = async (api: ApiPromise, collectionId: number)405  : Promise<ICollectionInterface | null> => {406  return await api.query.nft.collection(collectionId) as unknown as ICollectionInterface;407};408409export const getCreatedCollectionCount = async (api: ApiPromise): Promise<number> => {410  // set global object - collectionsCount411  return (await api.query.nft.createdCollectionCount() as unknown as BN).toNumber();412};