123456import { 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 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 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 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 166 const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10);167168 169 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 187 const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString(), 10);188189 190 const collection: any = (await api.query.nft.collection(result.collectionId)).toJSON();191192 193 194 expect(result.success).to.be.true;195 expect(result.collectionId).to.be.equal(BcollectionCount);196 197 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 226 const AcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());227228 229 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 235 const BcollectionCount = parseInt((await api.query.nft.createdCollectionCount()).toString());236237 238 239 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 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 276 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 285 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 291 const collection: any = (await api.query.nft.collection(collectionId)).toJSON();292293 294 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 304 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 310 const collection: any = (await api.query.nft.collection(collectionId)).toJSON();311312 313 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 323 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 329 const collection: any = (await api.query.nft.collection(collectionId)).toJSON();330331 332 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 342 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 352 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 362 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 368 const collection: any = (await api.query.nft.collection(collectionId)).toJSON();369370 371 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 381 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 enableContractSponsoringExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {388 await usingApi(async (api) => {389 const tx = api.tx.nft.enableContractSponsoring(contractAddress, enable);390 const events = await submitTransactionAsync(sender, tx);391 const result = getGenericResult(events);392393 expect(result.success).to.be.true;394 });395}396397export async function enableContractSponsoringExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, enable: boolean) {398 await usingApi(async (api) => {399 const tx = api.tx.nft.enableContractSponsoring(contractAddress, enable);400 const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;401 const result = getGenericResult(events);402403 expect(result.success).to.be.false;404 });405}406407export async function setContractSponsoringRateLimitExpectSuccess(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {408 await usingApi(async (api) => {409 const tx = api.tx.nft.setContractSponsoringRateLimit(contractAddress, rateLimit);410 const events = await submitTransactionAsync(sender, tx);411 const result = getGenericResult(events);412413 expect(result.success).to.be.true;414 });415}416417export async function setContractSponsoringRateLimitExpectFailure(sender: IKeyringPair, contractAddress: AccountId | string, rateLimit: number) {418 await usingApi(async (api) => {419 const tx = api.tx.nft.setContractSponsoringRateLimit(contractAddress, rateLimit);420 const events = await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;421 const result = getGenericResult(events);422423 expect(result.success).to.be.false;424 });425}426427export async function setVariableMetaDataExpectSuccess(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {428 await usingApi(async (api) => {429 const tx = api.tx.nft.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));430 const events = await submitTransactionAsync(sender, tx);431 const result = getGenericResult(events);432433 expect(result.success).to.be.true;434 });435}436437export async function setVariableMetaDataExpectFailure(sender: IKeyringPair, collectionId: number, itemId: number, data: number[]) {438 await usingApi(async (api) => {439 const tx = api.tx.nft.setVariableMetaData(collectionId, itemId, '0x' + Buffer.from(data).toString('hex'));440 await expect(submitTransactionExpectFailAsync(sender, tx)).to.be.rejected;441 });442}443444export interface CreateFungibleData extends Struct {445 readonly value: u128;446}447448export interface CreateReFungibleData extends Struct {}449export interface CreateNftData extends Struct {}450451export interface CreateItemData extends Enum {452 NFT: CreateNftData;453 Fungible: CreateFungibleData;454 ReFungible: CreateReFungibleData;455}456457export async function burnItemExpectSuccess(owner: IKeyringPair, collectionId: number, tokenId: number, value = 0) {458 await usingApi(async (api) => {459 const tx = api.tx.nft.burnItem(collectionId, tokenId, value);460 const events = await submitTransactionAsync(owner, tx);461 const result = getGenericResult(events);462 463 const item: any = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON();464 465 466 expect(result.success).to.be.true;467 468 expect(item).to.be.not.null;469 expect(item.Owner).to.be.equal(nullPublicKey);470 });471}472473export async function474approveExpectSuccess(collectionId: number,475 tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number = 1) {476 await usingApi(async (api: ApiPromise) => {477 const allowanceBefore =478 await api.query.nft.allowances(collectionId, [tokenId, owner.address, approved.address]) as unknown as BN;479 const approveNftTx = await api.tx.nft.approve(approved.address, collectionId, tokenId, amount);480 const events = await submitTransactionAsync(owner, approveNftTx);481 const result = getCreateItemResult(events);482 483 expect(result.success).to.be.true;484 const allowanceAfter =485 await api.query.nft.allowances(collectionId, [tokenId, owner.address, approved.address]) as unknown as BN;486 expect(allowanceAfter.toNumber() - allowanceBefore.toNumber()).to.be.equal(amount);487 });488}489490export async function491transferFromExpectSuccess(collectionId: number,492 tokenId: number,493 accountApproved: IKeyringPair,494 accountFrom: IKeyringPair,495 accountTo: IKeyringPair,496 value: number = 1,497 type: string = 'NFT') {498 await usingApi(async (api: ApiPromise) => {499 let balanceBefore = new BN(0);500 if (type === 'Fungible') {501 balanceBefore = await api.query.nft.balance(collectionId, accountTo.address) as unknown as BN;502 }503 const transferFromTx = await api.tx.nft.transferFrom(504 accountFrom.address, accountTo.address, collectionId, tokenId, value);505 const events = await submitTransactionAsync(accountFrom, transferFromTx);506 const result = getCreateItemResult(events);507 508 expect(result.success).to.be.true;509 if (type === 'NFT') {510 const nftItemData = await api.query.nft.nftItemList(collectionId, tokenId) as unknown as ITokenDataType;511 expect(nftItemData.Owner.toString()).to.be.equal(accountTo.address);512 }513 if (type === 'Fungible') {514 const balanceAfter = await api.query.nft.balance(collectionId, accountTo.address) as unknown as BN;515 expect(balanceAfter.sub(balanceBefore).toNumber()).to.be.equal(value);516 }517 if (type === 'ReFungible') {518 const nftItemData =519 await api.query.nft.reFungibleItemList(collectionId, tokenId) as unknown as IReFungibleTokenDataType;520 expect(nftItemData.Owner[0].Owner.toString()).to.be.equal(accountTo.address);521 expect(nftItemData.Owner[0].Fraction.toNumber()).to.be.equal(value);522 }523 });524}525526export async function527transferFromExpectFail(collectionId: number,528 tokenId: number,529 accountApproved: IKeyringPair,530 accountFrom: IKeyringPair,531 accountTo: IKeyringPair,532 value: number = 1) {533 await usingApi(async (api: ApiPromise) => {534 const transferFromTx = await api.tx.nft.transferFrom(535 accountFrom.address, accountTo.address, collectionId, tokenId, value);536 const events = await expect(submitTransactionExpectFailAsync(accountApproved, transferFromTx)).to.be.rejected;537 const result = getCreateCollectionResult(events);538 539 expect(result.success).to.be.false;540 });541}542543export async function544transferExpectSuccess(collectionId: number,545 tokenId: number,546 sender: IKeyringPair,547 recipient: IKeyringPair,548 value: number = 1,549 type: string = 'NFT') {550 await usingApi(async (api: ApiPromise) => {551 let balanceBefore = new BN(0);552 if (type === 'Fungible') {553 balanceBefore = await api.query.nft.balance(collectionId, recipient.address) as unknown as BN;554 }555 const transferTx = await api.tx.nft.transfer(recipient.address, collectionId, tokenId, value);556 const events = await submitTransactionAsync(sender, transferTx);557 const result = getCreateItemResult(events);558 559 expect(result.success).to.be.true;560 if (type === 'NFT') {561 const nftItemData = await api.query.nft.nftItemList(collectionId, tokenId) as unknown as ITokenDataType;562 expect(nftItemData.Owner.toString()).to.be.equal(recipient.address);563 }564 if (type === 'Fungible') {565 const balanceAfter = await api.query.nft.balance(collectionId, recipient.address) as unknown as BN;566 expect(balanceAfter.sub(balanceBefore).toNumber()).to.be.equal(value);567 }568 if (type === 'ReFungible') {569 const nftItemData =570 await api.query.nft.reFungibleItemList(collectionId, tokenId) as unknown as IReFungibleTokenDataType;571 expect(nftItemData.Owner[0].Owner.toString()).to.be.equal(recipient.address);572 expect(nftItemData.Owner[0].Fraction.toNumber()).to.be.equal(value);573 }574 });575}576577export async function578transferExpectFail(collectionId: number,579 tokenId: number,580 sender: IKeyringPair,581 recipient: IKeyringPair,582 value: number = 1,583 type: string = 'NFT') {584 await usingApi(async (api: ApiPromise) => {585 const transferTx = await api.tx.nft.transfer(recipient.address, collectionId, tokenId, value);586 const events = await expect(submitTransactionExpectFailAsync(sender, transferTx)).to.be.rejected;587 if (events && Array.isArray(events)) {588 const result = getCreateCollectionResult(events);589 590 expect(result.success).to.be.false;591 }592 });593}594595export async function596approveExpectFail(collectionId: number,597 tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number = 1) {598 await usingApi(async (api: ApiPromise) => {599 const approveNftTx = await api.tx.nft.approve(approved.address, collectionId, tokenId, amount);600 const events = await expect(submitTransactionExpectFailAsync(owner, approveNftTx)).to.be.rejected;601 const result = getCreateCollectionResult(events);602 603 expect(result.success).to.be.false;604 });605}606607export async function createItemExpectSuccess(608 sender: IKeyringPair, collectionId: number, createMode: string, owner: string = '') {609 let newItemId: number = 0;610 await usingApi(async (api) => {611 const AItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString(), 10);612 const Aitem: any = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON();613 const AItemBalance = new BigNumber(Aitem.Value);614615 if (owner === '') {616 owner = sender.address;617 }618619 let tx;620 if (createMode === 'Fungible') {621 const createData = {fungible: {value: 10}};622 tx = api.tx.nft.createItem(collectionId, owner, createData);623 } else {624 tx = api.tx.nft.createItem(collectionId, owner, createMode);625 }626 const events = await submitTransactionAsync(sender, tx);627 const result = getCreateItemResult(events);628629 const BItemCount = parseInt((await api.query.nft.itemListIndex(collectionId)).toString(), 10);630 const Bitem: any = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON();631 const BItemBalance = new BigNumber(Bitem.Value);632633 634 635 expect(result.success).to.be.true;636 if (createMode === 'Fungible') {637 expect(BItemBalance.minus(AItemBalance).toNumber()).to.be.equal(10);638 } else {639 expect(BItemCount).to.be.equal(AItemCount + 1);640 }641 expect(collectionId).to.be.equal(result.collectionId);642 expect(BItemCount).to.be.equal(result.itemId);643 newItemId = result.itemId;644 });645 return newItemId;646}647648export async function enableWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number) {649 await usingApi(async (api) => {650651 652 const tx = api.tx.nft.setPublicAccessMode(collectionId, 'WhiteList');653 const events = await submitTransactionAsync(sender, tx);654 const result = getGenericResult(events);655656 657 const collection: any = (await api.query.nft.collection(collectionId)).toJSON();658659 660 661 expect(result.success).to.be.true;662 expect(collection.Access).to.be.equal('WhiteList');663 });664}665666export async function enablePublicMintingExpectSuccess(sender: IKeyringPair, collectionId: number) {667 await usingApi(async (api) => {668669 670 const tx = api.tx.nft.setMintPermission(collectionId, true);671 const events = await submitTransactionAsync(sender, tx);672 const result = getGenericResult(events);673674 675 const collection: any = (await api.query.nft.collection(collectionId)).toJSON();676677 678 expect(result.success).to.be.true;679 expect(collection.MintMode).to.be.equal(true);680 });681}682683export async function addToWhiteListExpectSuccess(sender: IKeyringPair, collectionId: number, address: string) {684 await usingApi(async (api) => {685686 const whiteListedBefore = (await api.query.nft.whiteList(collectionId, address)).toJSON();687688 689 const tx = api.tx.nft.addToWhiteList(collectionId, address);690 const events = await submitTransactionAsync(sender, tx);691 const result = getGenericResult(events);692693 const whiteListedAfter = (await api.query.nft.whiteList(collectionId, address)).toJSON();694695 696 697 expect(result.success).to.be.true;698 699 expect(whiteListedBefore).to.be.false;700 701 expect(whiteListedAfter).to.be.true;702 });703}704705export const getDetailedCollectionInfo = async (api: ApiPromise, collectionId: number)706 : Promise<ICollectionInterface | null> => {707 return await api.query.nft.collection(collectionId) as unknown as ICollectionInterface;708};709710export const getCreatedCollectionCount = async (api: ApiPromise): Promise<number> => {711 712 return (await api.query.nft.createdCollectionCount() as unknown as BN).toNumber();713};