@aurigami/sdk 1.23.0 → 1.24.0

package/src/interactors/PlyGame.ts

@@ -56,14 +56,14 @@ export class PlyGameRead extends BlockchainEntityRead {
    * Get 100 most recent bets of the market users
    */
   public async getUserPlyGameHistory(user: Address): Promise<PlyGameBetResult[]> {
-    let block100 = await this.env.plygame.getLastBlock(user, 100);
+    let block100 = await this.env.plygame.callStatic.getLastBlock(user, 100);
 
     if (block100.eq(0)) {
       return [];
     }
 
-    let filter = this.env.plygame.filters.BetMade(user);
-    let events = await this.env.plygame.queryFilter(filter, block100.toNumber());
+    let filter = this.env.plygame.raw.filters.BetMade(user);
+    let events = await this.env.plygame.raw.queryFilter(filter, block100.toNumber());
     // Sort descending by block number
     sortEvents(events).reverse();
     return this.attachTimestamp(events.map((event) => this.parseBetMakeEvent(event)));
@@ -73,12 +73,12 @@ export class PlyGameRead extends BlockchainEntityRead {
    * Get current jackpot amount
    */
   public async currentJackpotAmount(): Promise<TokenAmount> {
-    let jackpot = await this.env.plygame.currentJackpotAmount();
+    let jackpot = await this.env.plygame.callStatic.currentJackpotAmount();
     return new TokenAmount(this.plyToken, jackpot.toString());
   }
 
   public async earlyUnlockedPulpAmount(user: Address): Promise<TokenAmount> {
-    let earlyUnlockedPulpAmount = await this.env.plygame.totalPlyUnlockedEarly(user);
+    let earlyUnlockedPulpAmount = await this.env.plygame.callStatic.totalPlyUnlockedEarly(user);
     return new TokenAmount(this.pulpToken, earlyUnlockedPulpAmount.toString());
   }
 
@@ -96,11 +96,11 @@ export class PlyGameRead extends BlockchainEntityRead {
       throw new Error(`Transaction ${txHash} takes too long to be mined`);
     }
 
-    let filter = this.env.plygame.filters.BetMade();
+    let filter = this.env.plygame.raw.filters.BetMade();
     let betMadeEvents: PlyBetMadeEvent[] = tx.logs
       .filter((log) => isSameAddress(log.topics[0], filter.topics![0] as string))
       .map((log) => ({
-        ...this.env.plygame.interface.parseLog(log),
+        ...this.env.plygame.raw.interface.parseLog(log),
         blockNumber: tx.blockNumber,
         transactionHash: txHash,
       })) as unknown as PlyBetMadeEvent[];
@@ -125,7 +125,7 @@ export class PlyGameRead extends BlockchainEntityRead {
     let round = BN.from(
       await this._networkConnection.provider.getStorageAt(this.env.plygame.address, 158)
     );
-    let result = await this.env.plygame.jackpotHistory(round.sub(1));
+    let result = await this.env.plygame.callStatic.jackpotHistory(round.sub(1));
     return {
       winner: result.winner.slice(0, 5) + '...' + result.winner.slice(-3),
       amount: new TokenAmount(this.plyToken, result.amount.toString()),
@@ -147,13 +147,13 @@ export class PlyGameReadWrite extends PlyGameRead {
    * Make a single bet
    */
   public async makeBetOnce(amount: TokenAmount): Promise<TransactionResponse> {
-    return this.env.plygame
+    return this.env.plygame.raw
       .connect(this._networkConnection.signer!)
       .makeBetOnce(amount.rawAmount());
   }
 
   public async approve(amount: TokenAmount): Promise<TransactionResponse> {
-    return this.env.ply
+    return this.env.ply.raw
       .connect(this._networkConnection.signer!)
       .approve(this.env.plygame.address, amount.rawAmount());
   }

package/src/interactors/PlyTokenLock.ts

@@ -1,5 +1,5 @@
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { BigNumber as BN, utils } from 'ethers';
+import { BigNumber as BN } from 'ethers';
 import {
   AuriEnv,
   BlockchainEntity,
@@ -8,7 +8,6 @@ import {
   Token,
   TokenAmount,
 } from '../entities';
-import * as helpers from '../helpers';
 import { Address, NetworkConnection } from '../types';
 
 export class PlyTokenLockRead extends BlockchainEntityRead {
@@ -28,7 +27,7 @@ export class PlyTokenLockRead extends BlockchainEntityRead {
 export class PlyTokenLockReadWrite extends PlyTokenLockRead {
   public async claim(recipient: Address, amount: TokenAmount): Promise<TransactionResponse> {
     const amountToClaim = BN.from(amount.rawAmount());
-    return await this.env.plyTokenLock
+    return await this.env.plyTokenLock.raw
       .connect(this._networkConnection.signer!)
       .claim(recipient, amountToClaim);
   }

package/src/interactors/Pulp.ts

@@ -12,7 +12,7 @@ export class PulpRead extends BlockchainEntityRead {
   }
 
   public async remainingEarlyUnlockPulp(user: Address): Promise<BN> {
-    return this.env.pulp.earlyRedeems(user);
+    return this.env.pulp.callStatic.earlyRedeems(user);
   }
 }
 
@@ -22,7 +22,9 @@ export class PulpReadWrite extends PulpRead {
     amount: TokenAmount
   ): Promise<TransactionResponse> {
     const amountToRedeem = BN.from(amount.rawAmount());
-    return this.env.pulp.connect(this._networkConnection.signer!).redeem(recipient, amountToRedeem);
+    return this.env.pulp.raw
+      .connect(this._networkConnection.signer!)
+      .redeem(recipient, amountToRedeem);
   }
 }
 

package/src/interactors/Referral.ts

@@ -34,7 +34,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.env.referralDirectoryV2.userReferralCode(userAddr);
+    const result = await this.env.referralDirectoryV2.raw.userReferralCode(userAddr);
     return ethers.utils.parseBytes32String(result);
   }
 
@@ -42,7 +42,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.env.referralDirectoryV2.referralCodeUsed(userAddr);
+    const result = await this.env.referralDirectoryV2.raw.referralCodeUsed(userAddr);
     return ethers.utils.parseBytes32String(result);
   }
 
@@ -51,7 +51,7 @@ export class ReferralRead extends BlockchainEntityRead {
    */
   public async getReferralCodeOwner(code: string): Promise<Address> {
     const referralCode = ethers.utils.formatBytes32String(code);
-    return this.env.referralDirectoryV2.referralCodeOwner(referralCode);
+    return this.env.referralDirectoryV2.raw.referralCodeOwner(referralCode);
   }
 
   /**
@@ -143,7 +143,7 @@ export class ReferralRead extends BlockchainEntityRead {
   }
 
   public async isWhitelistedAddress(address: Address): Promise<boolean> {
-    let result = await this.env.referralDirectoryV2.isUserWhitelisted(address);
+    let result = await this.env.referralDirectoryV2.raw.isUserWhitelisted(address);
     return result.eq(1);
   }
 
@@ -172,7 +172,7 @@ export class ReferralReadWrite extends ReferralRead {
    */
   public async registerNewReferralCode(): Promise<TransactionResponse> {
     const referralCode = ethers.utils.formatBytes32String(this.generateReferralCode());
-    return this.env.referralDirectoryV2
+    return this.env.referralDirectoryV2.raw
       .connect(this._networkConnection.signer!)
       .registerNewUserReferralCode(referralCode);
   }
@@ -182,7 +182,7 @@ export class ReferralReadWrite extends ReferralRead {
    */
   public async useReferralCode(code: string): Promise<TransactionResponse> {
     const referralCode = ethers.utils.formatBytes32String(code);
-    return this.env.referralDirectoryV2
+    return this.env.referralDirectoryV2.raw
       .connect(this._networkConnection.signer!)
       .registerReferralCodeUsed(referralCode);
   }

package/src/interactors/Staking.ts

@@ -1,7 +1,7 @@
 import { IERC20 } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
 import BigNumber from 'bignumber.js';
-import { BigNumber as BN, Contract } from 'ethers';
+import { BigNumber as BN } from 'ethers';
 import { EIP20InterfaceABI } from '../abis';
 import * as consts from '../consts';
 import {
@@ -13,6 +13,7 @@ import {
   TokenAmount,
 } from '../entities';
 import { calcLMRewardApr, getDecimal } from '../helpers';
+import { createContract } from '../helpers/multicall';
 import { fetchValuation } from '../helpers/priceFetcher';
 import { NetworkConnection, PLYWNEARPoolDetails, TokenAPY } from '../types';
 
@@ -24,7 +25,7 @@ export class StakingRead extends BlockchainEntityRead {
   }
 
   public async getPLYWNEARPoolDetails(): Promise<PLYWNEARPoolDetails> {
-    const { stakedLiquidity, rewardPerSeconds } = await this.env.auriFairLaunch
+    const { stakedLiquidity, rewardPerSeconds } = await this.env.auriFairLaunch.callStatic
       .getPoolInfo(consts.PLYWNEAR_POOL_ID)
       .then((res) => {
         const endedTime = res.endTime;
@@ -87,7 +88,10 @@ export class StakingRead extends BlockchainEntityRead {
    * Get amount of staked LP tokens
    */
   public async stakeBalanceOf(user: string): Promise<TokenAmount> {
-    const userInfo = await this.env.auriFairLaunch.getUserInfo(consts.PLYWNEAR_POOL_ID, user);
+    const userInfo = await this.env.auriFairLaunch.callStatic.getUserInfo(
+      consts.PLYWNEAR_POOL_ID,
+      user
+    );
     return new TokenAmount(PLYWNEARToken, userInfo.amount.toString());
   }
 
@@ -95,18 +99,18 @@ export class StakingRead extends BlockchainEntityRead {
    * Get amount of LP token in user wallet
    */
   public async LpBalanceOf(user: string): Promise<TokenAmount> {
-    let lpContract = new Contract(
+    let lpContract = createContract<IERC20>(
       consts.networkAddresses.tokens.PLYWNEAR,
       EIP20InterfaceABI.abi,
       this._networkConnection.provider
-    ) as IERC20;
-    let balance = await lpContract.balanceOf(user);
+    );
+    let balance = await lpContract.callStatic.balanceOf(user);
 
     return new TokenAmount(PLYWNEARToken, balance.toString());
   }
 
   public async unclaimedRewardsOf(user: string): Promise<TokenAmount[]> {
-    let userInfo = await this.env.auriFairLaunch.callStatic.updateAndGetUserInfo(
+    let userInfo = await this.env.auriFairLaunch.raw.callStatic.updateAndGetUserInfo(
       consts.PLYWNEAR_POOL_ID,
       user,
       { from: user }
@@ -121,7 +125,7 @@ export class StakingRead extends BlockchainEntityRead {
 
 export class StakingReadWrite extends StakingRead {
   public async stake(amount: TokenAmount): Promise<TransactionResponse> {
-    return this.env.auriFairLaunch
+    return this.env.auriFairLaunch.raw
       .connect(this._networkConnection.signer!)
       .deposit(consts.PLYWNEAR_POOL_ID, amount.rawAmount());
   }
@@ -132,7 +136,7 @@ export class StakingReadWrite extends StakingRead {
     const stakedAmount = BN.from((await this.stakeBalanceOf(msgSender)).rawAmount());
     // unstakeAmount = min(amountInput, stakedAmount - 1)
     const unstakeAmount = amountInput.lt(stakedAmount) ? amountInput : stakedAmount.sub(1);
-    return this.env.auriFairLaunch
+    return this.env.auriFairLaunch.raw
       .connect(this._networkConnection.signer!)
       .withdraw(consts.PLYWNEAR_POOL_ID, unstakeAmount);
   }

package/src/interactors/misc.ts

@@ -47,7 +47,7 @@ export class MiscRead extends BlockchainEntityRead {
       userMarketDetail.underlyingPrice = underlyingPrice.toString();
     }
 
-    assetsIn = await this.env.comptroller.getAssetsIn(userAddress);
+    assetsIn = await this.env.comptroller.raw.getAssetsIn(userAddress);
 
     var depositValues = [];
     for (var i = 0; i < marketCount; i++) {
@@ -74,7 +74,9 @@ export class MiscRead extends BlockchainEntityRead {
       return p;
     }, new BigNumber(0));
 
-    var accountLiquidity: [BN, BN] = await this.env.comptroller.getAccountLiquidity(userAddress);
+    var accountLiquidity: [BN, BN] = await this.env.comptroller.raw.getAccountLiquidity(
+      userAddress
+    );
 
     var borrowedvaluation: BigNumber = totalBorrowLimit.minus(
       new BigNumber(accountLiquidity[0].toString()).div(decimalFactor(18))
@@ -294,7 +296,7 @@ export class MiscRead extends BlockchainEntityRead {
     const tokens = tokenAddresses.map((addr) =>
       this.env.getContract<AuToken>(addr, abis.AuTokenABI.abi)
     );
-    const prices = await oracle.getUnderlyingPrices(tokenAddresses);
+    const prices = await oracle.callStatic.getUnderlyingPrices(tokenAddresses);
     const exrate = await this.env.auriInternalLens.callStatic.getExchangeRates(tokenAddresses);
 
     const res: types.AccountAuTokensInfo[] = [];
@@ -302,7 +304,7 @@ export class MiscRead extends BlockchainEntityRead {
     for (let addr of accounts) {
       const infos: types.AccountAuTokenInfo[] = [];
       for (let i = 0; i < tokens.length; ++i) {
-        const snapshot = await tokens[i].getAccountSnapshot(addr);
+        const snapshot = await tokens[i].callStatic.getAccountSnapshot(addr);
         const bal = snapshot[0].mul(exrate[i]).div(_1E18).mul(prices[i]).div(_1E18);
         const bor = snapshot[1].mul(prices[i]).div(_1E18);
 
@@ -329,7 +331,7 @@ export class MiscRead extends BlockchainEntityRead {
     let totalSuppliedValue = new BigNumber(0);
     let totalBorrowedValue = new BigNumber(0);
     let collateralValue = new BigNumber(0);
-    const assetsIn = await this.env.comptroller.getAssetsIn(userAddr);
+    const assetsIn = await this.env.comptroller.callStatic.getAssetsIn(userAddr);
     const marketValues = await Promise.all(
       consts.networkAddresses.auTokens.map(async (auToken) => {
         const moneyMarket: MoneyMarketRead = new MoneyMarketRead(

package/src/types/index.ts

@@ -1,7 +1,8 @@
 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 { providers, Signer } from 'ethers';
+import type { Contract, providers, Signer } from 'ethers';
 import { BigNumber as BN } from 'ethers';
 import { TokenAmount } from '../entities/tokenAmount';
 
@@ -95,6 +96,35 @@ export type PLYWNEARPoolDetails = {
   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 enum MarketAction {
   Deposit = 0,
   Borrow,
@@ -120,7 +150,7 @@ export type AccountAuTokensInfo = {
   tokens: AccountAuTokenInfo[];
 };
 
-export type AuTokenWithUnderlying = AuToken & {
+export type AuTokenWithUnderlying = MulticallStatic<AuToken> & {
   underlying: string;
 };