@defisaver/positions-sdk 0.0.1

package/src/types/contracts/generated/UniMulticall.ts

@@ -0,0 +1,83 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+
+import type BN from "bn.js";
+import type { ContractOptions } from "web3-eth-contract";
+import type { EventLog } from "web3-core";
+import type { EventEmitter } from "events";
+import type {
+  Callback,
+  PayableTransactionObject,
+  NonPayableTransactionObject,
+  BlockType,
+  ContractEventLog,
+  BaseContract,
+} from "./types";
+
+export interface EventOptions {
+  filter?: object;
+  fromBlock?: BlockType;
+  topics?: string[];
+}
+
+export declare namespace UniswapInterfaceMulticall {
+  export type CallStruct =
+    | [string, number | string | BN, string | number[]]
+    | {
+        target: string;
+        gasLimit: number | string | BN;
+        callData: string | number[];
+      };
+
+  export type CallStructOutputArray = [string, string, string];
+  export type CallStructOutputStruct = {
+    target: string;
+    gasLimit: string;
+    callData: string;
+  };
+  export type CallStructOutput = CallStructOutputArray & CallStructOutputStruct;
+
+  export type ResultStruct =
+    | [boolean, number | string | BN, string | number[]]
+    | {
+        success: boolean;
+        gasUsed: number | string | BN;
+        returnData: string | number[];
+      };
+
+  export type ResultStructOutputArray = [boolean, string, string];
+  export type ResultStructOutputStruct = {
+    success: boolean;
+    gasUsed: string;
+    returnData: string;
+  };
+  export type ResultStructOutput = ResultStructOutputArray &
+    ResultStructOutputStruct;
+}
+
+export interface UniMulticall extends BaseContract {
+  constructor(
+    jsonInterface: any[],
+    address?: string,
+    options?: ContractOptions
+  ): UniMulticall;
+  clone(): UniMulticall;
+  methods: {
+    getCurrentBlockTimestamp(): NonPayableTransactionObject<string>;
+
+    getEthBalance(addr: string): NonPayableTransactionObject<string>;
+
+    multicall(
+      calls: UniswapInterfaceMulticall.CallStruct[]
+    ): NonPayableTransactionObject<
+      [string, UniswapInterfaceMulticall.ResultStructOutput[]] & {
+        blockNumber: string;
+        returnData: UniswapInterfaceMulticall.ResultStructOutput[];
+      }
+    >;
+  };
+  events: {
+    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
+  };
+}

package/src/types/contracts/generated/WstETH.ts

