From fe8844c28c102162196f468482a14c069802e2bf Mon Sep 17 00:00:00 2001 From: Greg Zaitsev Date: Fri, 12 Feb 2021 14:12:36 +0000 Subject: [PATCH] Merge pull request #97 from usetech-llc/feature/NFTPAR-281_overflow_tests Fungible overflow tests --- --- a/tests/package.json +++ b/tests/package.json @@ -40,7 +40,8 @@ "testSetMintPermission": "mocha --timeout 9999999 -r ts-node/register ./**/setMintPermission.test.ts", "testCreditFeesToTreasury": "mocha --timeout 9999999 -r ts-node/register ./**/creditFeesToTreasury.test.ts", "testEnableContractSponsoring": "mocha --timeout 9999999 -r ts-node/register ./**/enableContractSponsoring.test.ts", - "testSetContractSponsoringRateLimit": "mocha --timeout 9999999 -r ts-node/register ./**/setContractSponsoringRateLimit.test.ts" + "testSetContractSponsoringRateLimit": "mocha --timeout 9999999 -r ts-node/register ./**/setContractSponsoringRateLimit.test.ts", + "testOverflow": "mocha --timeout 9999999 -r ts-node/register ./**/overflow.test.ts" }, "author": "", "license": "SEE LICENSE IN ../LICENSE", --- a/tests/src/approve.test.ts +++ b/tests/src/approve.test.ts @@ -12,8 +12,11 @@ approveExpectFail, approveExpectSuccess, createCollectionExpectSuccess, + createFungibleItemExpectSuccess, createItemExpectSuccess, destroyCollectionExpectSuccess, + transferFromExpectSuccess, + U128_MAX, } from './util/helpers'; chai.use(chaiAsPromised); --- /dev/null +++ b/tests/src/overflow.test.ts @@ -0,0 +1,67 @@ +// +// This file is subject to the terms and conditions defined in +// file 'LICENSE', which is part of this source code package. +// + +import { IKeyringPair } from "@polkadot/types/types"; +import chai from 'chai'; +import chaiAsPromised from "chai-as-promised"; +import privateKey from "./substrate/privateKey"; +import usingApi from "./substrate/substrate-api"; +import { approveExpectFail, approveExpectSuccess, createCollectionExpectSuccess, createFungibleItemExpectSuccess, getAllowance, getFungibleBalance, transferExpectFail, transferExpectSuccess, transferFromExpectFail, transferFromExpectSuccess, U128_MAX } from "./util/helpers"; + +chai.use(chaiAsPromised); +const expect = chai.expect; + +describe('Integration Test fungible overflows', () => { + let alice: IKeyringPair; + let bob: IKeyringPair; + let charlie: IKeyringPair; + + before(async () => { + await usingApi(async () => { + alice = privateKey('//Alice'); + bob = privateKey('//Bob'); + charlie = privateKey('//Charlie'); + }); + }); + + it('fails when overflows on transfer', async () => { + const fungibleCollectionId = await createCollectionExpectSuccess({ mode: { type: 'Fungible', decimalPoints: 0 } }); + + await createFungibleItemExpectSuccess(alice, fungibleCollectionId, { Value: U128_MAX }); + await transferExpectSuccess(fungibleCollectionId, 0, alice, bob, U128_MAX, 'Fungible'); + + await createFungibleItemExpectSuccess(alice, fungibleCollectionId, { Value: 1n }); + await transferExpectFail(fungibleCollectionId, 0, alice, bob, 1, 'Fungible'); + + expect(await getFungibleBalance(fungibleCollectionId, alice.address)).to.equal(1n); + expect(await getFungibleBalance(fungibleCollectionId, bob.address)).to.equal(U128_MAX); + }); + + it('fails on allowance overflow', async () => { + const fungibleCollectionId = await createCollectionExpectSuccess({ mode: { type: 'Fungible', decimalPoints: 0 } }); + + await createFungibleItemExpectSuccess(alice, fungibleCollectionId, { Value: U128_MAX }); + await approveExpectSuccess(fungibleCollectionId, 0, alice, bob, U128_MAX); + await approveExpectFail(fungibleCollectionId, 0, alice, bob, U128_MAX); + }); + + it('fails when overflows on transferFrom', async () => { + const fungibleCollectionId = await createCollectionExpectSuccess({ mode: { type: 'Fungible', decimalPoints: 0 } }); + + await createFungibleItemExpectSuccess(alice, fungibleCollectionId, { Value: U128_MAX }); + await approveExpectSuccess(fungibleCollectionId, 0, alice, bob, U128_MAX); + await transferFromExpectSuccess(fungibleCollectionId, 0, bob, alice, charlie, U128_MAX, 'Fungible'); + + expect(await getFungibleBalance(fungibleCollectionId, charlie.address)).to.equal(U128_MAX); + expect((await getAllowance(fungibleCollectionId, 0, alice.address, bob.address)).toString()).to.equal('0'); + + await createFungibleItemExpectSuccess(alice, fungibleCollectionId, { Value: U128_MAX }); + await approveExpectSuccess(fungibleCollectionId, 0, alice, bob, 1n); + await transferFromExpectFail(fungibleCollectionId, 0, bob, alice, charlie, 1); + + expect(await getFungibleBalance(fungibleCollectionId, charlie.address)).to.equal(U128_MAX); + expect((await getAllowance(fungibleCollectionId, 0, alice.address, bob.address)).toString()).to.equal('1'); + }); +}); --- a/tests/src/removeFromContractWhiteList.test.ts +++ b/tests/src/removeFromContractWhiteList.test.ts @@ -1,3 +1,8 @@ +// +// This file is subject to the terms and conditions defined in +// file 'LICENSE', which is part of this source code package. +// + import privateKey from "./substrate/privateKey"; import usingApi from "./substrate/substrate-api"; import { deployFlipper, toggleFlipValueExpectFailure, toggleFlipValueExpectSuccess } from "./util/contracthelpers"; --- a/tests/src/substrate/substrate-api.ts +++ b/tests/src/substrate/substrate-api.ts @@ -18,9 +18,10 @@ return { provider: wsProvider, types: rtt }; } -export default async function usingApi(action: (api: ApiPromise) => Promise, settings: ApiOptions | undefined = undefined): Promise { +export default async function usingApi(action: (api: ApiPromise) => Promise, settings: ApiOptions | undefined = undefined): Promise { settings = settings || defaultApiOptions(); let api: ApiPromise = new ApiPromise(settings); + let result: T = null as unknown as T; // TODO: Remove, this is temporary: Filter unneeded API output // (Jaco promised it will be removed in the next version) @@ -32,15 +33,16 @@ try { await promisifySubstrate(api, async () => { - if(api) { + if (api) { await api.isReadyOrError; - await action(api); + result = await action(api); } })(); } finally { await api.disconnect(); console.error = consoleErr; } + return result as T; } enum TransactionStatus { --- a/tests/src/transferFrom.test.ts +++ b/tests/src/transferFrom.test.ts @@ -11,8 +11,10 @@ approveExpectFail, approveExpectSuccess, createCollectionExpectSuccess, + createFungibleItemExpectSuccess, createItemExpectSuccess, destroyCollectionExpectSuccess, + getAllowance, transferFromExpectFail, transferFromExpectSuccess, burnItemExpectSuccess, @@ -48,6 +50,22 @@ newReFungibleTokenId, Bob, Alice, Charlie, 100, 'ReFungible'); }); }); + + it('Should reduce allowance if value is big', async () => { + await usingApi(async () => { + const alice = privateKey('//Alice'); + const bob = privateKey('//Bob'); + const charlie = privateKey('//Charlie'); + + // fungible + const fungibleCollectionId = await createCollectionExpectSuccess({mode: {type: 'Fungible', decimalPoints: 0}}); + const newFungibleTokenId = await createFungibleItemExpectSuccess(alice, fungibleCollectionId, { Value: 500000n }); + + await approveExpectSuccess(fungibleCollectionId, newFungibleTokenId, alice, bob, 500000n); + await transferFromExpectSuccess(fungibleCollectionId, newFungibleTokenId, bob, alice, charlie, 500000n, 'Fungible'); + expect((await getAllowance(fungibleCollectionId, newFungibleTokenId, alice.address, bob.address)).toString()).to.equal('0'); + }); + }); }); describe('Negative Integration Test transferFrom(from, recipient, collection_id, item_id, value):', () => { --- a/tests/src/util/helpers.ts +++ b/tests/src/util/helpers.ts @@ -21,6 +21,8 @@ chai.use(chaiAsPromised); const expect = chai.expect; +export const U128_MAX = (1n << 128n) - 1n; + type GenericResult = { success: boolean, }; @@ -238,6 +240,13 @@ return unused; } +export async function getAllowance(collectionId: number, tokenId: number, owner: string, approved: string) { + return await usingApi(async (api) => { + const bn = await api.query.nft.allowances(collectionId, [tokenId, owner, approved]) as unknown as BN; + return BigInt(bn.toString()); + }); +} + export function findUnusedAddresses(api: ApiPromise, amount: number): Promise { return Promise.all(new Array(amount).fill(null).map(() => findUnusedAddress(api, '_' + Date.now()))); } @@ -479,18 +488,20 @@ }); } -export interface CreateFungibleData extends Struct { - readonly value: u128; +export interface CreateFungibleData { + readonly Value: bigint; } -export interface CreateReFungibleData extends Struct {} -export interface CreateNftData extends Struct {} +export interface CreateReFungibleData { } +export interface CreateNftData { } -export interface CreateItemData extends Enum { +export type CreateItemData = { NFT: CreateNftData; +} | { Fungible: CreateFungibleData; +} | { ReFungible: CreateReFungibleData; -} +}; export async function burnItemExpectSuccess(owner: IKeyringPair, collectionId: number, tokenId: number, value = 0) { await usingApi(async (api) => { @@ -510,7 +521,7 @@ export async function approveExpectSuccess(collectionId: number, - tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number = 1) { //alice,bob + tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number | bigint = 1) { await usingApi(async (api: ApiPromise) => { const allowanceBefore = await api.query.nft.allowances(collectionId, [tokenId, owner.address, approved.address]) as unknown as BN; @@ -521,17 +532,17 @@ expect(result.success).to.be.true; const allowanceAfter = await api.query.nft.allowances(collectionId, [tokenId, owner.address, approved.address]) as unknown as BN; - expect(allowanceAfter.toNumber() - allowanceBefore.toNumber()).to.be.equal(amount); + expect(allowanceAfter.sub(allowanceBefore).toString()).to.be.equal(amount.toString()); }); } export async function transferFromExpectSuccess(collectionId: number, tokenId: number, - accountApproved: IKeyringPair, //bob - accountFrom: IKeyringPair, //alice - accountTo: IKeyringPair, //charlie - value: number = 1, + accountApproved: IKeyringPair, + accountFrom: IKeyringPair, + accountTo: IKeyringPair, + value: number | bigint = 1, type: string = 'NFT') { await usingApi(async (api: ApiPromise) => { let balanceBefore = new BN(0); @@ -550,7 +561,7 @@ } if (type === 'Fungible') { const balanceAfter = await api.query.nft.balance(collectionId, accountTo.address) as unknown as BN; - expect(balanceAfter.sub(balanceBefore).toNumber()).to.be.equal(value); + expect(balanceAfter.sub(balanceBefore).toString()).to.be.equal(value.toString()); } if (type === 'ReFungible') { const nftItemData = @@ -567,7 +578,7 @@ accountApproved: IKeyringPair, accountFrom: IKeyringPair, accountTo: IKeyringPair, - value: number = 1) { + value: number | bigint = 1) { await usingApi(async (api: ApiPromise) => { const transferFromTx = await api.tx.nft.transferFrom( accountFrom.address, accountTo.address, collectionId, tokenId, value); @@ -583,7 +594,7 @@ tokenId: number, sender: IKeyringPair, recipient: IKeyringPair, - value: number = 1, + value: number | bigint = 1, type: string = 'NFT') { await usingApi(async (api: ApiPromise) => { let balanceBefore = new BN(0); @@ -601,7 +612,7 @@ } if (type === 'Fungible') { const balanceAfter = await api.query.nft.balance(collectionId, recipient.address) as unknown as BN; - expect(balanceAfter.sub(balanceBefore).toNumber()).to.be.equal(value); + expect(balanceAfter.sub(balanceBefore).toString()).to.be.equal(value.toString()); } if (type === 'ReFungible') { const nftItemData = @@ -617,7 +628,7 @@ tokenId: number, sender: IKeyringPair, recipient: IKeyringPair, - value: number = 1, + value: number | bigint = 1, type: string = 'NFT') { await usingApi(async (api: ApiPromise) => { const transferTx = await api.tx.nft.transfer(recipient.address, collectionId, tokenId, value); @@ -632,7 +643,7 @@ export async function approveExpectFail(collectionId: number, - tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number = 1) { + tokenId: number, owner: IKeyringPair, approved: IKeyringPair, amount: number | bigint = 1) { await usingApi(async (api: ApiPromise) => { const approveNftTx = await api.tx.nft.approve(approved.address, collectionId, tokenId, amount); const events = await expect(submitTransactionExpectFailAsync(owner, approveNftTx)).to.be.rejected; @@ -642,6 +653,33 @@ }); } +export async function getFungibleBalance( + collectionId: number, + owner: string, +) { + return await usingApi(async (api) => { + const response = (await api.query.nft.fungibleItemList(collectionId, owner)).toJSON() as unknown as {Value: string}; + return BigInt(response.Value); + }); +} + +export async function createFungibleItemExpectSuccess( + sender: IKeyringPair, + collectionId: number, + data: CreateFungibleData, + owner: string = sender.address, +) { + return await usingApi(async (api) => { + const tx = api.tx.nft.createItem(collectionId, owner, { Fungible: data }); + + const events = await submitTransactionAsync(sender, tx); + const result = getCreateItemResult(events); + + expect(result.success).to.be.true; + return result.itemId; + }); +} + export async function createItemExpectSuccess( sender: IKeyringPair, collectionId: number, createMode: string, owner: string = '') { let newItemId: number = 0; --- a/tests/yarn.lock +++ b/tests/yarn.lock @@ -4710,7 +4710,7 @@ dependencies: ci-info "^2.0.0" -is-core-module@^2.1.0: +is-core-module@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.2.0.tgz#97037ef3d52224d85163f5597b2b63d9afed981a" integrity sha512-XRAfAdyyY5F5cOXn7hYQDqh2Xmii+DEfIcQGxK/uNwMHhIkPWO0g8msXcbzLe+MpGoR951MlqM/2iIlU4vKDdQ== @@ -7110,11 +7110,11 @@ integrity sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo= resolve@^1.1.6, resolve@^1.10.0, resolve@^1.10.1, resolve@^1.13.1, resolve@^1.17.0, resolve@^1.18.1, resolve@^1.19.0, resolve@^1.3.2: - version "1.19.0" - resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.19.0.tgz#1af5bf630409734a067cae29318aac7fa29a267c" - integrity sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg== + version "1.20.0" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.20.0.tgz#629a013fb3f70755d6f0b7935cc1c2c5378b1975" + integrity sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A== dependencies: - is-core-module "^2.1.0" + is-core-module "^2.2.0" path-parse "^1.0.6" responselike@^1.0.2: -- gitstuff