@aurigami/sdk 1.3.4 → 1.4.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.4",
+  "version": "1.4.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,6 +14,7 @@
     "start": "tsdx watch",
     "build": "tsdx build",
     "test": "tsdx test",
+    "test-hardhat": "env TS_NODE_PROJECT=\"tsconfig.test.json\" yarn hardhat test",
     "lint": "tsdx lint",
     "prepare": "tsdx build",
     "size": "size-limit",
@@ -57,10 +58,18 @@
     "typescript": "^4.5.4"
   },
   "dependencies": {
-    "@aurigami/contracts": "2.6.0",
+    "@aurigami/contracts": "2.7.1",
+    "@nomiclabs/hardhat-ethers": "^2.0.5",
+    "@nomiclabs/hardhat-etherscan": "^3.0.3",
+    "@nomiclabs/hardhat-waffle": "^2.0.3",
+    "@types/mocha": "^9.1.0",
     "axios": "^0.24.0",
     "bignumber.js": "^9.0.2",
+    "chai": "^4.3.6",
     "dotenv": "^16.0.0",
-    "ethers": "^5.0.0"
+    "ethereum-waffle": "^3.4.4",
+    "ethers": "^5.6.4",
+    "hardhat": "^2.9.3",
+    "ts-node": "^10.7.0"
   }
 }

package/src/MoneyMarket.ts

@@ -8,7 +8,7 @@ import AuriLensABI from '@aurigami/contracts/artifacts/contracts/AuriLens.sol/Au
 import EthRepayHelperABI from "@aurigami/contracts/artifacts/contracts/EthRepayHelper.sol/EthRepayHelper.json"
 import { AuErc20, AuETH, AuriLens, Comptroller, EthRepayHelper } from "@aurigami/contracts/typechain";
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { networkAddresses, ETHAddress, ONE_YEAR, INF, ONE_DAY } from "./constants";
+import { networkAddresses, ETHAddress, ONE_YEAR, INF, ONE_DAY, DEPOSIT_NEAR_REWARDS_PER_WEEK, BORROW_NEAR_REWARDS_PER_WEEK } from "./constants";
 import BigNumber from "bignumber.js";
 import { decimalFactor, isSameAddress, calcLMRewardApr, getCurrentTimestamp } from './helpers';
 import { Token, PLYToken } from './token';