@@ -0,0 +1,141 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+
+import type BN from "bn.js";
+import type { ContractOptions } from "web3-eth-contract";
+import type { EventLog } from "web3-core";
+import type { EventEmitter } from "events";
+import type {
+  Callback,
+  PayableTransactionObject,
+  NonPayableTransactionObject,
+  BlockType,
+  ContractEventLog,
+  BaseContract,
+} from "./types";
+
+export interface EventOptions {
+  filter?: object;
+  fromBlock?: BlockType;
+  topics?: string[];
+}
+
+export type Approval = ContractEventLog<{
+  owner: string;
+  spender: string;
+  value: string;
+  0: string;
+  1: string;
+  2: string;
+}>;
+export type Transfer = ContractEventLog<{
+  from: string;
+  to: string;
+  value: string;
+  0: string;
+  1: string;
+  2: string;
+}>;
+
+export interface WstETH extends BaseContract {
+  constructor(
+    jsonInterface: any[],
+    address?: string,
+    options?: ContractOptions
+  ): WstETH;
+  clone(): WstETH;
+  methods: {
+    DOMAIN_SEPARATOR(): NonPayableTransactionObject<string>;
+
+    allowance(
+      owner: string,
+      spender: string
+    ): NonPayableTransactionObject<string>;
+
+    approve(
+      spender: string,
+      amount: number | string | BN
+    ): NonPayableTransactionObject<boolean>;
+
+    balanceOf(account: string): NonPayableTransactionObject<string>;
+
+    decimals(): NonPayableTransactionObject<string>;
+
+    decreaseAllowance(
+      spender: string,
+      subtractedValue: number | string | BN
+    ): NonPayableTransactionObject<boolean>;
+
+    getStETHByWstETH(
+      _wstETHAmount: number | string | BN
+    ): NonPayableTransactionObject<string>;
+
+    getWstETHByStETH(
+      _stETHAmount: number | string | BN
+    ): NonPayableTransactionObject<string>;
+
+    increaseAllowance(
+      spender: string,
+      addedValue: number | string | BN
+    ): NonPayableTransactionObject<boolean>;
+
+    name(): NonPayableTransactionObject<string>;
+
+    nonces(owner: string): NonPayableTransactionObject<string>;
+
+    permit(
+      owner: string,
+      spender: string,
+      value: number | string | BN,
+      deadline: number | string | BN,
+      v: number | string | BN,
+      r: string | number[],
+      s: string | number[]
+    ): NonPayableTransactionObject<void>;
+
+    stETH(): NonPayableTransactionObject<string>;
+
+    stEthPerToken(): NonPayableTransactionObject<string>;
+
+    symbol(): NonPayableTransactionObject<string>;
+
+    tokensPerStEth(): NonPayableTransactionObject<string>;
+
+    totalSupply(): NonPayableTransactionObject<string>;
+
+    transfer(
+      recipient: string,
+      amount: number | string | BN
+    ): NonPayableTransactionObject<boolean>;
+
+    transferFrom(
+      sender: string,
+      recipient: string,
+      amount: number | string | BN
+    ): NonPayableTransactionObject<boolean>;
+
+    unwrap(
+      _wstETHAmount: number | string | BN
+    ): NonPayableTransactionObject<string>;
+
+    wrap(
+      _stETHAmount: number | string | BN
+    ): NonPayableTransactionObject<string>;
+  };
+  events: {
+    Approval(cb?: Callback<Approval>): EventEmitter;
+    Approval(options?: EventOptions, cb?: Callback<Approval>): EventEmitter;
+
+    Transfer(cb?: Callback<Transfer>): EventEmitter;
+    Transfer(options?: EventOptions, cb?: Callback<Transfer>): EventEmitter;
+
+    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
+  };
+
+  once(event: "Approval", cb: Callback<Approval>): void;
+  once(event: "Approval", options: EventOptions, cb: Callback<Approval>): void;
+
+  once(event: "Transfer", cb: Callback<Transfer>): void;
+  once(event: "Transfer", options: EventOptions, cb: Callback<Transfer>): void;
+}

package/src/types/contracts/generated/index.ts

@@ -0,0 +1,60 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+export type { AaveLendingPoolV2 } from "./AaveLendingPoolV2";
+export type { AaveLoanInfoV2 } from "./AaveLoanInfoV2";
+export type { AaveProtocolDataProvider } from "./AaveProtocolDataProvider";
+export type { AaveUiIncentiveDataProviderV3 } from "./AaveUiIncentiveDataProviderV3";
+export type { AaveV3LendingPool } from "./AaveV3LendingPool";
+export type { AaveV3PoolAddressesProvider } from "./AaveV3PoolAddressesProvider";
+export type { AaveV3ProtocolDataProvider } from "./AaveV3ProtocolDataProvider";
+export type { AaveV3View } from "./AaveV3View";
+export type { BalanceScanner } from "./BalanceScanner";
+export type { CbEth } from "./CbEth";
+export type { ChickenBondsView } from "./ChickenBondsView";
+export type { CollSurplusPool } from "./CollSurplusPool";
+export type { CompV3ETHBulker } from "./CompV3ETHBulker";
+export type { CompV3USDCBulker } from "./CompV3USDCBulker";
+export type { CompV3USDbCBulker } from "./CompV3USDbCBulker";
+export type { CompV3View } from "./CompV3View";
+export type { CompoundLoanInfo } from "./CompoundLoanInfo";
+export type { Comptroller } from "./Comptroller";
+export type { Erc20 } from "./Erc20";
+export type { GHO } from "./GHO";
+export type { GhoDiscountRateStrategy } from "./GhoDiscountRateStrategy";
+export type { IAToken } from "./IAToken";
+export type { IVariableDebtToken } from "./IVariableDebtToken";
+export type { LendingPoolAddressesProvider } from "./LendingPoolAddressesProvider";
+export type { Lido } from "./Lido";
+export type { LiquityActivePool } from "./LiquityActivePool";
+export type { LiquityView } from "./LiquityView";
+export type { McdDog } from "./McdDog";
+export type { McdJug } from "./McdJug";
+export type { McdSpotter } from "./McdSpotter";
+export type { McdVat } from "./McdVat";
+export type { McdView } from "./McdView";
+export type { MorphoAaveV2Proxy } from "./MorphoAaveV2Proxy";
+export type { MorphoAaveV2View } from "./MorphoAaveV2View";
+export type { MorphoAaveV3ProxyEthMarket } from "./MorphoAaveV3ProxyEthMarket";
+export type { Pot } from "./Pot";
+export type { PriceFeed } from "./PriceFeed";
+export type { REth } from "./REth";
+export type { SparkIncentiveDataProvider } from "./SparkIncentiveDataProvider";
+export type { SparkLendingPool } from "./SparkLendingPool";
+export type { SparkPoolAddressesProvider } from "./SparkPoolAddressesProvider";
+export type { SparkProtocolDataProvider } from "./SparkProtocolDataProvider";
+export type { SparkView } from "./SparkView";
+export type { TroveManager } from "./TroveManager";
+export type { UniMulticall } from "./UniMulticall";
+export type { CETHv3 } from "./CETHv3";
+export type { CUSDCv3 } from "./CUSDCv3";
+export type { CUSDbCv3 } from "./CUSDbCv3";
+export type { CrvUSDETHAmm } from "./CrvUSDETHAmm";
+export type { CrvUSDETHController } from "./CrvUSDETHController";
+export type { CrvUSDFactory } from "./CrvUSDFactory";
+export type { CrvUSDView } from "./CrvUSDView";
+export type { CrvUSDWBTCAmm } from "./CrvUSDWBTCAmm";
+export type { CrvUSDWBTCController } from "./CrvUSDWBTCController";
+export type { CrvUSDwstETHAmm } from "./CrvUSDwstETHAmm";
+export type { CrvUSDwstETHController } from "./CrvUSDwstETHController";
+export type { WstETH } from "./WstETH";

