base.ts

/*global fetch */

import Web3 from 'web3';
import RewardPoolABI from '../../contracts/abi/v0.9.0/reward-pool';
import { Contract, ContractOptions } from 'web3-eth-contract';
import { getAddress } from '../../contracts/addresses';
import { AbiItem, fromWei, toWei } from 'web3-utils';
import { signRewardSafe, signSafeTx, createEIP1271VerifyingData } from '../utils/signing-utils';
import { getSDK } from '../version-resolver';
import { getConstant, ZERO_ADDRESS } from '../constants';
import BN from 'bn.js';
import ERC20ABI from '../../contracts/abi/erc-20';
import ERC677ABI from '../../contracts/abi/erc-677';
import {
  gasEstimate,
  executeTransaction,
  getNextNonceFromEstimate,
  Operation,
  gasInToken,
  GasEstimate,
} from '../utils/safe-utils';
import { isTransactionHash, TransactionOptions, waitForTransactionConsistency } from '../utils/general-utils';
import type { SuccessfulTransactionReceipt } from '../utils/successful-transaction-receipt';
import { parseExplanationAmount, parseTemplateExplanation } from '../utils/reward-explanation-utils';
import GnosisSafeABI from '../../contracts/abi/gnosis-safe';
import { Signer } from 'ethers';
import { query } from '../utils/graphql';

/**
 * @group Cardpay
 */
export interface Proof {
  rootHash: string;
  paymentCycle: number;
  tokenAddress: string;
  payee: string;
  proofBytes: string[];
  rewardProgramId: string;
  amount: BN;
  leaf: string;
  isValid: boolean;
  explanationTemplate: string;
  explanationData: any;
  parsedExplanation?: string;
}

/**
 * @group Cardpay
 */
export interface ClaimableProof extends Proof {
  safeAddress: string;
  gasEstimate: GasEstimate;
}

/**
 * @group Cardpay
 */
export interface Leaf {
  rewardProgramId: string;
  paymentCycleNumber: number;
  validFrom: number;
  validTo: number;
  tokenType: number;
  payee: string;
  transferData: string;
}

/**
 * @group Cardpay
 */
export interface TokenTransferDetail {
  token: string;
  amount: BN;
}

/**
 * @group Cardpay
 */
export interface FullLeaf extends Partial<TokenTransferDetail>, Leaf {}

const DEFAULT_PAGE_SIZE = 1000000;

/**
 * @group Cardpay
 */
export interface RewardTokenBalance {
  rewardProgramId: string;
  tokenAddress: string;
  balance: BN;
}

/**
 * @group Cardpay
 */
export interface HasTokenAddress {
  tokenAddress: string;
}
/**
 * @group Cardpay
 */
export type WithSymbol<T extends HasTokenAddress> = T & {
  tokenSymbol: string;
};

/**
 * The `RewardPool` API is used to interact with tally (an offchain service similar to relayer) and the reward pool contract. As customers use their prepaid card they will be given rewards based the amount of spend they use and a reward-based algorithm.
 * @group Cardpay
 * @category Main
 */
export default class RewardPool {
  private rewardPool: Contract | undefined;

  constructor(private layer2Web3: Web3, private layer2Signer?: Signer) {}

  async isClaimed(leaf: string): Promise<boolean> {
    return (await this.getRewardPool()).methods.claimed(leaf).call();
  }

  async isValid(leaf: string, proofBytes: string[]): Promise<boolean> {
    return (await this.getRewardPool()).methods.valid(leaf, proofBytes).call();
  }
  // TOTAL balance of reward pool -- cumulative across reward program
  async getBalanceForPool(tokenAddress: string): Promise<string> {
    let rewardPoolAddress = await getAddress('rewardPool', this.layer2Web3);
    const tokenContract = new this.layer2Web3.eth.Contract(ERC20ABI as AbiItem[], tokenAddress);
    return await tokenContract.methods.balanceOf(rewardPoolAddress).call();
  }

