@defisaver/positions-sdk 2.1.52 → 2.1.53-aave-v4

package/src/types/claiming.ts

@@ -1,114 +1,114 @@
-import { EthAddress } from './common';
-
-export enum ClaimType {
-  /** Rewards from AAVE - various tokens & aTokens (supplied to protocol) */
-  AAVE_REWARDS = 'AAVE_REWARDS',
-  /** Merit rewards from AAVE (various tokens) */
-  AAVE_MERIT_REWARDS = 'AAVE_MERIT_REWARDS',
-  /** Rewards from Compound V3 (only in COMP) */
-  COMPOUND_V3_COMP = 'COMPOUND_V3_COMP',
-  /** Rewards from Spark (wstETH only for now) */
-  SPARK_REWARDS = 'SPARK_REWARDS',
-  /** Rewards from Morpho */
-  MORPHO = 'MORPHO',
-  /** Rewards from King (prev LTR^2 - received for weETH holding) */
-  KING_REWARDS = 'KING_REWARDS',
-  /** Spark Airdrop */
-  SPARK_AIRDROP = 'SPARK_AIRDROP',
-  /** Spark Airdrop */
-  SPARK_WST_ETH_REWARDS = 'SPARK_WST_ETH_REWARDS', // TODO: This will be removed once we fully refactor spark rewards
-
-  ETHENA_AIRDROP = 'ETHENA_AIRDROP',
-}
-
-type _ClaimableTokenPartial = {
-  symbol: string;
-  underlyingSymbol: string;
-  tokenAddress: EthAddress;
-  amount: string;
-  walletAddress: EthAddress;
-  label: string;
-};
-export type AaveRewardsClaimableToken = _ClaimableTokenPartial & {
-  claimType: ClaimType.AAVE_REWARDS;
-  additionalClaimFields: {
-    marketAddress: EthAddress;
-    aTokenAddresses: string[];
-    isAaveToken: boolean;
-  };
-};
-export type AaveMeritRewardsClaimableToken = _ClaimableTokenPartial & {
-  claimType: ClaimType.AAVE_MERIT_REWARDS;
-  additionalClaimFields: {
-    accumulated: string;
-    proof: string[];
-    decimals: string;
-    unclaimed: string;
-  };
-};
-
-export type SparkRewardsClaimableToken = _ClaimableTokenPartial & {
-  claimType: ClaimType.SPARK_REWARDS;
-  additionalClaimFields: {
-    sparkAssetAddresses: string[];
-  };
-};
-
-export type KingRewardsClaimableToken = _ClaimableTokenPartial & {
-  claimType: ClaimType.KING_REWARDS;
-  additionalClaimFields: {
-    allRewardsAmount: string;
-    merkleRoot: string;
-    merkleProofs: string[];
-  };
-};
-
-export type MorphoClaimableToken = _ClaimableTokenPartial & {
-  claimType: ClaimType.MORPHO,
-  additionalClaimFields: {
-    originalAmount: string,
-    merkleProofs: string[];
-    distributor: EthAddress;
-    isLegacy: boolean;
-    txData: string;
-  }
-};
-
-
-export type CompoundV3CompClaimableToken = _ClaimableTokenPartial & {
-  claimType: ClaimType.COMPOUND_V3_COMP,
-  additionalClaimFields: {
-    marketAddress: EthAddress;
-  }
-};
-
-export enum SparkAirdropType {
-  SPARK_IGNITION = 'spark-ignition',
-  PRE_FARMING_AND_SOCIAL = 'pre-farming-and-social',
-}
-
-export type SparkAirdropClaimableToken = _ClaimableTokenPartial & {
-  claimType: ClaimType.SPARK_AIRDROP,
-  additionalClaimFields: {
-    merkleRoot: string;
-    merkleProofs: string[];
-    epoch: number;
-    rewardType: SparkAirdropType;
-    allRewardsAmount: string;
-  };
-};
-
-export type SparkWstEthRewardsClaimableToken = _ClaimableTokenPartial & { claimType: ClaimType.SPARK_WST_ETH_REWARDS };
-
-export type EthenaAirdropClaimableToken = _ClaimableTokenPartial & { claimType: ClaimType.ETHENA_AIRDROP };
-
-export type ClaimableToken =
-    AaveRewardsClaimableToken
-    | AaveMeritRewardsClaimableToken
-    | CompoundV3CompClaimableToken
-    | MorphoClaimableToken
-    | SparkRewardsClaimableToken
-    | KingRewardsClaimableToken
-    | SparkAirdropClaimableToken
-    | SparkWstEthRewardsClaimableToken
-    | EthenaAirdropClaimableToken;
+import { EthAddress } from './common';
+
+export enum ClaimType {
+  /** Rewards from AAVE - various tokens & aTokens (supplied to protocol) */
+  AAVE_REWARDS = 'AAVE_REWARDS',
+  /** Merit rewards from AAVE (various tokens) */
+  AAVE_MERIT_REWARDS = 'AAVE_MERIT_REWARDS',
+  /** Rewards from Compound V3 (only in COMP) */
+  COMPOUND_V3_COMP = 'COMPOUND_V3_COMP',
+  /** Rewards from Spark (wstETH only for now) */
+  SPARK_REWARDS = 'SPARK_REWARDS',
+  /** Rewards from Morpho */
+  MORPHO = 'MORPHO',
+  /** Rewards from King (prev LTR^2 - received for weETH holding) */
+  KING_REWARDS = 'KING_REWARDS',
+  /** Spark Airdrop */
+  SPARK_AIRDROP = 'SPARK_AIRDROP',
+  /** Spark Airdrop */
+  SPARK_WST_ETH_REWARDS = 'SPARK_WST_ETH_REWARDS', // TODO: This will be removed once we fully refactor spark rewards
+
+  ETHENA_AIRDROP = 'ETHENA_AIRDROP',
+}
+
+type _ClaimableTokenPartial = {
+  symbol: string;
+  underlyingSymbol: string;
+  tokenAddress: EthAddress;
+  amount: string;
+  walletAddress: EthAddress;
+  label: string;
+};
+export type AaveRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.AAVE_REWARDS;
+  additionalClaimFields: {
+    marketAddress: EthAddress;
+    aTokenAddresses: string[];
+    isAaveToken: boolean;
+  };
+};
+export type AaveMeritRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.AAVE_MERIT_REWARDS;
+  additionalClaimFields: {
+    accumulated: string;
+    proof: string[];
+    decimals: string;
+    unclaimed: string;
+  };
+};
+
+export type SparkRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.SPARK_REWARDS;
+  additionalClaimFields: {
+    sparkAssetAddresses: string[];
+  };
+};
+
+export type KingRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.KING_REWARDS;
+  additionalClaimFields: {
+    allRewardsAmount: string;
+    merkleRoot: string;
+    merkleProofs: string[];
+  };
+};
+
+export type MorphoClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.MORPHO,
+  additionalClaimFields: {
+    originalAmount: string,
+    merkleProofs: string[];
+    distributor: EthAddress;
+    isLegacy: boolean;
+    txData: string;
+  }
+};
+
+
+export type CompoundV3CompClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.COMPOUND_V3_COMP,
+  additionalClaimFields: {
+    marketAddress: EthAddress;
+  }
+};
+
+export enum SparkAirdropType {
+  SPARK_IGNITION = 'spark-ignition',
+  PRE_FARMING_AND_SOCIAL = 'pre-farming-and-social',
+}
+
+export type SparkAirdropClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.SPARK_AIRDROP,
+  additionalClaimFields: {
+    merkleRoot: string;
+    merkleProofs: string[];
+    epoch: number;
+    rewardType: SparkAirdropType;
+    allRewardsAmount: string;
+  };
+};
+
+export type SparkWstEthRewardsClaimableToken = _ClaimableTokenPartial & { claimType: ClaimType.SPARK_WST_ETH_REWARDS };
+
+export type EthenaAirdropClaimableToken = _ClaimableTokenPartial & { claimType: ClaimType.ETHENA_AIRDROP };
+
+export type ClaimableToken =
+    AaveRewardsClaimableToken
+    | AaveMeritRewardsClaimableToken
+    | CompoundV3CompClaimableToken
+    | MorphoClaimableToken
+    | SparkRewardsClaimableToken
+    | KingRewardsClaimableToken
+    | SparkAirdropClaimableToken
+    | SparkWstEthRewardsClaimableToken
+    | EthenaAirdropClaimableToken;

