@aurigami/sdk 1.4.8 → 1.5.0-dummy-1

package/src/constants.ts

@@ -1,7 +1,8 @@
 import BigNumber from 'bignumber.js';
-import { ethers, Signer, BigNumber as BN} from 'ethers';
-export const dummyAddress: string = "0xDEADbeEfEEeEEEeEEEeEEeeeeeEeEEeeeeEEEEeE";
-export const ETHAddress: string = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+import { ethers, Signer, BigNumber as BN } from 'ethers';
+export const dummyAddress: string =
+  '0xDEADbeEfEEeEEEeEEEeEEeeeeeEeEEeeeeEEEEeE';
+export const ETHAddress: string = '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
 
 export const AURORA_CHAINID = 1313161554;
 
@@ -9,108 +10,129 @@ export const DECIMAL_PRECISION = 10;
 
 export type NetworkAddresses = {
   auTokens: {
-    name: string,
-    address: string,
-    underlying: string
-  }[],
-  misc: Record<string, string>,
-  tokens: Record<string, string>
-}
+    name: string;
+    address: string;
+    underlying: string;
+  }[];
+  misc: Record<string, string>;
+  tokens: Record<string, string>;
+};
 export const networkAddresses: NetworkAddresses = {
   auTokens: [
     {
-      name: "auUSDC",
+      name: 'auUSDC',
       address: '0x4f0d864b1ABf4B701799a0b30b57A22dFEB5917b'.toLowerCase(),
-      underlying: '0xb12bfca5a55806aaf64e99521918a4bf0fc40802'.toLowerCase()
+      underlying: '0xb12bfca5a55806aaf64e99521918a4bf0fc40802'.toLowerCase(),
     },
     {
-      name: "auETH",
+      name: 'auETH',
       address: '0xca9511B610bA5fc7E311FDeF9cE16050eE4449E9'.toLowerCase(),
-      underlying: ETHAddress.toLowerCase()
+      underlying: ETHAddress.toLowerCase(),
     },
     {
-      name: "auWBTC",
+      name: 'auWBTC',
       address: '0xCFb6b0498cb7555e7e21502E0F449bf28760Adbb'.toLowerCase(),
-      underlying: '0xf4eb217ba2454613b15dbdea6e5f22276410e89e'.toLowerCase()
+      underlying: '0xf4eb217ba2454613b15dbdea6e5f22276410e89e'.toLowerCase(),
     },
     {
-      name: "auUSDT",
+      name: 'auUSDT',
       address: '0xaD5A2437Ff55ed7A8Cad3b797b3eC7c5a19B1c54'.toLowerCase(),
-      underlying: '0x4988a896b1227218e4a686fde5eabdcabd91571f'.toLowerCase()
+      underlying: '0x4988a896b1227218e4a686fde5eabdcabd91571f'.toLowerCase(),
     },
     {
-      name: "auDAI",
+      name: 'auDAI',
       address: '0xCE4166363E3a584DAc84A47bCD3414B43EfCDd1c'.toLowerCase(),
-      underlying: '0xe3520349f477a5f6eb06107066048508498a291b'.toLowerCase()
+      underlying: '0xe3520349f477a5f6eb06107066048508498a291b'.toLowerCase(),
     },
     {
-      name: "auWNEAR",
+      name: 'auWNEAR',
       address: '0xaE4fac24dCdAE0132C6d04f564dCf059616E9423'.toLowerCase(),
-      underlying: '0xC42C30aC6Cc15faC9bD938618BcaA1a1FaE8501d'.toLowerCase()
+      underlying: '0xC42C30aC6Cc15faC9bD938618BcaA1a1FaE8501d'.toLowerCase(),
     },
     {
-      name: "auSTNEAR",
-      address: "0x3195949f267702723bc614cAE037cdc8D1E94786".toLowerCase(),
-      underlying: '0x07F9F7f963C5cD2BBFFd30CcfB964Be114332E30'.toLowerCase()
+      name: 'auSTNEAR',
+      address: '0x3195949f267702723bc614cAE037cdc8D1E94786'.toLowerCase(),
+      underlying: '0x07F9F7f963C5cD2BBFFd30CcfB964Be114332E30'.toLowerCase(),
     },
     {
-      name: "auAURORA",
-      address: "0x8888682E24dd4Df7B7Ff2B91fccB575737E433bf".toLowerCase(),
-      underlying: "0x8bec47865ade3b172a928df8f990bc7f2a3b9f79".toLowerCase(),
+      name: 'auAURORA',
+      address: '0x8888682E24dd4Df7B7Ff2B91fccB575737E433bf'.toLowerCase(),
+      underlying: '0x8bec47865ade3b172a928df8f990bc7f2a3b9f79'.toLowerCase(),
     },
     {
-      name: "auTRI",
-      address: "0x6Ea6C03061bDdCE23d4Ec60B6E6e880c33d24dca".toLowerCase(),
-      underlying: "0xFa94348467f64D5A457F75F8bc40495D33c65aBB".toLowerCase()
-    }
+      name: 'auTRI',
+      address: '0x6Ea6C03061bDdCE23d4Ec60B6E6e880c33d24dca'.toLowerCase(),
+      underlying: '0xFa94348467f64D5A457F75F8bc40495D33c65aBB'.toLowerCase(),
+    },
   ],
   misc: {
-    COMPTROLLER: "0x817af6cfAF35BdC1A634d6cC94eE9e4c68369Aeb".toLowerCase(),
-    oracle: "0xC6e5185438e1730959c1eF3551059A3feC744E90".toLowerCase(),
-    AURIFAIRLAUNCH: "0x6f068608573c840bB27b39458d7d87eB865e19Cc".toLowerCase(),
+    COMPTROLLER: '0x817af6cfAF35BdC1A634d6cC94eE9e4c68369Aeb'.toLowerCase(),
+    oracle: '0xC6e5185438e1730959c1eF3551059A3feC744E90'.toLowerCase(),
+    AURIFAIRLAUNCH: '0x6f068608573c840bB27b39458d7d87eB865e19Cc'.toLowerCase(),
     AURILENS: '0xFfdFfBDB966Cb84B50e62d70105f2Dbf2e0A1e70'.toLowerCase(),
     TOKENLOCK: '0xDACC02a4Ff16Ea3c1515AdbfdCeb7B1F448B79c8'.toLowerCase(),
-    ETHREPAYHELPER: "0xa308A5003fA1A25BFdD9418FcEE51d48Dbe441e6".toLowerCase(),
-    AURI_AIRDROP: "0x6C42aA5b128B62D6CCf357726D7d13F3888335EC".toLowerCase()
+    ETHREPAYHELPER: '0xa308A5003fA1A25BFdD9418FcEE51d48Dbe441e6'.toLowerCase(),
+    AURI_AIRDROP: '0x6C42aA5b128B62D6CCf357726D7d13F3888335EC'.toLowerCase(),
   },
   tokens: {
-    AURORA: "0x8bec47865ade3b172a928df8f990bc7f2a3b9f79".toLowerCase(),
-    PLY: "0x981bD5832EAB9C8F607940E0e9faCBf8C09ee20a".toLowerCase(),
-    stNEAR: "0x07f9f7f963c5cd2bbffd30ccfb964be114332e30".toLowerCase(),
+    AURORA: '0x8bec47865ade3b172a928df8f990bc7f2a3b9f79'.toLowerCase(),
+    PLY: '0x09c9d464b58d96837f8d8b6f4d9fe4ad408d3a4f'.toLowerCase(),
+    stNEAR: '0x07f9f7f963c5cd2bbffd30ccfb964be114332e30'.toLowerCase(),
     USDC: '0xb12bfca5a55806aaf64e99521918a4bf0fc40802'.toLowerCase(),
     WNEAR: '0xC42C30aC6Cc15faC9bD938618BcaA1a1FaE8501d'.toLowerCase(),
     TRI: '0xFa94348467f64D5A457F75F8bc40495D33c65aBB'.toLowerCase(),
     META: '0xc21ff01229e982d7c8b8691163b0a3cb8f357453'.toLocaleLowerCase(),
-    AURPLY: dummyAddress.toLowerCase() // This is dummy
-  }
-}
+    PULP: '0x04Ac48711BCdc45b4d223fb021E09DA73c71095e'.toLowerCase(),
+    PLYUSDC: '0x37cae2b29c18e05ece60111fa01d3ca217046016'.toLowerCase(),
+  },
+};
 
