git.delta.rocks / unique-network / refs/commits / c52f33f18ea3

difftreelog

Tests: fix flakyness

Max Andreev2022-09-07parent: #25c9617.patch.diff
in: master

3 files changed

modifiedtests/src/app-promotion.test.tsdiffbeforeafterboth
--- a/tests/src/app-promotion.test.ts
+++ b/tests/src/app-promotion.test.ts
@@ -37,6 +37,9 @@
 let nominal: bigint;
 const palletAddress = calculatePalleteAddress('appstake');
 let accounts: IKeyringPair[] = [];
+const LOCKING_PERIOD = 20n; // 20 blocks of relay
+const UNLOCKING_PERIOD = 10n; // 20 blocks of parachain
+const rewardAvailableInBlock = (stakedInBlock: bigint) => (stakedInBlock - stakedInBlock % LOCKING_PERIOD) + (LOCKING_PERIOD * 2n);
 
 before(async function () {
   await usingPlaygrounds(async (helper, privateKeyWrapper) => {
@@ -66,7 +69,6 @@
       expect (await helper.balance.getSubstrateFull(staker.address)).to.contain({miscFrozen: 100n * nominal, feeFrozen: 100n * nominal, reserved: 0n});
       await expect(helper.balance.transferToSubstrate(staker, recepient.address, 900n * nominal)).to.be.rejected;
       
-      expect(await helper.staking.getTotalStakingLocked({Substrate: staker.address})).to.be.equal(100n * nominal);
       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? 
@@ -74,7 +76,6 @@
 
       
       await helper.staking.stake(staker, 200n * nominal);
-      expect(await helper.staking.getTotalStakingLocked({Substrate: staker.address})).to.be.equal(300n * nominal);
       expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(300n * nominal);
       expect((await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).map((x) => x[1])).to.be.deep.equal([100n * nominal, 200n * nominal]);
     });
@@ -83,7 +84,6 @@
   it('should allow to create maximum 10 stakes for account', async () => {
     await usingPlaygrounds(async (helper) => {
       const [staker] = await helper.arrange.createAccounts([2000n], alice);
-      console.log(staker.address);
       for (let i = 0; i < 10; i++) {
         await helper.staking.stake(staker, 100n * nominal);
       }
@@ -147,14 +147,14 @@
   });
 
   it('should unlock balance after unlocking period ends and remove it from "pendingUnstake"', async () => {
-    // TODO Flaky test
     await usingPlaygrounds(async (helper) => {
       const staker = accounts.pop()!;
       await helper.staking.stake(staker, 100n * nominal);
       await helper.staking.unstake(staker);
+      const unstakedInBlock = (await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}))[0][0];
 
       // Wait for unstaking period. Balance now free ~1000; reserved, frozen, miscFrozeb: 0n
-      await waitForRelayBlock(helper.api!, 20);
+      await helper.wait.forParachainBlockNumber(unstakedInBlock);
       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);
 
@@ -181,6 +181,7 @@
      
       // Can unstake multiple stakes
       await helper.staking.unstake(staker);
+      const unstakingBlock = (await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address}))[0][0];
       pendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});
       unstakedPerBlock = (await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address})).map(stake => stake[1]);
       stakedPerBlock = (await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).map(stake => stake[1]);
@@ -189,7 +190,7 @@
       expect(unstakedPerBlock).to.be.deep.equal([600n * nominal]);
 
       expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 600n * nominal, feeFrozen: 0n, miscFrozen: 0n});
-      await waitForRelayBlock(helper.api!, 20);
+      await helper.wait.forParachainBlockNumber(unstakingBlock);
       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);
     });
@@ -202,7 +203,6 @@
       // 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.staking.getTotalStakingLocked({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();
@@ -213,7 +213,6 @@
       await helper.staking.unstake(staker);
 
       expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);
-      expect(await helper.staking.getTotalStakingLocked({Substrate: staker.address})).to.be.equal(100n * nominal);
       expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);
     });
   });
@@ -246,8 +245,6 @@
       }));
     });
   });