  /**
   * The `GetProofs` API is used to retrieve proofs that are used to claim rewards from tally; proofs are similar arcade coupons that are collected to claim a prize. A proof can only be used by the EOA-owner. Once a proof is used (i.e. `knownClaimed=true`) it cannot be re-used. `isValid` is a flag that checks if a proof is still valid. Assuming a proof has not been claimed, `isValid=false` means that a proof can no longer be claimed -- typically, to mean that the proof has expired.
   * @example
   * ```ts
   * let rewardPool = await getSDK('RewardPool', web3);
   * await rewardPool.getProofs(address, rewardProgramId, safeAddress?, tokenAddress?, knownClaimed?)
   * ```
   */
  async getProofs(
    address: string,
    rewardProgramId: string,
    safeAddress: string,
    tokenAddress?: string,
    knownClaimed?: boolean,
    offset?: number,
    limit?: number
  ): Promise<WithSymbol<ClaimableProof>[]>;
  async getProofs(
    address: string,
    rewardProgramId: string,
    safeAddress: undefined,
    tokenAddress?: string,
    knownClaimed?: boolean,
    offset?: number,
    limit?: number
  ): Promise<WithSymbol<Proof>[]>;
  async getProofs(
    address: string,
    rewardProgramId: string,
    safeAddress?: string,
    tokenAddress?: string,
    knownClaimed?: boolean,
    offset?: number,
    limit?: number
  ): Promise<WithSymbol<Proof | ClaimableProof>[]> {
    let hubUrl = await getConstant('hubUrl', this.layer2Web3);
    let url = new URL(`${hubUrl}/api/rewards/proofs/${address}`);
    if (offset) {
      url.searchParams.append('offset', offset.toString());
    }
    url.searchParams.append('rewardProgramId', rewardProgramId);
    url.searchParams.append('limit', limit ? limit.toString() : DEFAULT_PAGE_SIZE.toString());
    let options = {
      method: 'GET',
      headers: {
        'Content-Type': 'application/vnd.api+json',
      },
    };
    let response = await fetch(url.toString(), options);
    let json = await response.json();
    if (!response?.ok) {
      throw new Error(await response.text());
    }
    let currentBlock = await this.layer2Web3.eth.getBlockNumber();
    let rewardTokens = await this.getRewardTokens();
    let res: Proof[] = [];
    let claimedLeafs: string[];
    if (!knownClaimed) {
      claimedLeafs = await this.getClaimedLeafs(address, rewardProgramId);
    }
    let rewardManager = await getSDK('RewardManager', this.layer2Web3);
    const rule = await rewardManager.getRuleJson(rewardProgramId);
    json.data.map(({ attributes: o }: any) => {
      let { validFrom, validTo, token, amount }: FullLeaf = this.decodeLeaf(o.leaf) as FullLeaf;
      const isValid = validFrom <= currentBlock && validTo > currentBlock;
      // filters for known reward tokens
      if (token && rewardTokens.includes(token)) {
        const explanationTemplate = rewardManager.getClaimExplainer(rule, o.explanationId);
        if (tokenAddress && tokenAddress == token) {
          // filters for based upon the tokenAddress if it exists
          if (knownClaimed || !claimedLeafs.includes(o.leaf)) {
            res.push({
              ...o,
              tokenAddress,
              amount: amount,
              isValid,
              explanationTemplate,
            });
          }
        } else {
          if (knownClaimed || !claimedLeafs.includes(o.leaf)) {
            res.push({
              ...o,
              tokenAddress: token,
              amount: amount,
              isValid,
              explanationTemplate,
            });
          }
        }
      }
    });

    const proofs = await this.adjustExplanationInfo(await this.addTokenSymbol(res));

    if (safeAddress) {
      // if safeAddress is provided, we need to estimate gas of each proof claim
      // when gas estimation is performed, we filter out proofs that are not valid
      const proofsWithGasFees = await Promise.all(
        proofs
          .filter((o) => o.isValid)
          .map(async (proof) => {
            const gasEstimate = await this.claimGasEstimate(safeAddress, proof.leaf, proof.proofBytes, false);
            return {
              ...proof,
              gasEstimate,
              safeAddress,
            };
          })
      );
      return proofsWithGasFees;
    } else {
      return proofs;
    }
  }

  async getUnclaimedValidProofs(
    address: string,
    rewardProgramId: string,
    tokenAddress?: string
  ): Promise<WithSymbol<Proof>[]> {
    const proofs = await this.getProofs(address, rewardProgramId, undefined, tokenAddress, false);
    return proofs.filter((o) => o.isValid);
  }

  async getUnclaimedValidProofsWithoutDust(
    address: string,
    rewardProgramId: string,
    safeAddress: string,
    tokenAddress?: string
  ): Promise<WithSymbol<ClaimableProof>[]> {
    const proofs = await this.getProofs(address, rewardProgramId, safeAddress, tokenAddress, false);
    return proofs
      .filter((o) => o.isValid)
      .filter((o) => {
        return o.gasEstimate.amount.lt(new BN(o.amount));
      });
  }

  claimsQuery(payee: string, rewardProgramId?: string, skip = 0): string {
    if (rewardProgramId) {
      return `
      query {
          rewardeeClaims(
            where:{
              rewardee: "${payee}",
              rewardProgram: "${rewardProgramId}" 
            }, 
            skip: ${skip},
            orderBy: blockNumber, 
            orderDirection: asc
          ){
            leaf
          }
      }
    `;
    } else {
      return `
      query {
          rewardeeClaims(
            where:{
              rewardee: "${payee}"
            },
            skip: ${skip}
            orderBy: blockNumber, 
            orderDirection: asc
          ){
            leaf
          }
      }
    `;
    }
  }

