@strkfarm/sdk 2.0.0-dev.27 → 2.0.0-dev.28

package/src/strategies/universal-adapters/baseAdapter.ts

@@ -1,251 +1,263 @@
-import { Call, hash, num, shortString } from "starknet";
-import { SIMPLE_SANITIZER, toBigInt } from "./adapter-utils";
-import { ContractAddr, Web3Number } from "@/dataTypes";
-import { IConfig, IProtocol, TokenInfo } from "@/interfaces";
-import { PricerBase } from "@/modules/pricerBase";
-import { LeafData, logger, StandardMerkleTree } from "@/utils";
-import { CacheClass } from "@/utils/cacheClass";
-
-export interface ManageCall {
-  sanitizer: ContractAddr,
-  call: {
-    contractAddress: ContractAddr,
-    selector: string,
-    calldata: bigint[]
-  }
-}
-
-
-export interface DepositParams {
-  amount: Web3Number;
-}
-
-export interface WithdrawParams {
-  amount: Web3Number;
-}
-
-// export type GenerateCallFn<T> = (params: T) => ManageCall;
-// export type AdapterLeafType<T> = {leaf: LeafData, callConstructor: GenerateCallFn<T>}
-export type GenerateCallFn<T> = (params: T) => Promise<ManageCall[]>;
-export type AdapterLeafType<T> = {leaves: LeafData[], callConstructor: GenerateCallFn<T>}
-export type LeafAdapterFn<T> = () => AdapterLeafType<T>;
-
-export enum APYType {
-  BASE = "base",
-  REWARD = "reward",
-  LST = "lst"
-}
-
-export interface SupportedPosition {
-  asset: TokenInfo,
-  isDebt: boolean
-}
-
-export interface BaseAdapterConfig {
-  baseToken: TokenInfo,
-  supportedPositions: SupportedPosition[],
-  networkConfig: IConfig,
-  pricer: PricerBase,
-  vaultAllocator: ContractAddr
-  vaultAddress: ContractAddr
-}
-
-export type PositionAPY = { apy: number, type: APYType };
-export type PositionInfo = {
-  tokenInfo: TokenInfo,
-  amount: Web3Number,
-  usdValue: number,
-  remarks: string,
-  apy: PositionAPY,
-  protocol: IProtocol
-};
-
-export type PositionAmount = {
-  amount: Web3Number,
-  remarks: string,
-}
-
-export abstract class BaseAdapter<DepositParams, WithdrawParams> extends CacheClass {
-  readonly name: string;
-  readonly config: BaseAdapterConfig;
-  readonly protocol: IProtocol;
-
-  constructor(config: BaseAdapterConfig, name: string, protocol: IProtocol) {
-    super();
-    this.config = config;
-    this.name = name;
-    this.protocol = protocol;
-  }
-
-  /**
-   * Loop through all supported positions and return amount, usd value, remarks and apy for each
-   */
-  async getPositions(): Promise<PositionInfo[]> {
-    const results: PositionInfo[] = [];
-    for (const supported of this.config.supportedPositions) {
-      const amount = await this.getPosition(supported);
-      const usdValue = await this.getUSDValue(supported.asset, amount.amount);
-      const apy = await this.getAPY(supported);
-      results.push({ tokenInfo: supported.asset, amount: amount.amount, usdValue, apy, protocol: this.protocol, remarks: amount.remarks });
-    }
-    return results;
-  }
-
-  /**
-   * Implemented by child adapters to compute APY for a given supported position
-   */
-  protected abstract getAPY(supportedPosition: SupportedPosition): Promise<PositionAPY>;
-
-  /**
-   * Implemented by child adapters to fetch amount for a given supported position
-   */
-  protected abstract getPosition(supportedPosition: SupportedPosition): Promise<PositionAmount>;
-
-  /**
-   * Implemented by child adapters to calculate maximum deposit positions
-   * @param amount Optional amount in baseToken to deposit
-   */
-  abstract maxDeposit(amount?: Web3Number): Promise<PositionInfo>;
-
-  /**
-   * Implemented by child adapters to calculate maximum withdraw positions
-   */
-  abstract maxWithdraw(): Promise<PositionInfo>;
-
-  /**
-   * Uses pricer to convert an amount of an asset to USD value
-   */
-  protected async getUSDValue(asset: TokenInfo, amount: Web3Number): Promise<number> {
-    const priceInfo = await this.config.pricer.getPrice(asset.symbol);
-    return amount.toNumber() * priceInfo.price;
-  }
-
-  
-  protected constructSimpleLeafData(params: {
-    id: string,
-    target: ContractAddr,
-    method: string,
-    packedArguments: bigint[],
-  }, sanitizer: ContractAddr = SIMPLE_SANITIZER): LeafData {
-    const { id, target, method, packedArguments } = params;
-    return {
-      id: BigInt(num.getDecimalString(shortString.encodeShortString(id))),
-      readableId: id,
-      data: [
-        sanitizer.toBigInt(), // sanitizer address
-        target.toBigInt(), // contract
-        toBigInt(hash.getSelectorFromName(method)), // method name
-        BigInt(packedArguments.length),
-        ...packedArguments
-      ]
-    };
-  }
-
-  /**
-   * Implementor must provide target/method/packedArguments/sanitizer for deposit leaf construction
-   */
-  protected abstract _getDepositLeaf(): {
-    target: ContractAddr,
-    method: string,
-    packedArguments: bigint[],
-    sanitizer: ContractAddr,
-    id: string
-  }[];
-
-  /**
-   * Implementor must provide target/method/packedArguments/sanitizer for withdraw leaf construction
-   */
-  protected abstract _getWithdrawLeaf(): {
-    target: ContractAddr,
-    method: string,
-    packedArguments: bigint[],
-    sanitizer: ContractAddr,
-    id: string
-  }[];
-
-  /**
-   * Returns deposit leaf adapter using configured proof id
-   */
-  getDepositLeaf(): AdapterLeafType<DepositParams> {
-    const leafConfigs = this._getDepositLeaf();
-    const leaves = leafConfigs.map(config => {
-      const { target, method, packedArguments, sanitizer, id } = config;
-      const leaf = this.constructSimpleLeafData({
-        id: id,
-        target,
-        method,
-        packedArguments
-      }, sanitizer);
-      return leaf;
-    });
-    return { leaves, callConstructor: this.getDepositCall.bind(this) as unknown as GenerateCallFn<DepositParams> };
-  }
-
-  /**
-   * Returns withdraw leaf adapter using configured proof id
-   */
-  getWithdrawLeaf(): AdapterLeafType<WithdrawParams> {
-    const leafConfigs = this._getWithdrawLeaf();
-    const leaves = leafConfigs.map(config => {
-      const { target, method, packedArguments, sanitizer, id } = config;
-      const leaf = this.constructSimpleLeafData({
-        id: id,
-        target,
-        method,
-        packedArguments
-      }, sanitizer ?? SIMPLE_SANITIZER);
-      return leaf;
-    });
-    return { leaves, callConstructor: this.getWithdrawCall.bind(this) as unknown as GenerateCallFn<WithdrawParams> };
-  }
-
-  /**
-   * Implementor must provide deposit call
-   * @param params 
-   */
-  abstract getDepositCall(params: DepositParams): Promise<ManageCall[]>;
-
-  /**
-   * Implementor must provide withdraw call
-   * @param params 
-   */
-  abstract getWithdrawCall(params: WithdrawParams): Promise<ManageCall[]>;
-
-
-  getProofs<T>(isDeposit: boolean, tree: StandardMerkleTree): { proofs: string[][], callConstructor: GenerateCallFn<DepositParams> | GenerateCallFn<WithdrawParams> } {
-    let proofGroups: string[][] = [];
-
-    const ids = isDeposit ? this.getDepositLeaf().leaves.map(l => l.readableId) : this.getWithdrawLeaf().leaves.map(l => l.readableId);
-    // console.log(`${this.name}::getProofs ids: ${ids}`);
-    for (const [i, v] of tree.entries()) {
-     // console.log(`${this.name}::getProofs v: ${v.readableId}`);
-      if (ids.includes(v.readableId)) {
-       // console.log(`${this.name}::getProofs found id: ${v.readableId}`);
-        proofGroups.push(tree.getProof(i));
-      }
-    }
-    if (proofGroups.length != ids.length) {
-      throw new Error(`Not all proofs found for IDs: ${ids.join(', ')}`);
-    }
-
-    // find leaf adapter
-    return {
-      proofs: proofGroups,
-      callConstructor: isDeposit ? 
-        this.getDepositCall.bind(this) :
-        this.getWithdrawCall.bind(this)
-      };
-    }
-
-  async getNetAPY(): Promise<number> {
-    const positions = await this.getPositions();
-    logger.verbose(`${this.name}::getNetAPY: positions: ${JSON.stringify(positions)}`);
-    const netAmount = positions.reduce((acc, curr) => acc + curr.usdValue, 0);
-    const netAPY = positions.reduce((acc, curr) => acc + curr.apy.apy * curr.usdValue, 0) / netAmount;
-    logger.verbose(`${this.name}::getNetAPY: netAPY: ${netAPY}`);
-    return netAPY;
-  }
-
-  abstract getHealthFactor(): Promise<number>;
-}
-
+import { Call, hash, num, shortString } from "starknet";
+import { SIMPLE_SANITIZER, toBigInt } from "./adapter-utils";
+import { ContractAddr, Web3Number } from "@/dataTypes";
+import { IConfig, IProtocol, TokenInfo } from "@/interfaces";
+import { PricerBase } from "@/modules/pricerBase";
+import { LeafData, logger, StandardMerkleTree } from "@/utils";
+import { CacheClass } from "@/utils/cacheClass";
+
+export interface ManageCall {
+  proofReadableId: string,
+  sanitizer: ContractAddr,
+  call: {
+    contractAddress: ContractAddr,
+    selector: string,
+    calldata: bigint[]
+  }
+}
+
+export interface SwapPriceInfo {
+  source: 'avnu' | 'ekubo';
+  fromTokenSymbol: string;
+  toTokenSymbol: string;
+  fromAmount: number;
+  toAmount: number;
+  effectivePrice: number;
+}
+
+
+export interface DepositParams {
+  amount: Web3Number;
+}
+
+export interface WithdrawParams {
+  amount: Web3Number;
+}
+
+// export type GenerateCallFn<T> = (params: T) => ManageCall;
+// export type AdapterLeafType<T> = {leaf: LeafData, callConstructor: GenerateCallFn<T>}
+export type GenerateCallFn<T> = (params: T) => Promise<ManageCall[]>;
+export type AdapterLeafType<T> = {leaves: LeafData[], callConstructor: GenerateCallFn<T>}
+export type LeafAdapterFn<T> = () => AdapterLeafType<T>;
+
+export enum APYType {
+  BASE = "base",
+  REWARD = "reward",
+  LST = "lst"
+}
+
+export interface SupportedPosition {
+  asset: TokenInfo,
+  isDebt: boolean
+}
+
+export interface BaseAdapterConfig {
+  baseToken: TokenInfo,
+  supportedPositions: SupportedPosition[],
+  networkConfig: IConfig,
+  pricer: PricerBase,
+  vaultAllocator: ContractAddr
+  vaultAddress: ContractAddr
+}
+
+export type PositionAPY = { apy: number, type: APYType };
+export type PositionInfo = {
+  tokenInfo: TokenInfo,
+  amount: Web3Number,
+  usdValue: number,
+  remarks: string,
+  apy: PositionAPY,
+  protocol: IProtocol
+};
+
+export type PositionAmount = {
+  amount: Web3Number,
+  remarks: string,
+}
+
+export abstract class BaseAdapter<DepositParams, WithdrawParams> extends CacheClass {
+  readonly name: string;
+  readonly config: BaseAdapterConfig;
+  readonly protocol: IProtocol;
+
+  constructor(config: BaseAdapterConfig, name: string, protocol: IProtocol) {
+    super();
+    this.config = config;
+    this.name = name;
+    this.protocol = protocol;
+  }
+
+  /**
+   * Loop through all supported positions and return amount, usd value, remarks and apy for each
+   */
+  async getPositions(): Promise<PositionInfo[]> {
+    const results: PositionInfo[] = [];
+    for (const supported of this.config.supportedPositions) {
+      const amount = await this.getPosition(supported);
+      if (!amount) {
+        continue;
+      }
+      const usdValue = await this.getUSDValue(supported.asset, amount.amount);
+      const apy = await this.getAPY(supported);
+      results.push({ tokenInfo: supported.asset, amount: amount.amount, usdValue, apy, protocol: this.protocol, remarks: amount.remarks });
+    }
+    return results;
+  }
+
+  /**
+   * Implemented by child adapters to compute APY for a given supported position
+   */
+  protected abstract getAPY(supportedPosition: SupportedPosition): Promise<PositionAPY>;
+
+  /**
+   * Implemented by child adapters to fetch amount for a given supported position
+   */
+  protected abstract getPosition(supportedPosition: SupportedPosition): Promise<PositionAmount | null>;
+
+  /**
+   * Implemented by child adapters to calculate maximum deposit positions
+   * @param amount Optional amount in baseToken to deposit
+   */
+  abstract maxDeposit(amount?: Web3Number): Promise<PositionInfo>;
+
+  /**
+   * Implemented by child adapters to calculate maximum withdraw positions
+   */
+  abstract maxWithdraw(): Promise<PositionInfo>;
+
+  /**
+   * Uses pricer to convert an amount of an asset to USD value
+   */
+  protected async getUSDValue(asset: TokenInfo, amount: Web3Number): Promise<number> {
+    const priceInfo = await this.config.pricer.getPrice(asset.priceProxySymbol || asset.symbol);
+    return amount.toNumber() * priceInfo.price;
+  }
+
+
+  protected constructSimpleLeafData(params: {
+    id: string,
+    target: ContractAddr,
+    method: string,
+    packedArguments: bigint[],
+  }, sanitizer: ContractAddr = SIMPLE_SANITIZER): LeafData {
+    const { id, target, method, packedArguments } = params;
+    return {
+      id: BigInt(num.getDecimalString(shortString.encodeShortString(id))),
+      readableId: id,
+      data: [
+        sanitizer.toBigInt(), // sanitizer address
+        target.toBigInt(), // contract
+        toBigInt(hash.getSelectorFromName(method)), // method name
+        BigInt(packedArguments.length),
+        ...packedArguments
+      ]
+    };
+  }
+
+  /**
+   * Implementor must provide target/method/packedArguments/sanitizer for deposit leaf construction
+   */
+  protected abstract _getDepositLeaf(): {
+    target: ContractAddr,
+    method: string,
+    packedArguments: bigint[],
+    sanitizer: ContractAddr,
+    id: string
+  }[];
+
+  /**
+   * Implementor must provide target/method/packedArguments/sanitizer for withdraw leaf construction
+   */
+  protected abstract _getWithdrawLeaf(): {
+    target: ContractAddr,
+    method: string,
+    packedArguments: bigint[],
+    sanitizer: ContractAddr,
+    id: string
+  }[];
+
+  /**
+   * Returns deposit leaf adapter using configured proof id
+   */
+  getDepositLeaf(): AdapterLeafType<DepositParams> {
+    const leafConfigs = this._getDepositLeaf();
+    const leaves = leafConfigs.map(config => {
+      const { target, method, packedArguments, sanitizer, id } = config;
+      const leaf = this.constructSimpleLeafData({
+        id: id,
+        target,
+        method,
+        packedArguments
+      }, sanitizer);
+      return leaf;
+    });
+    return { leaves, callConstructor: this.getDepositCall.bind(this) as unknown as GenerateCallFn<DepositParams> };
+  }
+
+  /**
+   * Returns withdraw leaf adapter using configured proof id
+   */
+  getWithdrawLeaf(): AdapterLeafType<WithdrawParams> {
+    const leafConfigs = this._getWithdrawLeaf();
+    const leaves = leafConfigs.map(config => {
+      const { target, method, packedArguments, sanitizer, id } = config;
+      const leaf = this.constructSimpleLeafData({
+        id: id,
+        target,
+        method,
+        packedArguments
+      }, sanitizer ?? SIMPLE_SANITIZER);
+      return leaf;
+    });
+    return { leaves, callConstructor: this.getWithdrawCall.bind(this) as unknown as GenerateCallFn<WithdrawParams> };
+  }
+
+  /**
+   * Implementor must provide deposit call
+   * @param params
+   */
+  abstract getDepositCall(params: DepositParams): Promise<ManageCall[]>;
+
+  /**
+   * Implementor must provide withdraw call
+   * @param params
+   */
+  abstract getWithdrawCall(params: WithdrawParams): Promise<ManageCall[]>;
+
+
+  getProofs<T>(isDeposit: boolean, tree: StandardMerkleTree): { proofs: string[][], callConstructor: GenerateCallFn<DepositParams> | GenerateCallFn<WithdrawParams> } {
+    let proofGroups: string[][] = [];
+
+    const ids = isDeposit ? this.getDepositLeaf().leaves.map(l => l.readableId) : this.getWithdrawLeaf().leaves.map(l => l.readableId);
+    // console.log(`${this.name}::getProofs ids: ${ids}`);
+    for (const [i, v] of tree.entries()) {
+     // console.log(`${this.name}::getProofs v: ${v.readableId}`);
+      if (ids.includes(v.readableId)) {
+       // console.log(`${this.name}::getProofs found id: ${v.readableId}`);
+        proofGroups.push(tree.getProof(i));
+      }
+    }
+    if (proofGroups.length != ids.length) {
+      throw new Error(`Not all proofs found for IDs: ${ids.join(', ')}`);
+    }
+
+    // find leaf adapter
+    return {
+      proofs: proofGroups,
+      callConstructor: isDeposit ?
+        this.getDepositCall.bind(this) :
+        this.getWithdrawCall.bind(this)
+      };
+    }
+
+  async getNetAPY(): Promise<number> {
+    const positions = (await this.getPositions()).filter(position => position !== null);
+    logger.verbose(`${this.name}::getNetAPY: positions: ${JSON.stringify(positions)}`);
+    const netAmount = positions.reduce((acc, curr) => acc + curr.usdValue, 0);
+    const netAPY = positions.reduce((acc, curr) => acc + curr.apy.apy * curr.usdValue, 0) / netAmount;
+    logger.verbose(`${this.name}::getNetAPY: netAPY: ${netAPY}`);
+    return netAPY;
+  }
+
+  abstract getHealthFactor(): Promise<number>;
+}