@aurigami/sdk 1.7.6 → 1.7.7-dummy

package/dist/types/index.d.ts

@@ -105,3 +105,26 @@ export declare type AccountAuTokensInfo = {
 export declare type AuTokenWithUnderlying = AuToken & {
     underlying: string;
 };
+export declare type ReferralReward = {
+    campaign: string;
+    /**
+     * start timetamp of the referral round
+     */
+    startTime: number;
+    /**
+     * end timetamp of the referral round
+     */
+    endTime: number;
+    /**
+     * referrer's rewards
+     */
+    isReferrer: boolean;
+    /**
+     * reward amount
+     */
+    rewardTokenAmount: TokenAmount;
+    /**
+     * hash of the transaction on aurorascan (if no, return null)
+     */
+    transactionHash: string | null;
+};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.7.6",
+  "version": "1.7.7-dummy",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -70,4 +70,4 @@
   "jest": {
     "testURL": "https://app.aurigami.finance"
   }
-}
+}

package/src/consts/dummy.ts

@@ -1,7 +1,8 @@
 import { Token, TokenAmount } from '../entities';
-import { UserMarketDetails } from '../types';
+import { ReferralReward, UserMarketDetails } from '../types';
+import { networkAddresses } from './constants';
 
-export const dummyToken = new Token('0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e', 6);
+export const dummyToken = new Token(networkAddresses.tokens.WNEAR, 24);
 
 export const dummyPly = new Token('0x8729438eb15e2c8b576fcc6aecda6a148776c0f5', 18);
 
@@ -26,3 +27,21 @@ export const dummyUserMarketDetails: UserMarketDetails = {
   collateralRatio: 0.5,
   underlyingPrice: '1',
 };
+
+export const referralRewardDummy1: ReferralReward = {
+  campaign: 'testa',
+  startTime: 1652882400, // May 18, 2022 2:00:00 PM
+  endTime: 1653573599, // May 26, 2022 1:59:59 PM
+  isReferrer: false,
+  rewardTokenAmount: dummyTokenAmount,
+  transactionHash: null,
+};
+
+export const referralRewardDummy2: ReferralReward = {
+  campaign: 'testb',
+  startTime: 1652882400, // May 18, 2022 2:00:00 PM
+  endTime: 1653573599, // May 26, 2022 1:59:59 PM
+  isReferrer: true,
+  rewardTokenAmount: dummyTokenAmount2,
+  transactionHash: '0x4da9657663b46ef18d150b897b28c7b717f16421978b52e3a06d91b54ca3548b',
+};

package/src/contracts/Airdrop.ts

