From 9505eb68d4e488524e083ec928a8d1b37d30c42c Mon Sep 17 00:00:00 2001 From: Yaroslav Bolyukin Date: Wed, 18 Jan 2023 18:36:19 +0000 Subject: [PATCH] Merge pull request #841 from UniqueNetwork/tests/generalization Nesting to non-existing tokens --- --- a/Cargo.lock +++ b/Cargo.lock @@ -6754,6 +6754,7 @@ "frame-benchmarking", "frame-support", "frame-system", + "log", "pallet-common", "pallet-evm", "parity-scale-codec 3.2.1", --- a/pallets/nonfungible/src/lib.rs +++ b/pallets/nonfungible/src/lib.rs @@ -1332,7 +1332,10 @@ let permissive = nesting.permissive; if permissive { - // Pass + ensure!( + >::contains_key((handle.id, under)), + >::TokenNotFound + ); } else if nesting.token_owner && >::check_indirectly_owned( sender.clone(), @@ -1341,9 +1344,12 @@ Some(from), nesting_budget, )? { - // Pass + // Pass, token existence is checked in `check_indirectly_owned` } else if nesting.collection_admin && handle.is_owner_or_admin(&sender) { - // Pass + ensure!( + >::contains_key((handle.id, under)), + >::TokenNotFound + ); } else { fail!(>::UserIsNotAllowedToNest); } --- a/pallets/structure/Cargo.toml +++ b/pallets/structure/Cargo.toml @@ -17,19 +17,10 @@ ] } up-data-structs = { path = "../../primitives/data-structs", default-features = false } pallet-evm = { default-features = false, git = "https://github.com/uniquenetwork/frontier", branch = "unique-polkadot-v0.9.36" } +log = { version = "0.4.17", default-features = false } [features] default = ["std"] -std = [ - "frame-support/std", - "frame-system/std", - "frame-benchmarking/std", - "sp-std/std", - "pallet-common/std", - "scale-info/std", - "parity-scale-codec/std", - "up-data-structs/std", - "pallet-evm/std", -] +std = ["frame-support/std", "frame-system/std", "frame-benchmarking/std", "sp-std/std", "pallet-common/std", "scale-info/std", "parity-scale-codec/std", "up-data-structs/std", "pallet-evm/std"] runtime-benchmarks = ['frame-benchmarking', 'pallet-common/runtime-benchmarks'] try-runtime = ["frame-support/try-runtime"] --- a/pallets/structure/src/lib.rs +++ b/pallets/structure/src/lib.rs @@ -54,6 +54,7 @@ #![cfg_attr(not(feature = "std"), no_std)] use pallet_common::CommonCollectionOperations; +use pallet_common::{erc::CrossAccountId, eth::is_collection}; use sp_std::collections::btree_set::BTreeSet; use frame_support::dispatch::{DispatchError, DispatchResult, DispatchResultWithPostInfo}; @@ -86,6 +87,8 @@ BreadthLimit, /// Couldn't find the token owner that is itself a token. TokenNotFound, + /// Tried to nest token under collection contract address, instead of token address + CantNestTokenUnderCollection, } #[pallet::event] @@ -302,7 +305,7 @@ token_id: TokenId, nesting_budget: &dyn Budget, ) -> DispatchResult { - Self::try_exec_if_owner_is_valid_nft(under, |collection, parent_id| { + Self::try_exec_if_token(under, |collection, parent_id| { collection.check_nesting(from, (collection_id, token_id), parent_id, nesting_budget) }) } @@ -319,7 +322,7 @@ token_id: TokenId, nesting_budget: &dyn Budget, ) -> DispatchResult { - Self::try_exec_if_owner_is_valid_nft(under, |collection, parent_id| { + Self::try_exec_if_token(under, |collection, parent_id| { collection.check_nesting(from, (collection_id, token_id), parent_id, nesting_budget)?; collection.nest(parent_id, (collection_id, token_id)); @@ -336,7 +339,7 @@ collection_id: CollectionId, token_id: TokenId, ) { - Self::exec_if_owner_is_valid_nft(owner, |collection, parent_id| { + Self::exec_if_token(owner, |collection, parent_id| { collection.nest(parent_id, (collection_id, token_id)) }); } @@ -347,45 +350,45 @@ collection_id: CollectionId, token_id: TokenId, ) { - Self::exec_if_owner_is_valid_nft(owner, |collection, parent_id| { - collection.unnest(parent_id, (collection_id, token_id)) - }); + if let Err(e) = Self::try_exec_if_token(owner, |collection, parent_id| { + collection.unnest(parent_id, (collection_id, token_id)); + Ok(()) + }) { + log::warn!("unnest precondition failed: {e:?}") + } } - fn exec_if_owner_is_valid_nft( + /// # Panics + /// If [`Self::try_exec_if_token`] fails + fn exec_if_token( account: &T::CrossAccountId, action: impl FnOnce(&dyn CommonCollectionOperations, TokenId), ) { - Self::try_exec_if_owner_is_valid_nft(account, |collection, id| { + Self::try_exec_if_token(account, |collection, id| { action(collection, id); Ok(()) }) .unwrap(); } - fn try_exec_if_owner_is_valid_nft( + /// If `account` is a token address, execute `action` providing found collection as an argument + /// Token may not exist, it is expected it will be checked in the callback. + fn try_exec_if_token( account: &T::CrossAccountId, action: impl FnOnce(&dyn CommonCollectionOperations, TokenId) -> DispatchResult, ) -> DispatchResult { - let account = T::CrossTokenAddressMapping::address_to_token(account); - - if account.is_none() { - return Ok(()); + if is_collection(&account.as_eth()) { + fail!(>::CantNestTokenUnderCollection); } + let Some((collection, token)) = T::CrossTokenAddressMapping::address_to_token(account) else { + return Ok(()) + }; - let account = account.unwrap(); - - let handle = >::try_get(account.0); - - if handle.is_err() { - return Ok(()); - } - - let handle = handle.unwrap(); + let handle = >::try_get(collection)?; let dispatch = T::CollectionDispatch::dispatch(handle); let dispatch = dispatch.as_dyn(); - action(dispatch, account.1) + action(dispatch, token) } } --- a/tests/package.json +++ b/tests/package.json @@ -100,7 +100,7 @@ "testFT": "mocha --timeout 9999999 -r ts-node/register ./**/fungible.test.ts", "testEthFT": "mocha --timeout 9999999 -r ts-node/register ./**/eth/fungible.test.ts", "testRPC": "mocha --timeout 9999999 -r ts-node/register ./**/rpc.test.ts", - "testPromotion": "yarn setup && mocha --timeout 9999999 -r ts-node/register ./**/app-promotion.*test.ts", + "testPromotion": "yarn setup && mocha --timeout 9999999 -r ts-node/register ./**/appPromotion/*test.ts", "testXcmUnique": "RUN_XCM_TESTS=1 mocha --timeout 9999999 -r ts-node/register ./**/xcm/xcmUnique.test.ts", "testXcmQuartz": "RUN_XCM_TESTS=1 mocha --timeout 9999999 -r ts-node/register ./**/xcm/xcmQuartz.test.ts", "testXcmOpal": "RUN_XCM_TESTS=1 mocha --timeout 9999999 -r ts-node/register ./**/xcm/xcmOpal.test.ts", --- a/tests/src/app-promotion.seqtest.ts +++ /dev/null @@ -1,82 +0,0 @@ -// Copyright 2019-2022 Unique Network (Gibraltar) Ltd. -// This file is part of Unique Network. - -// Unique Network is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. - -// Unique Network is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. - -// You should have received a copy of the GNU General Public License -// along with Unique Network. If not, see . - -import {IKeyringPair} from '@polkadot/types/types'; -import {itSub, usingPlaygrounds, Pallets, requirePalletsOrSkip} from './util'; -import {expect} from './eth/util'; - -let superuser: IKeyringPair; -let donor: IKeyringPair; -let palletAdmin: IKeyringPair; - -describe('App promotion', () => { - before(async function () { - await usingPlaygrounds(async (helper, privateKey) => { - requirePalletsOrSkip(this, helper, [Pallets.AppPromotion]); - superuser = await privateKey('//Alice'); - donor = await privateKey({filename: __filename}); - palletAdmin = await privateKey('//PromotionAdmin'); - const api = helper.getApi(); - await helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address}))); - }); - }); - - after(async function () { - await usingPlaygrounds(async (helper) => { - if (helper.fetchMissingPalletNames([Pallets.AppPromotion]).length != 0) return; - const api = helper.getApi(); - await helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address}))); - }); - }); - - describe('admin adress', () => { - itSub('can be set by sudo only', async ({helper}) => { - const api = helper.getApi(); - const [nonAdmin] = await helper.arrange.createAccounts([10n], donor); - // nonAdmin can not set admin not from himself nor as a sudo - await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.setAdminAddress({Substrate: nonAdmin.address}))).to.be.rejected; - await expect(helper.signTransaction(nonAdmin, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: nonAdmin.address})))).to.be.rejected; - }); - - itSub('can be any valid CrossAccountId', async ({helper}) => { - // We are not going to set an eth address as a sponsor, - // but we do want to check, it doesn't break anything; - const api = helper.getApi(); - const [account] = await helper.arrange.createAccounts([10n], donor); - const ethAccount = helper.address.substrateToEth(account.address); - // Alice sets Ethereum address as a sudo. Then Substrate address back... - await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Ethereum: ethAccount})))).to.be.fulfilled; - await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address})))).to.be.fulfilled; - - // ...It doesn't break anything; - const collection = await helper.nft.mintCollection(account, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); - await expect(helper.signTransaction(account, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; - }); - - itSub('can be reassigned', async ({helper}) => { - const api = helper.getApi(); - const [oldAdmin, newAdmin, collectionOwner] = await helper.arrange.createAccounts([10n, 10n, 10n], donor); - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); - - await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: oldAdmin.address})))).to.be.fulfilled; - await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: newAdmin.address})))).to.be.fulfilled; - await expect(helper.signTransaction(oldAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; - - await expect(helper.signTransaction(newAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.fulfilled; - }); - }); -}); - --- a/tests/src/app-promotion.test.ts +++ /dev/null @@ -1,690 +0,0 @@ -// Copyright 2019-2022 Unique Network (Gibraltar) Ltd. -// This file is part of Unique Network. - -// Unique Network is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. - -// Unique Network is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. - -// You should have received a copy of the GNU General Public License -// along with Unique Network. If not, see . - -import {IKeyringPair} from '@polkadot/types/types'; -import { - itSub, usingPlaygrounds, Pallets, requirePalletsOrSkip, LOCKING_PERIOD, UNLOCKING_PERIOD, -} from './util'; -import {DevUniqueHelper} from './util/playgrounds/unique.dev'; -import {itEth, expect, SponsoringMode} from './eth/util'; - -let donor: IKeyringPair; -let palletAdmin: IKeyringPair; -let nominal: bigint; -let palletAddress: string; -let accounts: IKeyringPair[]; -// App promotion periods: -// LOCKING_PERIOD = 12 blocks of relay -// UNLOCKING_PERIOD = 6 blocks of parachain - -describe('App promotion', () => { - before(async function () { - await usingPlaygrounds(async (helper, privateKey) => { - requirePalletsOrSkip(this, helper, [Pallets.AppPromotion]); - donor = await privateKey({filename: __filename}); - palletAddress = helper.arrange.calculatePalletAddress('appstake'); - palletAdmin = await privateKey('//PromotionAdmin'); - nominal = helper.balance.getOneTokenNominal(); - - const accountBalances = new Array(100); - accountBalances.fill(1000n); - accounts = await helper.arrange.createAccounts(accountBalances, donor); // create accounts-pool to speed up tests - }); - }); - - describe('stake extrinsic', () => { - itSub('should "lock" staking balance, add it to "staked" map, and increase "totalStaked" amount', async ({helper}) => { - const [staker, recepient] = [accounts.pop()!, accounts.pop()!]; - const totalStakedBefore = await helper.staking.getTotalStaked(); - - // Minimum stake amount is 100: - await expect(helper.staking.stake(staker, 100n * nominal - 1n)).to.be.rejected; - await helper.staking.stake(staker, 100n * nominal); - - // Staker balance is: miscFrozen: 100, feeFrozen: 100, reserved: 0n... - // ...so he can not transfer 900 - expect(await helper.balance.getSubstrateFull(staker.address)).to.contain({miscFrozen: 100n * nominal, feeFrozen: 100n * nominal, reserved: 0n}); - expect(await helper.balance.getLocked(staker.address)).to.deep.eq([{id: 'appstake', amount: 100n * nominal, reasons: 'All'}]); - await expect(helper.balance.transferToSubstrate(staker, recepient.address, 900n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions'); - - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(100n * nominal); - expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); - // it is potentially flaky test. Promotion can credited some tokens. Maybe we need to use closeTo? - expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore + 100n * nominal); // total tokens amount staked in app-promotion increased - - - await helper.staking.stake(staker, 200n * nominal); - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(300n * nominal); - const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - expect(totalStakedPerBlock[0].amount).to.equal(100n * nominal); - expect(totalStakedPerBlock[1].amount).to.equal(200n * nominal); - }); - - itSub('should allow to create maximum 10 stakes for account', async ({helper}) => { - const [staker] = await helper.arrange.createAccounts([2000n], donor); - for (let i = 0; i < 10; i++) { - await helper.staking.stake(staker, 100n * nominal); - } - - // can have 10 stakes - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(1000n * nominal); - expect(await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).to.have.length(10); - - await expect(helper.staking.stake(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.NoPermission'); - - // After unstake can stake again - await helper.staking.unstake(staker); - await helper.staking.stake(staker, 100n * nominal); - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.equal(100n * nominal); - }); - - itSub('should reject transaction if stake amount is more than total free balance minus frozen', async ({helper}) => { - const staker = accounts.pop()!; - - // Can't stake full balance because Alice needs to pay some fee - await expect(helper.staking.stake(staker, 1000n * nominal)).to.be.rejected; - await helper.staking.stake(staker, 500n * nominal); - - // Can't stake 500 tkn because Alice has Less than 500 transferable; - await expect(helper.staking.stake(staker, 500n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions'); - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(500n * nominal); - }); - - itSub('for different accounts in one block is possible', async ({helper}) => { - const crowd = [accounts.pop()!, accounts.pop()!, accounts.pop()!, accounts.pop()!]; - - const crowdStartsToStake = crowd.map(user => helper.staking.stake(user, 100n * nominal)); - await expect(Promise.all(crowdStartsToStake)).to.be.fulfilled; - - const crowdStakes = await Promise.all(crowd.map(address => helper.staking.getTotalStaked({Substrate: address.address}))); - expect(crowdStakes).to.deep.equal([100n * nominal, 100n * nominal, 100n * nominal, 100n * nominal]); - }); - }); - - describe('unstake extrinsic', () => { - itSub('should change balance state from "frozen" to "reserved", add it to "pendingUnstake" map, and subtract it from totalStaked', async ({helper}) => { - const [staker, recepient] = [accounts.pop()!, accounts.pop()!]; - const totalStakedBefore = await helper.staking.getTotalStaked(); - await helper.staking.stake(staker, 900n * nominal); - await helper.staking.unstake(staker); - - // Right after unstake balance is reserved - // Staker can not transfer - expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 900n * nominal, miscFrozen: 0n, feeFrozen: 0n}); - await expect(helper.balance.transferToSubstrate(staker, recepient.address, 100n * nominal)).to.be.rejectedWith('balances.InsufficientBalance'); - expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(900n * nominal); - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n); - expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore); - }); - - itSub('should unlock balance after unlocking period ends and remove it from "pendingUnstake"', async ({helper}) => { - const staker = accounts.pop()!; - await helper.staking.stake(staker, 100n * nominal); - await helper.staking.unstake(staker); - const [pendingUnstake] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); - - // Wait for unstaking period. Balance now free ~1000; reserved, frozen, miscFrozeb: 0n - await helper.wait.forParachainBlockNumber(pendingUnstake.block); - expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 0n, feeFrozen: 0n}); - expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); - - // staker can transfer: - await helper.balance.transferToSubstrate(staker, donor.address, 998n * nominal); - expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(1n); - }); - - itSub('should successfully unstake multiple stakes', async ({helper}) => { - const staker = accounts.pop()!; - await helper.staking.stake(staker, 100n * nominal); - await helper.staking.stake(staker, 200n * nominal); - await helper.staking.stake(staker, 300n * nominal); - - // staked: [100, 200, 300]; unstaked: 0 - let totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address}); - let pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); - let stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - expect(totalPendingUnstake).to.be.deep.equal(0n); - expect(pendingUnstake).to.be.deep.equal([]); - expect(stakes[0].amount).to.equal(100n * nominal); - expect(stakes[1].amount).to.equal(200n * nominal); - expect(stakes[2].amount).to.equal(300n * nominal); - - // Can unstake multiple stakes - await helper.staking.unstake(staker); - pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); - totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address}); - stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - expect(totalPendingUnstake).to.be.equal(600n * nominal); - expect(stakes).to.be.deep.equal([]); - expect(pendingUnstake[0].amount).to.equal(600n * nominal); - - expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 600n * nominal, feeFrozen: 0n, miscFrozen: 0n}); - await helper.wait.forParachainBlockNumber(pendingUnstake[0].block); - expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 0n, miscFrozen: 0n}); - expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); - }); - - itSub('should not have any effects if no active stakes', async ({helper}) => { - const staker = accounts.pop()!; - - // unstake has no effect if no stakes at all - await helper.staking.unstake(staker); - expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(0n); - expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); // TODO bigint closeTo helper - - // TODO stake() unstake() waitUnstaked() unstake(); - - // can't unstake if there are only pendingUnstakes - await helper.staking.stake(staker, 100n * nominal); - await helper.staking.unstake(staker); - await helper.staking.unstake(staker); - - expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal); - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n); - }); - - itSub('should keep different unlocking block for each unlocking stake', async ({helper}) => { - const staker = accounts.pop()!; - await helper.staking.stake(staker, 100n * nominal); - await helper.staking.unstake(staker); - await helper.staking.stake(staker, 120n * nominal); - await helper.staking.unstake(staker); - - const unstakingPerBlock = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); - expect(unstakingPerBlock).has.length(2); - expect(unstakingPerBlock[0].amount).to.equal(100n * nominal); - expect(unstakingPerBlock[1].amount).to.equal(120n * nominal); - }); - - itSub('should be possible for different accounts in one block', async ({helper}) => { - const stakers = [accounts.pop()!, accounts.pop()!, accounts.pop()!]; - - await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal))); - await Promise.all(stakers.map(staker => helper.staking.unstake(staker))); - - await Promise.all(stakers.map(async (staker) => { - expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal); - expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n); - })); - }); - }); - - describe('collection sponsoring', () => { - itSub('should actually sponsor transactions', async ({helper}) => { - const api = helper.getApi(); - const [collectionOwner, tokenSender, receiver] = [accounts.pop()!, accounts.pop()!, accounts.pop()!]; - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'Name', description: 'Description', tokenPrefix: 'Prefix', limits: {sponsorTransferTimeout: 0}}); - const token = await collection.mintToken(collectionOwner, {Substrate: tokenSender.address}); - await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId)); - const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress); - - await token.transfer(tokenSender, {Substrate: receiver.address}); - expect (await token.getOwner()).to.be.deep.equal({Substrate: receiver.address}); - const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress); - - // senders balance the same, transaction has sponsored - expect (await helper.balance.getSubstrate(tokenSender.address)).to.be.equal(1000n * nominal); - expect (palletBalanceBefore > palletBalanceAfter).to.be.true; - }); - - itSub('can not be set by non admin', async ({helper}) => { - const api = helper.getApi(); - const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!]; - - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); - - await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; - expect((await collection.getData())?.raw.sponsorship).to.equal('Disabled'); - }); - - itSub('should set pallet address as confirmed admin', async ({helper}) => { - const api = helper.getApi(); - const [collectionOwner, oldSponsor] = [accounts.pop()!, accounts.pop()!]; - - // Can set sponsoring for collection without sponsor - const collectionWithoutSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'No-sponsor', description: 'New Collection', tokenPrefix: 'Promotion'}); - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithoutSponsor.collectionId))).to.be.fulfilled; - expect((await collectionWithoutSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); - - // Can set sponsoring for collection with unconfirmed sponsor - const collectionWithUnconfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Unconfirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address}); - expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: oldSponsor.address}); - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithUnconfirmedSponsor.collectionId))).to.be.fulfilled; - expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); - - // Can set sponsoring for collection with confirmed sponsor - const collectionWithConfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Confirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address}); - await collectionWithConfirmedSponsor.confirmSponsorship(oldSponsor); - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithConfirmedSponsor.collectionId))).to.be.fulfilled; - expect((await collectionWithConfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); - }); - - itSub('can be overwritten by collection owner', async ({helper}) => { - const api = helper.getApi(); - const [collectionOwner, newSponsor] = [accounts.pop()!, accounts.pop()!]; - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); - const collectionId = collection.collectionId; - - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionId))).to.be.fulfilled; - - // Collection limits still can be changed by the owner - expect(await collection.setLimits(collectionOwner, {sponsorTransferTimeout: 0})).to.be.true; - expect((await collection.getData())?.raw.limits.sponsorTransferTimeout).to.be.equal(0); - expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); - - // Collection sponsor can be changed too - expect((await collection.setSponsor(collectionOwner, newSponsor.address))).to.be.true; - expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: newSponsor.address}); - }); - - itSub('should not overwrite collection limits set by the owner earlier', async ({helper}) => { - const api = helper.getApi(); - const limits = {ownerCanDestroy: true, ownerCanTransfer: true, sponsorTransferTimeout: 0}; - const collectionWithLimits = await helper.nft.mintCollection(accounts.pop()!, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits}); - - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithLimits.collectionId))).to.be.fulfilled; - expect((await collectionWithLimits.getData())?.raw.limits).to.be.deep.contain(limits); - }); - - itSub('should reject transaction if collection doesn\'t exist', async ({helper}) => { - const api = helper.getApi(); - const collectionOwner = accounts.pop()!; - - // collection has never existed - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(999999999))).to.be.rejected; - // collection has been burned - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); - await collection.burn(collectionOwner); - - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; - }); - }); - - describe('stopSponsoringCollection', () => { - itSub('can not be called by non-admin', async ({helper}) => { - const api = helper.getApi(); - const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!]; - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); - - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.fulfilled; - - await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected; - expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); - }); - - itSub('should set sponsoring as disabled', async ({helper}) => { - const api = helper.getApi(); - const [collectionOwner, recepient] = [accounts.pop()!, accounts.pop()!]; - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits: {sponsorTransferTimeout: 0}}); - const token = await collection.mintToken(collectionOwner, {Substrate: collectionOwner.address}); - - await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId)); - await helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId)); - - expect((await collection.getData())?.raw.sponsorship).to.be.equal('Disabled'); - - // Transactions are not sponsored anymore: - const ownerBalanceBefore = await helper.balance.getSubstrate(collectionOwner.address); - await token.transfer(collectionOwner, {Substrate: recepient.address}); - const ownerBalanceAfter = await helper.balance.getSubstrate(collectionOwner.address); - expect(ownerBalanceAfter < ownerBalanceBefore).to.be.equal(true); - }); - - itSub('should not affect collection which is not sponsored by pallete', async ({helper}) => { - const api = helper.getApi(); - const collectionOwner = accounts.pop()!; - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: collectionOwner.address}); - await collection.confirmSponsorship(collectionOwner); - - await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected; - - expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: collectionOwner.address}); - }); - - itSub('should reject transaction if collection does not exist', async ({helper}) => { - const collectionOwner = accounts.pop()!; - const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); - - await collection.burn(collectionOwner); - await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [collection.collectionId], true)).to.be.rejectedWith('common.CollectionNotFound'); - await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [999_999_999], true)).to.be.rejectedWith('common.CollectionNotFound'); - }); - }); - - describe('contract sponsoring', () => { - itEth('should set palletes address as a sponsor', async ({helper}) => { - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); - const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); - - await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]); - - expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; - expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); - expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ - confirmed: { - substrate: palletAddress, - }, - }); - }); - - itEth('should overwrite sponsoring mode and existed sponsor', async ({helper}) => { - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); - const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); - - await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled; - - // Contract is self sponsored - expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.be.deep.equal({ - confirmed: { - ethereum: flipper.options.address.toLowerCase(), - }, - }); - - // set promotion sponsoring - await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); - - // new sponsor is pallet address - expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; - expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); - expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ - confirmed: { - substrate: palletAddress, - }, - }); - }); - - itEth('can be overwritten by contract owner', async ({helper}) => { - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); - const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); - - // contract sponsored by pallet - await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); - - // owner sets self sponsoring - await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.not.rejected; - - expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; - expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); - expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ - confirmed: { - ethereum: flipper.options.address.toLowerCase(), - }, - }); - }); - - itEth('can not be set by non admin', async ({helper}) => { - const nonAdmin = accounts.pop()!; - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); - const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); - - await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled; - - // nonAdmin calls sponsorContract - await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission'); - - // contract still self-sponsored - expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ - confirmed: { - ethereum: flipper.options.address.toLowerCase(), - }, - }); - }); - - itEth('should actually sponsor transactions', async ({helper}) => { - // Contract caller - const caller = await helper.eth.createAccountWithBalance(donor, 1000n); - const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress); - - // Deploy flipper - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); - const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); - - // Owner sets to sponsor every tx - await contractHelper.methods.setSponsoringRateLimit(flipper.options.address, 0).send({from: contractOwner}); - await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner}); - await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address, 1000n); // transferBalanceToEth(api, alice, flipper.options.address, 1000n); - - // Set promotion to the Flipper - await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); - - // Caller calls Flipper - await flipper.methods.flip().send({from: caller}); - expect(await flipper.methods.getValue().call()).to.be.true; - - // The contracts and caller balances have not changed - const callerBalance = await helper.balance.getEthereum(caller); - const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address); - expect(callerBalance).to.be.equal(1000n * nominal); - expect(1000n * nominal === contractBalanceAfter).to.be.true; - - // The pallet balance has decreased - const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress); - expect(palletBalanceAfter < palletBalanceBefore).to.be.true; - }); - }); - - describe('stopSponsoringContract', () => { - itEth('should remove pallet address from contract sponsors', async ({helper}) => { - const caller = await helper.eth.createAccountWithBalance(donor, 1000n); - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); - await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address); - const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); - - await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner}); - await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); - await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true); - - expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.false; - expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); - expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ - disabled: null, - }); - - await flipper.methods.flip().send({from: caller}); - expect(await flipper.methods.getValue().call()).to.be.true; - - const callerBalance = await helper.balance.getEthereum(caller); - const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address); - - // caller payed for call - expect(1000n * nominal > callerBalance).to.be.true; - expect(contractBalanceAfter).to.be.equal(100n * nominal); - }); - - itEth('can not be called by non-admin', async ({helper}) => { - const nonAdmin = accounts.pop()!; - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); - - await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]); - await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address])) - .to.be.rejectedWith(/appPromotion\.NoPermission/); - }); - - itEth('should not affect a contract which is not sponsored by pallete', async ({helper}) => { - const nonAdmin = accounts.pop()!; - const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); - const flipper = await helper.eth.deployFlipper(contractOwner); - const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); - await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled; - - await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission'); - }); - }); - - describe('payoutStakers', () => { - itSub('can not be called by non admin', async ({helper}) => { - const nonAdmin = accounts.pop()!; - await expect(helper.admin.payoutStakers(nonAdmin, 100)).to.be.rejectedWith('appPromotion.NoPermission'); - }); - - itSub('should increase total staked', async ({helper}) => { - const staker = accounts.pop()!; - const totalStakedBefore = await helper.staking.getTotalStaked(); - await helper.staking.stake(staker, 100n * nominal); - - // Wait for rewards and pay - const [stakedInBlock] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stakedInBlock.block)); - const totalPayout = (await helper.admin.payoutStakers(palletAdmin, 100)).reduce((prev, payout) => prev + payout.payout, 0n); - - const totalStakedAfter = await helper.staking.getTotalStaked(); - expect(totalStakedAfter).to.equal(totalStakedBefore + (100n * nominal) + totalPayout); - // staker can unstake - await helper.staking.unstake(staker); - expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedAfter - calculateIncome(100n * nominal)); - }); - - itSub('should credit 0.05% for staking period', async ({helper}) => { - const staker = accounts.pop()!; - - await waitPromotionPeriodDoesntEnd(helper); - - await helper.staking.stake(staker, 100n * nominal); - await helper.staking.stake(staker, 200n * nominal); - - // wait rewards are available: - const [_stake1, stake2] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake2.block)); - - const payoutToStaker = (await helper.admin.payoutStakers(palletAdmin, 100)).find((payout) => payout.staker === staker.address)?.payout; - expect(payoutToStaker + 300n * nominal).to.equal(calculateIncome(300n * nominal)); - - const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - const income1 = calculateIncome(100n * nominal); - const income2 = calculateIncome(200n * nominal); - expect(totalStakedPerBlock[0].amount).to.equal(income1); - expect(totalStakedPerBlock[1].amount).to.equal(income2); - - const stakerBalance = await helper.balance.getSubstrateFull(staker.address); - expect(stakerBalance).to.contain({miscFrozen: income1 + income2, feeFrozen: income1 + income2, reserved: 0n}); - expect(stakerBalance.free / nominal).to.eq(999n); - }); - - itSub('shoud be paid for more than one period if payments was missed', async ({helper}) => { - const staker = accounts.pop()!; - - await helper.staking.stake(staker, 100n * nominal); - // wait for two rewards are available: - let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD); - - await helper.admin.payoutStakers(palletAdmin, 100); - [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - const frozenBalanceShouldBe = calculateIncome(100n * nominal, 2); - expect(stake.amount).to.be.equal(frozenBalanceShouldBe); - - const stakerFullBalance = await helper.balance.getSubstrateFull(staker.address); - - expect(stakerFullBalance).to.contain({reserved: 0n, feeFrozen: frozenBalanceShouldBe, miscFrozen: frozenBalanceShouldBe}); - }); - - itSub('should not be credited for unstaked (reserved) balance', async ({helper}) => { - // staker unstakes before rewards has been payed - const staker = accounts.pop()!; - await helper.staking.stake(staker, 100n * nominal); - const [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD); - await helper.staking.unstake(staker); - - // so he did not receive any rewards - const totalBalanceBefore = await helper.balance.getSubstrate(staker.address); - await helper.admin.payoutStakers(palletAdmin, 100); - const totalBalanceAfter = await helper.balance.getSubstrate(staker.address); - - expect(totalBalanceBefore).to.be.equal(totalBalanceAfter); - }); - - itSub('should bring compound interest', async ({helper}) => { - const staker = accounts.pop()!; - - await helper.staking.stake(staker, 100n * nominal); - - let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block)); - - await helper.admin.payoutStakers(palletAdmin, 100); - [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - expect(stake.amount).to.equal(calculateIncome(100n * nominal)); - - await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD); - await helper.admin.payoutStakers(palletAdmin, 100); - [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); - expect(stake.amount).to.equal(calculateIncome(100n * nominal, 2)); - }); - - itSub.skip('can be paid 1000 rewards in a time', async ({helper}) => { - // all other stakes should be unstaked - const oneHundredStakers = await helper.arrange.createCrowd(100, 1050n, donor); - - // stakers stakes 10 times each - for (let i = 0; i < 10; i++) { - await Promise.all(oneHundredStakers.map(staker => helper.staking.stake(staker, 100n * nominal))); - } - await helper.wait.newBlocks(40); - await helper.admin.payoutStakers(palletAdmin, 100); - }); - - itSub.skip('can handle 40.000 rewards', async ({helper}) => { - const crowdStakes = async () => { - // each account in the crowd stakes 2 times - const crowd = await helper.arrange.createCrowd(500, 300n, donor); - await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal))); - await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal))); - // - }; - - for (let i = 0; i < 40; i++) { - await crowdStakes(); - } - - // TODO pay rewards for some period - }); - }); -}); - -function calculateIncome(base: bigint, iter = 0, calcPeriod: bigint = UNLOCKING_PERIOD): bigint { - const DAY = 7200n; - const ACCURACY = 1_000_000_000n; - // 5n / 10_000n = 0.05% p/day - const income = base + base * (ACCURACY * (calcPeriod * 5n) / (10_000n * DAY)) / ACCURACY ; - - if (iter > 1) { - return calculateIncome(income, iter - 1, calcPeriod); - } else return income; -} - -function rewardAvailableInBlock(stakedInBlock: bigint) { - if (stakedInBlock % LOCKING_PERIOD === 0n) return stakedInBlock + LOCKING_PERIOD; - return (stakedInBlock - stakedInBlock % LOCKING_PERIOD) + (LOCKING_PERIOD * 2n); -} - -// Wait while promotion period less than specified block, to avoid boundary cases -// 0 if this should be the beginning of the period. -async function waitPromotionPeriodDoesntEnd(helper: DevUniqueHelper, waitBlockLessThan = LOCKING_PERIOD / 3n) { - const relayBlockNumber = (await helper.callRpc('api.query.parachainSystem.validationData', [])).value.relayParentNumber.toNumber(); // await helper.chain.getLatestBlockNumber(); - const currentPeriodBlock = BigInt(relayBlockNumber) % LOCKING_PERIOD; - - if (currentPeriodBlock > waitBlockLessThan) { - await helper.wait.forRelayBlockNumber(BigInt(relayBlockNumber) + LOCKING_PERIOD - currentPeriodBlock); - } -} --- /dev/null +++ b/tests/src/sub/appPromotion/appPromotion.seqtest.ts @@ -0,0 +1,82 @@ +// Copyright 2019-2022 Unique Network (Gibraltar) Ltd. +// This file is part of Unique Network. + +// Unique Network is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. + +// Unique Network is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License +// along with Unique Network. If not, see . + +import {IKeyringPair} from '@polkadot/types/types'; +import {itSub, usingPlaygrounds, Pallets, requirePalletsOrSkip} from '../../util'; +import {expect} from '../../eth/util'; + +let superuser: IKeyringPair; +let donor: IKeyringPair; +let palletAdmin: IKeyringPair; + +describe('App promotion', () => { + before(async function () { + await usingPlaygrounds(async (helper, privateKey) => { + requirePalletsOrSkip(this, helper, [Pallets.AppPromotion]); + superuser = await privateKey('//Alice'); + donor = await privateKey({filename: __filename}); + palletAdmin = await privateKey('//PromotionAdmin'); + const api = helper.getApi(); + await helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address}))); + }); + }); + + after(async function () { + await usingPlaygrounds(async (helper) => { + if (helper.fetchMissingPalletNames([Pallets.AppPromotion]).length != 0) return; + const api = helper.getApi(); + await helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address}))); + }); + }); + + describe('admin adress', () => { + itSub('can be set by sudo only', async ({helper}) => { + const api = helper.getApi(); + const [nonAdmin] = await helper.arrange.createAccounts([10n], donor); + // nonAdmin can not set admin not from himself nor as a sudo + await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.setAdminAddress({Substrate: nonAdmin.address}))).to.be.rejected; + await expect(helper.signTransaction(nonAdmin, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: nonAdmin.address})))).to.be.rejected; + }); + + itSub('can be any valid CrossAccountId', async ({helper}) => { + // We are not going to set an eth address as a sponsor, + // but we do want to check, it doesn't break anything; + const api = helper.getApi(); + const [account] = await helper.arrange.createAccounts([10n], donor); + const ethAccount = helper.address.substrateToEth(account.address); + // Alice sets Ethereum address as a sudo. Then Substrate address back... + await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Ethereum: ethAccount})))).to.be.fulfilled; + await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address})))).to.be.fulfilled; + + // ...It doesn't break anything; + const collection = await helper.nft.mintCollection(account, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); + await expect(helper.signTransaction(account, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; + }); + + itSub('can be reassigned', async ({helper}) => { + const api = helper.getApi(); + const [oldAdmin, newAdmin, collectionOwner] = await helper.arrange.createAccounts([10n, 10n, 10n], donor); + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); + + await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: oldAdmin.address})))).to.be.fulfilled; + await expect(helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: newAdmin.address})))).to.be.fulfilled; + await expect(helper.signTransaction(oldAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; + + await expect(helper.signTransaction(newAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.fulfilled; + }); + }); +}); + --- /dev/null +++ b/tests/src/sub/appPromotion/appPromotion.test.ts @@ -0,0 +1,690 @@ +// Copyright 2019-2022 Unique Network (Gibraltar) Ltd. +// This file is part of Unique Network. + +// Unique Network is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. + +// Unique Network is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License +// along with Unique Network. If not, see . + +import {IKeyringPair} from '@polkadot/types/types'; +import { + itSub, usingPlaygrounds, Pallets, requirePalletsOrSkip, LOCKING_PERIOD, UNLOCKING_PERIOD, +} from '../../util'; +import {DevUniqueHelper} from '../../util/playgrounds/unique.dev'; +import {itEth, expect, SponsoringMode} from '../../eth/util'; + +let donor: IKeyringPair; +let palletAdmin: IKeyringPair; +let nominal: bigint; +let palletAddress: string; +let accounts: IKeyringPair[]; +// App promotion periods: +// LOCKING_PERIOD = 12 blocks of relay +// UNLOCKING_PERIOD = 6 blocks of parachain + +describe('App promotion', () => { + before(async function () { + await usingPlaygrounds(async (helper, privateKey) => { + requirePalletsOrSkip(this, helper, [Pallets.AppPromotion]); + donor = await privateKey({filename: __filename}); + palletAddress = helper.arrange.calculatePalletAddress('appstake'); + palletAdmin = await privateKey('//PromotionAdmin'); + nominal = helper.balance.getOneTokenNominal(); + + const accountBalances = new Array(100); + accountBalances.fill(1000n); + accounts = await helper.arrange.createAccounts(accountBalances, donor); // create accounts-pool to speed up tests + }); + }); + + describe('stake extrinsic', () => { + itSub('should "lock" staking balance, add it to "staked" map, and increase "totalStaked" amount', async ({helper}) => { + const [staker, recepient] = [accounts.pop()!, accounts.pop()!]; + const totalStakedBefore = await helper.staking.getTotalStaked(); + + // Minimum stake amount is 100: + await expect(helper.staking.stake(staker, 100n * nominal - 1n)).to.be.rejected; + await helper.staking.stake(staker, 100n * nominal); + + // Staker balance is: miscFrozen: 100, feeFrozen: 100, reserved: 0n... + // ...so he can not transfer 900 + expect(await helper.balance.getSubstrateFull(staker.address)).to.contain({miscFrozen: 100n * nominal, feeFrozen: 100n * nominal, reserved: 0n}); + expect(await helper.balance.getLocked(staker.address)).to.deep.eq([{id: 'appstake', amount: 100n * nominal, reasons: 'All'}]); + await expect(helper.balance.transferToSubstrate(staker, recepient.address, 900n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions'); + + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(100n * nominal); + expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); + // it is potentially flaky test. Promotion can credited some tokens. Maybe we need to use closeTo? + expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore + 100n * nominal); // total tokens amount staked in app-promotion increased + + + await helper.staking.stake(staker, 200n * nominal); + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(300n * nominal); + const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + expect(totalStakedPerBlock[0].amount).to.equal(100n * nominal); + expect(totalStakedPerBlock[1].amount).to.equal(200n * nominal); + }); + + itSub('should allow to create maximum 10 stakes for account', async ({helper}) => { + const [staker] = await helper.arrange.createAccounts([2000n], donor); + for (let i = 0; i < 10; i++) { + await helper.staking.stake(staker, 100n * nominal); + } + + // can have 10 stakes + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(1000n * nominal); + expect(await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).to.have.length(10); + + await expect(helper.staking.stake(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.NoPermission'); + + // After unstake can stake again + await helper.staking.unstake(staker); + await helper.staking.stake(staker, 100n * nominal); + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.equal(100n * nominal); + }); + + itSub('should reject transaction if stake amount is more than total free balance minus frozen', async ({helper}) => { + const staker = accounts.pop()!; + + // Can't stake full balance because Alice needs to pay some fee + await expect(helper.staking.stake(staker, 1000n * nominal)).to.be.rejected; + await helper.staking.stake(staker, 500n * nominal); + + // Can't stake 500 tkn because Alice has Less than 500 transferable; + await expect(helper.staking.stake(staker, 500n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions'); + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(500n * nominal); + }); + + itSub('for different accounts in one block is possible', async ({helper}) => { + const crowd = [accounts.pop()!, accounts.pop()!, accounts.pop()!, accounts.pop()!]; + + const crowdStartsToStake = crowd.map(user => helper.staking.stake(user, 100n * nominal)); + await expect(Promise.all(crowdStartsToStake)).to.be.fulfilled; + + const crowdStakes = await Promise.all(crowd.map(address => helper.staking.getTotalStaked({Substrate: address.address}))); + expect(crowdStakes).to.deep.equal([100n * nominal, 100n * nominal, 100n * nominal, 100n * nominal]); + }); + }); + + describe('unstake extrinsic', () => { + itSub('should change balance state from "frozen" to "reserved", add it to "pendingUnstake" map, and subtract it from totalStaked', async ({helper}) => { + const [staker, recepient] = [accounts.pop()!, accounts.pop()!]; + const totalStakedBefore = await helper.staking.getTotalStaked(); + await helper.staking.stake(staker, 900n * nominal); + await helper.staking.unstake(staker); + + // Right after unstake balance is reserved + // Staker can not transfer + expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 900n * nominal, miscFrozen: 0n, feeFrozen: 0n}); + await expect(helper.balance.transferToSubstrate(staker, recepient.address, 100n * nominal)).to.be.rejectedWith('balances.InsufficientBalance'); + expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(900n * nominal); + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n); + expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore); + }); + + itSub('should unlock balance after unlocking period ends and remove it from "pendingUnstake"', async ({helper}) => { + const staker = accounts.pop()!; + await helper.staking.stake(staker, 100n * nominal); + await helper.staking.unstake(staker); + const [pendingUnstake] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); + + // Wait for unstaking period. Balance now free ~1000; reserved, frozen, miscFrozeb: 0n + await helper.wait.forParachainBlockNumber(pendingUnstake.block); + expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 0n, feeFrozen: 0n}); + expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); + + // staker can transfer: + await helper.balance.transferToSubstrate(staker, donor.address, 998n * nominal); + expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(1n); + }); + + itSub('should successfully unstake multiple stakes', async ({helper}) => { + const staker = accounts.pop()!; + await helper.staking.stake(staker, 100n * nominal); + await helper.staking.stake(staker, 200n * nominal); + await helper.staking.stake(staker, 300n * nominal); + + // staked: [100, 200, 300]; unstaked: 0 + let totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address}); + let pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); + let stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + expect(totalPendingUnstake).to.be.deep.equal(0n); + expect(pendingUnstake).to.be.deep.equal([]); + expect(stakes[0].amount).to.equal(100n * nominal); + expect(stakes[1].amount).to.equal(200n * nominal); + expect(stakes[2].amount).to.equal(300n * nominal); + + // Can unstake multiple stakes + await helper.staking.unstake(staker); + pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); + totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address}); + stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + expect(totalPendingUnstake).to.be.equal(600n * nominal); + expect(stakes).to.be.deep.equal([]); + expect(pendingUnstake[0].amount).to.equal(600n * nominal); + + expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 600n * nominal, feeFrozen: 0n, miscFrozen: 0n}); + await helper.wait.forParachainBlockNumber(pendingUnstake[0].block); + expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 0n, miscFrozen: 0n}); + expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); + }); + + itSub('should not have any effects if no active stakes', async ({helper}) => { + const staker = accounts.pop()!; + + // unstake has no effect if no stakes at all + await helper.staking.unstake(staker); + expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(0n); + expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); // TODO bigint closeTo helper + + // TODO stake() unstake() waitUnstaked() unstake(); + + // can't unstake if there are only pendingUnstakes + await helper.staking.stake(staker, 100n * nominal); + await helper.staking.unstake(staker); + await helper.staking.unstake(staker); + + expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal); + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n); + }); + + itSub('should keep different unlocking block for each unlocking stake', async ({helper}) => { + const staker = accounts.pop()!; + await helper.staking.stake(staker, 100n * nominal); + await helper.staking.unstake(staker); + await helper.staking.stake(staker, 120n * nominal); + await helper.staking.unstake(staker); + + const unstakingPerBlock = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}); + expect(unstakingPerBlock).has.length(2); + expect(unstakingPerBlock[0].amount).to.equal(100n * nominal); + expect(unstakingPerBlock[1].amount).to.equal(120n * nominal); + }); + + itSub('should be possible for different accounts in one block', async ({helper}) => { + const stakers = [accounts.pop()!, accounts.pop()!, accounts.pop()!]; + + await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal))); + await Promise.all(stakers.map(staker => helper.staking.unstake(staker))); + + await Promise.all(stakers.map(async (staker) => { + expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal); + expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n); + })); + }); + }); + + describe('collection sponsoring', () => { + itSub('should actually sponsor transactions', async ({helper}) => { + const api = helper.getApi(); + const [collectionOwner, tokenSender, receiver] = [accounts.pop()!, accounts.pop()!, accounts.pop()!]; + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'Name', description: 'Description', tokenPrefix: 'Prefix', limits: {sponsorTransferTimeout: 0}}); + const token = await collection.mintToken(collectionOwner, {Substrate: tokenSender.address}); + await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId)); + const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress); + + await token.transfer(tokenSender, {Substrate: receiver.address}); + expect (await token.getOwner()).to.be.deep.equal({Substrate: receiver.address}); + const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress); + + // senders balance the same, transaction has sponsored + expect (await helper.balance.getSubstrate(tokenSender.address)).to.be.equal(1000n * nominal); + expect (palletBalanceBefore > palletBalanceAfter).to.be.true; + }); + + itSub('can not be set by non admin', async ({helper}) => { + const api = helper.getApi(); + const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!]; + + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); + + await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; + expect((await collection.getData())?.raw.sponsorship).to.equal('Disabled'); + }); + + itSub('should set pallet address as confirmed admin', async ({helper}) => { + const api = helper.getApi(); + const [collectionOwner, oldSponsor] = [accounts.pop()!, accounts.pop()!]; + + // Can set sponsoring for collection without sponsor + const collectionWithoutSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'No-sponsor', description: 'New Collection', tokenPrefix: 'Promotion'}); + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithoutSponsor.collectionId))).to.be.fulfilled; + expect((await collectionWithoutSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); + + // Can set sponsoring for collection with unconfirmed sponsor + const collectionWithUnconfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Unconfirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address}); + expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: oldSponsor.address}); + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithUnconfirmedSponsor.collectionId))).to.be.fulfilled; + expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); + + // Can set sponsoring for collection with confirmed sponsor + const collectionWithConfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Confirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address}); + await collectionWithConfirmedSponsor.confirmSponsorship(oldSponsor); + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithConfirmedSponsor.collectionId))).to.be.fulfilled; + expect((await collectionWithConfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); + }); + + itSub('can be overwritten by collection owner', async ({helper}) => { + const api = helper.getApi(); + const [collectionOwner, newSponsor] = [accounts.pop()!, accounts.pop()!]; + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); + const collectionId = collection.collectionId; + + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionId))).to.be.fulfilled; + + // Collection limits still can be changed by the owner + expect(await collection.setLimits(collectionOwner, {sponsorTransferTimeout: 0})).to.be.true; + expect((await collection.getData())?.raw.limits.sponsorTransferTimeout).to.be.equal(0); + expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); + + // Collection sponsor can be changed too + expect((await collection.setSponsor(collectionOwner, newSponsor.address))).to.be.true; + expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: newSponsor.address}); + }); + + itSub('should not overwrite collection limits set by the owner earlier', async ({helper}) => { + const api = helper.getApi(); + const limits = {ownerCanDestroy: true, ownerCanTransfer: true, sponsorTransferTimeout: 0}; + const collectionWithLimits = await helper.nft.mintCollection(accounts.pop()!, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits}); + + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithLimits.collectionId))).to.be.fulfilled; + expect((await collectionWithLimits.getData())?.raw.limits).to.be.deep.contain(limits); + }); + + itSub('should reject transaction if collection doesn\'t exist', async ({helper}) => { + const api = helper.getApi(); + const collectionOwner = accounts.pop()!; + + // collection has never existed + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(999999999))).to.be.rejected; + // collection has been burned + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); + await collection.burn(collectionOwner); + + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected; + }); + }); + + describe('stopSponsoringCollection', () => { + itSub('can not be called by non-admin', async ({helper}) => { + const api = helper.getApi(); + const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!]; + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); + + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.fulfilled; + + await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected; + expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress}); + }); + + itSub('should set sponsoring as disabled', async ({helper}) => { + const api = helper.getApi(); + const [collectionOwner, recepient] = [accounts.pop()!, accounts.pop()!]; + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits: {sponsorTransferTimeout: 0}}); + const token = await collection.mintToken(collectionOwner, {Substrate: collectionOwner.address}); + + await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId)); + await helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId)); + + expect((await collection.getData())?.raw.sponsorship).to.be.equal('Disabled'); + + // Transactions are not sponsored anymore: + const ownerBalanceBefore = await helper.balance.getSubstrate(collectionOwner.address); + await token.transfer(collectionOwner, {Substrate: recepient.address}); + const ownerBalanceAfter = await helper.balance.getSubstrate(collectionOwner.address); + expect(ownerBalanceAfter < ownerBalanceBefore).to.be.equal(true); + }); + + itSub('should not affect collection which is not sponsored by pallete', async ({helper}) => { + const api = helper.getApi(); + const collectionOwner = accounts.pop()!; + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: collectionOwner.address}); + await collection.confirmSponsorship(collectionOwner); + + await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected; + + expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: collectionOwner.address}); + }); + + itSub('should reject transaction if collection does not exist', async ({helper}) => { + const collectionOwner = accounts.pop()!; + const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'}); + + await collection.burn(collectionOwner); + await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [collection.collectionId], true)).to.be.rejectedWith('common.CollectionNotFound'); + await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [999_999_999], true)).to.be.rejectedWith('common.CollectionNotFound'); + }); + }); + + describe('contract sponsoring', () => { + itEth('should set palletes address as a sponsor', async ({helper}) => { + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); + const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); + + await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]); + + expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; + expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); + expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ + confirmed: { + substrate: palletAddress, + }, + }); + }); + + itEth('should overwrite sponsoring mode and existed sponsor', async ({helper}) => { + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); + const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); + + await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled; + + // Contract is self sponsored + expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.be.deep.equal({ + confirmed: { + ethereum: flipper.options.address.toLowerCase(), + }, + }); + + // set promotion sponsoring + await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); + + // new sponsor is pallet address + expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; + expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); + expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ + confirmed: { + substrate: palletAddress, + }, + }); + }); + + itEth('can be overwritten by contract owner', async ({helper}) => { + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); + const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); + + // contract sponsored by pallet + await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); + + // owner sets self sponsoring + await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.not.rejected; + + expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; + expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); + expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ + confirmed: { + ethereum: flipper.options.address.toLowerCase(), + }, + }); + }); + + itEth('can not be set by non admin', async ({helper}) => { + const nonAdmin = accounts.pop()!; + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); + const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); + + await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled; + + // nonAdmin calls sponsorContract + await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission'); + + // contract still self-sponsored + expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ + confirmed: { + ethereum: flipper.options.address.toLowerCase(), + }, + }); + }); + + itEth('should actually sponsor transactions', async ({helper}) => { + // Contract caller + const caller = await helper.eth.createAccountWithBalance(donor, 1000n); + const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress); + + // Deploy flipper + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner); + const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); + + // Owner sets to sponsor every tx + await contractHelper.methods.setSponsoringRateLimit(flipper.options.address, 0).send({from: contractOwner}); + await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner}); + await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address, 1000n); // transferBalanceToEth(api, alice, flipper.options.address, 1000n); + + // Set promotion to the Flipper + await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); + + // Caller calls Flipper + await flipper.methods.flip().send({from: caller}); + expect(await flipper.methods.getValue().call()).to.be.true; + + // The contracts and caller balances have not changed + const callerBalance = await helper.balance.getEthereum(caller); + const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address); + expect(callerBalance).to.be.equal(1000n * nominal); + expect(1000n * nominal === contractBalanceAfter).to.be.true; + + // The pallet balance has decreased + const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress); + expect(palletBalanceAfter < palletBalanceBefore).to.be.true; + }); + }); + + describe('stopSponsoringContract', () => { + itEth('should remove pallet address from contract sponsors', async ({helper}) => { + const caller = await helper.eth.createAccountWithBalance(donor, 1000n); + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); + await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address); + const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); + + await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner}); + await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true); + await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true); + + expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.false; + expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); + expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({ + disabled: null, + }); + + await flipper.methods.flip().send({from: caller}); + expect(await flipper.methods.getValue().call()).to.be.true; + + const callerBalance = await helper.balance.getEthereum(caller); + const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address); + + // caller payed for call + expect(1000n * nominal > callerBalance).to.be.true; + expect(contractBalanceAfter).to.be.equal(100n * nominal); + }); + + itEth('can not be called by non-admin', async ({helper}) => { + const nonAdmin = accounts.pop()!; + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); + + await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]); + await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address])) + .to.be.rejectedWith(/appPromotion\.NoPermission/); + }); + + itEth('should not affect a contract which is not sponsored by pallete', async ({helper}) => { + const nonAdmin = accounts.pop()!; + const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase(); + const flipper = await helper.eth.deployFlipper(contractOwner); + const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner); + await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled; + + await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission'); + }); + }); + + describe('payoutStakers', () => { + itSub('can not be called by non admin', async ({helper}) => { + const nonAdmin = accounts.pop()!; + await expect(helper.admin.payoutStakers(nonAdmin, 100)).to.be.rejectedWith('appPromotion.NoPermission'); + }); + + itSub('should increase total staked', async ({helper}) => { + const staker = accounts.pop()!; + const totalStakedBefore = await helper.staking.getTotalStaked(); + await helper.staking.stake(staker, 100n * nominal); + + // Wait for rewards and pay + const [stakedInBlock] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stakedInBlock.block)); + const totalPayout = (await helper.admin.payoutStakers(palletAdmin, 100)).reduce((prev, payout) => prev + payout.payout, 0n); + + const totalStakedAfter = await helper.staking.getTotalStaked(); + expect(totalStakedAfter).to.equal(totalStakedBefore + (100n * nominal) + totalPayout); + // staker can unstake + await helper.staking.unstake(staker); + expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedAfter - calculateIncome(100n * nominal)); + }); + + itSub('should credit 0.05% for staking period', async ({helper}) => { + const staker = accounts.pop()!; + + await waitPromotionPeriodDoesntEnd(helper); + + await helper.staking.stake(staker, 100n * nominal); + await helper.staking.stake(staker, 200n * nominal); + + // wait rewards are available: + const [_stake1, stake2] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake2.block)); + + const payoutToStaker = (await helper.admin.payoutStakers(palletAdmin, 100)).find((payout) => payout.staker === staker.address)?.payout; + expect(payoutToStaker + 300n * nominal).to.equal(calculateIncome(300n * nominal)); + + const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + const income1 = calculateIncome(100n * nominal); + const income2 = calculateIncome(200n * nominal); + expect(totalStakedPerBlock[0].amount).to.equal(income1); + expect(totalStakedPerBlock[1].amount).to.equal(income2); + + const stakerBalance = await helper.balance.getSubstrateFull(staker.address); + expect(stakerBalance).to.contain({miscFrozen: income1 + income2, feeFrozen: income1 + income2, reserved: 0n}); + expect(stakerBalance.free / nominal).to.eq(999n); + }); + + itSub('shoud be paid for more than one period if payments was missed', async ({helper}) => { + const staker = accounts.pop()!; + + await helper.staking.stake(staker, 100n * nominal); + // wait for two rewards are available: + let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD); + + await helper.admin.payoutStakers(palletAdmin, 100); + [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + const frozenBalanceShouldBe = calculateIncome(100n * nominal, 2); + expect(stake.amount).to.be.equal(frozenBalanceShouldBe); + + const stakerFullBalance = await helper.balance.getSubstrateFull(staker.address); + + expect(stakerFullBalance).to.contain({reserved: 0n, feeFrozen: frozenBalanceShouldBe, miscFrozen: frozenBalanceShouldBe}); + }); + + itSub('should not be credited for unstaked (reserved) balance', async ({helper}) => { + // staker unstakes before rewards has been payed + const staker = accounts.pop()!; + await helper.staking.stake(staker, 100n * nominal); + const [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD); + await helper.staking.unstake(staker); + + // so he did not receive any rewards + const totalBalanceBefore = await helper.balance.getSubstrate(staker.address); + await helper.admin.payoutStakers(palletAdmin, 100); + const totalBalanceAfter = await helper.balance.getSubstrate(staker.address); + + expect(totalBalanceBefore).to.be.equal(totalBalanceAfter); + }); + + itSub('should bring compound interest', async ({helper}) => { + const staker = accounts.pop()!; + + await helper.staking.stake(staker, 100n * nominal); + + let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block)); + + await helper.admin.payoutStakers(palletAdmin, 100); + [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + expect(stake.amount).to.equal(calculateIncome(100n * nominal)); + + await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD); + await helper.admin.payoutStakers(palletAdmin, 100); + [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}); + expect(stake.amount).to.equal(calculateIncome(100n * nominal, 2)); + }); + + itSub.skip('can be paid 1000 rewards in a time', async ({helper}) => { + // all other stakes should be unstaked + const oneHundredStakers = await helper.arrange.createCrowd(100, 1050n, donor); + + // stakers stakes 10 times each + for (let i = 0; i < 10; i++) { + await Promise.all(oneHundredStakers.map(staker => helper.staking.stake(staker, 100n * nominal))); + } + await helper.wait.newBlocks(40); + await helper.admin.payoutStakers(palletAdmin, 100); + }); + + itSub.skip('can handle 40.000 rewards', async ({helper}) => { + const crowdStakes = async () => { + // each account in the crowd stakes 2 times + const crowd = await helper.arrange.createCrowd(500, 300n, donor); + await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal))); + await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal))); + // + }; + + for (let i = 0; i < 40; i++) { + await crowdStakes(); + } + + // TODO pay rewards for some period + }); + }); +}); + +function calculateIncome(base: bigint, iter = 0, calcPeriod: bigint = UNLOCKING_PERIOD): bigint { + const DAY = 7200n; + const ACCURACY = 1_000_000_000n; + // 5n / 10_000n = 0.05% p/day + const income = base + base * (ACCURACY * (calcPeriod * 5n) / (10_000n * DAY)) / ACCURACY ; + + if (iter > 1) { + return calculateIncome(income, iter - 1, calcPeriod); + } else return income; +} + +function rewardAvailableInBlock(stakedInBlock: bigint) { + if (stakedInBlock % LOCKING_PERIOD === 0n) return stakedInBlock + LOCKING_PERIOD; + return (stakedInBlock - stakedInBlock % LOCKING_PERIOD) + (LOCKING_PERIOD * 2n); +} + +// Wait while promotion period less than specified block, to avoid boundary cases +// 0 if this should be the beginning of the period. +async function waitPromotionPeriodDoesntEnd(helper: DevUniqueHelper, waitBlockLessThan = LOCKING_PERIOD / 3n) { + const relayBlockNumber = (await helper.callRpc('api.query.parachainSystem.validationData', [])).value.relayParentNumber.toNumber(); // await helper.chain.getLatestBlockNumber(); + const currentPeriodBlock = BigInt(relayBlockNumber) % LOCKING_PERIOD; + + if (currentPeriodBlock > waitBlockLessThan) { + await helper.wait.forRelayBlockNumber(BigInt(relayBlockNumber) + LOCKING_PERIOD - currentPeriodBlock); + } +} --- /dev/null +++ b/tests/src/sub/nesting/common.test.ts @@ -0,0 +1,207 @@ +// Copyright 2019-2022 Unique Network (Gibraltar) Ltd. +// This file is part of Unique Network. + +// Unique Network is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. + +// Unique Network is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License +// along with Unique Network. If not, see . + +import {IKeyringPair} from '@polkadot/types/types'; +import {expect, itSub, Pallets, usingPlaygrounds} from '../../util'; +import {UniqueNFTCollection, UniqueRFTCollection} from '../../util/playgrounds/unique'; +import {itEth} from '../../eth/util'; + +describe('Nesting', () => { + let alice: IKeyringPair; + + before(async () => { + await usingPlaygrounds(async (helper, privateKey) => { + const donor = await privateKey({filename: __filename}); + [alice] = await helper.arrange.createAccounts([50n], donor); + }); + }); + + [ + {mode: 'nft' as const, requiredPallets: []}, + {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]}, + ].map(testCase => { + itSub.ifWithPallets(`Owner can nest ${testCase.mode.toUpperCase()}`, testCase.requiredPallets, async ({helper}) => { + // Only NFT allows nesting, permissions should be set: + const aliceNFTCollection = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}}); + const targetToken = await aliceNFTCollection.mintToken(alice); + + const collectionForNesting = await helper[testCase.mode].mintCollection(alice); + + // 1. Alice can immediately create nested token: + const nestedToken1 = testCase.mode === 'nft' + ? await (collectionForNesting as UniqueNFTCollection).mintToken(alice, targetToken.nestingAccount()) + : await (collectionForNesting as UniqueRFTCollection).mintToken(alice, 10n, targetToken.nestingAccount()); + expect(await nestedToken1.getTopmostOwner()).to.be.deep.equal({Substrate: alice.address}); + expect(await nestedToken1.getOwner()).to.be.deep.equal(targetToken.nestingAccount().toLowerCase()); + + // 2. Alice can mint and nest token: + const nestedToken2 = await collectionForNesting.mintToken(alice); + await nestedToken2.nest(alice, targetToken); + expect(await nestedToken2.getTopmostOwner()).to.be.deep.equal({Substrate: alice.address}); + expect(await nestedToken2.getOwner()).to.be.deep.equal(targetToken.nestingAccount().toLowerCase()); + }); + }); + + itSub('Owner can nest FT', async ({helper}) => { + // Only NFT allows nesting, permissions should be set: + const aliceNFTCollection = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}}); + const targetToken = await aliceNFTCollection.mintToken(alice); + + const collectionForNesting = await helper.ft.mintCollection(alice); + + // 1. Alice can immediately create nested tokens: + await collectionForNesting.mint(alice, 100n, targetToken.nestingAccount()); + expect(await collectionForNesting.getTop10Owners()).deep.eq([targetToken.nestingAccount().toLowerCase()]); + expect(await collectionForNesting.getBalance(targetToken.nestingAccount())).eq(100n); + + // 2. Alice can mint and nest token: + await collectionForNesting.mint(alice, 100n); + await collectionForNesting.transfer(alice, targetToken.nestingAccount(), 50n); + expect(await collectionForNesting.getBalance(targetToken.nestingAccount())).eq(150n); + }); +}); + +describe('Nesting negative', () => { + let alice: IKeyringPair; + + before(async () => { + await usingPlaygrounds(async (helper, privateKey) => { + const donor = await privateKey({filename: __filename}); + [alice] = await helper.arrange.createAccounts([50n], donor); + }); + }); + + [ + {mode: 'nft' as const, requiredPallets: []}, + {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]}, + ].map(testCase => { + itSub.ifWithPallets(`Owner cannot nest ${testCase.mode.toUpperCase()} if nesting not allowed`, testCase.requiredPallets, async ({helper}) => { + // Create default collection, permissions are not set: + const aliceNFTCollection = await helper.nft.mintCollection(alice); + const targetToken = await aliceNFTCollection.mintToken(alice); + + const collectionForNesting = await helper[testCase.mode].mintCollection(alice); + + // 1. Alice cannot create immediately nested tokens: + const nestingTx = testCase.mode === 'nft' + ? (collectionForNesting as UniqueNFTCollection).mintToken(alice, targetToken.nestingAccount()) + : (collectionForNesting as UniqueRFTCollection).mintToken(alice, 10n, targetToken.nestingAccount()); + await expect(nestingTx).to.be.rejectedWith('common.UserIsNotAllowedToNest'); + + // 2. Alice cannot mint and nest token: + const nestedToken2 = await collectionForNesting.mintToken(alice); + await expect(nestedToken2.nest(alice, targetToken)).to.be.rejectedWith('common.UserIsNotAllowedToNest'); + }); + }); + + itSub('Owner cannot nest FT if nesting not allowed', async ({helper}) => { + // Create default collection, permissions are not set: + const aliceNFTCollection = await helper.nft.mintCollection(alice); + const targetToken = await aliceNFTCollection.mintToken(alice); + + const collectionForNesting = await helper.ft.mintCollection(alice); + + // 1. Alice cannot create immediately nested tokens: + await expect(collectionForNesting.mint(alice, 100n, targetToken.nestingAccount())).to.be.rejectedWith('common.UserIsNotAllowedToNest'); + + // 2. Alice can mint and nest token: + await collectionForNesting.mint(alice, 100n); + await expect(collectionForNesting.transfer(alice, targetToken.nestingAccount(), 50n)).to.be.rejectedWith('common.UserIsNotAllowedToNest'); + }); + + itSub.ifWithPallets('Cannot nest to a future collection', [Pallets.ReFungible], async ({helper}) => { + const nonExistingCollectionId = await helper.collection.getTotalCount() + 1000; + const futureToken = helper.nft.getTokenObject(nonExistingCollectionId, 1); + + const nftCollectionForNesting = await helper.nft.mintCollection(alice); + const rftCollectionForNesting = await helper.rft.mintCollection(alice); + const ftCollectionForNesting = await helper.ft.mintCollection(alice); + + // 1. Alice cannot create nested token to future token + await expect(nftCollectionForNesting.mintToken(alice, futureToken.nestingAccount())).to.be.rejectedWith('CollectionNotFound'); + await expect(rftCollectionForNesting.mintToken(alice, 10n, futureToken.nestingAccount())).to.be.rejectedWith('CollectionNotFound'); + await expect(ftCollectionForNesting.mint(alice, 10n, futureToken.nestingAccount())).to.be.rejectedWith('CollectionNotFound'); + + // 2. Alice cannot mint and nest token: + const nft = await nftCollectionForNesting.mintToken(alice); + const rft = await rftCollectionForNesting.mintToken(alice, 100n); + const _ft = await ftCollectionForNesting.mint(alice, 100n); + await expect(nft.transfer(alice, futureToken.nestingAccount())).to.be.rejectedWith('CollectionNotFound'); + await expect(rft.transfer(alice, futureToken.nestingAccount())).to.be.rejectedWith('CollectionNotFound'); + await expect(ftCollectionForNesting.transfer(alice, futureToken.nestingAccount(), 50n)).to.be.rejectedWith('CollectionNotFound'); + }); + + itSub.ifWithPallets('Cannot nest to a future token in a NFT collection', [Pallets.ReFungible], async ({helper}) => { + const {collectionId} = await helper.nft.mintCollection(alice); + // To avoid UserIsNotAllowedToNest error + await helper.collection.setPermissions(alice, collectionId, {nesting: {collectionAdmin: true}}); + const futureToken = helper.nft.getTokenObject(collectionId, 1); + + const nftCollectionForNesting = await helper.nft.mintCollection(alice); + const rftCollectionForNesting = await helper.rft.mintCollection(alice); + const ftCollectionForNesting = await helper.ft.mintCollection(alice); + + // 1. Alice cannot create nested token to future token + await expect(nftCollectionForNesting.mintToken(alice, futureToken.nestingAccount())).to.be.rejectedWith('TokenNotFound'); + await expect(rftCollectionForNesting.mintToken(alice, 10n, futureToken.nestingAccount())).to.be.rejectedWith('TokenNotFound'); + await expect(ftCollectionForNesting.mint(alice, 10n, futureToken.nestingAccount())).to.be.rejectedWith('TokenNotFound'); + + // 2. Alice cannot mint and nest token: + const nft = await nftCollectionForNesting.mintToken(alice); + const rft = await rftCollectionForNesting.mintToken(alice, 100n); + const _ft = await ftCollectionForNesting.mint(alice, 100n); + await expect(nft.transfer(alice, futureToken.nestingAccount())).to.be.rejectedWith('TokenNotFound'); + await expect(rft.transfer(alice, futureToken.nestingAccount())).to.be.rejectedWith('TokenNotFound'); + await expect(ftCollectionForNesting.transfer(alice, futureToken.nestingAccount(), 50n)).to.be.rejectedWith('TokenNotFound'); + }); + + itEth.ifWithPallets('Cannot nest to collection address', [Pallets.ReFungible], async({helper}) => { + const existingCollection = await helper.nft.mintCollection(alice); + const existingCollectionAddress = helper.ethAddress.fromCollectionId(existingCollection.collectionId); + const futureCollectionAddress = helper.ethAddress.fromCollectionId(99999999); + + const nftCollectionForNesting = await helper.nft.mintCollection(alice); + + // 1. Alice cannot create nested token to collection address + await expect(nftCollectionForNesting.mintToken(alice, {Ethereum: existingCollectionAddress})).to.be.rejectedWith('CantNestTokenUnderCollection'); + await expect(nftCollectionForNesting.mintToken(alice, {Ethereum: futureCollectionAddress})).to.be.rejectedWith('CantNestTokenUnderCollection'); + + // 2. Alice cannot mint and nest token to collection address: + const nft = await nftCollectionForNesting.mintToken(alice); + await expect(nft.transfer(alice, {Ethereum: existingCollectionAddress})).to.be.rejectedWith('CantNestTokenUnderCollection'); + await expect(nft.transfer(alice, {Ethereum: futureCollectionAddress})).to.be.rejectedWith('CantNestTokenUnderCollection'); + }); + + itEth.ifWithPallets('Cannot nest in RFT or FT', [Pallets.ReFungible], async ({helper}) => { + // Create default collection, permissions are not set: + const rftCollection = await helper.rft.mintCollection(alice); + const ftCollection = await helper.ft.mintCollection(alice); + + const rftToken = await rftCollection.mintToken(alice); + const _ftToken = await ftCollection.mint(alice, 100n); + + const collectionForNesting = await helper.nft.mintCollection(alice); + + // 1. Alice cannot create immediately nested tokens: + await expect(collectionForNesting.mintToken(alice, rftToken.nestingAccount())).to.be.rejectedWith('refungible.RefungibleDisallowsNesting'); + await expect(collectionForNesting.mintToken(alice, {Ethereum: helper.ethAddress.fromTokenId(ftCollection.collectionId, 0)})).to.be.rejectedWith('fungible.FungibleDisallowsNesting'); + + // 2. Alice cannot mint and nest token: + const nestedToken2 = await collectionForNesting.mintToken(alice); + await expect(nestedToken2.nest(alice, rftToken)).to.be.rejectedWith('refungible.RefungibleDisallowsNesting'); + await expect(ftCollection.transfer(alice, {Ethereum: helper.ethAddress.fromTokenId(ftCollection.collectionId, 0)})).to.be.rejectedWith('fungible.FungibleDisallowsNesting'); + }); +}); --- a/tests/src/util/playgrounds/unique.ts +++ b/tests/src/util/playgrounds/unique.ts @@ -1392,6 +1392,80 @@ } /** + * Get token's owner + * @param collectionId ID of collection + * @param tokenId ID of token + * @param blockHashAt optionally query the data at the block with this hash + * @example getTokenOwner(10, 5); + * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."} + */ + async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise { + let owner; + if (typeof blockHashAt === 'undefined') { + owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]); + } else { + owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]); + } + return CrossAccountId.fromLowerCaseKeys(owner.toJSON()); + } + + /** + * Recursively find the address that owns the token + * @param collectionId ID of collection + * @param tokenId ID of token + * @param blockHashAt + * @example getTokenTopmostOwner(10, 5); + * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."} + */ + async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise { + let owner; + if (typeof blockHashAt === 'undefined') { + owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]); + } else { + owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]); + } + + if (owner === null) return null; + + return owner.toHuman(); + } + + /** + * Nest one token into another + * @param signer keyring of signer + * @param tokenObj token to be nested + * @param rootTokenObj token to be parent + * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}); + * @returns ```true``` if extrinsic success, otherwise ```false``` + */ + async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise { + const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj); + const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress); + if(!result) { + throw Error('Unable to nest token!'); + } + return result; + } + + /** + * Remove token from nested state + * @param signer keyring of signer + * @param tokenObj token to unnest + * @param rootTokenObj parent of a token + * @param toAddressObj address of a new token owner + * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."}); + * @returns ```true``` if extrinsic success, otherwise ```false``` + */ + async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise { + const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj); + const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj); + if(!result) { + throw Error('Unable to unnest token!'); + } + return result; + } + + /** * Set permissions to change token properties * * @param signer keyring of signer @@ -1555,24 +1629,6 @@ */ getTokenObject(collectionId: number, tokenId: number): UniqueNFToken { return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId)); - } - - /** - * Get token's owner - * @param collectionId ID of collection - * @param tokenId ID of token - * @param blockHashAt optionally query the data at the block with this hash - * @example getTokenOwner(10, 5); - * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."} - */ - async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise { - let owner; - if (typeof blockHashAt === 'undefined') { - owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]); - } else { - owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]); - } - return CrossAccountId.fromLowerCaseKeys(owner.toJSON()); } /** @@ -1617,27 +1673,6 @@ } /** - * Recursively find the address that owns the token - * @param collectionId ID of collection - * @param tokenId ID of token - * @param blockHashAt - * @example getTokenTopmostOwner(10, 5); - * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."} - */ - async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise { - let owner; - if (typeof blockHashAt === 'undefined') { - owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]); - } else { - owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]); - } - - if (owner === null) return null; - - return owner.toHuman(); - } - - /** * Get tokens nested in the provided token * @param collectionId ID of collection * @param tokenId ID of token @@ -1656,44 +1691,9 @@ return children.toJSON().map((x: any) => { return {collectionId: x.collection, tokenId: x.token}; }); - } - - /** - * Nest one token into another - * @param signer keyring of signer - * @param tokenObj token to be nested - * @param rootTokenObj token to be parent - * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}); - * @returns ```true``` if extrinsic success, otherwise ```false``` - */ - async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise { - const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj); - const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress); - if(!result) { - throw Error('Unable to nest token!'); - } - return result; } /** - * Remove token from nested state - * @param signer keyring of signer - * @param tokenObj token to unnest - * @param rootTokenObj parent of a token - * @param toAddressObj address of a new token owner - * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."}); - * @returns ```true``` if extrinsic success, otherwise ```false``` - */ - async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise { - const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj); - const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj); - if(!result) { - throw Error('Unable to unnest token!'); - } - return result; - } - - /** * Mint new collection * @param signer keyring of signer * @param collectionOptions Collection options @@ -3531,6 +3531,10 @@ return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt); } + async getTokenOwner(tokenId: number, blockHashAt?: string) { + return await this.helper.rft.getTokenOwner(this.collectionId, tokenId, blockHashAt); + } + async getTokensByAddress(addressObj: ICrossAccountId) { return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj); } @@ -3539,6 +3543,10 @@ return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId); } + async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) { + return await this.helper.rft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt); + } + async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) { return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj); } @@ -3582,7 +3590,7 @@ return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount); } - async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) { + async mintToken(signer: TSigner, pieces = 1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) { return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties}); } @@ -3610,6 +3618,14 @@ return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions); } + async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) { + return await this.helper.rft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj); + } + + async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) { + return await this.helper.rft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj); + } + scheduleAt( executionBlockNumber: number, options: ISchedulerOptions = {}, @@ -3849,10 +3865,26 @@ return await this.collection.getToken(this.tokenId, blockHashAt); } + async getOwner(blockHashAt?: string) { + return await this.collection.getTokenOwner(this.tokenId, blockHashAt); + } + async getTop10Owners() { return await this.collection.getTop10TokenOwners(this.tokenId); } + async getTopmostOwner(blockHashAt?: string) { + return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt); + } + + async nest(signer: TSigner, toTokenObj: IToken) { + return await this.collection.nestToken(signer, this.tokenId, toTokenObj); + } + + async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) { + return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj); + } + async getBalance(addressObj: ICrossAccountId) { return await this.collection.getTokenBalance(this.tokenId, addressObj); } -- gitstuff