-
-  // TODO for different accounts in one block is possible
 });
 
 describe('Admin adress', () => {
@@ -636,13 +633,16 @@
   });
 
   it('should credit 0.05% for staking period', async () => {    
-    // TODO flaky test
     await usingPlaygrounds(async helper => {
       const staker = accounts.pop()!;
       
       await helper.staking.stake(staker, 100n * nominal);
       await helper.staking.stake(staker, 200n * nominal);
-      await waitForRelayBlock(helper.api!, 30);
+
+      // wair rewards are available:
+      const stakedInBlock = (await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}))[1][0];
+      await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stakedInBlock));
+
       await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
 
       const totalStakedPerBlock = (await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).map(s => s[1]);
@@ -651,21 +651,20 @@
   });
 
   it('shoud be paid for more than one period if payments was missed', async () => {
-    // TODO flaky test
     await usingPlaygrounds(async (helper) => {
       const staker = accounts.pop()!;
 
       await helper.staking.stake(staker, 100n * nominal);
-      await helper.staking.stake(staker, 200n * nominal);
+      // wait for two rewards are available:
+      const stakedInBlock = (await helper.staking.getTotalStakedPerBlock({Substrate: staker.address}))[0][0];
+      await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stakedInBlock) + LOCKING_PERIOD);
 
-      await waitForRelayBlock(helper.api!, 55);
       await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
       const stakedPerBlock = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
-      expect(stakedPerBlock[0][1]).to.be.equal(calculateIncome(100n * nominal, 10n, 2));
-      expect(stakedPerBlock[1][1]).to.be.equal(calculateIncome(200n * nominal, 10n, 2));
+      const frozenBalanceShouldBe = calculateIncome(100n * nominal, 10n, 2);
+      expect(stakedPerBlock[0][1]).to.be.equal(frozenBalanceShouldBe);
 
       const stakerFullBalance = await helper.balance.getSubstrateFull(staker.address);
-      const frozenBalanceShouldBe = calculateIncome(300n * nominal, 10n, 2);
 
       expect(stakerFullBalance).to.contain({reserved: 0n, feeFrozen: frozenBalanceShouldBe, miscFrozen: frozenBalanceShouldBe});
     });
@@ -673,7 +672,7 @@
   
   it('should not be credited for unstaked (reserved) balance', async () => {
     await usingPlaygrounds(async helper => {
-      // staker unstakes before rewards has been initialized
+      // staker unstakes before rewards has been payed
       const staker = accounts.pop()!;
       await helper.staking.stake(staker, 100n * nominal);
       await waitForRelayBlock(helper.api!, 40);
@@ -709,6 +708,12 @@
     });
   });
 