@@ -211,9 +211,12 @@ export class MoneyMarketRead extends BlockchainEntityRead {
 
   private getDepositNEARRewardPerWeek(): TokenAmount {
     const NEARToken = new Token(networkAddresses.tokens.WNEAR, getDecimal(networkAddresses.tokens.WNEAR));
-    const rewardStopTime = 1650463200;
-    if (isSameAddress(this.underlying.address, networkAddresses.tokens.USDC) && getCurrentTimestamp() <= rewardStopTime) {
-      return new TokenAmount(NEARToken, "1250", false);
+    const rewardStartTime = 1650636000;
+    const rewardStopTime = 1651845600; // May 06, 2022 2 PM GMT
+    const currentTime = getCurrentTimestamp();
+    if (currentTime <= rewardStopTime && currentTime > rewardStartTime) {
+      const reward = DEPOSIT_NEAR_REWARDS_PER_WEEK[this.underlying.address.toLocaleLowerCase()] ?? "0";
+      return new TokenAmount(NEARToken, reward, false);
     } else {
       return new TokenAmount(NEARToken, "0");
     }
@@ -221,9 +224,12 @@ export class MoneyMarketRead extends BlockchainEntityRead {
 
   private getBorrowNEARRewardPerWeek(): TokenAmount {
     const NEARToken = new Token(networkAddresses.tokens.WNEAR, getDecimal(networkAddresses.tokens.WNEAR));
-    const rewardStopTime = 1650463200;
-    if (isSameAddress(this.underlying.address, networkAddresses.tokens.USDC) && getCurrentTimestamp() <= rewardStopTime) {
-      return new TokenAmount(NEARToken, "3750", false);
+    const rewardStartTime = 1650636000;
+    const rewardStopTime = 1651845600; // May 06, 2022 2 PM GMT
+    const currentTime = getCurrentTimestamp();
+    if (currentTime <= rewardStopTime && currentTime > rewardStartTime) {
+      const reward = BORROW_NEAR_REWARDS_PER_WEEK[this.underlying.address.toLocaleLowerCase()] ?? "0";
+      return new TokenAmount(NEARToken, reward, false);
     } else {
       return new TokenAmount(NEARToken, "0");
     }

package/src/airdrop-lottery.ts

@@ -1,12 +1,18 @@
 import { Provider } from "@ethersproject/abstract-provider";
+import { TransactionResponse } from '@ethersproject/abstract-provider';
 import { BlockchainEntity, BlockchainEntityRead } from "./BlockchainEntity";
-import { NetworkConnection } from "./types";
-import { BigNumber as BN } from "ethers";
+import { Address, NetworkConnection } from "./types";
+import { BigNumber as BN, Contract, utils } from "ethers";
 import { TransferEventQuery } from "./transfer-event-query";
-import { AIRDROP_START_TIMESTAMP, AIRDROP_KEEP_THRESHOLD, AIRDROP_END_TIMESTAMP } from "./constants";
-import { getBlockBeforeTimestamp, getCurrentTimestamp } from "./helpers";
+import { AIRDROP_START_TIMESTAMP, AIRDROP_KEEP_THRESHOLD, AIRDROP_END_TIMESTAMP, networkAddresses } from "./constants";
+import AuriAirdropABI from "@aurigami/contracts/artifacts/contracts/AuriAirdrop.sol/AuriAirdrop.json"
+import { getBlockBeforeTimestamp, getCurrentTimestamp, getDecimal } from "./helpers";
 import AIRDROP_AUTOKEN_INFO from "./airdrop_misc/auTokensInfo.json"
 import AIRDROP_WHITELIST_ADDRESSES from "./airdrop_misc/whitelist.json"
+import { AuriAirdrop } from "@aurigami/contracts/typechain";
+import assert from 'assert';
+import { TokenAmount } from "./tokenAmount";
+import { Token } from "./token";
 
 type AirdropUnderlyingInfo = {
     minDeposit: BN,
@@ -162,10 +168,16 @@ class AirdropAuTokenKeepTracker extends BlockchainEntityRead {
 }
 
 export class AirdropRead extends BlockchainEntityRead {
+    protected _airDrop: AuriAirdrop;
     private _whitelistedAddresses: Set<string>;
     private keepTrackers: AirdropAuTokenKeepTracker[] = [];
     public constructor(networkConnection: NetworkConnection) {
         super(networkConnection);
+        this._airDrop = new Contract(
+            networkAddresses.misc.AURI_AIRDROP,
+            AuriAirdropABI.abi,
+            networkConnection.provider
+        ) as AuriAirdrop;
 
         this._whitelistedAddresses = new Set(
             (AIRDROP_WHITELIST_ADDRESSES as string[]).map(e => e.toLocaleLowerCase())
@@ -218,6 +230,45 @@ export class AirdropRead extends BlockchainEntityRead {
             return keepTracker.isEligible(user);
         }))).includes(true);
     }
+
+    /**
+     * Get redeemable rewards amount of user
+     */
+    public async getRedeemableReward(campaign: string, token: Address, user: Address): Promise<TokenAmount> {
+        let tokenInstance: Token = new Token(
+            token,
+            getDecimal(token),
+        );
+
+        let rewards: BN = await this._airDrop.getRedeemableReward(
+            utils.formatBytes32String(campaign),
+            token,
+            user
+        )
+
+        return new TokenAmount(tokenInstance, rewards.toString());
+    }
+}
+
+export class AirdropReadWrite extends AirdropRead {
+    /**
+     * Transfer rewards from multiple campaigns to msg.sender
+     */
+    public async redeemMultiple(campaigns: string[], tokens: Address[]): Promise<TransactionResponse> {
+        assert(campaigns.length == tokens.length, "campaigns and tokens must have the same length");
+        return this._airDrop.connect(this._networkConnection.signer!).redeem(
+            campaigns.map(e => utils.formatBytes32String(e)),
+            tokens,
+            await this._networkConnection.signer!.getAddress(),
+        );
+    }
+
+    /**
+     * Redeem reward from a single campaign
+     */
+    public async redeemSingle(campaign: string, token: Address): Promise<TransactionResponse> {
+        return this.redeemMultiple([campaign], [token]);
+    }
 }
 
 export class Airdrop extends BlockchainEntity {
@@ -227,5 +278,7 @@ export class Airdrop extends BlockchainEntity {
     public read(networkConnection: NetworkConnection): AirdropRead {
         return new AirdropRead(networkConnection);
     }
-
+    public readWrite(networkConnection: NetworkConnection): AirdropReadWrite {
+        return new AirdropReadWrite(networkConnection);
+    }
 }

package/src/constants.ts

@@ -70,7 +70,8 @@ export const networkAddresses: NetworkAddresses = {
     AURIFAIRLAUNCH: "0x9F9ceE911509abC6Af899c12ED625B0A6580D6e6".toLowerCase(),
     AURILENS: '0xC41a5C1625d492436600789469c1CE2eA20CEA6B'.toLowerCase(),
     TOKENLOCK: '0xDACC02a4Ff16Ea3c1515AdbfdCeb7B1F448B79c8'.toLowerCase(),
-    ETHREPAYHELPER: "0xa308A5003fA1A25BFdD9418FcEE51d48Dbe441e6".toLowerCase()
+    ETHREPAYHELPER: "0xa308A5003fA1A25BFdD9418FcEE51d48Dbe441e6".toLowerCase(),
+    AURI_AIRDROP: "0x6C42aA5b128B62D6CCf357726D7d13F3888335EC".toLowerCase()
   },
   tokens: {
     AURORA: "0x8bec47865ade3b172a928df8f990bc7f2a3b9f79".toLowerCase(),
@@ -97,3 +98,18 @@ export const INF = BN.from(2).pow(256).sub(1)
 export const AIRDROP_START_TIMESTAMP = 1649858400;
 export const AIRDROP_END_TIMESTAMP = 1651068000;
 export const AIRDROP_KEEP_THRESHOLD = 7 * 86400;
+
+export const DEPOSIT_NEAR_REWARDS_PER_WEEK: {[k : string]: string} = Object.fromEntries(
+  // lower case all addresses
+  Object.entries({
+    '0xb12bfca5a55806aaf64e99521918a4bf0fc40802': '36375', // USDC
+    '0x4988a896b1227218e4a686fde5eabdcabd91571f': '14550', // USDT
+    '0xf4eb217ba2454613b15dbdea6e5f22276410e89e': '3638',  // WBTC
+    '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE': '14550', // ETH
+    '0xc42c30ac6cc15fac9bd938618bcaa1a1fae8501d': '3638',  // WNEAR
+  }).map(([k, v]) => [k.toLowerCase(), v])
+);
+
+export const BORROW_NEAR_REWARDS_PER_WEEK: {[k : string]: string} = {
+  // currently 0 for all markets
+}

package/src/decimals.ts

@@ -17,5 +17,6 @@ export const decimalRecords: Record<string, number> = {
   '0x8888682e24dd4df7b7ff2b91fccb575737e433bf': 8,
   '0xae4fac24dcdae0132c6d04f564dcf059616e9423': 8,
   '0xce4166363e3a584dac84a47bcd3414b43efcdd1c': 8,
-  '0xf4eb217ba2454613b15dbdea6e5f22276410e89e': 8
-}
+  '0xf4eb217ba2454613b15dbdea6e5f22276410e89e': 8,
+  '0xc21ff01229e982d7c8b8691163b0a3cb8f357453': 24
+}

package/src/helpers.ts

@@ -1,6 +1,8 @@
+import EIP20InterfaceABI from "@aurigami/contracts/artifacts/contracts/interfaces/EIP20Interface.sol/EIP20Interface.json"
+import { EIP20Interface, IERC20 } from "@aurigami/contracts/typechain";
 import { Provider } from "@ethersproject/abstract-provider";
 import BigNumber from "bignumber.js";
-import { BigNumber as BN, providers, utils } from "ethers";
+import { BigNumber as BN, Contract, providers, utils } from "ethers";
 import { decimalRecords } from "./decimals";
 import { Address, NetworkConnection } from "./types";
 
@@ -31,6 +33,19 @@ export function validateAndParseAddress(address: Address): Address {
 export function getDecimal(address: Address): number {
   return decimalRecords[address.toLowerCase()];
 }
+
+/**
+ * Get the decimals of a token via EIP20Interface
+ */
+export async function getDecimalsViaContract(address: Address, provider: Provider): Promise<number> {
+  let result = getDecimal(address);
+  if (result) {
+    return result;
+  }
+  let token: EIP20Interface = new Contract(address, EIP20InterfaceABI.abi, provider) as EIP20Interface;
+  return token.decimals();
+}
+
 export function calcLMRewardApr(rewardsValue: BigNumber, totalStakeValue: BigNumber, frequencyPerYear: number): BigNumber {
   if (totalStakeValue.lte(0)) { // avoid division by zero when there is no stake
       return new BigNumber('999999999');