package/src/types/common.ts

@@ -1,107 +1,115 @@
-export enum IncentiveKind {
-  Staking = 'staking',
-  Reward = 'reward',
-}
-
-export enum IncentiveEligibilityId {
-  AaveV3EthenaLiquidLeverage = '0x8014e0076e5393e62c49a7134070d8fccc922e46BORROW_BL',
-  AaveV3ArbitrumEthSupply = '0x5d16261c6715a653248269861bbacf68a9774cde',
-  AaveV3ArbitrumETHLSBorrow = '0x0c84331e39d6658Cd6e6b9ba04736cC4c4734351',
-  AaveV3EthenaLiquidLeveragePlasma = '0x67264783f1e9a2af8627a235853057a6fc975bd2BORROW_BL',
-}
-
-export interface IncentiveData {
-  token: string,
-  apy: string,
-  incentiveKind?: IncentiveKind;
-  description?: string;
-  eligibilityId?: IncentiveEligibilityId;
-}
-
-// General
-export type EthAddress = HexString;
-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,
-  Linea = 59144,
-  Plasma = 9745,
-}
-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,
-  borrowRateP2P?: string,
-  supplyRateP2P?: string,
-  supplyIncentives: IncentiveData[];
-  borrowIncentives: IncentiveData[];
-}
-
-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,
-  stableBorrowRate?: string,
-  debt?: string,
-  supplyRate?: string,
-  borrowRate?: 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,
-}
-
-export type EthereumProvider = { request(...args: any): Promise<any> }; // TODO
-
-export type HexString = `0x${string}`;
+export enum IncentiveKind {
+  Staking = 'staking',
+  Reward = 'reward',
+}
+
+export enum IncentiveEligibilityId {
+  AaveV3EthenaLiquidLeverage = '0x8014e0076e5393e62c49a7134070d8fccc922e46BORROW_BL',
+  AaveV3ArbitrumEthSupply = '0x5d16261c6715a653248269861bbacf68a9774cde',
+  AaveV3ArbitrumETHLSBorrow = '0x0c84331e39d6658Cd6e6b9ba04736cC4c4734351',
+  AaveV3EthenaLiquidLeveragePlasma = '0x67264783f1e9a2af8627a235853057a6fc975bd2BORROW_BL',
+}
+
+export enum LeverageType {
+  Long = 'long',
+  Short = 'short',
+  VolatilePair = 'volatile-pair',
+  VolatilePairReverse = 'volatile-pair-reverse',
+  None = '',
+}
+
+export interface IncentiveData {
+  token: string,
+  apy: string,
+  incentiveKind?: IncentiveKind;
+  description?: string;
+  eligibilityId?: IncentiveEligibilityId;
+}
+
+// General
+export type EthAddress = HexString;
+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,
+  Linea = 59144,
+  Plasma = 9745,
+}
+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,
+  borrowRateP2P?: string,
+  supplyRateP2P?: string,
+  supplyIncentives: IncentiveData[];
+  borrowIncentives: IncentiveData[];
+}
+
+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,
+  stableBorrowRate?: string,
+  debt?: string,
+  supplyRate?: string,
+  borrowRate?: 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,
+}
+
+export type EthereumProvider = { request(...args: any): Promise<any> }; // TODO
+
+export type HexString = `0x${string}`;