+  it('can be paid 1000 rewards in a time', async () => {
+    await usingPlaygrounds(async (helper) => {
+      expect.fail('Test not implemented');
+    });
+  });
+
   it.skip('can handle 40.000 rewards', async () => {
     await usingPlaygrounds(async (helper) => {
       const [donor] = await helper.arrange.createAccounts([7_000_000n], alice);
modifiedtests/src/util/playgrounds/unique.dev.tsdiffbeforeafterboth
60 * Arrange methods for tests59 * Arrange methods for tests
61 */60 */
62 arrange: ArrangeGroup;61 arrange: ArrangeGroup;
62 wait: WaitGroup;
6363
64 constructor(logger: { log: (msg: any, level: any) => void, level: any }) {64 constructor(logger: { log: (msg: any, level: any) => void, level: any }) {
65 super(logger);65 super(logger);
66 this.arrange = new ArrangeGroup(this);66 this.arrange = new ArrangeGroup(this);
67 this.wait = new WaitGroup(this);
67 }68 }
6869
69 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {70 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {
152 for (let index = 0; index < 5; index++) {153 for (let index = 0; index < 5; index++) {
153 accountsCreated = await checkBalances();154 accountsCreated = await checkBalances();
154 if(accountsCreated) break;155 if(accountsCreated) break;
155 await this.waitNewBlocks(1);156
156 }157 }
157158
158 if (!accountsCreated) throw Error('Accounts generation failed');159 if (!accountsCreated) throw Error('Accounts generation failed');
163164
164 // TODO combine this method and createAccounts into one165 // TODO combine this method and createAccounts into one
165 createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {166 createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {
167 const createAsManyAsCan = async () => {
166 let transactions: any = [];168 let transactions: any = [];
167 const accounts: IKeyringPair[] = [];169 const accounts: IKeyringPair[] = [];
168
169 const createAsManyAsCan = async () => {
170 let nonce = await this.helper.chain.getNonce(donor.address);170 let nonce = await this.helper.chain.getNonce(donor.address);
171 const tokenNominal = this.helper.balance.getOneTokenNominal();171 const tokenNominal = this.helper.balance.getOneTokenNominal();
172 for (let i = 0; i < accountsToCreate; i++) {172 for (let i = 0; i < accountsToCreate; i++) {
193 }193 }
194 }194 }
195 return fullfilledAccounts;195 return fullfilledAccounts;
196 };196 };
197197
198 198
199 const crowd: IKeyringPair[] = [];199 const crowd: IKeyringPair[] = [];
227 if(block2date! - block1date! < 9000) return true;227 if(block2date! - block1date! < 9000) return true;
228 };228 };
229
230 /**
231 * Wait for specified bnumber of blocks
232 * @param blocksCount number of blocks to wait
233 * @returns
234 */
235 async waitNewBlocks(blocksCount = 1): Promise<void> {
236 // eslint-disable-next-line no-async-promise-executor
237 const promise = new Promise<void>(async (resolve) => {
238 const unsubscribe = await this.helper.api!.rpc.chain.subscribeNewHeads(() => {
239 if (blocksCount > 0) {
240 blocksCount--;
241 } else {
242 unsubscribe();
243 resolve();
244 }
245 });
246 });
247 return promise;
248 }
249}229}
230
231class WaitGroup {
232 helper: UniqueHelper;
233
234 constructor(helper: UniqueHelper) {
235 this.helper = helper;
236 }
237
238 /**
239 * Wait for specified bnumber of blocks
240 * @param blocksCount number of blocks to wait
241 * @returns
242 */
243 async newBlocks(blocksCount = 1): Promise<void> {
244 // eslint-disable-next-line no-async-promise-executor
245 const promise = new Promise<void>(async (resolve) => {
246 const unsubscribe = await this.helper.api!.rpc.chain.subscribeNewHeads(() => {
247 if (blocksCount > 0) {
248 blocksCount--;
249 } else {
250 unsubscribe();
251 resolve();
252 }
253 });
254 });
255 return promise;
256 }
257
258 async forParachainBlockNumber(blockNumber: bigint) {
259 return new Promise<void>(async (resolve) => {
260 const unsubscribe = await this.helper.api!.rpc.chain.subscribeNewHeads(async (data: any) => {
261 if (data.number.toNumber() >= blockNumber) {
262 unsubscribe();
263 resolve();
264 }
265 });
266 });
267 }
268
269 async forRelayBlockNumber(blockNumber: bigint) {
270 return new Promise<void>(async (resolve) => {
271 const unsubscribe = await this.helper.api!.query.parachainSystem.validationData(async (data: any) => {
272 if (data.value.relayParentNumber.toNumber() >= blockNumber) {
273 unsubscribe();
274 resolve();
275 }
276 });
277 });
278 }
279}
250280
modifiedtests/src/util/playgrounds/unique.tsdiffbeforeafterboth
--- a/tests/src/util/playgrounds/unique.ts
+++ b/tests/src/util/playgrounds/unique.ts
@@ -1980,16 +1980,16 @@
    * @param signer keyring of signer
    * @param amountToUnstake amount of tokens to unstake
    * @param label extra label for log
-   * @returns 
+   * @returns block number where balances will be unlocked
    */
-  async unstake(signer: TSigner, label?: string): Promise<boolean> {
+  async unstake(signer: TSigner, label?: string): Promise<number> {
     if(typeof label === 'undefined') label = `${signer.address}`;
     const unstakeResult = await this.helper.executeExtrinsic(
       signer, 'api.tx.appPromotion.unstake', 
       [], true,
     );
-    // TODO extract info from unstakeResult
-    return true;
+    // TODO extract block number fron events
+    return 1;
   }
 
   async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {
@@ -1997,10 +1997,6 @@
     return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();
   }
 
-  async getTotalStakingLocked(address: ICrossAccountId): Promise<bigint> {
-    return (await this.helper.callRpc('api.rpc.appPromotion.totalStakingLocked', [address])).toBigInt();
-  }
-
   async getTotalStakedPerBlock(address: ICrossAccountId): Promise<bigint[][]> {
     return (await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address])).map(([block, amount]: any[]) => [block.toBigInt(), amount.toBigInt()]);
   }
@@ -2447,4 +2443,4 @@
   async burn(signer: TSigner, amount=1n) {
     return await this.collection.burnToken(signer, this.tokenId, amount);
   }
-}
\ No newline at end of file
+}