@aurigami/sdk 1.23.1 → 1.24.0

package/dist/types/index.d.ts

@@ -1,197 +1,175 @@
-import { AuToken } from '@aurigami/contracts/typechain';
-import { TypedEvent } from '@aurigami/contracts/typechain/common';
-import BigNumber from 'bignumber.js';
-import type { providers, Signer } from 'ethers';
-import { BigNumber as BN } from 'ethers';
-import { TokenAmount } from '../entities/tokenAmount';
-export declare enum ComptrollerRewardType {
-    PLY = 0,
-    AURORA = 1
-}
-export declare type NetworkConnection = {
-    provider: providers.Provider;
-    signer?: Signer;
-};
-export declare type Address = string;
-export declare type CurrencyAmount = {
-    currency: string;
-    amount: string;
-};
-export declare type TokenValuation = {
-    tokenAmount: TokenAmount;
-    currencyAmount: CurrencyAmount;
-};
-export declare type MoneyMarketDetails = {
-    auTokenAddress: string;
-    totalTokenDeposited: TokenAmount;
-    totalTokenBorrowed: TokenAmount;
-    depositApy: number;
-    depositPlyApy: number;
-    borrowApy: number;
-    borrowPlyApy: number;
-    collateralRatio: number;
-    depositPlyPerWeek: TokenAmount;
-    borrowPlyPerWeek: TokenAmount;
-    depositMETAApy: number;
-    depositNEARApy: number;
-    borrowNEARApy: number;
-    staderDepositApy: number;
-};
-export declare type UserDetails = {
-    markets: UserMarketDetails[];
-    borrowLimit: CurrencyAmount;
-    borrowableAmount: CurrencyAmount;
-};
-export declare type UserLockingDetails = {
-    vestingStart: number;
-    /** % of reward they will receive in PLY, if they claim this week */
-    currentUnlockPortion: number;
-    accruedPly: TokenAmount;
-    /** Amount of PLY they will receive, if they claim this week */
-    currentPly: TokenAmount;
-    /** Amount of PULP they will receive, if they claim this week */
-    currentPulp: TokenAmount;
-    /** % of reward they will receive in PLY, if they claim next week */
-    nextUnlockPortion: number;
-    /**
-     * Amount of PLY they will receive, if they claim next week.
-     * This doesn't include the additional reward that they will earn
-     * in the next week.
-     */
-    nextPly: TokenAmount;
-    /**
-     * Amount of PULP they will receive, if they claim next week.
-     * This doesn't include the additional reward that they will earn
-     * in the next week.
-     */
-    nextPulp: TokenAmount;
-};
-export declare type UserMarketDetails = {
-    market: string;
-    depositBalance: TokenAmount;
-    borrowBalance: TokenAmount;
-    isCollateral: boolean;
-    maxWithdrawableAmount: TokenAmount;
-    collateralRatio: number;
-    underlyingPrice: string;
-};
-export declare type TokenAPY = {
-    address: string;
-    apy: string;
-};
-export declare type PLYWNEARPoolDetails = {
-    totalStakedLiquidity: TokenAmount;
-    APYs: TokenAPY[];
-};
-export declare enum MarketAction {
-    Deposit = 0,
-    Borrow = 1,
-    Withdraw = 2,
-    Repay = 3,
-    EnableCollateral = 4,
-    DisableCollateral = 5
-}
-export declare type HypotheticalStats = {
-    newBorrowLimit: CurrencyAmount;
-    newBorrowUtilization: number;
-};
-export declare type AccountAuTokenInfo = {
-    token: string;
-    deposit: BigNumber;
-    borrow: BigNumber;
-};
-export declare type AccountAuTokensInfo = {
-    address: string;
-    tokens: AccountAuTokenInfo[];
-};
-export declare type AuTokenWithUnderlying = AuToken & {
-    underlying: string;
-};
-export declare type ReferralReward = {
-    campaign: string;
-    /**
-     * Truncated user address.
-     */
-    userAddr: 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;
-    refereeAddress: string | null;
-};
-export declare type PlyGameBetResult = {
-    player: string;
-    /**
-     * Bet outcome result
-     */
-    outcome: string;
-    /**
-     * ply lost amount
-     */
-    lostAmount: TokenAmount;
-    unlockedPulpAmount: TokenAmount;
-    block: number;
-    timestamp: number;
-    /**
-     * hash of the transaction on aurorascan (if no, return null)
-     */
-    transactionHash: string;
-};
-export declare type PlyGameLeaderboardItem = {
-    player: string;
-    gamesPlayed: number;
-    unlockedPulpAmount: TokenAmount;
-};
-export declare type PlyBetMadeEvent = TypedEvent<[string, BN, number] & {
-    player: string;
-    amount: BN;
-    outcome: number;
-}>;
-export declare type Apy = {
-    sum: BigNumber;
-    suppliedValue: BigNumber;
-    borrowedValue: BigNumber;
-};
-export declare type UserNotification = {
-    message: string;
-    userSetting: {
-        address: Address;
-        mail: string;
-        utilisation: number;
-        liquidation: boolean;
-    }[];
-};
-export declare type LiquidationEventEntity = {
-    liquidator: string;
-    borrower: string;
-    /** bigint string */
-    repayAmount: string;
-    marketRepayToken: string;
-    /** bigint string */
-    seizeTokens: string;
-    auTokenCollateral: string;
-    txnHash: string;
-    blockNumber: number;
-};
-export declare type LiquidationDetail = {
-    liquidationTime: Timestamp;
-    tokenAmount: TokenAmount;
-    transactionId: string;
-};
-export declare type Timestamp = number;
+import { AuToken } from '@aurigami/contracts/typechain';
+import { TypedEvent } from '@aurigami/contracts/typechain/common';
+import type { BlockTag } from '@ethersproject/abstract-provider';
+import BigNumber from 'bignumber.js';
+import type { Contract, providers, Signer } from 'ethers';
+import { BigNumber as BN } from 'ethers';
+import { TokenAmount } from '../entities/tokenAmount';
+export declare enum ComptrollerRewardType {
+    PLY = 0,
+    AURORA = 1
+}
+export type NetworkConnection = {
+    provider: providers.Provider;
+    signer?: Signer;
+};
+export type Address = string;
+export type CurrencyAmount = {
+    currency: string;
+    amount: string;
+};
+export type TokenValuation = {
+    tokenAmount: TokenAmount;
+    currencyAmount: CurrencyAmount;
+};
+export type MoneyMarketDetails = {
+    auTokenAddress: string;
+    totalTokenDeposited: TokenAmount;
+    totalTokenBorrowed: TokenAmount;
+    depositApy: number;
+    depositPlyApy: number;
+    borrowApy: number;
+    borrowPlyApy: number;
+    collateralRatio: number;
+    depositPlyPerWeek: TokenAmount;
+    borrowPlyPerWeek: TokenAmount;
+    depositMETAApy: number;
+    depositNEARApy: number;
+    borrowNEARApy: number;
+    staderDepositApy: number;
+};
+export type UserDetails = {
+    markets: UserMarketDetails[];
+    borrowLimit: CurrencyAmount;
+    borrowableAmount: CurrencyAmount;
+};
+export type UserLockingDetails = {
+    vestingStart: number;
+    currentUnlockPortion: number;
+    accruedPly: TokenAmount;
+    currentPly: TokenAmount;
+    currentPulp: TokenAmount;
+    nextUnlockPortion: number;
+    nextPly: TokenAmount;
+    nextPulp: TokenAmount;
+};
+export type UserMarketDetails = {
+    market: string;
+    depositBalance: TokenAmount;
+    borrowBalance: TokenAmount;
+    isCollateral: boolean;
+    maxWithdrawableAmount: TokenAmount;
+    collateralRatio: number;
+    underlyingPrice: string;
+};
+export type TokenAPY = {
+    address: string;
+    apy: string;
+};
+export type PLYWNEARPoolDetails = {
+    totalStakedLiquidity: TokenAmount;
+    APYs: TokenAPY[];
+};
+export type MulticallOverrides = {
+    blockTag?: BlockTag | Promise<BlockTag>;
+};
+type ConcatTuple<A extends any[], B extends any[]> = [...A, ...B];
+type RemoveLastOptionalParam<Fn extends (...params: any[]) => any> = Fn extends (...params: [...infer Head, any?]) => infer R ? (...params: Head) => R : Fn;
+type AddParams<Fn extends (...params: any[]) => any, P extends any[]> = Fn extends (...params: infer Params) => infer R ? (...params: ConcatTuple<Params, P>) => R : Fn;
+export type MulticallStatic<T extends Contract> = {
+    callStatic: {
+        [P in keyof T['callStatic']]: AddParams<RemoveLastOptionalParam<T['callStatic'][P]>, [
+            multicallOverrides?: MulticallOverrides
+        ]>;
+    };
+    address: string;
+    raw: T;
+};
+export declare enum MarketAction {
+    Deposit = 0,
+    Borrow = 1,
+    Withdraw = 2,
+    Repay = 3,
+    EnableCollateral = 4,
+    DisableCollateral = 5
+}
+export type HypotheticalStats = {
+    newBorrowLimit: CurrencyAmount;
+    newBorrowUtilization: number;
+};
+export type AccountAuTokenInfo = {
+    token: string;
+    deposit: BigNumber;
+    borrow: BigNumber;
+};
+export type AccountAuTokensInfo = {
+    address: string;
+    tokens: AccountAuTokenInfo[];
+};
+export type AuTokenWithUnderlying = MulticallStatic<AuToken> & {
+    underlying: string;
+};
+export type ReferralReward = {
+    campaign: string;
+    userAddr: string;
+    startTime: number;
+    endTime: number;
+    isReferrer: boolean;
+    rewardTokenAmount: TokenAmount;
+    transactionHash: string | null;
+    refereeAddress: string | null;
+};
+export type PlyGameBetResult = {
+    player: string;
+    outcome: string;
+    lostAmount: TokenAmount;
+    unlockedPulpAmount: TokenAmount;
+    block: number;
+    timestamp: number;
+    transactionHash: string;
+};
+export type PlyGameLeaderboardItem = {
+    player: string;
+    gamesPlayed: number;
+    unlockedPulpAmount: TokenAmount;
+};
+export type PlyBetMadeEvent = TypedEvent<[
+    string,
+    BN,
+    number
+] & {
+    player: string;
+    amount: BN;
+    outcome: number;
+}>;
+export type Apy = {
+    sum: BigNumber;
+    suppliedValue: BigNumber;
+    borrowedValue: BigNumber;
+};
+export type UserNotification = {
+    message: string;
+    userSetting: {
+        address: Address;
+        mail: string;
+        utilisation: number;
+        liquidation: boolean;
+    }[];
+};
+export type LiquidationEventEntity = {
+    liquidator: string;
+    borrower: string;
+    repayAmount: string;
+    marketRepayToken: string;
+    seizeTokens: string;
+    auTokenCollateral: string;
+    txnHash: string;
+    blockNumber: number;
+};
+export type LiquidationDetail = {
+    liquidationTime: Timestamp;
+    tokenAmount: TokenAmount;
+    transactionId: string;
+};
+export type Timestamp = number;
+export {};

