difftreelog
Merge branch 'develop' into tests/eth-helpers
in: master
3 files changed
tests/src/app-promotion.test.tsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import {IKeyringPair} from '@polkadot/types/types';18import {19 itSub, usingPlaygrounds, Pallets, requirePalletsOrSkip, LOCKING_PERIOD, UNLOCKING_PERIOD,20} from './util';21import {DevUniqueHelper} from './util/playgrounds/unique.dev';22import {itEth, expect, SponsoringMode} from './eth/util';2324let donor: IKeyringPair;25let palletAdmin: IKeyringPair;26let nominal: bigint;27let palletAddress: string;28let accounts: IKeyringPair[];29// App promotion periods:30// LOCKING_PERIOD = 12 blocks of relay31// UNLOCKING_PERIOD = 6 blocks of parachain3233describe('App promotion', () => {34 before(async function () {35 await usingPlaygrounds(async (helper, privateKey) => {36 requirePalletsOrSkip(this, helper, [Pallets.AppPromotion]);37 donor = await privateKey({filename: __filename});38 palletAddress = helper.arrange.calculatePalletAddress('appstake');39 palletAdmin = await privateKey('//PromotionAdmin');40 nominal = helper.balance.getOneTokenNominal();4142 const accountBalances = new Array(100);43 accountBalances.fill(1000n);44 accounts = await helper.arrange.createAccounts(accountBalances, donor); // create accounts-pool to speed up tests45 });46 });4748 describe('stake extrinsic', () => { 49 itSub('should "lock" staking balance, add it to "staked" map, and increase "totalStaked" amount', async ({helper}) => {50 const [staker, recepient] = [accounts.pop()!, accounts.pop()!];51 const totalStakedBefore = await helper.staking.getTotalStaked();52 53 // Minimum stake amount is 100:54 await expect(helper.staking.stake(staker, 100n * nominal - 1n)).to.be.rejected;55 await helper.staking.stake(staker, 100n * nominal);56 57 // Staker balance is: miscFrozen: 100, feeFrozen: 100, reserved: 0n...58 // ...so he can not transfer 90059 expect (await helper.balance.getSubstrateFull(staker.address)).to.contain({miscFrozen: 100n * nominal, feeFrozen: 100n * nominal, reserved: 0n});60 await expect(helper.balance.transferToSubstrate(staker, recepient.address, 900n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions');61 62 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(100n * nominal);63 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);64 // it is potentially flaky test. Promotion can credited some tokens. Maybe we need to use closeTo? 65 expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore + 100n * nominal); // total tokens amount staked in app-promotion increased 66 67 68 await helper.staking.stake(staker, 200n * nominal);69 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(300n * nominal);70 const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});71 expect(totalStakedPerBlock[0].amount).to.equal(100n * nominal);72 expect(totalStakedPerBlock[1].amount).to.equal(200n * nominal);73 });74 75 itSub('should allow to create maximum 10 stakes for account', async ({helper}) => {76 const [staker] = await helper.arrange.createAccounts([2000n], donor);77 for (let i = 0; i < 10; i++) {78 await helper.staking.stake(staker, 100n * nominal);79 }80 81 // can have 10 stakes82 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(1000n * nominal);83 expect(await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).to.have.length(10);84 85 await expect(helper.staking.stake(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.NoPermission');86 87 // After unstake can stake again88 await helper.staking.unstake(staker);89 await helper.staking.stake(staker, 100n * nominal);90 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.equal(100n * nominal);91 });92 93 itSub('should reject transaction if stake amount is more than total free balance minus frozen', async ({helper}) => {94 const staker = accounts.pop()!;95 96 // Can't stake full balance because Alice needs to pay some fee97 await expect(helper.staking.stake(staker, 1000n * nominal)).to.be.rejected;98 await helper.staking.stake(staker, 500n * nominal);99 100 // Can't stake 500 tkn because Alice has Less than 500 transferable;101 await expect(helper.staking.stake(staker, 500n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions'); 102 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(500n * nominal);103 });104 105 itSub('for different accounts in one block is possible', async ({helper}) => {106 const crowd = [accounts.pop()!, accounts.pop()!, accounts.pop()!, accounts.pop()!];107 108 const crowdStartsToStake = crowd.map(user => helper.staking.stake(user, 100n * nominal));109 await expect(Promise.all(crowdStartsToStake)).to.be.fulfilled;110 111 const crowdStakes = await Promise.all(crowd.map(address => helper.staking.getTotalStaked({Substrate: address.address})));112 expect(crowdStakes).to.deep.equal([100n * nominal, 100n * nominal, 100n * nominal, 100n * nominal]);113 });114 });115 116 describe('unstake extrinsic', () => { 117 itSub('should change balance state from "frozen" to "reserved", add it to "pendingUnstake" map, and subtract it from totalStaked', async ({helper}) => {118 const [staker, recepient] = [accounts.pop()!, accounts.pop()!];119 const totalStakedBefore = await helper.staking.getTotalStaked();120 await helper.staking.stake(staker, 900n * nominal);121 await helper.staking.unstake(staker);122 123 // Right after unstake balance is reserved124 // Staker can not transfer 125 expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 900n * nominal, miscFrozen: 0n, feeFrozen: 0n});126 await expect(helper.balance.transferToSubstrate(staker, recepient.address, 100n * nominal)).to.be.rejectedWith('balances.InsufficientBalance');127 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(900n * nominal);128 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);129 expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore);130 });131 132 itSub('should unlock balance after unlocking period ends and remove it from "pendingUnstake"', async ({helper}) => {133 const staker = accounts.pop()!;134 await helper.staking.stake(staker, 100n * nominal);135 await helper.staking.unstake(staker);136 const [pendingUnstake] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});137 138 // Wait for unstaking period. Balance now free ~1000; reserved, frozen, miscFrozeb: 0n139 await helper.wait.forParachainBlockNumber(pendingUnstake.block);140 expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 0n, feeFrozen: 0n});141 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);142 143 // staker can transfer:144 await helper.balance.transferToSubstrate(staker, donor.address, 998n * nominal);145 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(1n);146 });147 148 itSub('should successfully unstake multiple stakes', async ({helper}) => {149 const staker = accounts.pop()!;150 await helper.staking.stake(staker, 100n * nominal);151 await helper.staking.stake(staker, 200n * nominal);152 await helper.staking.stake(staker, 300n * nominal);153 154 // staked: [100, 200, 300]; unstaked: 0155 let totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});156 let pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});157 let stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});158 expect(totalPendingUnstake).to.be.deep.equal(0n);159 expect(pendingUnstake).to.be.deep.equal([]);160 expect(stakes[0].amount).to.equal(100n * nominal);161 expect(stakes[1].amount).to.equal(200n * nominal);162 expect(stakes[2].amount).to.equal(300n * nominal);163 164 // Can unstake multiple stakes165 await helper.staking.unstake(staker);166 pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});167 totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});168 stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});169 expect(totalPendingUnstake).to.be.equal(600n * nominal);170 expect(stakes).to.be.deep.equal([]);171 expect(pendingUnstake[0].amount).to.equal(600n * nominal);172 173 expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 600n * nominal, feeFrozen: 0n, miscFrozen: 0n});174 await helper.wait.forParachainBlockNumber(pendingUnstake[0].block);175 expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 0n, miscFrozen: 0n});176 expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);177 });178 179 itSub('should not have any effects if no active stakes', async ({helper}) => {180 const staker = accounts.pop()!;181 182 // unstake has no effect if no stakes at all183 await helper.staking.unstake(staker);184 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(0n);185 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); // TODO bigint closeTo helper186 187 // TODO stake() unstake() waitUnstaked() unstake();188 189 // can't unstake if there are only pendingUnstakes190 await helper.staking.stake(staker, 100n * nominal);191 await helper.staking.unstake(staker);192 await helper.staking.unstake(staker);193 194 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);195 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);196 });197 198 itSub('should keep different unlocking block for each unlocking stake', async ({helper}) => {199 const staker = accounts.pop()!;200 await helper.staking.stake(staker, 100n * nominal);201 await helper.staking.unstake(staker);202 await helper.staking.stake(staker, 120n * nominal);203 await helper.staking.unstake(staker);204 205 const unstakingPerBlock = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});206 expect(unstakingPerBlock).has.length(2);207 expect(unstakingPerBlock[0].amount).to.equal(100n * nominal);208 expect(unstakingPerBlock[1].amount).to.equal(120n * nominal);209 });210 211 itSub('should be possible for different accounts in one block', async ({helper}) => {212 const stakers = [accounts.pop()!, accounts.pop()!, accounts.pop()!];213 214 await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal)));215 await Promise.all(stakers.map(staker => helper.staking.unstake(staker)));216 217 await Promise.all(stakers.map(async (staker) => {218 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);219 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);220 }));221 });222 });223 224 describe('collection sponsoring', () => {225 itSub('should actually sponsor transactions', async ({helper}) => {226 const api = helper.getApi();227 const [collectionOwner, tokenSender, receiver] = [accounts.pop()!, accounts.pop()!, accounts.pop()!];228 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'Name', description: 'Description', tokenPrefix: 'Prefix', limits: {sponsorTransferTimeout: 0}});229 const token = await collection.mintToken(collectionOwner, {Substrate: tokenSender.address});230 await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId));231 const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress);232 233 await token.transfer(tokenSender, {Substrate: receiver.address});234 expect (await token.getOwner()).to.be.deep.equal({Substrate: receiver.address});235 const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress);236 237 // senders balance the same, transaction has sponsored238 expect (await helper.balance.getSubstrate(tokenSender.address)).to.be.equal(1000n * nominal);239 expect (palletBalanceBefore > palletBalanceAfter).to.be.true;240 });241 242 itSub('can not be set by non admin', async ({helper}) => {243 const api = helper.getApi();244 const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!];245 246 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});247 248 await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected;249 expect((await collection.getData())?.raw.sponsorship).to.equal('Disabled');250 });251 252 itSub('should set pallet address as confirmed admin', async ({helper}) => {253 const api = helper.getApi();254 const [collectionOwner, oldSponsor] = [accounts.pop()!, accounts.pop()!];255 256 // Can set sponsoring for collection without sponsor257 const collectionWithoutSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'No-sponsor', description: 'New Collection', tokenPrefix: 'Promotion'});258 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithoutSponsor.collectionId))).to.be.fulfilled;259 expect((await collectionWithoutSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});260 261 // Can set sponsoring for collection with unconfirmed sponsor262 const collectionWithUnconfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Unconfirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address});263 expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: oldSponsor.address});264 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithUnconfirmedSponsor.collectionId))).to.be.fulfilled;265 expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});266 267 // Can set sponsoring for collection with confirmed sponsor268 const collectionWithConfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Confirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address});269 await collectionWithConfirmedSponsor.confirmSponsorship(oldSponsor);270 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithConfirmedSponsor.collectionId))).to.be.fulfilled;271 expect((await collectionWithConfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});272 });273 274 itSub('can be overwritten by collection owner', async ({helper}) => { 275 const api = helper.getApi();276 const [collectionOwner, newSponsor] = [accounts.pop()!, accounts.pop()!];277 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});278 const collectionId = collection.collectionId;279 280 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionId))).to.be.fulfilled;281 282 // Collection limits still can be changed by the owner283 expect(await collection.setLimits(collectionOwner, {sponsorTransferTimeout: 0})).to.be.true;284 expect((await collection.getData())?.raw.limits.sponsorTransferTimeout).to.be.equal(0);285 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});286 287 // Collection sponsor can be changed too288 expect((await collection.setSponsor(collectionOwner, newSponsor.address))).to.be.true;289 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: newSponsor.address});290 });291 292 itSub('should not overwrite collection limits set by the owner earlier', async ({helper}) => {293 const api = helper.getApi();294 const limits = {ownerCanDestroy: true, ownerCanTransfer: true, sponsorTransferTimeout: 0};295 const collectionWithLimits = await helper.nft.mintCollection(accounts.pop()!, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits});296 297 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithLimits.collectionId))).to.be.fulfilled;298 expect((await collectionWithLimits.getData())?.raw.limits).to.be.deep.contain(limits);299 });300 301 itSub('should reject transaction if collection doesn\'t exist', async ({helper}) => {302 const api = helper.getApi();303 const collectionOwner = accounts.pop()!;304 305 // collection has never existed306 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(999999999))).to.be.rejected;307 // collection has been burned308 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});309 await collection.burn(collectionOwner);310 311 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected;312 });313 });314 315 describe('stopSponsoringCollection', () => {316 itSub('can not be called by non-admin', async ({helper}) => {317 const api = helper.getApi();318 const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!];319 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});320 321 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.fulfilled;322 323 await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected;324 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});325 });326 327 itSub('should set sponsoring as disabled', async ({helper}) => {328 const api = helper.getApi();329 const [collectionOwner, recepient] = [accounts.pop()!, accounts.pop()!];330 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits: {sponsorTransferTimeout: 0}});331 const token = await collection.mintToken(collectionOwner, {Substrate: collectionOwner.address});332 333 await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId));334 await helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId));335 336 expect((await collection.getData())?.raw.sponsorship).to.be.equal('Disabled');337 338 // Transactions are not sponsored anymore:339 const ownerBalanceBefore = await helper.balance.getSubstrate(collectionOwner.address);340 await token.transfer(collectionOwner, {Substrate: recepient.address});341 const ownerBalanceAfter = await helper.balance.getSubstrate(collectionOwner.address);342 expect(ownerBalanceAfter < ownerBalanceBefore).to.be.equal(true);343 });344 345 itSub('should not affect collection which is not sponsored by pallete', async ({helper}) => {346 const api = helper.getApi();347 const collectionOwner = accounts.pop()!;348 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: collectionOwner.address});349 await collection.confirmSponsorship(collectionOwner);350 351 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected;352 353 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: collectionOwner.address});354 });355 356 itSub('should reject transaction if collection does not exist', async ({helper}) => { 357 const collectionOwner = accounts.pop()!;358 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});359 360 await collection.burn(collectionOwner);361 await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [collection.collectionId], true)).to.be.rejectedWith('common.CollectionNotFound');362 await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [999_999_999], true)).to.be.rejectedWith('common.CollectionNotFound');363 });364 });365 366 describe('contract sponsoring', () => {367 itEth('should set palletes address as a sponsor', async ({helper}) => {368 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();369 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);370 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);371 372 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]);373 374 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; 375 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 376 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({377 confirmed: {378 substrate: palletAddress,379 },380 });381 });382 383 itEth('should overwrite sponsoring mode and existed sponsor', async ({helper}) => {384 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();385 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);386 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);387 388 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled;389 390 // Contract is self sponsored391 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.be.deep.equal({392 confirmed: {393 ethereum: flipper.options.address.toLowerCase(),394 },395 });396 397 // set promotion sponsoring398 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);399 400 // new sponsor is pallet address401 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; 402 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 403 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({404 confirmed: {405 substrate: palletAddress,406 },407 });408 });409 410 itEth('can be overwritten by contract owner', async ({helper}) => {411 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();412 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);413 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);414 415 // contract sponsored by pallet416 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);417 418 // owner sets self sponsoring419 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.not.rejected;420 421 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; 422 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 423 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({424 confirmed: {425 ethereum: flipper.options.address.toLowerCase(),426 },427 });428 });429 430 itEth('can not be set by non admin', async ({helper}) => {431 const nonAdmin = accounts.pop()!;432 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();433 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);434 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);435 436 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled;437 438 // nonAdmin calls sponsorContract439 await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission');440 441 // contract still self-sponsored 442 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({443 confirmed: {444 ethereum: flipper.options.address.toLowerCase(),445 },446 });447 });448 449 itEth('should actually sponsor transactions', async ({helper}) => {450 // Contract caller451 const caller = await helper.eth.createAccountWithBalance(donor, 1000n);452 const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress);453 454 // Deploy flipper455 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();456 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);457 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);458 459 // Owner sets to sponsor every tx460 await contractHelper.methods.setSponsoringRateLimit(flipper.options.address, 0).send({from: contractOwner});461 await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner});462 await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address, 1000n); // transferBalanceToEth(api, alice, flipper.options.address, 1000n);463 464 // Set promotion to the Flipper465 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);466 467 // Caller calls Flipper468 await flipper.methods.flip().send({from: caller});469 expect(await flipper.methods.getValue().call()).to.be.true;470 471 // The contracts and caller balances have not changed472 const callerBalance = await helper.balance.getEthereum(caller);473 const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address);474 expect(callerBalance).to.be.equal(1000n * nominal);475 expect(1000n * nominal === contractBalanceAfter).to.be.true;476 477 // The pallet balance has decreased478 const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress);479 expect(palletBalanceAfter < palletBalanceBefore).to.be.true;480 });481 });482 483 describe('stopSponsoringContract', () => { 484 itEth('should remove pallet address from contract sponsors', async ({helper}) => {485 const caller = await helper.eth.createAccountWithBalance(donor, 1000n);486 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();487 const flipper = await helper.eth.deployFlipper(contractOwner);488 await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address);489 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);490 491 await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner});492 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);493 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true);494 495 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.false; 496 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 497 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({498 disabled: null,499 });500 501 await flipper.methods.flip().send({from: caller});502 expect(await flipper.methods.getValue().call()).to.be.true;503 504 const callerBalance = await helper.balance.getEthereum(caller);505 const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address);506 507 // caller payed for call508 expect(1000n * nominal > callerBalance).to.be.true;509 expect(contractBalanceAfter).to.be.equal(100n * nominal);510 });511 512 itEth('can not be called by non-admin', async ({helper}) => {513 const nonAdmin = accounts.pop()!;514 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();515 const flipper = await helper.eth.deployFlipper(contractOwner);516 517 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]);518 await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address]))519 .to.be.rejectedWith(/appPromotion\.NoPermission/);520 });521 522 itEth('should not affect a contract which is not sponsored by pallete', async ({helper}) => {523 const nonAdmin = accounts.pop()!;524 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();525 const flipper = await helper.eth.deployFlipper(contractOwner);526 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);527 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled;528 529 await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission');530 });531 });532 533 describe('rewards', () => {534 itSub('can not be called by non admin', async ({helper}) => {535 const nonAdmin = accounts.pop()!;536 await expect(helper.admin.payoutStakers(nonAdmin, 100)).to.be.rejectedWith('appPromotion.NoPermission');537 });538 539 itSub('should increase total staked', async ({helper}) => {540 const staker = accounts.pop()!;541 const totalStakedBefore = await helper.staking.getTotalStaked();542 await helper.staking.stake(staker, 100n * nominal);543 544 // Wait for rewards and pay545 const [stakedInBlock] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});546 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stakedInBlock.block));547 const totalPayout = (await helper.admin.payoutStakers(palletAdmin, 100)).reduce((prev, payout) => prev + payout.payout, 0n);548 549 const totalStakedAfter = await helper.staking.getTotalStaked();550 expect(totalStakedAfter).to.equal(totalStakedBefore + (100n * nominal) + totalPayout);551 // staker can unstake552 await helper.staking.unstake(staker);553 expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedAfter - calculateIncome(100n * nominal));554 });555 556 itSub('should credit 0.05% for staking period', async ({helper}) => { 557 const staker = accounts.pop()!;558 559 await waitPromotionPeriodDoesntEnd(helper);560 561 await helper.staking.stake(staker, 100n * nominal);562 await helper.staking.stake(staker, 200n * nominal);563 564 // wait rewards are available:565 const [_stake1, stake2] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});566 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake2.block));567 568 const payoutToStaker = (await helper.admin.payoutStakers(palletAdmin, 100)).find((payout) => payout.staker === staker.address)?.payout;569 expect(payoutToStaker + 300n * nominal).to.equal(calculateIncome(300n * nominal));570 571 const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});572 expect(totalStakedPerBlock[0].amount).to.equal(calculateIncome(100n * nominal));573 expect(totalStakedPerBlock[1].amount).to.equal(calculateIncome(200n * nominal));574 });575 576 itSub('shoud be paid for more than one period if payments was missed', async ({helper}) => {577 const staker = accounts.pop()!;578 579 await helper.staking.stake(staker, 100n * nominal);580 // wait for two rewards are available:581 let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});582 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD);583 584 await helper.admin.payoutStakers(palletAdmin, 100);585 [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});586 const frozenBalanceShouldBe = calculateIncome(100n * nominal, 2);587 expect(stake.amount).to.be.equal(frozenBalanceShouldBe);588 589 const stakerFullBalance = await helper.balance.getSubstrateFull(staker.address);590 591 expect(stakerFullBalance).to.contain({reserved: 0n, feeFrozen: frozenBalanceShouldBe, miscFrozen: frozenBalanceShouldBe});592 });593 594 itSub('should not be credited for unstaked (reserved) balance', async ({helper}) => {595 // staker unstakes before rewards has been payed596 const staker = accounts.pop()!;597 await helper.staking.stake(staker, 100n * nominal);598 const [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});599 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD);600 await helper.staking.unstake(staker);601 602 // so he did not receive any rewards603 const totalBalanceBefore = await helper.balance.getSubstrate(staker.address);604 await helper.admin.payoutStakers(palletAdmin, 100);605 const totalBalanceAfter = await helper.balance.getSubstrate(staker.address);606 607 expect(totalBalanceBefore).to.be.equal(totalBalanceAfter);608 });609 610 itSub('should bring compound interest', async ({helper}) => {611 const staker = accounts.pop()!;612 613 await helper.staking.stake(staker, 100n * nominal);614 615 let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});616 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block));617 618 await helper.admin.payoutStakers(palletAdmin, 100);619 [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});620 expect(stake.amount).to.equal(calculateIncome(100n * nominal));621 622 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD);623 await helper.admin.payoutStakers(palletAdmin, 100);624 [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});625 expect(stake.amount).to.equal(calculateIncome(100n * nominal, 2));626 });627 628 itSub.skip('can be paid 1000 rewards in a time', async ({helper}) => {629 // all other stakes should be unstaked630 const oneHundredStakers = await helper.arrange.createCrowd(100, 1050n, donor);631 632 // stakers stakes 10 times each633 for (let i = 0; i < 10; i++) {634 await Promise.all(oneHundredStakers.map(staker => helper.staking.stake(staker, 100n * nominal)));635 }636 await helper.wait.newBlocks(40);637 await helper.admin.payoutStakers(palletAdmin, 100);638 });639 640 itSub.skip('can handle 40.000 rewards', async ({helper}) => {641 const crowdStakes = async () => {642 // each account in the crowd stakes 2 times643 const crowd = await helper.arrange.createCrowd(500, 300n, donor);644 await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal)));645 await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal)));646 // 647 };648 649 for (let i = 0; i < 40; i++) {650 await crowdStakes();651 }652 653 // TODO pay rewards for some period654 });655 });656});657658function calculateIncome(base: bigint, iter = 0, calcPeriod: bigint = UNLOCKING_PERIOD): bigint {659 const DAY = 7200n;660 const ACCURACY = 1_000_000_000n;661 // 5n / 10_000n = 0.05% p/day662 const income = base + base * (ACCURACY * (calcPeriod * 5n) / (10_000n * DAY)) / ACCURACY ;663 664 if (iter > 1) {665 return calculateIncome(income, iter - 1, calcPeriod);666 } else return income;667}668669function rewardAvailableInBlock(stakedInBlock: bigint) {670 if (stakedInBlock % LOCKING_PERIOD === 0n) return stakedInBlock + LOCKING_PERIOD;671 return (stakedInBlock - stakedInBlock % LOCKING_PERIOD) + (LOCKING_PERIOD * 2n);672}673674// Wait while promotion period less than specified block, to avoid boundary cases675// 0 if this should be the beginning of the period.676async function waitPromotionPeriodDoesntEnd(helper: DevUniqueHelper, waitBlockLessThan = LOCKING_PERIOD / 3n) {677 const relayBlockNumber = (await helper.callRpc('api.query.parachainSystem.validationData', [])).value.relayParentNumber.toNumber(); // await helper.chain.getLatestBlockNumber();678 const currentPeriodBlock = BigInt(relayBlockNumber) % LOCKING_PERIOD;679680 if (currentPeriodBlock > waitBlockLessThan) {681 await helper.wait.forRelayBlockNumber(BigInt(relayBlockNumber) + LOCKING_PERIOD - currentPeriodBlock);682 }683}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import {IKeyringPair} from '@polkadot/types/types';18import {19 itSub, usingPlaygrounds, Pallets, requirePalletsOrSkip, LOCKING_PERIOD, UNLOCKING_PERIOD,20} from './util';21import {DevUniqueHelper} from './util/playgrounds/unique.dev';22import {itEth, expect, SponsoringMode} from './eth/util';2324let donor: IKeyringPair;25let palletAdmin: IKeyringPair;26let nominal: bigint;27let palletAddress: string;28let accounts: IKeyringPair[];29// App promotion periods:30// LOCKING_PERIOD = 12 blocks of relay31// UNLOCKING_PERIOD = 6 blocks of parachain3233describe('App promotion', () => {34 before(async function () {35 await usingPlaygrounds(async (helper, privateKey) => {36 requirePalletsOrSkip(this, helper, [Pallets.AppPromotion]);37 donor = await privateKey({filename: __filename});38 palletAddress = helper.arrange.calculatePalletAddress('appstake');39 palletAdmin = await privateKey('//PromotionAdmin');40 nominal = helper.balance.getOneTokenNominal();4142 const accountBalances = new Array(100);43 accountBalances.fill(1000n);44 accounts = await helper.arrange.createAccounts(accountBalances, donor); // create accounts-pool to speed up tests45 });46 });4748 describe('stake extrinsic', () => { 49 itSub('should "lock" staking balance, add it to "staked" map, and increase "totalStaked" amount', async ({helper}) => {50 const [staker, recepient] = [accounts.pop()!, accounts.pop()!];51 const totalStakedBefore = await helper.staking.getTotalStaked();52 53 // Minimum stake amount is 100:54 await expect(helper.staking.stake(staker, 100n * nominal - 1n)).to.be.rejected;55 await helper.staking.stake(staker, 100n * nominal);56 57 // Staker balance is: miscFrozen: 100, feeFrozen: 100, reserved: 0n...58 // ...so he can not transfer 90059 expect(await helper.balance.getSubstrateFull(staker.address)).to.contain({miscFrozen: 100n * nominal, feeFrozen: 100n * nominal, reserved: 0n});60 expect(await helper.balance.getLocked(staker.address)).to.deep.eq([{id: 'appstake', amount: 100n * nominal, reasons: 'All'}]);61 await expect(helper.balance.transferToSubstrate(staker, recepient.address, 900n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions');62 63 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(100n * nominal);64 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);65 // it is potentially flaky test. Promotion can credited some tokens. Maybe we need to use closeTo? 66 expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore + 100n * nominal); // total tokens amount staked in app-promotion increased 67 68 69 await helper.staking.stake(staker, 200n * nominal);70 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(300n * nominal);71 const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});72 expect(totalStakedPerBlock[0].amount).to.equal(100n * nominal);73 expect(totalStakedPerBlock[1].amount).to.equal(200n * nominal);74 });75 76 itSub('should allow to create maximum 10 stakes for account', async ({helper}) => {77 const [staker] = await helper.arrange.createAccounts([2000n], donor);78 for (let i = 0; i < 10; i++) {79 await helper.staking.stake(staker, 100n * nominal);80 }81 82 // can have 10 stakes83 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(1000n * nominal);84 expect(await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).to.have.length(10);85 86 await expect(helper.staking.stake(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.NoPermission');87 88 // After unstake can stake again89 await helper.staking.unstake(staker);90 await helper.staking.stake(staker, 100n * nominal);91 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.equal(100n * nominal);92 });93 94 itSub('should reject transaction if stake amount is more than total free balance minus frozen', async ({helper}) => {95 const staker = accounts.pop()!;96 97 // Can't stake full balance because Alice needs to pay some fee98 await expect(helper.staking.stake(staker, 1000n * nominal)).to.be.rejected;99 await helper.staking.stake(staker, 500n * nominal);100 101 // Can't stake 500 tkn because Alice has Less than 500 transferable;102 await expect(helper.staking.stake(staker, 500n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions'); 103 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(500n * nominal);104 });105 106 itSub('for different accounts in one block is possible', async ({helper}) => {107 const crowd = [accounts.pop()!, accounts.pop()!, accounts.pop()!, accounts.pop()!];108 109 const crowdStartsToStake = crowd.map(user => helper.staking.stake(user, 100n * nominal));110 await expect(Promise.all(crowdStartsToStake)).to.be.fulfilled;111 112 const crowdStakes = await Promise.all(crowd.map(address => helper.staking.getTotalStaked({Substrate: address.address})));113 expect(crowdStakes).to.deep.equal([100n * nominal, 100n * nominal, 100n * nominal, 100n * nominal]);114 });115 });116 117 describe('unstake extrinsic', () => { 118 itSub('should change balance state from "frozen" to "reserved", add it to "pendingUnstake" map, and subtract it from totalStaked', async ({helper}) => {119 const [staker, recepient] = [accounts.pop()!, accounts.pop()!];120 const totalStakedBefore = await helper.staking.getTotalStaked();121 await helper.staking.stake(staker, 900n * nominal);122 await helper.staking.unstake(staker);123 124 // Right after unstake balance is reserved125 // Staker can not transfer 126 expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 900n * nominal, miscFrozen: 0n, feeFrozen: 0n});127 await expect(helper.balance.transferToSubstrate(staker, recepient.address, 100n * nominal)).to.be.rejectedWith('balances.InsufficientBalance');128 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(900n * nominal);129 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);130 expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore);131 });132 133 itSub('should unlock balance after unlocking period ends and remove it from "pendingUnstake"', async ({helper}) => {134 const staker = accounts.pop()!;135 await helper.staking.stake(staker, 100n * nominal);136 await helper.staking.unstake(staker);137 const [pendingUnstake] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});138 139 // Wait for unstaking period. Balance now free ~1000; reserved, frozen, miscFrozeb: 0n140 await helper.wait.forParachainBlockNumber(pendingUnstake.block);141 expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 0n, feeFrozen: 0n});142 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);143 144 // staker can transfer:145 await helper.balance.transferToSubstrate(staker, donor.address, 998n * nominal);146 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(1n);147 });148 149 itSub('should successfully unstake multiple stakes', async ({helper}) => {150 const staker = accounts.pop()!;151 await helper.staking.stake(staker, 100n * nominal);152 await helper.staking.stake(staker, 200n * nominal);153 await helper.staking.stake(staker, 300n * nominal);154 155 // staked: [100, 200, 300]; unstaked: 0156 let totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});157 let pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});158 let stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});159 expect(totalPendingUnstake).to.be.deep.equal(0n);160 expect(pendingUnstake).to.be.deep.equal([]);161 expect(stakes[0].amount).to.equal(100n * nominal);162 expect(stakes[1].amount).to.equal(200n * nominal);163 expect(stakes[2].amount).to.equal(300n * nominal);164 165 // Can unstake multiple stakes166 await helper.staking.unstake(staker);167 pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});168 totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});169 stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});170 expect(totalPendingUnstake).to.be.equal(600n * nominal);171 expect(stakes).to.be.deep.equal([]);172 expect(pendingUnstake[0].amount).to.equal(600n * nominal);173 174 expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 600n * nominal, feeFrozen: 0n, miscFrozen: 0n});175 await helper.wait.forParachainBlockNumber(pendingUnstake[0].block);176 expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 0n, miscFrozen: 0n});177 expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);178 });179 180 itSub('should not have any effects if no active stakes', async ({helper}) => {181 const staker = accounts.pop()!;182 183 // unstake has no effect if no stakes at all184 await helper.staking.unstake(staker);185 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(0n);186 expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); // TODO bigint closeTo helper187 188 // TODO stake() unstake() waitUnstaked() unstake();189 190 // can't unstake if there are only pendingUnstakes191 await helper.staking.stake(staker, 100n * nominal);192 await helper.staking.unstake(staker);193 await helper.staking.unstake(staker);194 195 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);196 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);197 });198 199 itSub('should keep different unlocking block for each unlocking stake', async ({helper}) => {200 const staker = accounts.pop()!;201 await helper.staking.stake(staker, 100n * nominal);202 await helper.staking.unstake(staker);203 await helper.staking.stake(staker, 120n * nominal);204 await helper.staking.unstake(staker);205 206 const unstakingPerBlock = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});207 expect(unstakingPerBlock).has.length(2);208 expect(unstakingPerBlock[0].amount).to.equal(100n * nominal);209 expect(unstakingPerBlock[1].amount).to.equal(120n * nominal);210 });211 212 itSub('should be possible for different accounts in one block', async ({helper}) => {213 const stakers = [accounts.pop()!, accounts.pop()!, accounts.pop()!];214 215 await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal)));216 await Promise.all(stakers.map(staker => helper.staking.unstake(staker)));217 218 await Promise.all(stakers.map(async (staker) => {219 expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);220 expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);221 }));222 });223 });224 225 describe('collection sponsoring', () => {226 itSub('should actually sponsor transactions', async ({helper}) => {227 const api = helper.getApi();228 const [collectionOwner, tokenSender, receiver] = [accounts.pop()!, accounts.pop()!, accounts.pop()!];229 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'Name', description: 'Description', tokenPrefix: 'Prefix', limits: {sponsorTransferTimeout: 0}});230 const token = await collection.mintToken(collectionOwner, {Substrate: tokenSender.address});231 await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId));232 const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress);233 234 await token.transfer(tokenSender, {Substrate: receiver.address});235 expect (await token.getOwner()).to.be.deep.equal({Substrate: receiver.address});236 const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress);237 238 // senders balance the same, transaction has sponsored239 expect (await helper.balance.getSubstrate(tokenSender.address)).to.be.equal(1000n * nominal);240 expect (palletBalanceBefore > palletBalanceAfter).to.be.true;241 });242 243 itSub('can not be set by non admin', async ({helper}) => {244 const api = helper.getApi();245 const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!];246 247 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});248 249 await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected;250 expect((await collection.getData())?.raw.sponsorship).to.equal('Disabled');251 });252 253 itSub('should set pallet address as confirmed admin', async ({helper}) => {254 const api = helper.getApi();255 const [collectionOwner, oldSponsor] = [accounts.pop()!, accounts.pop()!];256 257 // Can set sponsoring for collection without sponsor258 const collectionWithoutSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'No-sponsor', description: 'New Collection', tokenPrefix: 'Promotion'});259 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithoutSponsor.collectionId))).to.be.fulfilled;260 expect((await collectionWithoutSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});261 262 // Can set sponsoring for collection with unconfirmed sponsor263 const collectionWithUnconfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Unconfirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address});264 expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: oldSponsor.address});265 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithUnconfirmedSponsor.collectionId))).to.be.fulfilled;266 expect((await collectionWithUnconfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});267 268 // Can set sponsoring for collection with confirmed sponsor269 const collectionWithConfirmedSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'Confirmed', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: oldSponsor.address});270 await collectionWithConfirmedSponsor.confirmSponsorship(oldSponsor);271 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithConfirmedSponsor.collectionId))).to.be.fulfilled;272 expect((await collectionWithConfirmedSponsor.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});273 });274 275 itSub('can be overwritten by collection owner', async ({helper}) => { 276 const api = helper.getApi();277 const [collectionOwner, newSponsor] = [accounts.pop()!, accounts.pop()!];278 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});279 const collectionId = collection.collectionId;280 281 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionId))).to.be.fulfilled;282 283 // Collection limits still can be changed by the owner284 expect(await collection.setLimits(collectionOwner, {sponsorTransferTimeout: 0})).to.be.true;285 expect((await collection.getData())?.raw.limits.sponsorTransferTimeout).to.be.equal(0);286 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});287 288 // Collection sponsor can be changed too289 expect((await collection.setSponsor(collectionOwner, newSponsor.address))).to.be.true;290 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Unconfirmed: newSponsor.address});291 });292 293 itSub('should not overwrite collection limits set by the owner earlier', async ({helper}) => {294 const api = helper.getApi();295 const limits = {ownerCanDestroy: true, ownerCanTransfer: true, sponsorTransferTimeout: 0};296 const collectionWithLimits = await helper.nft.mintCollection(accounts.pop()!, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits});297 298 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithLimits.collectionId))).to.be.fulfilled;299 expect((await collectionWithLimits.getData())?.raw.limits).to.be.deep.contain(limits);300 });301 302 itSub('should reject transaction if collection doesn\'t exist', async ({helper}) => {303 const api = helper.getApi();304 const collectionOwner = accounts.pop()!;305 306 // collection has never existed307 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(999999999))).to.be.rejected;308 // collection has been burned309 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});310 await collection.burn(collectionOwner);311 312 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.rejected;313 });314 });315 316 describe('stopSponsoringCollection', () => {317 itSub('can not be called by non-admin', async ({helper}) => {318 const api = helper.getApi();319 const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!];320 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});321 322 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.fulfilled;323 324 await expect(helper.signTransaction(nonAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected;325 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: palletAddress});326 });327 328 itSub('should set sponsoring as disabled', async ({helper}) => {329 const api = helper.getApi();330 const [collectionOwner, recepient] = [accounts.pop()!, accounts.pop()!];331 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits: {sponsorTransferTimeout: 0}});332 const token = await collection.mintToken(collectionOwner, {Substrate: collectionOwner.address});333 334 await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId));335 await helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId));336 337 expect((await collection.getData())?.raw.sponsorship).to.be.equal('Disabled');338 339 // Transactions are not sponsored anymore:340 const ownerBalanceBefore = await helper.balance.getSubstrate(collectionOwner.address);341 await token.transfer(collectionOwner, {Substrate: recepient.address});342 const ownerBalanceAfter = await helper.balance.getSubstrate(collectionOwner.address);343 expect(ownerBalanceAfter < ownerBalanceBefore).to.be.equal(true);344 });345 346 itSub('should not affect collection which is not sponsored by pallete', async ({helper}) => {347 const api = helper.getApi();348 const collectionOwner = accounts.pop()!;349 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: collectionOwner.address});350 await collection.confirmSponsorship(collectionOwner);351 352 await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.stopSponsoringCollection(collection.collectionId))).to.be.rejected;353 354 expect((await collection.getData())?.raw.sponsorship).to.be.deep.equal({Confirmed: collectionOwner.address});355 });356 357 itSub('should reject transaction if collection does not exist', async ({helper}) => { 358 const collectionOwner = accounts.pop()!;359 const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});360 361 await collection.burn(collectionOwner);362 await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [collection.collectionId], true)).to.be.rejectedWith('common.CollectionNotFound');363 await expect(helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringCollection', [999_999_999], true)).to.be.rejectedWith('common.CollectionNotFound');364 });365 });366 367 describe('contract sponsoring', () => {368 itEth('should set palletes address as a sponsor', async ({helper}) => {369 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();370 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);371 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);372 373 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]);374 375 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; 376 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 377 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({378 confirmed: {379 substrate: palletAddress,380 },381 });382 });383 384 itEth('should overwrite sponsoring mode and existed sponsor', async ({helper}) => {385 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();386 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);387 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);388 389 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled;390 391 // Contract is self sponsored392 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.be.deep.equal({393 confirmed: {394 ethereum: flipper.options.address.toLowerCase(),395 },396 });397 398 // set promotion sponsoring399 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);400 401 // new sponsor is pallet address402 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; 403 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 404 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({405 confirmed: {406 substrate: palletAddress,407 },408 });409 });410 411 itEth('can be overwritten by contract owner', async ({helper}) => {412 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();413 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);414 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);415 416 // contract sponsored by pallet417 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);418 419 // owner sets self sponsoring420 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.not.rejected;421 422 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.true; 423 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 424 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({425 confirmed: {426 ethereum: flipper.options.address.toLowerCase(),427 },428 });429 });430 431 itEth('can not be set by non admin', async ({helper}) => {432 const nonAdmin = accounts.pop()!;433 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();434 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);435 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);436 437 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled;438 439 // nonAdmin calls sponsorContract440 await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission');441 442 // contract still self-sponsored 443 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({444 confirmed: {445 ethereum: flipper.options.address.toLowerCase(),446 },447 });448 });449 450 itEth('should actually sponsor transactions', async ({helper}) => {451 // Contract caller452 const caller = await helper.eth.createAccountWithBalance(donor, 1000n);453 const palletBalanceBefore = await helper.balance.getSubstrate(palletAddress);454 455 // Deploy flipper456 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();457 const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);458 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);459 460 // Owner sets to sponsor every tx461 await contractHelper.methods.setSponsoringRateLimit(flipper.options.address, 0).send({from: contractOwner});462 await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner});463 await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address, 1000n); // transferBalanceToEth(api, alice, flipper.options.address, 1000n);464 465 // Set promotion to the Flipper466 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);467 468 // Caller calls Flipper469 await flipper.methods.flip().send({from: caller});470 expect(await flipper.methods.getValue().call()).to.be.true;471 472 // The contracts and caller balances have not changed473 const callerBalance = await helper.balance.getEthereum(caller);474 const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address);475 expect(callerBalance).to.be.equal(1000n * nominal);476 expect(1000n * nominal === contractBalanceAfter).to.be.true;477 478 // The pallet balance has decreased479 const palletBalanceAfter = await helper.balance.getSubstrate(palletAddress);480 expect(palletBalanceAfter < palletBalanceBefore).to.be.true;481 });482 });483 484 describe('stopSponsoringContract', () => { 485 itEth('should remove pallet address from contract sponsors', async ({helper}) => {486 const caller = await helper.eth.createAccountWithBalance(donor, 1000n);487 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();488 const flipper = await helper.eth.deployFlipper(contractOwner);489 await helper.eth.transferBalanceFromSubstrate(donor, flipper.options.address);490 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);491 492 await contractHelper.methods.setSponsoringMode(flipper.options.address, SponsoringMode.Generous).send({from: contractOwner});493 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address], true);494 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true);495 496 expect(await contractHelper.methods.hasSponsor(flipper.options.address).call()).to.be.false; 497 expect((await helper.callRpc('api.query.evmContractHelpers.owner', [flipper.options.address])).toJSON()).to.be.equal(contractOwner); 498 expect((await helper.callRpc('api.query.evmContractHelpers.sponsoring', [flipper.options.address])).toJSON()).to.deep.equal({499 disabled: null,500 });501 502 await flipper.methods.flip().send({from: caller});503 expect(await flipper.methods.getValue().call()).to.be.true;504 505 const callerBalance = await helper.balance.getEthereum(caller);506 const contractBalanceAfter = await helper.balance.getEthereum(flipper.options.address);507 508 // caller payed for call509 expect(1000n * nominal > callerBalance).to.be.true;510 expect(contractBalanceAfter).to.be.equal(100n * nominal);511 });512 513 itEth('can not be called by non-admin', async ({helper}) => {514 const nonAdmin = accounts.pop()!;515 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();516 const flipper = await helper.eth.deployFlipper(contractOwner);517 518 await helper.executeExtrinsic(palletAdmin, 'api.tx.appPromotion.sponsorContract', [flipper.options.address]);519 await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address]))520 .to.be.rejectedWith(/appPromotion\.NoPermission/);521 });522 523 itEth('should not affect a contract which is not sponsored by pallete', async ({helper}) => {524 const nonAdmin = accounts.pop()!;525 const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();526 const flipper = await helper.eth.deployFlipper(contractOwner);527 const contractHelper = helper.ethNativeContract.contractHelpers(contractOwner);528 await expect(contractHelper.methods.selfSponsoredEnable(flipper.options.address).send()).to.be.fulfilled;529 530 await expect(helper.executeExtrinsic(nonAdmin, 'api.tx.appPromotion.stopSponsoringContract', [flipper.options.address], true)).to.be.rejectedWith('appPromotion.NoPermission');531 });532 });533 534 describe('payoutStakers', () => {535 itSub('can not be called by non admin', async ({helper}) => {536 const nonAdmin = accounts.pop()!;537 await expect(helper.admin.payoutStakers(nonAdmin, 100)).to.be.rejectedWith('appPromotion.NoPermission');538 });539 540 itSub('should increase total staked', async ({helper}) => {541 const staker = accounts.pop()!;542 const totalStakedBefore = await helper.staking.getTotalStaked();543 await helper.staking.stake(staker, 100n * nominal);544 545 // Wait for rewards and pay546 const [stakedInBlock] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});547 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stakedInBlock.block));548 const totalPayout = (await helper.admin.payoutStakers(palletAdmin, 100)).reduce((prev, payout) => prev + payout.payout, 0n);549 550 const totalStakedAfter = await helper.staking.getTotalStaked();551 expect(totalStakedAfter).to.equal(totalStakedBefore + (100n * nominal) + totalPayout);552 // staker can unstake553 await helper.staking.unstake(staker);554 expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedAfter - calculateIncome(100n * nominal));555 });556 557 itSub('should credit 0.05% for staking period', async ({helper}) => { 558 const staker = accounts.pop()!;559 560 await waitPromotionPeriodDoesntEnd(helper);561 562 await helper.staking.stake(staker, 100n * nominal);563 await helper.staking.stake(staker, 200n * nominal);564 565 // wait rewards are available:566 const [_stake1, stake2] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});567 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake2.block));568 569 const payoutToStaker = (await helper.admin.payoutStakers(palletAdmin, 100)).find((payout) => payout.staker === staker.address)?.payout;570 expect(payoutToStaker + 300n * nominal).to.equal(calculateIncome(300n * nominal));571 572 const totalStakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});573 const income1 = calculateIncome(100n * nominal);574 const income2 = calculateIncome(200n * nominal);575 expect(totalStakedPerBlock[0].amount).to.equal(income1);576 expect(totalStakedPerBlock[1].amount).to.equal(income2);577578 const stakerBalance = await helper.balance.getSubstrateFull(staker.address);579 expect(stakerBalance).to.contain({miscFrozen: income1 + income2, feeFrozen: income1 + income2, reserved: 0n});580 expect(stakerBalance.free / nominal).to.eq(999n);581 });582 583 itSub('shoud be paid for more than one period if payments was missed', async ({helper}) => {584 const staker = accounts.pop()!;585 586 await helper.staking.stake(staker, 100n * nominal);587 // wait for two rewards are available:588 let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});589 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD);590 591 await helper.admin.payoutStakers(palletAdmin, 100);592 [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});593 const frozenBalanceShouldBe = calculateIncome(100n * nominal, 2);594 expect(stake.amount).to.be.equal(frozenBalanceShouldBe);595 596 const stakerFullBalance = await helper.balance.getSubstrateFull(staker.address);597 598 expect(stakerFullBalance).to.contain({reserved: 0n, feeFrozen: frozenBalanceShouldBe, miscFrozen: frozenBalanceShouldBe});599 });600 601 itSub('should not be credited for unstaked (reserved) balance', async ({helper}) => {602 // staker unstakes before rewards has been payed603 const staker = accounts.pop()!;604 await helper.staking.stake(staker, 100n * nominal);605 const [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});606 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD);607 await helper.staking.unstake(staker);608 609 // so he did not receive any rewards610 const totalBalanceBefore = await helper.balance.getSubstrate(staker.address);611 await helper.admin.payoutStakers(palletAdmin, 100);612 const totalBalanceAfter = await helper.balance.getSubstrate(staker.address);613 614 expect(totalBalanceBefore).to.be.equal(totalBalanceAfter);615 });616 617 itSub('should bring compound interest', async ({helper}) => {618 const staker = accounts.pop()!;619 620 await helper.staking.stake(staker, 100n * nominal);621 622 let [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});623 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block));624 625 await helper.admin.payoutStakers(palletAdmin, 100);626 [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});627 expect(stake.amount).to.equal(calculateIncome(100n * nominal));628 629 await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD);630 await helper.admin.payoutStakers(palletAdmin, 100);631 [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});632 expect(stake.amount).to.equal(calculateIncome(100n * nominal, 2));633 });634 635 itSub.skip('can be paid 1000 rewards in a time', async ({helper}) => {636 // all other stakes should be unstaked637 const oneHundredStakers = await helper.arrange.createCrowd(100, 1050n, donor);638 639 // stakers stakes 10 times each640 for (let i = 0; i < 10; i++) {641 await Promise.all(oneHundredStakers.map(staker => helper.staking.stake(staker, 100n * nominal)));642 }643 await helper.wait.newBlocks(40);644 await helper.admin.payoutStakers(palletAdmin, 100);645 });646 647 itSub.skip('can handle 40.000 rewards', async ({helper}) => {648 const crowdStakes = async () => {649 // each account in the crowd stakes 2 times650 const crowd = await helper.arrange.createCrowd(500, 300n, donor);651 await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal)));652 await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal)));653 // 654 };655 656 for (let i = 0; i < 40; i++) {657 await crowdStakes();658 }659 660 // TODO pay rewards for some period661 });662 });663});664665function calculateIncome(base: bigint, iter = 0, calcPeriod: bigint = UNLOCKING_PERIOD): bigint {666 const DAY = 7200n;667 const ACCURACY = 1_000_000_000n;668 // 5n / 10_000n = 0.05% p/day669 const income = base + base * (ACCURACY * (calcPeriod * 5n) / (10_000n * DAY)) / ACCURACY ;670 671 if (iter > 1) {672 return calculateIncome(income, iter - 1, calcPeriod);673 } else return income;674}675676function rewardAvailableInBlock(stakedInBlock: bigint) {677 if (stakedInBlock % LOCKING_PERIOD === 0n) return stakedInBlock + LOCKING_PERIOD;678 return (stakedInBlock - stakedInBlock % LOCKING_PERIOD) + (LOCKING_PERIOD * 2n);679}680681// Wait while promotion period less than specified block, to avoid boundary cases682// 0 if this should be the beginning of the period.683async function waitPromotionPeriodDoesntEnd(helper: DevUniqueHelper, waitBlockLessThan = LOCKING_PERIOD / 3n) {684 const relayBlockNumber = (await helper.callRpc('api.query.parachainSystem.validationData', [])).value.relayParentNumber.toNumber(); // await helper.chain.getLatestBlockNumber();685 const currentPeriodBlock = BigInt(relayBlockNumber) % LOCKING_PERIOD;686687 if (currentPeriodBlock > waitBlockLessThan) {688 await helper.wait.forRelayBlockNumber(BigInt(relayBlockNumber) + LOCKING_PERIOD - currentPeriodBlock);689 }690}tests/src/util/playgrounds/unique.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/unique.ts
+++ b/tests/src/util/playgrounds/unique.ts
@@ -2200,6 +2200,15 @@
}
/**
+ * Get latest relay block
+ * @returns {number} relay block
+ */
+ async getRelayBlockNumber(): Promise<bigint> {
+ const blockNumber = (await this.helper.callRpc('api.query.parachainSystem.validationData')).toJSON().relayParentNumber;
+ return BigInt(blockNumber);
+ }
+
+ /**
* Get account nonce
* @param address substrate address
* @example getNonce("5GrwvaEF5zXb26Fz...");
@@ -2257,6 +2266,11 @@
const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;
return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};
}
+
+ async getLocked(address: TSubstrateAccount): Promise<[{id: string, amount: bigint, reason: string}]> {
+ const locks = (await this.helper.callRpc('api.query.balances.locks', [address])).toHuman();
+ return locks.map((lock: any) => {return {id: lock.id, amount: BigInt(lock.amount.replace(/,/g, '')), reasons: lock.reasons};});
+ }
}
class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {
@@ -2341,6 +2355,15 @@
}
/**
+ * Get locked balances
+ * @param address substrate address
+ * @returns locked balances with reason via api.query.balances.locks
+ */
+ getLocked(address: TSubstrateAccount) {
+ return this.subBalanceGroup.getLocked(address);
+ }
+
+ /**
* Get ethereum address balance
* @param address ethereum address
* @example getEthereum("0x9F0583DbB855d...")
@@ -2380,6 +2403,52 @@
isSuccess = isSuccess && BigInt(amount) === transfer.amount;
return isSuccess;
}
+
+ /**
+ * Transfer tokens with the unlock period
+ * @param signer signers Keyring
+ * @param address Substrate address of recipient
+ * @param schedule Schedule params
+ * @example vestedTransfer(signer, recepient.address, 20000, 100, 10, 50 * nominal); // total amount of vested tokens will be 100 * 50 = 5000
+ */
+ async vestedTransfer(signer: TSigner, address: TSubstrateAccount, schedule: {start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}): Promise<void> {
+ const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.vestedTransfer', [address, schedule]);
+ const event = result.result.events
+ .find(e => e.event.section === 'vesting' &&
+ e.event.method === 'VestingScheduleAdded' &&
+ e.event.data[0].toHuman() === signer.address);
+ if (!event) throw Error('Cannot find transfer in events');
+ }
+
+ /**
+ * Get schedule for recepient of vested transfer
+ * @param address Substrate address of recipient
+ * @returns
+ */
+ async getVestingSchedules(address: TSubstrateAccount): Promise<{start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}[]> {
+ const schedule = (await this.helper.callRpc('api.query.vesting.vestingSchedules', [address])).toJSON();
+ return schedule.map((schedule: any) => {
+ return {
+ start: BigInt(schedule.start),
+ period: BigInt(schedule.period),
+ periodCount: BigInt(schedule.periodCount),
+ perPeriod: BigInt(schedule.perPeriod),
+ };
+ });
+ }
+
+ /**
+ * Claim vested tokens
+ * @param signer signers Keyring
+ */
+ async claim(signer: TSigner) {
+ const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.claim', []);
+ const event = result.result.events
+ .find(e => e.event.section === 'vesting' &&
+ e.event.method === 'Claimed' &&
+ e.event.data[0].toHuman() === signer.address);
+ if (!event) throw Error('Cannot find claim in events');
+ }
}
class AddressGroup extends HelperGroup<ChainHelperBase> {
tests/src/vesting.test.tsdiffbeforeafterboth--- /dev/null
+++ b/tests/src/vesting.test.ts
@@ -0,0 +1,153 @@
+// 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 <http://www.gnu.org/licenses/>.
+
+import {IKeyringPair} from '@polkadot/types/types';
+import {itSub, usingPlaygrounds, expect} from './util';
+
+describe('Vesting', () => {
+ let donor: IKeyringPair;
+ let nominal: bigint;
+
+ before(async () => {
+ await usingPlaygrounds(async (helper, privateKey) => {
+ donor = await privateKey({filename: __filename});
+ nominal = helper.balance.getOneTokenNominal();
+ });
+ });
+
+ itSub('can perform vestedTransfer and claim tokens', async ({helper}) => {
+ // arrange
+ const [sender, recepient] = await helper.arrange.createAccounts([1000n, 1n], donor);
+ const currentRelayBlock = await helper.chain.getRelayBlockNumber();
+ const schedule1 = {start: currentRelayBlock + 4n, period: 4n, periodCount: 2n, perPeriod: 50n * nominal};
+ const schedule2 = {start: currentRelayBlock + 8n, period: 8n, periodCount: 2n, perPeriod: 100n * nominal};
+
+ // act
+ await helper.balance.vestedTransfer(sender, recepient.address, schedule1);
+ await helper.balance.vestedTransfer(sender, recepient.address, schedule2);
+ let schedule = await helper.balance.getVestingSchedules(recepient.address);
+
+ // check senders balance after vesting:
+ let balanceSender = await helper.balance.getSubstrateFull(sender.address);
+ expect(balanceSender.free / nominal).to.eq(699n);
+ expect(balanceSender.feeFrozen).to.eq(0n);
+ expect(balanceSender.miscFrozen).to.eq(0n);
+ expect(balanceSender.reserved).to.eq(0n);
+
+ // check recepient balance after vesting:
+ let balanceRecepient = await helper.balance.getSubstrateFull(recepient.address);
+ expect(balanceRecepient.free).to.eq(301n * nominal);
+ expect(balanceRecepient.feeFrozen).to.eq(300n * nominal);
+ expect(balanceRecepient.miscFrozen).to.eq(300n * nominal);
+ expect(balanceRecepient.reserved).to.eq(0n);
+
+ // Schedules list correct:
+ expect(schedule).to.has.length(2);
+ expect(schedule[0]).to.deep.eq(schedule1);
+ expect(schedule[1]).to.deep.eq(schedule2);
+
+ await helper.wait.forRelayBlockNumber(currentRelayBlock + 8n);
+ await helper.balance.claim(recepient);
+
+ // check recepient balance after claim (50 tokens claimed):
+ balanceRecepient = await helper.balance.getSubstrateFull(recepient.address);
+ expect(balanceRecepient.free / nominal).to.eq(300n);
+ expect(balanceRecepient.feeFrozen).to.eq(250n * nominal);
+ expect(balanceRecepient.miscFrozen).to.eq(250n * nominal);
+ expect(balanceRecepient.reserved).to.eq(0n);
+
+ await helper.wait.forRelayBlockNumber(currentRelayBlock + 16n);
+ await helper.balance.claim(recepient);
+
+ // check recepient balance after second claim (150 tokens claimed):
+ balanceRecepient = await helper.balance.getSubstrateFull(recepient.address);
+ expect(balanceRecepient.free / nominal).to.eq(300n);
+ expect(balanceRecepient.feeFrozen).to.eq(100n * nominal);
+ expect(balanceRecepient.miscFrozen).to.eq(100n * nominal);
+ expect(balanceRecepient.reserved).to.eq(0n);
+
+ // Schedules list contain 1 vesting:
+ schedule = await helper.balance.getVestingSchedules(recepient.address);
+ expect(schedule).to.has.length(1);
+ expect(schedule[0]).to.deep.eq(schedule2);
+
+ await helper.wait.forRelayBlockNumber(currentRelayBlock + 24n);
+ await helper.balance.claim(recepient);
+
+ // check recepient balance after second claim (100 tokens claimed):
+ balanceRecepient = await helper.balance.getSubstrateFull(recepient.address);
+ expect(balanceRecepient.free / nominal).to.eq(300n);
+ expect(balanceRecepient.feeFrozen).to.eq(0n);
+ expect(balanceRecepient.miscFrozen).to.eq(0n);
+ expect(balanceRecepient.reserved).to.eq(0n);
+
+ // check sender balance does not changed:
+ balanceSender = await helper.balance.getSubstrateFull(sender.address);
+ expect(balanceSender.free / nominal).to.eq(699n);
+ expect(balanceSender.feeFrozen).to.eq(0n);
+ expect(balanceSender.miscFrozen).to.eq(0n);
+ expect(balanceSender.reserved).to.eq(0n);
+ });
+
+ itSub('cannot send more tokens than have', async ({helper}) => {
+ const [sender, receiver] = await helper.arrange.createAccounts([1000n, 1n], donor);
+ const schedule = {start: 0n, period: 1n, periodCount: 1n, perPeriod: 100n * nominal};
+ const manyPeriodsSchedule = {start: 0n, period: 1n, periodCount: 100n, perPeriod: 10n * nominal};
+ const oneBigSumSchedule = {start: 0n, period: 1n, periodCount: 1n, perPeriod: 5000n * nominal};
+
+ // Sender cannot send vestedTransfer to self or other
+ await expect(helper.balance.vestedTransfer(sender, sender.address, manyPeriodsSchedule)).to.be.rejectedWith(/InsufficientBalance/);
+ await expect(helper.balance.vestedTransfer(sender, receiver.address, manyPeriodsSchedule)).to.be.rejectedWith(/InsufficientBalance/);
+ await expect(helper.balance.vestedTransfer(sender, sender.address, oneBigSumSchedule)).to.be.rejectedWith(/InsufficientBalance/);
+ await expect(helper.balance.vestedTransfer(sender, receiver.address, oneBigSumSchedule)).to.be.rejectedWith(/InsufficientBalance/);
+
+ const balanceSender = await helper.balance.getSubstrateFull(sender.address);
+ const balanceReceiver = await helper.balance.getSubstrateFull(receiver.address);
+
+ // Sender's balance has not changed
+ expect(balanceSender.free / nominal).to.eq(999n);
+ expect(balanceSender.feeFrozen).to.eq(0n);
+ expect(balanceSender.miscFrozen).to.eq(0n);
+ expect(balanceSender.reserved).to.eq(0n);
+
+ // Receiver's balance has not changed
+ expect(balanceReceiver.free).to.be.eq(1n * nominal);
+ expect(balanceReceiver.feeFrozen).to.be.eq(0n);
+ expect(balanceReceiver.miscFrozen).to.be.eq(0n);
+ expect(balanceReceiver.reserved).to.be.eq(0n);
+
+ // Receiver cannot send vestedTransfer back because of freeze
+ await expect(helper.balance.vestedTransfer(receiver, sender.address, schedule)).to.be.rejectedWith(/InsufficientBalance/);
+ });
+
+ itSub('cannot send vestedTransfer with incorrect parameters', async ({helper}) => {
+ const [sender, receiver] = await helper.arrange.createAccounts([1000n, 1n], donor);
+ const incorrectperiodSchedule = {start: 0n, period: 0n, periodCount: 10n, perPeriod: 10n * nominal};
+ const incorrectPeriodCountSchedule = {start: 0n, period: 1n, periodCount: 0n, perPeriod: 10n * nominal};
+ const incorrectPerPeriodSchedule = {start: 0n, period: 1n, periodCount: 1n, perPeriod: 0n * nominal};
+
+ await expect(helper.balance.vestedTransfer(sender, sender.address, incorrectperiodSchedule)).to.be.rejectedWith(/vesting.ZeroVestingPeriod/);
+ await expect(helper.balance.vestedTransfer(sender, receiver.address, incorrectPeriodCountSchedule)).to.be.rejectedWith(/vesting.ZeroVestingPeriod/);
+ await expect(helper.balance.vestedTransfer(sender, receiver.address, incorrectPerPeriodSchedule)).to.be.rejectedWith(/vesting.AmountLow/);
+
+ const balanceSender = await helper.balance.getSubstrateFull(sender.address);
+ // Sender's balance has not changed
+ expect(balanceSender.free / nominal).to.eq(999n);
+ expect(balanceSender.feeFrozen).to.eq(0n);
+ expect(balanceSender.miscFrozen).to.eq(0n);
+ expect(balanceSender.reserved).to.eq(0n);
+ });
+});