  async getClaimedLeafs(payee: string, rewardProgramId?: string): Promise<string[]> {
    //PLEASE DO NOT CHANGE THIS.
    //Subgraph has a max pagination of 100
    let paginateSize = 100;
    let i = 0;
    let done = false;
    let leafs: string[] = [];
    while (!done) {
      let queryStr = this.claimsQuery(payee, rewardProgramId, i * paginateSize);
      let res = await query(this.layer2Web3, queryStr);
      if (res.data.rewardeeClaims.length != 0) {
        let {
          data: { rewardeeClaims },
        } = res;
        let new_leafs = rewardeeClaims.reduce((accum: string[], o: any) => {
          return [...accum, o.leaf];
        }, []);
        leafs = leafs.concat(new_leafs);
        i++;
      } else {
        done = true;
      }
    }
    return leafs;
  }

  /**
   * @returns the balance of ALL tokens in the RewardPool for prepaid card owners address.
   * This function takes in a parameter of the prepaid card owner address and , reward token address, and reward program id. This balance also accounts for the claims of a prepaid card owner in the past. The tokens that are part of the rewards are CARDPXD and DAICPXD -- federated tokens of the card protocol.
   * The `RewardPool` API is used to interact with tally (an offchain service similar to relayer) and the reward pool contract. As customers use their prepaid card they will be given rewards based the amount of spend they use and a reward-based algorithm.
   * @example
   * ```ts
   * let rewardPool = await getSDK('RewardPool', web3);
   * let balanceForAllTokens = await rewardPool.rewardTokenBalances(address, rewardProgramId)
   *
   * ```
   */
  async rewardTokenBalances(address: string, rewardProgramId: string): Promise<WithSymbol<RewardTokenBalance>[]> {
    const unclaimedValidProofs = await this.getUnclaimedValidProofs(address, rewardProgramId);
    const tokenBalances = unclaimedValidProofs.map((o: Proof) => {
      return {
        tokenAddress: o.tokenAddress,
        rewardProgramId: o.rewardProgramId,
        balance: new BN(o.amount),
      };
    });
    return this.addTokenSymbol(aggregateBalance(tokenBalances));
  }

  /**
   * This call is exactly the same as `RewardPool.rewardTokenBalances` except it excludes `rewardAmount < gasFees` (crypto dust).
   * @example
   * ```ts
   * let rewardPool = await getSDK('RewardPool', web3);
   * let balanceForAllTokens = await rewardPool.rewardTokenBalancesWithoutDust(address, rewardProgramId, rewardSafe)
   * ```
   */
  async rewardTokenBalancesWithoutDust(
    address: string,
    rewardProgramId: string,
    safeAddress: string
  ): Promise<WithSymbol<RewardTokenBalance>[]> {
    const unclaimedValidProofs = await this.getUnclaimedValidProofsWithoutDust(address, rewardProgramId, safeAddress);
    const tokenBalances = unclaimedValidProofs.map((o: ClaimableProof) => {
      return {
        tokenAddress: o.tokenAddress,
        rewardProgramId: o.rewardProgramId,
        balance: new BN(o.amount),
      };
    });
    return this.addTokenSymbol(aggregateBalance(tokenBalances));
  }