package/dist/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarketAction = exports.ComptrollerRewardType = void 0;
+var ComptrollerRewardType;
+(function (ComptrollerRewardType) {
+    ComptrollerRewardType[ComptrollerRewardType["PLY"] = 0] = "PLY";
+    ComptrollerRewardType[ComptrollerRewardType["AURORA"] = 1] = "AURORA";
+})(ComptrollerRewardType || (exports.ComptrollerRewardType = ComptrollerRewardType = {}));
+var MarketAction;
+(function (MarketAction) {
+    MarketAction[MarketAction["Deposit"] = 0] = "Deposit";
+    MarketAction[MarketAction["Borrow"] = 1] = "Borrow";
+    MarketAction[MarketAction["Withdraw"] = 2] = "Withdraw";
+    MarketAction[MarketAction["Repay"] = 3] = "Repay";
+    MarketAction[MarketAction["EnableCollateral"] = 4] = "EnableCollateral";
+    MarketAction[MarketAction["DisableCollateral"] = 5] = "DisableCollateral";
+})(MarketAction || (exports.MarketAction = MarketAction = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBUUEsSUFBWSxxQkFHWDtBQUhELFdBQVkscUJBQXFCO0lBQy9CLCtEQUFPLENBQUE7SUFDUCxxRUFBTSxDQUFBO0FBQ1IsQ0FBQyxFQUhXLHFCQUFxQixxQ0FBckIscUJBQXFCLFFBR2hDO0FBb0hELElBQVksWUFPWDtBQVBELFdBQVksWUFBWTtJQUN0QixxREFBVyxDQUFBO0lBQ1gsbURBQU0sQ0FBQTtJQUNOLHVEQUFRLENBQUE7SUFDUixpREFBSyxDQUFBO0lBQ0wsdUVBQWdCLENBQUE7SUFDaEIseUVBQWlCLENBQUE7QUFDbkIsQ0FBQyxFQVBXLFlBQVksNEJBQVosWUFBWSxRQU92QiJ9

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.23.1",
+  "version": "1.24.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "start": "tsdx watch",
-    "build": "tsdx build",
+    "build": "tsc -p ./tsconfig.build.json ",
     "test": "tsdx test --no-cache",
     "w-hardhat": "env TS_NODE_PROJECT=\"test-hardhat/tsconfig.json\" yarn hardhat",
     "lint": "prettier --check \"{src,test,test-hardhat}/**/*.{js,ts}\"",
@@ -58,7 +58,7 @@
     "ts-node": "^10.7.0",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",
-    "typescript": "^4.5.4"
+    "typescript": "^5.0.2"
   },
   "dependencies": {
     "@aurigami/contracts": "3.21.0",

package/src/SDK.ts

@@ -187,7 +187,7 @@ export class SdkReadWrite extends SdkRead {
    * Claim rewards in all markets + staking pools
    */
   public async claim(): Promise<TransactionResponse> {
-    return this.env.auriLens
+    return this.env.auriLens.raw
       .connect(this._networkConnection.signer!)
       .claimRewards(
         this.env.comptroller.address,

package/src/entities/auriEnv.ts

@@ -1,5 +1,6 @@
 import {
   AuErc20,
+  AuToken,
   AuriAirdrop,
   AuriFairLaunch,
   AuriInternalLens,
@@ -16,32 +17,33 @@ import { Contract } from 'ethers';
 import * as abis from '../abis';
 import { networkAddresses } from '../consts/constants';
 import { assert } from '../helpers/helpers';
-import { AuTokenWithUnderlying } from '../types';
+import { createContract } from '../helpers/multicall';
+import { AuTokenWithUnderlying, MulticallStatic } from '../types';
 import { BlockchainEntityRead } from './BlockchainEntity';
 
 export class AuriEnv extends BlockchainEntityRead {
-  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 _referralDirectoryV2: ReferralDirectoryV2 | null = null;
-  private _oracle: AuriOracle | null = null;
-  private _plygame: PlyGame | null = null;
-  private _plyTokenLock: PlyTokenLock | null = null;
+  private _comptroller: MulticallStatic<Comptroller> | null = null;
+  private _auriFairLaunch: MulticallStatic<AuriFairLaunch> | null = null;
+  private _auriLens: MulticallStatic<AuriLens> | null = null;
+  private _ply: MulticallStatic<IERC20> | null = null;
+  private _pulp: MulticallStatic<PULP> | null = null;
+  private _auriInternalLens: MulticallStatic<AuriInternalLens> | null = null;
+  private _auriAirdrop: MulticallStatic<AuriAirdrop> | null = null;
+  private _referralDirectoryV2: MulticallStatic<ReferralDirectoryV2> | null = null;
+  private _oracle: MulticallStatic<AuriOracle> | null = null;
+  private _plygame: MulticallStatic<PlyGame> | null = null;
+  private _plyTokenLock: MulticallStatic<PlyTokenLock> | null = null;
 
   public getContract<CType extends Contract>(address: string, abi: any) {
-    return new Contract(address, abi, this._networkConnection.provider) as CType;
+    return createContract<CType>(address, abi, this._networkConnection.provider);
   }
 
   public getAuTokenContracts(): AuTokenWithUnderlying[] {
     return networkAddresses.auTokens.map((auToken) => {
-      const contract = this.getContract<AuTokenWithUnderlying>(
+      const contract = this.getContract<AuToken>(
         auToken.address,
         abis.AuTokenABI.abi
-      );
+      ) as AuTokenWithUnderlying;
       contract.underlying = auToken.underlying;
       return contract;
     });
@@ -59,7 +61,7 @@ export class AuriEnv extends BlockchainEntityRead {
   }: {
     address?: string;
     underlyingName?: string;
-  }): AuErc20 {
+  }) {
     assert(
       address !== undefined || underlyingName !== undefined,
       'Either address or underlyingName must be provided'
@@ -75,7 +77,7 @@ export class AuriEnv extends BlockchainEntityRead {
     return this.getContract<AuErc20>(address!, abis.AuErc20ABI.abi);
   }
 
-  get comptroller(): Comptroller {
+  get comptroller() {
     if (!this._comptroller) {
       this._comptroller = this.getContract<Comptroller>(
         networkAddresses.misc.COMPTROLLER,
@@ -85,7 +87,7 @@ export class AuriEnv extends BlockchainEntityRead {
     return this._comptroller;
   }
 
-  get auriFairLaunch(): AuriFairLaunch {
+  get auriFairLaunch() {
     if (!this._auriFairLaunch) {
       this._auriFairLaunch = this.getContract<AuriFairLaunch>(
         networkAddresses.misc.AURIFAIRLAUNCH,
@@ -95,7 +97,7 @@ export class AuriEnv extends BlockchainEntityRead {
     return this._auriFairLaunch;
   }
 
-  get auriLens(): AuriLens {
+  get auriLens() {
     if (!this._auriLens) {
       this._auriLens = this.getContract<AuriLens>(
         networkAddresses.misc.AURILENS,
@@ -105,21 +107,21 @@ export class AuriEnv extends BlockchainEntityRead {
     return this._auriLens;
   }
 
-  get ply(): IERC20 {
+  get ply() {
     if (!this._ply) {
       this._ply = this.getContract<IERC20>(networkAddresses.tokens.PLY, abis.EIP20InterfaceABI.abi);
     }
     return this._ply;
   }
 
-  get pulp(): PULP {
+  get pulp() {
     if (!this._pulp) {
       this._pulp = this.getContract<PULP>(networkAddresses.tokens.PULP, abis.PulpABI.abi);
     }
     return this._pulp;
   }
 
-  get auriInternalLens(): AuriInternalLens {
+  get auriInternalLens() {
     if (!this._auriInternalLens) {
       this._auriInternalLens = this.getContract<AuriInternalLens>(
         networkAddresses.misc.AURI_INTERNAL_LENS,
@@ -129,7 +131,7 @@ export class AuriEnv extends BlockchainEntityRead {
     return this._auriInternalLens;
   }
 
-  get auriAirdrop(): AuriAirdrop {
+  get auriAirdrop() {
     if (!this._auriAirdrop) {
       this._auriAirdrop = this.getContract<AuriAirdrop>(
         networkAddresses.misc.AURI_AIRDROP,
@@ -139,7 +141,7 @@ export class AuriEnv extends BlockchainEntityRead {
     return this._auriAirdrop;
   }
 
-  get referralDirectoryV2(): ReferralDirectoryV2 {
+  get referralDirectoryV2() {
     if (!this._referralDirectoryV2) {
       this._referralDirectoryV2 = this.getContract<ReferralDirectoryV2>(
         networkAddresses.misc.REFERRAL_V2,
@@ -149,7 +151,7 @@ export class AuriEnv extends BlockchainEntityRead {
     return this._referralDirectoryV2;
   }
 
-  get oracle(): AuriOracle {
+  get oracle() {
     if (!this._oracle) {
       this._oracle = this.getContract<AuriOracle>(
         networkAddresses.misc.PYTH_ORACLE,
@@ -159,14 +161,14 @@ export class AuriEnv extends BlockchainEntityRead {
     return this._oracle;
   }
 
-  get plygame(): PlyGame {
+  get plygame() {
     if (!this._plygame) {
       this._plygame = this.getContract<PlyGame>(networkAddresses.misc.PLYGAME, abis.PlyGameABI.abi);
     }
     return this._plygame;
   }
 
-  get plyTokenLock(): PlyTokenLock {
+  get plyTokenLock() {
     if (!this._plyTokenLock) {
       this._plyTokenLock = this.getContract<PlyTokenLock>(
         networkAddresses.misc.PLY_TOKEN_LOCK,

package/src/helpers/historicalPriceFetcher.ts

@@ -1,10 +1,11 @@
 import { IUniswapV2Pair, PriceOracle } from '@aurigami/contracts/typechain';
 import BigNumber from 'bignumber.js';
-import { BigNumber as BN, Contract, providers } from 'ethers';
+import { BigNumber as BN, providers } from 'ethers';
 import { AuriOracleABI, IUniswapV2PairABI } from '../abis';
 import { HARDCODE_PRICE_TOKENS, networkAddresses } from '../consts/constants';
 import { Address } from '../types';
 import { decimalFactor, devLog, getDecimal, isSameAddress } from './helpers';
+import { createContract } from './multicall';
 
 export async function fetchHistoricalLPPositions(
   LPAddress: Address,
@@ -17,12 +18,12 @@ export async function fetchHistoricalLPPositions(
   reserve1: BN;
   totalSupply: BN;
 }> {
-  const LPContract = new Contract(LPAddress, IUniswapV2PairABI.abi, provider) as IUniswapV2Pair;
+  const LPContract = createContract<IUniswapV2Pair>(LPAddress, IUniswapV2PairABI.abi, provider);
   var promises: any[] = [];
-  promises.push(LPContract.token0());
-  promises.push(LPContract.token1());
-  promises.push(LPContract.getReserves({ blockTag: block }));
-  promises.push(LPContract.totalSupply({ blockTag: block }));
+  promises.push(LPContract.callStatic.token0());
+  promises.push(LPContract.callStatic.token1());
+  promises.push(LPContract.callStatic.getReserves({ blockTag: block }));
+  promises.push(LPContract.callStatic.totalSupply({ blockTag: block }));
   const values: any[] = await Promise.all(promises);
 
   return {
@@ -111,12 +112,8 @@ export async function fetchHistoricalPriceFromOracle(
       ? networkAddresses.misc.DEPRECATED_OLD_ORACLE
       : networkAddresses.misc.PYTH_ORACLE;
 
-  const oracleContract: PriceOracle = new Contract(
-    oracleAddress,
-    AuriOracleABI.abi,
-    provider
-  ) as PriceOracle;
-  const rawPrice = await oracleContract
+  const oracleContract = createContract<PriceOracle>(oracleAddress, AuriOracleABI.abi, provider);
+  const rawPrice = await oracleContract.callStatic
     .getUnderlyingPrice(auTokenAddress, { blockTag: block })
     .catch((e: any) => {
       console.log(`Unable to fetch price from oracle for ${auTokenAddress}`);