-export const BORROW_LIMIT_BUFFER = new BigNumber(1);
+// All token that we can calculate the price via oracle + coingecko
+export const PRICE_WHITELISTED = new Set([
+  ...networkAddresses.auTokens.map((t) => t.underlying),
+  networkAddresses.tokens.AURORA,
+  networkAddresses.tokens.TRI,
+  networkAddresses.tokens.META,
+  networkAddresses.tokens.stNEAR,
+]);
 
-export const REWARDCLAIMSTART = 1640995200;
+export const REWARD_CLAIM_START = 1651762800; // 5 May 2022 15:00:00 UTC
+
+export const BORROW_LIMIT_BUFFER = new BigNumber(1);
 
 export const ONE_DAY = 86400;
+export const ONE_WEEK = ONE_DAY * 7;
 export const ONE_YEAR = ONE_DAY * 365;
 
-export const AurPlyPid = 0;
-export const INF = BN.from(2).pow(256).sub(1)
-
+export const PlyUsdcPid = 0;
+export const PLYUSDCRewardTokens = [
+  '0x09C9D464b58d96837f8d8b6f4d9fE4aD408d3A4f', // PLY
+  '0xC42C30aC6Cc15faC9bD938618BcaA1a1FaE8501d', // WNEAR
+  '0x8BEc47865aDe3B172A928df8f990Bc7f2A3b9f79', // AURORA
+  '0xFa94348467f64D5A457F75F8bc40495D33c65aBB', // TRI
+];
+// could call RPC to get all the staking pools but it's not necessary for now
+// export const ALL_STAKING_POOLS = [PlyUsdcPid];
+// TODO: fix this
+export const ALL_STAKING_POOLS = [];
+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 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} = {
+export const BORROW_NEAR_REWARDS_PER_WEEK: { [k: string]: string } = {
   // currently 0 for all markets
-}
+};