@@ -1,23 +1,15 @@
-import { AuriAirdrop } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { BigNumber as BN, Contract, utils } from 'ethers';
-import { AuriAirdropABI } from '../abis';
-import * as consts from '../consts';
-import { BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
+import { BigNumber as BN, utils } from 'ethers';
+import { AuriEnv, BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
 import * as helpers from '../helpers';
 import { Address, NetworkConnection } from '../types';
 
 export class AirdropRead extends BlockchainEntityRead {
-  public readonly airDrop: AuriAirdrop;
+  public readonly env: AuriEnv;
 
   public constructor(networkConnection: NetworkConnection) {
     super(networkConnection);
-
-    this.airDrop = new Contract(
-      consts.networkAddresses.misc.AURI_AIRDROP,
-      AuriAirdropABI.abi,
-      networkConnection.provider
-    ) as AuriAirdrop;
+    this.env = new AuriEnv(networkConnection);
   }
 
   /**
@@ -30,7 +22,7 @@ export class AirdropRead extends BlockchainEntityRead {
   ): Promise<TokenAmount> {
     let tokenInstance: Token = new Token(token, helpers.getDecimal(token));
 
-    let rewards: BN = await this.airDrop.getRedeemableReward(
+    let rewards: BN = await this.env.auriAirdrop.getRedeemableReward(
       utils.formatBytes32String(campaign),
       token,
       user
@@ -52,7 +44,7 @@ export class AirdropReadWrite extends AirdropRead {
       campaigns.length == tokens.length,
       'campaigns and tokens must have the same length'
     );
-    return this.airDrop.connect(this._networkConnection.signer!).redeem(
+    return this.env.auriAirdrop.connect(this._networkConnection.signer!).redeem(
       campaigns.map((e) => utils.formatBytes32String(e)),
       tokens,
       await this._networkConnection.signer!.getAddress()

package/src/contracts/Referral.ts

@@ -1,22 +1,17 @@
-import { ReferralDirectory } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { Contract, ethers } from 'ethers';
-import { getBlocksTimestamp } from '..';
-import * as abis from '../abis';
-import * as consts from '../consts';
-import { BlockchainEntity, BlockchainEntityRead } from '../entities';
+import { ethers } from 'ethers';
+import { referralRewardDummy1, referralRewardDummy2 } from '../consts';
+import { AuriEnv, BlockchainEntity, BlockchainEntityRead } from '../entities';
+import { getBlocksTimestamp } from '../helpers';
 import * as AuriAPI from '../helpers/aurigami-api';
-import { Address, NetworkConnection } from '../types';
+import { Address, NetworkConnection, ReferralReward } from '../types';
+import { AirdropReadWrite } from './Airdrop';
 
 export class ReferralRead extends BlockchainEntityRead {
-  public readonly referral: ReferralDirectory;
+  public readonly env: AuriEnv;
   constructor(networkConnection: NetworkConnection) {
     super(networkConnection);
-    this.referral = new Contract(
-      consts.networkAddresses.misc.REFERRAL,
-      abis.ReferralDirectoryABI.abi,
-      networkConnection.provider
-    ) as ReferralDirectory;
+    this.env = new AuriEnv(networkConnection);
   }
 
   /**
@@ -38,7 +33,7 @@ export class ReferralRead extends BlockchainEntityRead {
    * Called to check if a user has a referral code.
    */
   public async getUserReferralCode(userAddr: Address): Promise<string> {
-    const result = await this.referral.userReferralCode(userAddr);
+    const result = await this.env.referralDirectory.userReferralCode(userAddr);
     return ethers.utils.parseBytes32String(result);
   }
 
@@ -46,7 +41,7 @@ export class ReferralRead extends BlockchainEntityRead {
    * Get referral code that a user was referred by, returns empty string if not found.
    */
   public async getReferralCodeUsed(userAddr: Address): Promise<string> {
-    const result = await this.referral.referralCodeUsed(userAddr);
+    const result = await this.env.referralDirectory.referralCodeUsed(userAddr);
     return ethers.utils.parseBytes32String(result);
   }
 
@@ -55,7 +50,7 @@ export class ReferralRead extends BlockchainEntityRead {
    */
   public async getReferralCodeOwner(code: string): Promise<Address> {
     const referralCode = ethers.utils.formatBytes32String(code);
-    return this.referral.referralCodeOwner(referralCode);
+    return this.env.referralDirectory.referralCodeOwner(referralCode);
   }
 
   /**
@@ -71,6 +66,22 @@ export class ReferralRead extends BlockchainEntityRead {
     }));
     return items;
   }
+
+  /**
+   * Array of rewards, sorted by time of the referral period (from latest to oldest)
+   */
+  public async referralRewards(userAddr: Address): Promise<ReferralReward[]> {
+    // TODO: Fix this
+    return [referralRewardDummy1, referralRewardDummy2];
+  }
+
+  /**
+   * Top 50 reward earners from the last round, sorted by token amount
+   */
+  public async leaderboard(): Promise<ReferralReward[]> {
+    // TODO: Fix this
+    return [referralRewardDummy2, referralRewardDummy1];
+  }
 }
 
 export class ReferralReadWrite extends ReferralRead {
@@ -81,7 +92,7 @@ export class ReferralReadWrite extends ReferralRead {
    */
   public async registerNewReferralCode(): Promise<TransactionResponse> {
     const referralCode = ethers.utils.formatBytes32String(this.generateReferralCode());
-    return this.referral
+    return this.env.referralDirectory
       .connect(this._networkConnection.signer!)
       .registerNewUserReferralCode(referralCode);
   }
@@ -91,10 +102,22 @@ export class ReferralReadWrite extends ReferralRead {
    */
   public async useReferralCode(code: string): Promise<TransactionResponse> {
     const referralCode = ethers.utils.formatBytes32String(code);
-    return this.referral
+    return this.env.referralDirectory
       .connect(this._networkConnection.signer!)
       .registerReferralCodeUsed(referralCode);
   }
+
+  /**
+   * Claim all unclaimed rewards for a given user
+   */
+  public async claimReferralRewards(): Promise<TransactionResponse> {
+    const unclaimedRewards = (
+      await this.referralRewards(await this._networkConnection.signer!.getAddress())
+    ).filter((reward) => reward.transactionHash == null);
+    const campaigns = unclaimedRewards.map((reward) => reward.campaign);
+    const tokens = unclaimedRewards.map((reward) => reward.rewardTokenAmount.token.address);
+    return new AirdropReadWrite(this._networkConnection).redeemMultiple(campaigns, tokens);
+  }
 }
 
 export class Referral extends BlockchainEntity {

package/src/entities/auriEnv.ts

@@ -1,25 +1,28 @@
 import {
+  AuriAirdrop,
   AuriFairLaunch,
   AuriInternalLens,
   AuriLens,
   Comptroller,
   IERC20,
   PULP,
+  ReferralDirectory,
 } from '@aurigami/contracts/typechain';
 import { Contract } from 'ethers';
 import * as abis from '../abis';
 import { networkAddresses } from '../consts/constants';
-import { AuTokenWithUnderlying, NetworkConnection } from '../types';
+import { AuTokenWithUnderlying } from '../types';
 import { BlockchainEntityRead } from './BlockchainEntity';
 
 export class AuriEnv extends BlockchainEntityRead {
-  public comptroller: Comptroller;
-  public auriFairLaunch: AuriFairLaunch;
-  public auriLens: AuriLens;
-  public ply: IERC20;
-  public pulp: PULP;
-  public auriInternalLens: AuriInternalLens;
-  // public faucet: Faucet;
+  private _comptroller: Comptroller | null = null;
+  private _auriFairLaunch: AuriFairLaunch | null = null;
+  private _auriLens: AuriLens | null = null;
+  private _ply: IERC20 | null = null;
+  private _pulp: PULP | null = null;
+  private _auriInternalLens: AuriInternalLens | null = null;
+  private _auriAirdrop: AuriAirdrop | null = null;
+  private _referralDirectory: ReferralDirectory | null = null;
 
   public getContract<CType extends Contract>(address: string, abi: any) {
     return new Contract(address, abi, this._networkConnection.provider) as CType;
@@ -36,28 +39,77 @@ export class AuriEnv extends BlockchainEntityRead {
     });
   }
 
-  public constructor(networkConnection: NetworkConnection) {
-    super(networkConnection);
-    this.comptroller = this.getContract<Comptroller>(
-      networkAddresses.misc.COMPTROLLER,
-      abis.ComptrollerABI.abi
-    );
-    this.auriFairLaunch = this.getContract<AuriFairLaunch>(
-      networkAddresses.misc.AURIFAIRLAUNCH,
-      abis.AuriFairLaunchABI.abi
-    );
-    this.auriLens = this.getContract<AuriLens>(
-      networkAddresses.misc.AURILENS,
-      abis.AuriLensABI.abi
-    );
-
-    this.ply = this.getContract<IERC20>(networkAddresses.tokens.PLY, abis.EIP20InterfaceABI.abi);
-    this.pulp = this.getContract<PULP>(networkAddresses.tokens.PULP, abis.PulpABI.abi);
-    // this.faucet = this.getContract<Faucet>(networkAddresses.misc.FAUCET, abis.FaucetABI.abi);
-
-    this.auriInternalLens = this.getContract<AuriInternalLens>(
-      networkAddresses.misc.AURI_INTERNAL_LENS,
-      abis.AuriInternalLensABI.abi
-    );
+  get comptroller(): Comptroller {
+    if (!this._comptroller) {
+      this._comptroller = this.getContract<Comptroller>(
+        networkAddresses.misc.COMPTROLLER,
+        abis.ComptrollerABI.abi
+      );
+    }
+    return this._comptroller;
+  }
+
+  get auriFairLaunch(): AuriFairLaunch {
+    if (!this._auriFairLaunch) {
+      this._auriFairLaunch = this.getContract<AuriFairLaunch>(
+        networkAddresses.misc.AURIFAIRLAUNCH,
+        abis.AuriFairLaunchABI.abi
+      );
+    }
+    return this._auriFairLaunch;
+  }
+
+  get auriLens(): AuriLens {
+    if (!this._auriLens) {
+      this._auriLens = this.getContract<AuriLens>(
+        networkAddresses.misc.AURILENS,
+        abis.AuriLensABI.abi
+      );
+    }
+    return this._auriLens;
+  }
+
+  get ply(): IERC20 {
+    if (!this._ply) {
+      this._ply = this.getContract<IERC20>(networkAddresses.tokens.PLY, abis.EIP20InterfaceABI.abi);
+    }
+    return this._ply;
+  }
+
+  get pulp(): PULP {
+    if (!this._pulp) {
+      this._pulp = this.getContract<PULP>(networkAddresses.tokens.PULP, abis.PulpABI.abi);
+    }
+    return this._pulp;
+  }
+
+  get auriInternalLens(): AuriInternalLens {
+    if (!this._auriInternalLens) {
+      this._auriInternalLens = this.getContract<AuriInternalLens>(
+        networkAddresses.misc.AURI_INTERNAL_LENS,
+        abis.AuriInternalLensABI.abi
+      );
+    }
+    return this._auriInternalLens;
+  }
+
+  get auriAirdrop(): AuriAirdrop {
+    if (!this._auriAirdrop) {
+      this._auriAirdrop = this.getContract<AuriAirdrop>(
+        networkAddresses.misc.AURI_AIRDROP,
+        abis.AuriAirdropABI.abi
+      );
+    }
+    return this._auriAirdrop;
+  }
+
+  get referralDirectory(): ReferralDirectory {
+    if (!this._referralDirectory) {
+      this._referralDirectory = this.getContract<ReferralDirectory>(
+        networkAddresses.misc.REFERRAL,
+        abis.ReferralDirectoryABI.abi
+      );
+    }
+    return this._referralDirectory;
   }
 }

package/src/types/index.ts

@@ -121,3 +121,27 @@ export type AccountAuTokensInfo = {
 export type AuTokenWithUnderlying = AuToken & {
   underlying: string;
 };
+
+export type ReferralReward = {
+  campaign: string;
+  /**
+   * start timetamp of the referral round
+   */
+  startTime: number;
+  /**
+   * end timetamp of the referral round
+   */
+  endTime: number;
+  /**
+   * referrer's rewards
+   */
+  isReferrer: boolean;
+  /**
+   * reward amount
+   */
+  rewardTokenAmount: TokenAmount;
+  /**
+   * hash of the transaction on aurorascan (if no, return null)
+   */
+  transactionHash: string | null;
+};