package/src/types/contracts/generated/types.ts

@@ -0,0 +1,73 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+import type BN from "bn.js";
+import type { EventEmitter } from "events";
+import type { EventLog, PromiEvent, TransactionReceipt } from "web3-core/types";
+import type { Contract } from "web3-eth-contract";
+
+export interface EstimateGasOptions {
+  from?: string;
+  gas?: number;
+  value?: number | string | BN;
+}
+
+export interface EventOptions {
+  filter?: object;
+  fromBlock?: BlockType;
+  topics?: string[];
+}
+
+export type Callback<T> = (error: Error, result: T) => void;
+export interface ContractEventLog<T> extends EventLog {
+  returnValues: T;
+}
+export interface ContractEventEmitter<T> extends EventEmitter {
+  on(event: "connected", listener: (subscriptionId: string) => void): this;
+  on(
+    event: "data" | "changed",
+    listener: (event: ContractEventLog<T>) => void
+  ): this;
+  on(event: "error", listener: (error: Error) => void): this;
+}
+
+export interface NonPayableTx {
+  nonce?: string | number | BN;
+  chainId?: string | number | BN;
+  from?: string;
+  to?: string;
+  data?: string;
+  gas?: string | number | BN;
+  maxPriorityFeePerGas?: string | number | BN;
+  maxFeePerGas?: string | number | BN;
+  gasPrice?: string | number | BN;
+}
+
+export interface PayableTx extends NonPayableTx {
+  value?: string | number | BN;
+}
+
+export interface NonPayableTransactionObject<T> {
+  arguments: any[];
+  call(tx?: NonPayableTx, block?: BlockType): Promise<T>;
+  send(tx?: NonPayableTx): PromiEvent<TransactionReceipt>;
+  estimateGas(tx?: NonPayableTx): Promise<number>;
+  encodeABI(): string;
+}
+
+export interface PayableTransactionObject<T> {
+  arguments: any[];
+  call(tx?: PayableTx, block?: BlockType): Promise<T>;
+  send(tx?: PayableTx): PromiEvent<TransactionReceipt>;
+  estimateGas(tx?: PayableTx): Promise<number>;
+  encodeABI(): string;
+}
+
+export type BlockType =
+  | "latest"
+  | "pending"
+  | "genesis"
+  | "earliest"
+  | number
+  | BN;
+export type BaseContract = Omit<Contract, "clone" | "once">;

package/src/types/curveUsd.ts