  /**
   * The `AddRewardTokens` API is used to refill the reward pool for a particular reward program with any single owner safe. Currently, the sdk supports using single-owner safe like depot safe or merchant safe to send funds (the protocol supports prepaid card payments too). If a reward program doesn't have any funds inside of the pool rewardees will be unable to claim. Anyone can call this function not only the rewardProgramAdmin.
   * @example
   * ```ts
   * let rewardPool = await getSDK('RewardPool', web3);
   * await rewardPool.addRewardTokens(safe, rewardProgramId, tokenAddress, amount)
   * ```
   */
  async addRewardTokens(txnHash: string): Promise<SuccessfulTransactionReceipt>;
  async addRewardTokens(
    safeAddress: string,
    rewardProgramId: string,
    tokenAddress: string,
    amount: string,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt>;
  async addRewardTokens(
    safeAddressOrTxnHash: string,
    rewardProgramId?: string,
    tokenAddress?: string,
    amount?: string,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt> {
    if (isTransactionHash(safeAddressOrTxnHash)) {
      let txnHash = safeAddressOrTxnHash;
      return await waitForTransactionConsistency(this.layer2Web3, txnHash);
    }
    let safeAddress = safeAddressOrTxnHash;
    if (!rewardProgramId) {
      throw new Error('rewardProgramId must be provided');
    }
    if (!tokenAddress) {
      throw new Error('tokenAddress must be provided');
    }
    if (!amount) {
      throw new Error('amount must be provided');
    }

    let rewardManager = await getSDK('RewardManager', this.layer2Web3);

    if (!(await rewardManager.isRewardProgram(rewardProgramId))) {
      throw new Error('reward program does not exist');
    }

    let from = contractOptions?.from ?? (await this.layer2Web3.eth.getAccounts())[0];
    let token = new this.layer2Web3.eth.Contract(ERC677ABI as AbiItem[], tokenAddress);
    let symbol = await token.methods.symbol().call();
    let balance = new BN(await token.methods.balanceOf(safeAddress).call());
    let weiAmount = new BN(toWei(amount));
    if (balance.lt(weiAmount)) {
      throw new Error(
        `Safe does not have enough balance add reward tokens. The reward token ${tokenAddress} balance of the safe ${safeAddress} is ${fromWei(
          balance
        )}, the total amount necessary to add reward tokens is ${fromWei(weiAmount)} ${symbol} + a small amount for gas`
      );
    }
    let payload = await this.getAddRewardTokensPayload(rewardProgramId, tokenAddress, weiAmount);
    let estimate = await gasEstimate(
      this.layer2Web3,
      safeAddress,
      tokenAddress,
      '0',
      payload,
      Operation.CALL,
      tokenAddress
    );
    let { nonce, onNonce, onTxnHash } = txnOptions ?? {};

    if (nonce == null) {
      nonce = getNextNonceFromEstimate(estimate);
      if (typeof onNonce === 'function') {
        onNonce(nonce);
      }
    }
    let gnosisTxn = await executeTransaction(
      this.layer2Web3,
      safeAddress,
      tokenAddress,
      payload,
      Operation.CALL,
      estimate,
      nonce,
      await signSafeTx(
        this.layer2Web3,
        safeAddress,
        tokenAddress,
        payload,
        Operation.CALL,
        estimate,
        nonce,
        from,
        this.layer2Signer
      )
    );
    if (typeof onTxnHash === 'function') {
      await onTxnHash(gnosisTxn.ethereumTx.txHash);
    }
    return await waitForTransactionConsistency(this.layer2Web3, gnosisTxn.ethereumTx.txHash, safeAddress, nonce);
  }

  /**
   *
   * The `Claim` API is used by the rewardee to claim rewards from an associated reward program.
   * Pre-requisite for this action:
   * - reward program has to be registered
   * - rewardee has to register and create safe for that particular reward program. The funds will be claimed into this safe -- reward safe
   * - rewardee must get an existing proof and leaf from tally api  -- look at `rewardPool.getProofs`
   * - reward pool has to be filled with reward token for that reward program
   *
   * @example
   * ```ts
   * let rewardPool = await getSDK('RewardPool', web3);
   * await rewardPool.claim(safe, leaf, proofArray, acceptPartialClaim)
   *
   * ```
   * The leaf item contains most information about the claim, such as the reward program (`rewardProgramId`), the expiry of the proof (`validFrom`, `validTo`), the type of token of the reward (`tokenType`, `transferData`), the eoa owner of the safe (`payee`). This information can be decoded easily.
   * `acceptPartialClaim` is a special scenario whereby a rewardee is willing to compromise his full reward compensation for a partial one. This scneario occurs, for example, when rewardee has 10 card in his proof but the reward pool only has 5 card, the rewardee may opt to just accepting that 5 card by setting `acceptPartialClaim=true`.
   */
  async claim(txnHash: string): Promise<SuccessfulTransactionReceipt>;
  async claim(
    safeAddress: string,
    leaf: string,
    proofBytes: string[],
    acceptPartialClaim: boolean,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt>;
  async claim(
    safeAddressOrTxnHash: string,
    leaf?: string,
    proofBytes?: string[],
    acceptPartialClaim?: boolean,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt> {
    if (isTransactionHash(safeAddressOrTxnHash)) {
      let txnHash = safeAddressOrTxnHash;
      return await waitForTransactionConsistency(this.layer2Web3, txnHash);
    }
    let safeAddress = safeAddressOrTxnHash;
    if (!proofBytes) {
      //proofBytes can be empty e.g reward only for single rewardee
      throw new Error('proof must be provided');
    }
    if (!leaf) {
      throw new Error('leaf must be provided');
    }

    let { rewardProgramId, payee, token, amount }: FullLeaf = this.decodeLeaf(leaf) as FullLeaf;

    if (!rewardProgramId) {
      throw new Error('rewardProgramId must be provided');
    }
    if (!token) {
      throw new Error('token must be provided');
    }
    if (!amount) {
      throw new Error('amount must be provided');
    }

    let rewardManager = await getSDK('RewardManager', this.layer2Web3);

    if (!(await rewardManager.isRewardProgram(rewardProgramId))) {
      throw new Error('reward program does not exist');
    }
    if (!(await rewardManager.isValidRewardSafe(safeAddress, rewardProgramId))) {
      throw new Error('reward safe is not valid');
    }
    let rewardSafeOwner = await rewardManager.getRewardSafeOwner(safeAddress);

    if (rewardSafeOwner != payee) {
      throw new Error('payee is not owner of the reward safe');
    }

    if (!(await this.isValid(leaf, proofBytes))) {
      throw new Error('proof is not valid');
    }
    if (await this.isClaimed(leaf)) {
      throw new Error('reward has been claimed');
    }
    let from = contractOptions?.from ?? (await this.layer2Web3.eth.getAccounts())[0];
    let weiAmount = new BN(amount);
    let rewardPoolBalanceForRewardProgram = (await this.rewardProgramBalance(rewardProgramId, token)).balance;
    if (weiAmount.gt(rewardPoolBalanceForRewardProgram)) {
      if (acceptPartialClaim) {
        // acceptPartialClaim means: if reward pool balance is less than amount,
        // rewardee is willing sacrifice full reward and accept the entire reward pool balance
        weiAmount = rewardPoolBalanceForRewardProgram;
      } else {
        throw new Error(
          `Insufficient funds inside reward pool for reward program.
The reward program ${rewardProgramId} has balance equals ${fromWei(
            rewardPoolBalanceForRewardProgram.toString()
          )} but user is asking for ${amount}`
        );
      }
    }

    if (!(rewardSafeOwner == from)) {
      throw new Error(
        `Reward safe owner is NOT the signer of transaction.
    The owner of reward safe ${safeAddress} is ${rewardSafeOwner}, but the signer is ${from}`
      );
    }
    let rewardPoolAddress = await getAddress('rewardPool', this.layer2Web3);

    let payload = (await this.getRewardPool()).methods.claim(leaf, proofBytes, acceptPartialClaim).encodeABI();
    let estimate = await gasEstimate(
      this.layer2Web3,
      safeAddress,
      rewardPoolAddress,
      '0',
      payload,
      Operation.CALL,
      token
    );

    let gasCost = new BN(estimate.safeTxGas).add(new BN(estimate.baseGas)).mul(new BN(estimate.gasPrice));
    if (weiAmount.lt(gasCost)) {
      throw new Error(
        `Rewards claimed does not have enough to cover the gas cost. The amount to be claimed is ${fromWei(
          weiAmount
        )}, the gas cost is ${fromWei(gasCost)}`
      );
    }
    let { nonce, onNonce, onTxnHash } = txnOptions ?? {};

    if (nonce == null) {
      nonce = getNextNonceFromEstimate(estimate);
      if (typeof onNonce === 'function') {
        onNonce(nonce);
      }
    }
    let fullSignature = await signRewardSafe(
      this.layer2Web3,
      rewardPoolAddress,
      0,
      payload,
      Operation.CALL,
      estimate,
      token,
      ZERO_ADDRESS,
      nonce,
      rewardSafeOwner,
      safeAddress,
      await getAddress('rewardManager', this.layer2Web3),
      this.layer2Signer
    );

    let eip1271Data = createEIP1271VerifyingData(
      this.layer2Web3,
      rewardPoolAddress,
      '0',
      payload,
      Operation.CALL.toString(),
      estimate.safeTxGas,
      estimate.baseGas,
      estimate.gasPrice,
      token,
      ZERO_ADDRESS,
      nonce.toString()
    );
    let gnosisTxn = await executeTransaction(
      this.layer2Web3,
      safeAddress,
      rewardPoolAddress,
      payload,
      Operation.CALL,
      estimate,
      nonce,
      fullSignature,
      eip1271Data
    );
    if (typeof onTxnHash === 'function') {
      await onTxnHash(gnosisTxn.ethereumTx.txHash);
    }
    return await waitForTransactionConsistency(this.layer2Web3, gnosisTxn.ethereumTx.txHash, safeAddress, nonce);
  }

  /**
   *
   * The `claimAll` is used by the rewardee to claim all rewards from a list of proofs. The looping occurs as separate transactions so the failure of one transaction will lead to the failure of all transactions after it (transactions before it will stil succeed). Proofs which have claims `rewardAmount < gasFees` (crypto dust) will be excluded; this filter is to decrease the probability of `claimAll` failing.
   *
   * @example
   * ```ts
   * let rewardManagerAPI = await getSDK('RewardManager', web3);
   * await rewardManagerAPI.claimAll(rewardSafe, rewardProgramId, tokenAddress?)
   * ```
   */
  async claimAll(
    safeAddress: string,
    rewardProgramId: string,
    tokenAddress?: string,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt[]> {
    let rewardManager = await getSDK('RewardManager', this.layer2Web3);
    let rewardSafeOwner = await rewardManager.getRewardSafeOwner(safeAddress);
    const unclaimedValidProofsWithoutDust = await this.getUnclaimedValidProofsWithoutDust(
      rewardSafeOwner,
      rewardProgramId,
      safeAddress,
      tokenAddress
    );
    console.log(`Claiming ${unclaimedValidProofsWithoutDust.length} proofs`);
    return this.claimProofs(unclaimedValidProofsWithoutDust, safeAddress, txnOptions, contractOptions);
  }

  async claimProofs(
    proofs: WithSymbol<Proof>[],
    safeAddress: string,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt[]> {
    const validProofs = proofs.filter((o) => o.isValid);
    const receipts: SuccessfulTransactionReceipt[] = [];
    for (const { leaf, proofBytes } of validProofs) {
      const receipt = await this.claim(safeAddress, leaf, proofBytes, false, txnOptions, contractOptions);
      receipts.push(receipt);
    }
    return receipts;
  }

  async sufficientBalanceInPool(
    rewardProgramId: string,
    amount: BN,
    token: string,
    acceptPartialClaim?: boolean
  ): Promise<any> {
    let weiAmount = new BN(amount);
    let rewardPoolBalanceForRewardProgram = (await this.rewardProgramBalance(rewardProgramId, token)).balance;
    if (weiAmount.gt(rewardPoolBalanceForRewardProgram)) {
      if (acceptPartialClaim) {
        // acceptPartialClaim means: if reward pool balance is less than amount,
        // rewardee is willing sacrifice full reward and accept the entire reward pool balance
        weiAmount = rewardPoolBalanceForRewardProgram;
        return true;
      } else {
        return false;
      }
    }
    return true;
  }

  /**
   *
   * The `claimGasEstimate` returns a gas estimate a claim of a reward. The gas is paid out in tokens of the reward received. For example, if a person recieves 10 CARD, they will receive `10 CARD - (gas fees in CARD)` into their reward safe.
   * @example
   * ```ts
   * let rewardManagerAPI = await getSDK('RewardManager', web3);
   * await rewardManagerAPI.claimGasEstimate(rewardSafeAddress, leaf, proofArray, acceptPartialClaim)
   * ```
   */
  async claimGasEstimate(
    rewardSafeAddress: string,
    leaf: string,
    proofBytes: string[],
    acceptPartialClaim?: boolean
  ): Promise<GasEstimate> {
    let payload = (await this.getRewardPool()).methods.claim(leaf, proofBytes, acceptPartialClaim).encodeABI();
    let o: FullLeaf = this.decodeLeaf(leaf) as FullLeaf;
    if (!o.token) {
      throw new Error('token must be provided');
    }
    let rewardPoolAddress = await getAddress('rewardPool', this.layer2Web3);
    let estimate = await gasEstimate(
      this.layer2Web3,
      rewardSafeAddress,
      rewardPoolAddress,
      '0',
      payload,
      Operation.CALL,
      o.token
    );
    return {
      gasToken: estimate.gasToken,
      amount: gasInToken(estimate),
    };
  }

  async claimAllGasEstimate(
    rewardSafeAddress: string,
    rewardProgramId: string,
    tokenAddress: string
  ): Promise<GasEstimate> {
    let rewardManager = await getSDK('RewardManager', this.layer2Web3);
    let rewardSafeOwner = await rewardManager.getRewardSafeOwner(rewardSafeAddress);

    const unclaimedValidProofsWithoutDust = await this.getUnclaimedValidProofsWithoutDust(
      rewardSafeOwner,
      rewardProgramId,
      rewardSafeAddress,
      tokenAddress
    );
    const amount = unclaimedValidProofsWithoutDust.reduce((accum, proof) => {
      return accum.add(new BN(proof.gasEstimate.amount));
    }, new BN(0));
    return {
      gasToken: tokenAddress,
      amount,
    };
  }
  /**
   *
   * The `RecoverTokens` API is used by the rewardProgramAdmin to recover the tokens that are previously added inside the pool. This function can be called at anytime throughout the lifecycle of the reward program. The funds recovered will be used to pay for the gas fees to execute the transaction.
   * @example
   * ```ts
   * let rewardPool = await getSDK('RewardPool', web3);
   * await rewardPool.recoverTokens(safe, rewardProgramId, tokenAddress, amount?)
   * ```
   */
  async recoverTokens(txnHash: string): Promise<SuccessfulTransactionReceipt>;
  async recoverTokens(
    safeAddress: string,
    rewardProgramId: string,
    tokenAddress: string,
    amount?: string,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt>;
  async recoverTokens(
    safeAddressOrTxnHash: string,
    rewardProgramId?: string,
    tokenAddress?: string,
    amount?: string,
    txnOptions?: TransactionOptions,
    contractOptions?: ContractOptions
  ): Promise<SuccessfulTransactionReceipt> {
    if (isTransactionHash(safeAddressOrTxnHash)) {
      let txnHash = safeAddressOrTxnHash;
      return waitForTransactionConsistency(this.layer2Web3, txnHash);
    }
    let safeAddress = safeAddressOrTxnHash;

    if (!rewardProgramId) {
      throw new Error('rewardProgramId is required');
    }
    if (!tokenAddress) {
      throw new Error('tokenAddress is required');
    }
    let { nonce, onNonce, onTxnHash } = txnOptions ?? {};
    let from = contractOptions?.from ?? (await this.layer2Web3.eth.getAccounts())[0];

    let rewardPoolAddress = await getAddress('rewardPool', this.layer2Web3);
    let rewardPoolBalanceForRewardProgram = (await this.rewardProgramBalance(rewardProgramId, tokenAddress)).balance;

    let rewardManager = await getSDK('RewardManager', this.layer2Web3);

    if (!(await rewardManager.isRewardProgram(rewardProgramId))) {
      throw new Error('reward program does not exist');
    }

    if (!((await rewardManager.getRewardProgramAdmin(rewardProgramId)) == from)) {
      throw new Error('signer is not reward program admin');
    }

    let safe = new this.layer2Web3.eth.Contract(GnosisSafeABI as AbiItem[], safeAddress);
    const safeOwner = (await safe.methods.getOwners().call())[0];

    if (!(safeOwner == from)) {
      throw new Error('signer is not safe owner');
    }
    let weiAmount = amount ? new BN(toWei(amount)) : rewardPoolBalanceForRewardProgram;

    if (rewardPoolBalanceForRewardProgram.lt(weiAmount)) {
      throw new Error(
        `Insufficient funds inside reward pool for reward program. The amount to be claimed is ${amount},
but the balance is the reward pool is ${fromWei(rewardPoolBalanceForRewardProgram).toString()}`
      );
    }
    let payload = (await this.getRewardPool()).methods
      .recoverTokens(rewardProgramId, tokenAddress, weiAmount)
      .encodeABI();
    let estimate = await gasEstimate(
      this.layer2Web3,
      safeAddress,
      rewardPoolAddress,
      '0',
      payload,
      Operation.CALL,
      tokenAddress
    );
    let gasCost = new BN(estimate.safeTxGas).add(new BN(estimate.baseGas)).mul(new BN(estimate.gasPrice));
    if (weiAmount.lt(gasCost)) {
      throw new Error(
        `Funds recovered does not have enough to cover the gas cost. The amount to be recovered is ${amount}, the gas cost is ${fromWei(
          gasCost
        )}`
      );
    }
    if (nonce == null) {
      nonce = getNextNonceFromEstimate(estimate);
      if (typeof onNonce === 'function') {
        onNonce(nonce);
      }
    }
    let gnosisResult = await executeTransaction(
      this.layer2Web3,
      safeAddress,
      rewardPoolAddress,
      payload,
      Operation.CALL,
      estimate,
      nonce,
      await signSafeTx(
        this.layer2Web3,
        safeAddress,
        rewardPoolAddress,
        payload,
        Operation.CALL,
        estimate,
        nonce,
        from,
        this.layer2Signer
      )
    );

    let txnHash = gnosisResult.ethereumTx.txHash;
    if (typeof onTxnHash === 'function') {
      await onTxnHash(txnHash);
    }
    return await waitForTransactionConsistency(this.layer2Web3, txnHash, safeAddress, nonce);
  }

  /**
   *
   * The `rewardProgramBalances` API is used to query the token balances inside the reward pool for a particular reward program. This is useful if a rewardProgramAdmin wants to assess how much is left inside the pool for the reward program they manage.
   * @example
   * ```ts
   * let rewardPool = await getSDK('RewardPool', web3);
   * await rewardPool.rewardProgramBalances(rewardProgramId)
   * ```
   */
  async rewardProgramBalances(rewardProgramId: string): Promise<WithSymbol<RewardTokenBalance>[]> {
    const tokensAvailable = await this.getRewardTokens();
    let promises = tokensAvailable.map((tokenAddress) => {
      return this.rewardProgramBalance(rewardProgramId, tokenAddress);
    });
    let rewardTokenBalance = await Promise.all(promises);
    return this.addTokenSymbol(rewardTokenBalance);
  }

  async rewardProgramBalance(rewardProgramId: string, tokenAddress: string): Promise<RewardTokenBalance> {
    let balance: string = await (await this.getRewardPool()).methods
      .rewardBalance(rewardProgramId, tokenAddress)
      .call();
    return {
      rewardProgramId,
      tokenAddress,
      balance: new BN(balance),
    };
  }

  async address(): Promise<string> {
    return await getAddress('rewardPool', this.layer2Web3);
  }

  async addTokenSymbol<T extends HasTokenAddress>(arrWithTokenAddress: T[]): Promise<WithSymbol<T>[]> {
    const tokenAddresses = [...new Set(arrWithTokenAddress.map((item) => item.tokenAddress))];
    const tokenMapping = await this.tokenSymbolMapping(tokenAddresses);
    return arrWithTokenAddress.map((o) => {
      return {
        ...o,
        tokenSymbol: tokenMapping[o.tokenAddress],
      };
    });
  }

  async tokenSymbolMapping(tokenAddresses: string[]): Promise<any> {
    let assets = await getSDK('Assets', this.layer2Web3);
    let rewardTokens = await this.getRewardTokens();
    let entries = await Promise.all(
      tokenAddresses.map(async (tokenAddress) => {
        if (!rewardTokens.includes(tokenAddress)) {
          throw new Error(`Reward token ${tokenAddress} not recognized by sdk`);
        }
        return [tokenAddress, (await assets.getTokenInfo(tokenAddress)).symbol];
      })
    );
    return Object.fromEntries(entries);
  }

  decodeLeaf(leaf: string): FullLeaf {
    let outerObj = this.layer2Web3.eth.abi.decodeParameters(
      [
        { type: 'address', name: 'rewardProgramId' },
        { type: 'uint256', name: 'paymentCycleNumber' },
        { type: 'uint256', name: 'validFrom' },
        { type: 'uint256', name: 'validTo' },
        { type: 'uint256', name: 'tokenType' },
        { type: 'address', name: 'payee' },
        { type: 'bytes', name: 'transferData' },
      ],
      leaf
    ) as Leaf;
    let transferDataObj = this.decodeTransferData(outerObj.tokenType, outerObj.transferData);
    if (this.hasTokenTransferDetail(transferDataObj)) {
      return { ...outerObj, ...transferDataObj };
    } else {
      return outerObj;
    }
  }

  isClaimableProof(proof: WithSymbol<Proof> | WithSymbol<ClaimableProof>): proof is WithSymbol<ClaimableProof> {
    if ((proof as WithSymbol<ClaimableProof>).gasEstimate) {
      return true;
    } else {
      return false;
    }
  }

  private hasTokenTransferDetail(o: any): o is TokenTransferDetail {
    return 'token' in o && 'amount' in o;
  }

  private decodeTransferData(tokenType: number, transferData: string): TokenTransferDetail | string {
    if (tokenType == 0) {
      // Default data
      return transferData;
    } else if (
      // ERC677 / ERC20
      tokenType == 1 ||
      // ERC721 (NFT)
      tokenType == 2
    ) {
      return this.layer2Web3.eth.abi.decodeParameters(
        [
          { type: 'address', name: 'token' },
          { type: 'uint256', name: 'amount' },
        ],
        transferData
      ) as TokenTransferDetail;
    } else {
      throw new Error('Unknown tokenType');
    }
  }

  private async getAddRewardTokensPayload(rewardProgramId: string, tokenAddress: string, amount: BN): Promise<string> {
    let token = new this.layer2Web3.eth.Contract(ERC677ABI as AbiItem[], tokenAddress);
    let rewardPoolAddress = await getAddress('rewardPool', this.layer2Web3);
    let data = this.layer2Web3.eth.abi.encodeParameters(['address'], [rewardProgramId]);
    return token.methods.transferAndCall(rewardPoolAddress, amount, data).encodeABI();
  }

  private async getRewardPool(): Promise<Contract> {
    if (this.rewardPool) {
      return this.rewardPool;
    }
    this.rewardPool = new this.layer2Web3.eth.Contract(
      RewardPoolABI as AbiItem[],
      await getAddress('rewardPool', this.layer2Web3)
    );
    return this.rewardPool;
  }
  private async getRewardTokens(): Promise<string[]> {
    let cardTokenAddress = await getAddress('cardCpxd', this.layer2Web3);
    return [cardTokenAddress];
  }

  private async adjustExplanationInfo(proofs: WithSymbol<Proof>[]): Promise<WithSymbol<Proof>[]> {
    return Promise.all(
      proofs.map(async (proof) => {
        // explanationData and token address are needed for getting token info
        if (!proof.explanationData?.token) return proof;

        const assets = await getSDK('Assets', this.layer2Web3);
        const { symbol, decimals } = await assets.getTokenInfo(proof.explanationData?.token || '');

        // to keep proof.explanationData unchanged
        const adjustedData = { ...proof.explanationData };

        if (symbol) {
          adjustedData.token = symbol;
        }

        if (adjustedData?.amount) {
          adjustedData.amount = parseExplanationAmount(adjustedData.amount, decimals);
        }

        if (adjustedData?.rollover_amount) {
          adjustedData.rollover_amount = parseExplanationAmount(adjustedData.rollover_amount, decimals);
        }

        if (adjustedData && proof.explanationTemplate) {
          proof.parsedExplanation = parseTemplateExplanation(proof.explanationTemplate, adjustedData);
        }

        return proof;
      })
    );
  }
}

const aggregateBalance = (arr: RewardTokenBalance[]): RewardTokenBalance[] => {
  let output: RewardTokenBalance[] = [];
  arr.forEach(function (item) {
    let existing = output.filter(function (v) {
      return v.rewardProgramId == item.rewardProgramId && v.tokenAddress == item.tokenAddress;
    });
    if (existing.length) {
      var existingIndex = output.indexOf(existing[0]);
      output[existingIndex].balance = output[existingIndex].balance.add(item.balance);
    } else {
      output.push(item);
    }
  });
  return output;
};