package/src/decimals.ts

@@ -1,6 +1,6 @@
 export const decimalRecords: Record<string, number> = {
   '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee': 18,
-  '0x981bd5832eab9c8f607940e0e9facbf8c09ee20a': 18,
+  '0x09c9d464b58d96837f8d8b6f4d9fe4ad408d3a4f': 18,
   '0x3195949f267702723bc614cae037cdc8d1e94786': 8,
   '0xfa94348467f64d5a457f75f8bc40495d33c65abb': 18,
   '0x07f9f7f963c5cd2bbffd30ccfb964be114332e30': 24,
@@ -18,5 +18,7 @@ export const decimalRecords: Record<string, number> = {
   '0xae4fac24dcdae0132c6d04f564dcf059616e9423': 8,
   '0xce4166363e3a584dac84a47bcd3414b43efcdd1c': 8,
   '0xf4eb217ba2454613b15dbdea6e5f22276410e89e': 8,
-  '0xc21ff01229e982d7c8b8691163b0a3cb8f357453': 24
-}
+  '0xc21ff01229e982d7c8b8691163b0a3cb8f357453': 24,
+  '0x04ac48711bcdc45b4d223fb021e09da73c71095e': 18, // PULP
+  '0x37cae2b29c18e05ece60111fa01d3ca217046016': 18, // PLYUSDC
+};

package/src/dummy.ts

@@ -2,34 +2,28 @@ import { Token } from './token';
 import { TokenAmount } from './tokenAmount';
 import { UserMarketDetails } from './types';
 