@@ -0,0 +1,111 @@
+import { NetworkNumber } from './common';
+
+export enum CrvUSDVersions {
+  'wstETH' = 'wstETH',
+  'WBTC' = 'WBTC',
+  'ETH' = 'ETH',
+}
+
+export enum CrvUSDStatus {
+  Nonexistant = 'Nonexistant',
+  Safe = 'Safe',
+  Risk = 'Risk',
+  SoftLiquidating = 'SoftLiquidating',
+  SoftLiquidated = 'SoftLiquidated',
+}
+
+export interface CrvUSDMarketData {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  value: CrvUSDVersions,
+  collAsset: string,
+  baseAsset: string,
+  controllerAddress: string,
+  ammAddress: string,
+  createCollAssets: string[],
+}
+
+export interface BandData {
+  id: string,
+  collAmount: string,
+  debtAmount: string,
+  lowPrice: string,
+  highPrice: string,
+}
+
+export interface UserBandData {
+  id: string,
+  collAmount: string,
+  debtAmount: string,
+  lowPrice: string,
+  highPrice: string,
+  userDebtAmount: string,
+  userCollAmount: string,
+}
+
+export interface CrvUSDGlobalMarketData {
+  collateral: string,
+  decimals: string,
+  activeBand: string,
+  totalDebt: string,
+  ammPrice: string,
+  basePrice: string,
+  oraclePrice: string,
+  minted: string,
+  redeemed: string,
+  monetaryPolicyRate: string,
+  ammRate: string,
+  minBand: string,
+  maxBand: string,
+  debtCeiling: string,
+  borrowRate: string,
+  futureBorrowRate: string,
+  leftToBorrow: string,
+  bands: BandData[],
+}
+
+export interface CrvUSDAggregatedPositionData {
+  ratio: string,
+  supplied: string,
+  suppliedUsd: string,
+  borrowedUsd: string,
+  borrowed: string,
+  safetyRatio: string,
+}
+
+export interface CrvUSDUsedAsset {
+  isSupplied: boolean,
+  supplied: string,
+  suppliedUsd: string,
+  borrowed: string,
+  borrowedUsd: string,
+  isBorrowed: boolean,
+  symbol: string,
+  collateral: boolean,
+  price: string,
+  interestRate?: string,
+}
+
+export interface CrvUSDUsedAssets {
+  [key: string]: CrvUSDUsedAsset,
+}
+
+export interface CrvUSDUserData {
+  debtAmount: string,
+  health: string,
+  healthPercent: string,
+  priceHigh: string,
+  priceLow: string,
+  liquidationDiscount: string,
+  numOfBands: string,
+  usedAssets: CrvUSDUsedAssets,
+  status: CrvUSDStatus,
+  ratio: string,
+  supplied: string,
+  suppliedUsd: string,
+  borrowedUsd: string,
+  borrowed: string,
+  safetyRatio: string,
+  userBands: UserBandData[],
+}

package/src/types/index.ts

@@ -0,0 +1,6 @@
+export * from './aave';
+export * from './compound';
+export * from './spark';
+export * from './curveUsd';
+export * from './liquity';
+export * from './maker';

package/src/types/liquity.ts

@@ -0,0 +1,30 @@
+export enum LIQUITY_TROVE_STATUS_ENUM {
+  nonExistent,
+  active,
+  closedByOwner,
+  closedByLiquidation,
+  closedByRedemption,
+}
+
+export const LIQUITY_STATUS_MAPPING = {
+  nonExistent: 'Non existent',
+  active: 'Active',
+  closedByOwner: 'Closed',
+  closedByLiquidation: 'Liquidated',
+  closedByRedemption: 'Redeemed',
+};
+
+export interface LiquityTroveInfo {
+  troveStatus: string,
+  collateral: string,
+  debtInAsset: string,
+  TCRatio: string,
+  recoveryMode: boolean,
+  claimableCollateral: string,
+  borrowingRateWithDecay: string,
+  assetPrice: string,
+  totalETH: string,
+  totalLUSD: string,
+  minCollateralRatio: number,
+  priceForRecovery: string,
+}

package/src/types/maker.ts

