@defisaver/positions-sdk 0.0.12 → 0.0.13

package/src/types/common.ts

@@ -1,84 +1,84 @@
-// General
-export type EthAddress = string;
-export type Blockish = number | 'latest';
-export type AssetSymbol = string;
-export type Amount = string | number;
-
-export enum NetworkNumber {
-  Eth = 1,
-  Opt = 10,
-  Arb = 42161,
-  Base = 8453,
-}
-export type Networkish = string | NetworkNumber;
-
-// Common
-export interface MMAssetData {
-  symbol: string,
-  supplyRate: string,
-  borrowRate: string,
-  price: string,
-  collateralFactor: string,
-  underlyingTokenAddress: string,
-  marketLiquidity: string,
-  utilization: string,
-  borrowCap: string,
-  totalSupply: string,
-  canBeBorrowed: boolean,
-  canBeSupplied: boolean,
-  totalBorrow: string,
-  incentiveBorrowApy?: string,
-  incentiveBorrowToken?: string,
-  incentiveSupplyApy?: string,
-  incentiveSupplyToken?: string,
-  borrowRateP2P?: string,
-  supplyRateP2P?: string,
-}
-
-export interface MMAssetsData {
-  [token: string]: MMAssetData,
-}
-export interface MMMarketData {
-  assetsData: MMAssetData[],
-}
-export interface MMUsedAsset {
-  symbol: string,
-  supplied: string,
-  suppliedUsd: string,
-  isSupplied: boolean,
-  borrowed: string,
-  borrowedUsd: string,
-  isBorrowed: boolean,
-  debt: string,
-  supplyRate?: string,
-  borrowRate?: string,
-  discountedBorrowRate?: string,
-  stableBorrowRate?: string,
-  interestMode?: string,
-  collateral?: boolean,
-}
-export interface MMUsedAssets {
-  [token: string]: MMUsedAsset,
-}
-export interface MMUsedAssetWStableB extends MMUsedAsset {
-  stableBorrowRate: string,
-  borrowedStable: string,
-  borrowedVariable: string,
-  borrowedUsdStable: string,
-  borrowedUsdVariable: string,
-  interestMode: string,
-}
-export interface MMPositionData {
-  usedAssets: any,
-  netApy: string,
-  lastUpdated: number,
-  // ...
-}
-
-export type Balances = Record<AssetSymbol, Amount>;
-export interface PositionBalances {
-  collateral?: Balances,
-  debt?: Balances,
-  selling?: Balances,
-  deposited?: Balances,
+// General
+export type EthAddress = string;
+export type Blockish = number | 'latest';
+export type AssetSymbol = string;
+export type Amount = string | number;
+
+export enum NetworkNumber {
+  Eth = 1,
+  Opt = 10,
+  Arb = 42161,
+  Base = 8453,
+}
+export type Networkish = string | NetworkNumber;
+
+// Common
+export interface MMAssetData {
+  symbol: string,
+  supplyRate: string,
+  borrowRate: string,
+  price: string,
+  collateralFactor: string,
+  underlyingTokenAddress: string,
+  marketLiquidity: string,
+  utilization: string,
+  borrowCap: string,
+  totalSupply: string,
+  canBeBorrowed: boolean,
+  canBeSupplied: boolean,
+  totalBorrow: string,
+  incentiveBorrowApy?: string,
+  incentiveBorrowToken?: string,
+  incentiveSupplyApy?: string,
+  incentiveSupplyToken?: string,
+  borrowRateP2P?: string,
+  supplyRateP2P?: string,
+}
+
+export interface MMAssetsData {
+  [token: string]: MMAssetData,
+}
+export interface MMMarketData {
+  assetsData: MMAssetData[],
+}
+export interface MMUsedAsset {
+  symbol: string,
+  supplied: string,
+  suppliedUsd: string,
+  isSupplied: boolean,
+  borrowed: string,
+  borrowedUsd: string,
+  isBorrowed: boolean,
+  debt: string,
+  supplyRate?: string,
+  borrowRate?: string,
+  discountedBorrowRate?: string,
+  stableBorrowRate?: string,
+  interestMode?: string,
+  collateral?: boolean,
+}
+export interface MMUsedAssets {
+  [token: string]: MMUsedAsset,
+}
+export interface MMUsedAssetWStableB extends MMUsedAsset {
+  stableBorrowRate: string,
+  borrowedStable: string,
+  borrowedVariable: string,
+  borrowedUsdStable: string,
+  borrowedUsdVariable: string,
+  interestMode: string,
+}
+export interface MMPositionData {
+  usedAssets: any,
+  netApy: string,
+  lastUpdated: number,
+  // ...
+}
+
+export type Balances = Record<AssetSymbol, Amount>;
+export interface PositionBalances {
+  collateral?: Balances,
+  debt?: Balances,
+  selling?: Balances,
+  deposited?: Balances,
 }

package/src/types/compound.ts

@@ -1,122 +1,122 @@
-import {
-  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
-} from './common';
-
-export enum CompoundVersions {
-  'CompoundV2' = 'v2',
-  'CompoundV3USDC' = 'v3-USDC',
-  'CompoundV3ETH' = 'v3-ETH',
-  'CompoundV3USDbC' = 'v3-USDbC',
-}
-
-export interface CompoundMarketData {
-  chainIds: NetworkNumber[],
-  label: string,
-  shortLabel: string,
-  value: CompoundVersions,
-  baseAsset: string,
-  collAssets: readonly string[],
-  baseMarket: string,
-  baseMarketAddress: string,
-  secondLabel: string,
-  bulkerName: string,
-  bulkerAddress: string,
-  bulkerOptions: { supply: string | number, withdraw: string | number },
-  // icon: Function,
-}
-
-export interface CompoundUsedAsset extends MMUsedAsset {
-  collateral: boolean,
-  limit?: string,
-}
-
-export interface CompoundV2UsedAsset extends CompoundUsedAsset {
-}
-export interface CompoundV3UsedAsset extends CompoundUsedAsset {
-}
-
-export interface CompoundUsedAssets<T> {
-  [token: string]: T,
-}
-
-export type CompoundV2UsedAssets = CompoundUsedAssets<CompoundV2UsedAsset>;
-export type CompoundV3UsedAssets = CompoundUsedAssets<CompoundV3UsedAsset>;
-
-export interface CompoundAssetData extends MMAssetData {
-  supplyCapAlternative?: string,
-  totalSupplyAlternative?: string,
-  priceAlternative?: string,
-  sortIndex?: number,
-}
-
-export interface CompoundV2AssetData extends CompoundAssetData {
-}
-export interface CompoundV3AssetData extends CompoundAssetData {
-  borrowCollateralFactor: string,
-  liquidateCollateralFactor: string,
-  minDebt: string,
-  liquidationRatio: string,
-  supplyCap: string,
-}
-
-export interface CompoundAssetsData<T> {
-  [token: string]: T
-}
-export type CompoundV2AssetsData = CompoundAssetsData<CompoundV2AssetData>;
-export type CompoundV3AssetsData = CompoundAssetsData<CompoundV3AssetData>;
-
-export type CompoundMarketsData<T> = { assetsData: T };
-export type CompoundV2MarketsData = CompoundMarketsData<CompoundV2AssetsData>;
-export type CompoundV3MarketsData = CompoundMarketsData<CompoundV3AssetsData>;
-
-export interface BaseAdditionalAssetData {
-  totalBorrow: string,
-  utilization: string,
-  marketLiquidity: string,
-  rewardSupplySpeed: string,
-  rewardBorrowSpeed: string,
-  minDebt: string,
-  isBase: boolean,
-}
-
-export interface CompoundAggregatedPositionData {
-  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,
-  minRatio: string,
-  debtTooLow: boolean,
-  minDebt: string,
-}
-
-export interface CompoundPositionData extends MMPositionData {
-  ratio: string,
-  minRatio: string,
-  borrowedUsd: string,
-  borrowLimitUsd: string,
-  incentiveUsd: string,
-  totalInterestUsd: string,
-  isSubscribedToAutomation?: boolean,
-  automationResubscribeRequired?: boolean,
-}
-
-export interface CompoundV2PositionData extends CompoundPositionData {
-  usedAssets: CompoundV2UsedAssets,
-}
-
-export interface CompoundV3PositionData extends CompoundPositionData {
-  usedAssets: CompoundV3UsedAssets,
+import {
+  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
+} from './common';
+
+export enum CompoundVersions {
+  'CompoundV2' = 'v2',
+  'CompoundV3USDC' = 'v3-USDC',
+  'CompoundV3ETH' = 'v3-ETH',
+  'CompoundV3USDbC' = 'v3-USDbC',
+}
+
+export interface CompoundMarketData {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  value: CompoundVersions,
+  baseAsset: string,
+  collAssets: readonly string[],
+  baseMarket: string,
+  baseMarketAddress: string,
+  secondLabel: string,
+  bulkerName: string,
+  bulkerAddress: string,
+  bulkerOptions: { supply: string | number, withdraw: string | number },
+  // icon: Function,
+}
+
+export interface CompoundUsedAsset extends MMUsedAsset {
+  collateral: boolean,
+  limit?: string,
+}
+
+export interface CompoundV2UsedAsset extends CompoundUsedAsset {
+}
+export interface CompoundV3UsedAsset extends CompoundUsedAsset {
+}
+
+export interface CompoundUsedAssets<T> {
+  [token: string]: T,
+}
+
+export type CompoundV2UsedAssets = CompoundUsedAssets<CompoundV2UsedAsset>;
+export type CompoundV3UsedAssets = CompoundUsedAssets<CompoundV3UsedAsset>;
+
+export interface CompoundAssetData extends MMAssetData {
+  supplyCapAlternative?: string,
+  totalSupplyAlternative?: string,
+  priceAlternative?: string,
+  sortIndex?: number,
+}
+
+export interface CompoundV2AssetData extends CompoundAssetData {
+}
+export interface CompoundV3AssetData extends CompoundAssetData {
+  borrowCollateralFactor: string,
+  liquidateCollateralFactor: string,
+  minDebt: string,
+  liquidationRatio: string,
+  supplyCap: string,
+}
+
+export interface CompoundAssetsData<T> {
+  [token: string]: T
+}
+export type CompoundV2AssetsData = CompoundAssetsData<CompoundV2AssetData>;
+export type CompoundV3AssetsData = CompoundAssetsData<CompoundV3AssetData>;
+
+export type CompoundMarketsData<T> = { assetsData: T };
+export type CompoundV2MarketsData = CompoundMarketsData<CompoundV2AssetsData>;
+export type CompoundV3MarketsData = CompoundMarketsData<CompoundV3AssetsData>;
+
+export interface BaseAdditionalAssetData {
+  totalBorrow: string,
+  utilization: string,
+  marketLiquidity: string,
+  rewardSupplySpeed: string,
+  rewardBorrowSpeed: string,
+  minDebt: string,
+  isBase: boolean,
+}
+
+export interface CompoundAggregatedPositionData {
+  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,
+  minRatio: string,
+  debtTooLow: boolean,
+  minDebt: string,
+}
+
+export interface CompoundPositionData extends MMPositionData {
+  ratio: string,
+  minRatio: string,
+  borrowedUsd: string,
+  borrowLimitUsd: string,
+  incentiveUsd: string,
+  totalInterestUsd: string,
+  isSubscribedToAutomation?: boolean,
+  automationResubscribeRequired?: boolean,
+}
+
+export interface CompoundV2PositionData extends CompoundPositionData {
+  usedAssets: CompoundV2UsedAssets,
+}
+
+export interface CompoundV3PositionData extends CompoundPositionData {
+  usedAssets: CompoundV3UsedAssets,
 }

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

@@ -0,0 +1,286 @@
+/* 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 TokenExchange = ContractEventLog<{
+  buyer: string;
+  sold_id: string;
+  tokens_sold: string;
+  bought_id: string;
+  tokens_bought: string;
+  0: string;
+  1: string;
+  2: string;
+  3: string;
+  4: string;
+}>;
+export type Deposit = ContractEventLog<{
+  provider: string;
+  amount: string;
+  n1: string;
+  n2: string;
+  0: string;
+  1: string;
+  2: string;
+  3: string;
+}>;
+export type Withdraw = ContractEventLog<{
+  provider: string;
+  amount_borrowed: string;
+  amount_collateral: string;
+  0: string;
+  1: string;
+  2: string;
+}>;
+export type SetRate = ContractEventLog<{
+  rate: string;
+  rate_mul: string;
+  time: string;
+  0: string;
+  1: string;
+  2: string;
+}>;
+export type SetFee = ContractEventLog<{
+  fee: string;
+  0: string;
+}>;
+export type SetAdminFee = ContractEventLog<{
+  fee: string;
+  0: string;
+}>;
+
+export interface CrvUSDtBTCAmm extends BaseContract {
+  constructor(
+    jsonInterface: any[],
+    address?: string,
+    options?: ContractOptions
+  ): CrvUSDtBTCAmm;
+  clone(): CrvUSDtBTCAmm;
+  methods: {
+    set_admin(_admin: string): NonPayableTransactionObject<void>;
+
+    coins(i: number | string | BN): NonPayableTransactionObject<string>;
+
+    price_oracle(): NonPayableTransactionObject<string>;
+
+    dynamic_fee(): NonPayableTransactionObject<string>;
+
+    get_rate_mul(): NonPayableTransactionObject<string>;
+
+    get_base_price(): NonPayableTransactionObject<string>;
+
+    p_current_up(n: number | string | BN): NonPayableTransactionObject<string>;
+
+    p_current_down(
+      n: number | string | BN
+    ): NonPayableTransactionObject<string>;
+
+    p_oracle_up(n: number | string | BN): NonPayableTransactionObject<string>;
+
+    p_oracle_down(n: number | string | BN): NonPayableTransactionObject<string>;
+
+    get_p(): NonPayableTransactionObject<string>;
+
+    read_user_tick_numbers(
+      user: string
+    ): NonPayableTransactionObject<[string, string]>;
+
+    can_skip_bands(
+      n_end: number | string | BN
+    ): NonPayableTransactionObject<boolean>;
+
+    active_band_with_skip(): NonPayableTransactionObject<string>;
+
+    has_liquidity(user: string): NonPayableTransactionObject<boolean>;
+
+    deposit_range(
+      user: string,
+      amount: number | string | BN,
+      n1: number | string | BN,
+      n2: number | string | BN
+    ): NonPayableTransactionObject<void>;
+
+    withdraw(
+      user: string,
+      frac: number | string | BN
+    ): NonPayableTransactionObject<[string, string]>;
+
+    get_dy(
+      i: number | string | BN,
+      j: number | string | BN,
+      in_amount: number | string | BN
+    ): NonPayableTransactionObject<string>;
+
+    get_dxdy(
+      i: number | string | BN,
+      j: number | string | BN,
+      in_amount: number | string | BN
+    ): NonPayableTransactionObject<[string, string]>;
+
+    get_dx(
+      i: number | string | BN,
+      j: number | string | BN,
+      out_amount: number | string | BN
+    ): NonPayableTransactionObject<string>;
+
+    get_dydx(
+      i: number | string | BN,
+      j: number | string | BN,
+      out_amount: number | string | BN
+    ): NonPayableTransactionObject<[string, string]>;
+
+    "exchange(uint256,uint256,uint256,uint256)"(
+      i: number | string | BN,
+      j: number | string | BN,
+      in_amount: number | string | BN,
+      min_amount: number | string | BN
+    ): NonPayableTransactionObject<[string, string]>;
+
+    "exchange(uint256,uint256,uint256,uint256,address)"(
+      i: number | string | BN,
+      j: number | string | BN,
+      in_amount: number | string | BN,
+      min_amount: number | string | BN,
+      _for: string
+    ): NonPayableTransactionObject<[string, string]>;
+
+    "exchange_dy(uint256,uint256,uint256,uint256)"(
+      i: number | string | BN,
+      j: number | string | BN,
+      out_amount: number | string | BN,
+      max_amount: number | string | BN
+    ): NonPayableTransactionObject<[string, string]>;
+
+    "exchange_dy(uint256,uint256,uint256,uint256,address)"(
+      i: number | string | BN,
+      j: number | string | BN,
+      out_amount: number | string | BN,
+      max_amount: number | string | BN,
+      _for: string
+    ): NonPayableTransactionObject<[string, string]>;
+
+    get_y_up(user: string): NonPayableTransactionObject<string>;
+
+    get_x_down(user: string): NonPayableTransactionObject<string>;
+
+    get_sum_xy(user: string): NonPayableTransactionObject<[string, string]>;
+
+    get_xy(user: string): NonPayableTransactionObject<[string[], string[]]>;
+
+    get_amount_for_price(
+      p: number | string | BN
+    ): NonPayableTransactionObject<[string, boolean]>;
+
+    set_rate(rate: number | string | BN): NonPayableTransactionObject<string>;
+
+    set_fee(fee: number | string | BN): NonPayableTransactionObject<void>;
+
+    set_admin_fee(fee: number | string | BN): NonPayableTransactionObject<void>;
+
+    reset_admin_fees(): NonPayableTransactionObject<void>;
+
+    set_callback(
+      liquidity_mining_callback: string
+    ): NonPayableTransactionObject<void>;
+
+    admin(): NonPayableTransactionObject<string>;
+
+    A(): NonPayableTransactionObject<string>;
+
+    fee(): NonPayableTransactionObject<string>;
+
+    admin_fee(): NonPayableTransactionObject<string>;
+
+    rate(): NonPayableTransactionObject<string>;
+
+    active_band(): NonPayableTransactionObject<string>;
+
+    min_band(): NonPayableTransactionObject<string>;
+
+    max_band(): NonPayableTransactionObject<string>;
+
+    admin_fees_x(): NonPayableTransactionObject<string>;
+
+    admin_fees_y(): NonPayableTransactionObject<string>;
+
+    price_oracle_contract(): NonPayableTransactionObject<string>;
+
+    bands_x(arg0: number | string | BN): NonPayableTransactionObject<string>;
+
+    bands_y(arg0: number | string | BN): NonPayableTransactionObject<string>;
+
+    liquidity_mining_callback(): NonPayableTransactionObject<string>;
+  };
+  events: {
+    TokenExchange(cb?: Callback<TokenExchange>): EventEmitter;
+    TokenExchange(
+      options?: EventOptions,
+      cb?: Callback<TokenExchange>
+    ): EventEmitter;
+
+    Deposit(cb?: Callback<Deposit>): EventEmitter;
+    Deposit(options?: EventOptions, cb?: Callback<Deposit>): EventEmitter;
+
+    Withdraw(cb?: Callback<Withdraw>): EventEmitter;
+    Withdraw(options?: EventOptions, cb?: Callback<Withdraw>): EventEmitter;
+
+    SetRate(cb?: Callback<SetRate>): EventEmitter;
+    SetRate(options?: EventOptions, cb?: Callback<SetRate>): EventEmitter;
+
+    SetFee(cb?: Callback<SetFee>): EventEmitter;
+    SetFee(options?: EventOptions, cb?: Callback<SetFee>): EventEmitter;
+
+    SetAdminFee(cb?: Callback<SetAdminFee>): EventEmitter;
+    SetAdminFee(
+      options?: EventOptions,
+      cb?: Callback<SetAdminFee>
+    ): EventEmitter;
+
+    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
+  };
+
+  once(event: "TokenExchange", cb: Callback<TokenExchange>): void;
+  once(
+    event: "TokenExchange",
+    options: EventOptions,
+    cb: Callback<TokenExchange>
+  ): void;
+
+  once(event: "Deposit", cb: Callback<Deposit>): void;
+  once(event: "Deposit", options: EventOptions, cb: Callback<Deposit>): void;
+
+  once(event: "Withdraw", cb: Callback<Withdraw>): void;
+  once(event: "Withdraw", options: EventOptions, cb: Callback<Withdraw>): void;
+
+  once(event: "SetRate", cb: Callback<SetRate>): void;
+  once(event: "SetRate", options: EventOptions, cb: Callback<SetRate>): void;
+
+  once(event: "SetFee", cb: Callback<SetFee>): void;
+  once(event: "SetFee", options: EventOptions, cb: Callback<SetFee>): void;
+
+  once(event: "SetAdminFee", cb: Callback<SetAdminFee>): void;
+  once(
+    event: "SetAdminFee",
+    options: EventOptions,
+    cb: Callback<SetAdminFee>
+  ): void;
+}