-export const dummyToken = new Token('0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e', 6);
-
-export const dummyPly = new Token('0x8729438eb15e2c8b576fcc6aecda6a148776c0f5', 18);
-
-export const dummyPlyAurora = new Token('0xE530dC2095Ef5653205CF5ea79F8979a7028065c', 18);
-
-export const dummyTokenAmount = new TokenAmount(
-  dummyToken,
-  '123.456',
-  false,
+export const dummyToken = new Token(
+  '0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
+  6
 );
 
-export const dummyZeroTokenAmount = new TokenAmount(
-  dummyToken,
-   '0',
+export const dummyPly = new Token(
+  '0x8729438eb15e2c8b576fcc6aecda6a148776c0f5',
+  18
 );
 
-export const dummyTokenAmount2 = new TokenAmount(
-  dummyToken,
-  '456.123',
- false,
+export const dummyPlyAurora = new Token(
+  '0xE530dC2095Ef5653205CF5ea79F8979a7028065c',
+  18
 );
 
-export const dummyTokenAmount3 = new TokenAmount(
-  dummyToken,
-  '1000.123',
-  false,
-);
+export const dummyTokenAmount = new TokenAmount(dummyToken, '123.456', false);
+
+export const dummyZeroTokenAmount = new TokenAmount(dummyToken, '0');
+
+export const dummyTokenAmount2 = new TokenAmount(dummyToken, '456.123', false);
+
+export const dummyTokenAmount3 = new TokenAmount(dummyToken, '1000.123', false);
 
 export const dummyMarketAddress = '0xbeb5d47a3f720ec0a390d04b4d41ed7d9688bc7f'; // qiUSDC
 
@@ -40,5 +34,5 @@ export const dummyUserMarketDetails: UserMarketDetails = {
   isCollateral: true,
   maxWithdrawableAmount: dummyTokenAmount,
   collateralRatio: 0.5,
-  underlyingPrice: "1"
+  underlyingPrice: '1',
 };

package/src/helpers.ts

@@ -1,11 +1,12 @@
-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, Contract, providers, utils } from "ethers";
-import { getQuery as getAuroraAPIQuery } from "./aurora-api-helpers";
-import { decimalRecords } from "./decimals";
-import { Address, NetworkConnection } from "./types";
+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, Contract, providers, utils } from 'ethers';
+import { getQuery as getAuroraAPIQuery } from './aurora-api-helpers';
+import { decimalRecords } from './decimals';
+import { Address, NetworkConnection } from './types';
+import assert from 'assert';
 
 export function formatObject(object: Object) {
   return JSON.stringify(object, null, '  ');
@@ -15,34 +16,50 @@ export function decimalFactor(decimal: number) {
   return BN.from(10).pow(decimal).toString();
 }
 
-export const isSameAddress = (address1: Address, address2: Address): boolean => {
-  return address1.toLowerCase() == address2.toLowerCase()
-}
+export const isSameAddress = (
+  address1: Address,
+  address2: Address
+): boolean => {
+  return address1.toLowerCase() == address2.toLowerCase();
+};
 
 export const getCurrentTimestamp = (): number => {
-  return Math.trunc(Date.now() / 1000)
-}
+  return Math.trunc(Date.now() / 1000);
+};
 
 export function validateAndParseAddress(address: Address): Address {
   try {
     return utils.getAddress(address);
   } catch (error) {
-    throw new Error("Invalid address: " + address);
+    throw new Error('Invalid address: ' + address);
   }
 }
 
 export function getDecimal(address: Address): number {
-  return decimalRecords[address.toLowerCase()];
+  let addressLowercase = address.toLowerCase();
+  assert(
+    decimalRecords[addressLowercase] != undefined,
+    'Decimal not found for ' + address
+  );
+  return decimalRecords[addressLowercase];
 }
 
-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');
+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');
   }
   return rewardsValue.multipliedBy(frequencyPerYear).dividedBy(totalStakeValue);
 }
 
-export async function getBlockTimestamp(provider: Provider, blockNumber: number): Promise<number> {
+export async function getBlockTimestamp(
+  provider: Provider,
+  blockNumber: number
+): Promise<number> {
   const block = await provider.getBlock(blockNumber);
   return block.timestamp;
 }
@@ -55,14 +72,16 @@ export async function getBlockTimestamp(provider: Provider, blockNumber: number)
  *
  * This function is much faster than using binary search.
  */
- export async function getBlockBeforeTimestamp(provider: Provider, timestamp: number) {
-  let result = await getAuroraAPIQuery(
-    'block',
-    'getblocknobytime',
-    {'timestamp': timestamp, 'closest': 'before'}
-  );
+export async function getBlockBeforeTimestamp(
+  provider: Provider,
+  timestamp: number
+) {
+  let result = await getAuroraAPIQuery('block', 'getblocknobytime', {
+    timestamp: timestamp,
+    closest: 'before',
+  });
 
   // In case the API return `Block timestamp too far in the future`
   // use the last block number
-  return parseInt(result) || await provider.getBlockNumber();
+  return parseInt(result) || (await provider.getBlockNumber());
 }

package/src/index.ts

@@ -3,7 +3,7 @@ import { ethers } from 'ethers';
 import { Logger } from 'ethers/lib/utils';
 
 ethers.utils.Logger.setLogLevel(Logger.levels.ERROR);
-BigNumber.config({DECIMAL_PLACES: 50})
+BigNumber.config({ DECIMAL_PLACES: 50 });
 
 export * from './SDK';
 export * from './MoneyMarket';
@@ -17,3 +17,4 @@ export * from './tokenAmount';
 export * from './types';
 export * from './airdrop-lottery';
 export * from './transfer-event-query';
+export * from './Papermill';