feat: updated rewards controller

Author: grothem

packages/contract-helpers/src/umbrella/RewardsDistributor.test.ts

@@ -9,13 +9,37 @@ import { RewardsDistributorService } from './';
 
 describe('Umbrella Rewards distributor', () => {
   const { address: STAKE_TOKEN } = makePair('STAKE_TOKEN');
+  const { address: STAKE_TOKEN_2 } = makePair('STAKE_TOKEN_2');
   const { address: ALICE } = makePair('ALICE');
 
   const REWARD_1 = makePair('REWARD_1').address;
   const REWARD_2 = makePair('REWARD_2').address;
 
   const stakeTokenService = new RewardsDistributorService(STAKE_TOKEN);
   const stakeTokenInterface = IRewardsDistributor__factory.createInterface();
+  describe('claimAllAvailableRewards', () => {
+    it('should properly create the transaction', () => {
+      const tx = stakeTokenService.claimAllAvailableRewards({
+        stakeTokens: [STAKE_TOKEN, STAKE_TOKEN_2],
+        sender: ALICE,
+      });
+      expect(tx.from).toEqual(ALICE);
+      expect(tx.to).toEqual(STAKE_TOKEN);
+      expectToBeDefined(tx.gasLimit);
+      expectToBeDefined(tx.data);
+      expect(tx.gasLimit.toString()).toEqual(
+        gasLimitRecommendations[ProtocolAction.umbrellaClaimAllRewards]
+          .recommended,
+      );
+      const decoded = stakeTokenInterface.decodeFunctionData(
+        'claimAllRewards(address[],address)',
+        tx.data,
+      );
+      expect(decoded).toHaveLength(2);
+      expect(decoded[0]).toEqual([STAKE_TOKEN, STAKE_TOKEN_2]);
+      expect(decoded[1]).toEqual(ALICE);
+    });
+  });
   describe('claimAllRewards', () => {
     it('should properly create the transaction', () => {
       const tx = stakeTokenService.claimAllRewards({
@@ -31,7 +55,7 @@ describe('Umbrella Rewards distributor', () => {
           .recommended,
       );
       const decoded = stakeTokenInterface.decodeFunctionData(
-        'claimAllRewards',
+        'claimAllRewards(address,address)',
         tx.data,
       );
       expect(decoded).toHaveLength(2);
@@ -56,7 +80,7 @@ describe('Umbrella Rewards distributor', () => {
           .recommended,
       );
       const decoded = stakeTokenInterface.decodeFunctionData(
-        'claimSelectedRewards',
+        'claimSelectedRewards(address,address[],address)',
         tx.data,
       );
       expect(decoded).toHaveLength(3);

packages/contract-helpers/src/umbrella/RewardsDistributor.ts

@@ -4,6 +4,11 @@ import { gasLimitRecommendations } from '../commons/utils';
 import { IRewardsDistributorInterface } from './typechain/IRewardsDistributor';
 import { IRewardsDistributor__factory } from './typechain/IRewardsDistributor__factory';
 
+interface RewardsDistributorClaimAllAvailableRewardsParams {
+  stakeTokens: string[];
+  sender: string;
+}
+
 interface RewardsDistributorClaimAllRewardsParams {
   stakeToken: string;
   sender: string;
@@ -22,16 +27,37 @@ export class RewardsDistributorService {
     this.interface = IRewardsDistributor__factory.createInterface();
   }
 
+  // Claim all rewards across all stake tokens
+  claimAllAvailableRewards({
+    stakeTokens,
+    sender,
+  }: RewardsDistributorClaimAllAvailableRewardsParams) {
+    const tx: PopulatedTransaction = {};
+    const receiver = sender;
+    tx.data = this.interface.encodeFunctionData(
+      'claimAllRewards(address[],address)',
+      [stakeTokens, receiver],
+    );
+    tx.from = sender;
+    tx.to = this.rewardsDistributorAddress;
+    tx.gasLimit = BigNumber.from(
+      gasLimitRecommendations[ProtocolAction.umbrellaClaimAllRewards]
+        .recommended,
+    );
+    return tx;
+  }
+
+  // Claim all rewards for a specific stake token
   claimAllRewards({
     stakeToken,
     sender,
   }: RewardsDistributorClaimAllRewardsParams) {
     const tx: PopulatedTransaction = {};
     const receiver = sender;
-    const txData = this.interface.encodeFunctionData('claimAllRewards', [
-      stakeToken,
-      receiver,
-    ]);
+    const txData = this.interface.encodeFunctionData(
+      'claimAllRewards(address,address)',
+      [stakeToken, receiver],
+    );
     tx.data = txData;
     tx.from = sender;
     tx.to = this.rewardsDistributorAddress;
@@ -49,11 +75,10 @@ export class RewardsDistributorService {
   }: RewardsDistributorClaimSelectedRewardsParams) {
     const tx: PopulatedTransaction = {};
     const receiver = sender;
-    const txData = this.interface.encodeFunctionData('claimSelectedRewards', [
-      stakeToken,
-      rewards,
-      receiver,
-    ]);
+    const txData = this.interface.encodeFunctionData(
+      'claimSelectedRewards(address,address[],address)',
+      [stakeToken, rewards, receiver],
+    );
     tx.data = txData;
     tx.from = sender;
     tx.to = this.rewardsDistributorAddress;