@@ -0,0 +1,51 @@
+import { EthAddress } from './common';
+
+export interface IlkInfo {
+  ilkLabel: string;
+  currentRate: string;
+  futureRate: string;
+  minDebt: string;
+  globalDebtCeiling: string;
+  globalDebtCurrent: string;
+  assetPrice: string;
+  liqRatio: string;
+  liqPercent: number;
+  stabilityFee: number;
+  liquidationFee: string;
+  creatableDebt: string;
+}
+
+export interface CdpData {
+  owner: EthAddress,
+  userAddress: EthAddress,
+  id: string,
+  urn: EthAddress,
+  type: string,
+  ilk: string,
+  ilkLabel: string,
+  asset: string,
+  collateral: string,
+  collateralUsd: string,
+  futureDebt: string,
+  debtDai: string,
+  debtUsd: string,
+  debtInAsset: string,
+  debtAssetPrice: string,
+  debtAssetMarketPrice: string,
+  liquidationPrice: string,
+  ratio: string,
+  liqRatio: string,
+  liqPercent: number,
+  assetPrice: string,
+  daiLabel: string,
+  debtAsset: string,
+  unclaimedCollateral: string,
+  debtTooLow: boolean,
+  minDebt: string,
+  stabilityFee: number,
+  creatableDebt: string,
+  globalDebtCeiling: string,
+  globalDebtCurrent: string,
+  liquidationFee: string,
+  lastUpdated: number,
+}

package/src/types/spark.ts

@@ -0,0 +1,107 @@
+import { EModeCategoryData, EModeCategoryDataMapping } from './aave';
+import {
+  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
+} from './common';
+
+export enum SparkVersions {
+  SparkV1 = 'v1default',
+}
+
+export interface SparkMarketData {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  url: string,
+  value: SparkVersions,
+  assets: readonly string[],
+  provider: '' | 'SparkPoolAddressesProvider',
+  providerAddress: string,
+  lendingPool: 'SparkLendingPool',
+  lendingPoolAddress: string,
+  protocolData: '' | 'SparkProtocolDataProvider',
+  protocolDataAddress: string
+  subVersionLabel?: string
+  // icon: Function,
+  protocolName: string,
+  disabled?: boolean,
+}
+
+export interface SparkAssetData extends MMAssetData {
+  totalBorrowVar: string,
+  sortIndex?: number,
+  usageAsCollateralEnabled: boolean,
+  isIsolated: boolean,
+  eModeCategory: number,
+  eModeCategoryData: EModeCategoryData,
+  liquidationRatio: string,
+}
+
+export interface SparkAssetsData {
+  [token: string]: SparkAssetData,
+}
+
+export type SparkMarketsData = { assetsData: SparkAssetsData };
+
+export interface SparkUsedAsset extends MMUsedAsset {
+  stableBorrowRate: string,
+  borrowedStable: string,
+  borrowedVariable: string,
+  borrowedUsdStable: string,
+  borrowedUsdVariable: string,
+  stableLimit: string,
+  variableLimit: string,
+  limit: string,
+  eModeCategory: number,
+}
+
+export interface SparkUsedAssets {
+  [token: string]: SparkUsedAsset,
+}
+
+export interface SparkHelperCommon {
+  usedAssets: SparkUsedAssets,
+  eModeCategory: number,
+  eModeCategories?: { [key: number]: EModeCategoryDataMapping },
+  assetsData: SparkAssetsData,
+  selectedMarket?: SparkMarketData,
+  network?: NetworkNumber,
+}
+
+export interface SparkAggregatedPositionData {
+  suppliedUsd: string,
+  suppliedCollateralUsd: string,
+  borrowedUsd: string,
+  borrowLimitUsd: string,
+  liquidationLimitUsd: string,
+  leftToBorrowUsd: string,
+  ratio: string,
+  collRatio: string,
+  netApy: string,
+  incentiveUsd: string,
+  totalInterestUsd: string,
+  liqRatio: string,
+  liqPercent: string,
+  leveragedType: string,
+  leveragedAsset?: string,
+  leveragedLsdAssetRatio?: string,
+  liquidationPrice?: string,
+}
+
+export interface SparkPositionData extends MMPositionData {
+  ratio: string,
+  minRatio: string,
+  collRatio: string,
+  borrowedUsd: string,
+  borrowLimitUsd: string,
+  suppliedCollateralUsd: string,
+  incentiveUsd: string,
+  totalInterestUsd: string,
+  isSubscribedToAutomation?: boolean,
+  automationResubscribeRequired?: boolean,
+  totalSupplied: string,
+  usedAssets: SparkUsedAssets,
+  eModeCategory: number,
+  isInIsolationMode: boolean,
+  isInSiloedMode: boolean,
+  eModeCategories: { [key: number]: EModeCategoryDataMapping },
+}