@dhedge/v2-sdk 2.1.7 → 2.2.0

package/src/types.ts

@@ -1,6 +1,8 @@
 import { Deployment } from "@lyrafinance/lyra-js";
 import { BigNumber } from "ethers";
 
+/** Networks supported by the SDK. The string value matches keys in `routerAddress`,
+ * `nonfungiblePositionManagerAddress`, etc. in `config.ts`. */
 export enum Network {
   POLYGON = "polygon",
   OPTIMISM = "optimism",
@@ -11,6 +13,8 @@ export enum Network {
   HYPERLIQUID = "hyperliquid"
 }
 
+/** Identifies a target protocol/integration for `pool.trade`, `pool.approve`, etc.
+ * Each entry maps to address registries (router, factory, gauge) in `config.ts`. */
 export enum Dapp {
   SUSHISWAP = "sushiswap",
   AAVE = "aave",
@@ -18,7 +22,6 @@ export enum Dapp {
   QUICKSWAP = "quickswap",
   BALANCER = "balancer",
   UNISWAPV3 = "uniswapV3",
-  SYNTHETIX = "synthetix",
   AAVEV3 = "aavev3",
   ARRAKIS = "arrakis",
   TOROS = "toros",
@@ -26,18 +29,19 @@ export enum Dapp {
   VELODROMEV2 = "velodromeV2",
   VELODROMECL = "velodromeCL",
   LYRA = "lyra",
-  RAMSES = "ramses",
   AERODROME = "aerodrome",
   AERODROMECL = "aerodromeCL",
-  RAMSESCL = "ramsesCL",
   PANCAKECL = "pancakeCL",
   COMPOUNDV3 = "compoundV3",
   ODOS = "odos",
   PENDLE = "pendle",
   KYBERSWAP = "kyberswap",
-  HYPERLIQUID = "hyperliquid"
+  HYPERLIQUID = "hyperliquid",
+  COWSWAP = "cowswap"
 }
 
+/** Function-name strings used when encoding ABI calls — keep in sync with the
+ * matching ABI files in `src/abi/`. */
 export enum Transaction {
   SWAP = "swapExactTokensForTokens",
   ADD_LIQUIDITY = "addLiquidity",
@@ -55,7 +59,6 @@ export enum Transaction {
   WITHDRAW = "withdraw",
   MINT = "mint",
   BURN = "burn",
-  SWAP_SYNTHS = "exchangeWithTracking",
   ADD_LIQUIDITY_STAKE = "addLiquidityAndStake",
   REMOVE_LIQUIDITY_UNSTAKE = "removeLiquidityAndUnstake"
 }
@@ -68,13 +71,16 @@ export type AddressDappMap = {
 
 export type AddressDappNetworkMap = Readonly<Record<Network, AddressDappMap>>;
 
+/** Tuple form `[asset, isDeposit]` accepted by the factory's `createFund`. */
 export type SupportedAsset = [string, boolean];
 
+/** Object form of a supported asset entry; preferred over `SupportedAsset` in SDK methods. */
 export type AssetEnabled = {
   asset: string;
   isDeposit: boolean;
 };
 
+/** A pool's holding of one asset returned by `pool.getComposition()`. */
 export type FundComposition = {
   asset: string;
   isDeposit: boolean;
@@ -106,14 +112,24 @@ export type LyraPosition = {
   state: number;
 };
 
+/**
+ * Options that control how SDK methods dispatch a transaction:
+ *  - `estimateGas`: simulate and return gas + minAmountOut without sending.
+ *  - `onlyGetTxData`: return the encoded calldata without sending or simulating.
+ *  - `useTraderAddressAsFrom`: send via the EOA wallet instead of the pool's
+ *    `execTransaction` (used when the SDK is acting as a non-dHEDGE caller).
+ *  - `boolean` shorthand: `true` is equivalent to `{ estimateGas: true }` (kept
+ *    for backward compatibility).
+ */
 export type SDKOptions =
   | {
       estimateGas: boolean;
       onlyGetTxData?: boolean;
       useTraderAddressAsFrom?: boolean;
     }
-  | boolean; // shorthand for { estimateGas: true/false }; for backward compatibility
+  | boolean;
 
+/** Parameters for a Toros limit order (stop-loss / take-profit) on a vault token. */
 export type LimitOrderInfo = {
   amount: BigNumber;
   stopLossPriceD18: BigNumber;

package/src/utils/contract.ts

@@ -6,6 +6,7 @@ import { multiCallAddress } from "../config";
 import { ethers, Network, Pool, SDKOptions } from "..";
 import { Signer } from "ethers";
 
+/** Single contract read: `call = [address, methodName, params?]`. */
 export async function call(
   provider: ethers.Signer,
   abi: any[],
@@ -21,6 +22,11 @@ export async function call(
   }
 }
 
+/**
+ * Batch multiple contract reads through Multicall's `tryAggregate`.
+ * Each call entry is `[address, methodName, params]`. When `requireSuccess` is false,
+ * failing calls return `null` instead of reverting the whole batch.
+ */
 export async function multicall<T>(
   network: Network,
   provider: ethers.Signer,
@@ -59,6 +65,11 @@ export async function multicall<T>(
   }
 }
 
+/**
+ * Fluent helper for building a multicall and dispatching results into a typed object.
+ * Use `.call(path, address, fn, params)` repeatedly, then `.execute()` returns the
+ * populated object with results placed at the given lodash paths.
+ */
 export class Multicaller {
   public network: Network;
   public provider: ethers.Signer;
@@ -135,6 +146,15 @@ export const isSdkOptionsBoolean = (
   return typeof sdkOptions === "boolean";
 };
 
+/**
+ * Central executor for SDK transactions. Routes a (`to`, `data`, `txOptions`) tuple
+ * through one of four paths depending on `pool.isDhedge` and `sdkOptions`:
+ *   - dHEDGE pool:    `pool.poolLogic.execTransaction(...)` (or its gas estimate)
+ *   - non-dHEDGE/EOA: `pool.signer.sendTransaction(...)` (or its gas estimate)
+ * Honours `sdkOptions.onlyGetTxData` (returns the encoded tx without sending),
+ * `estimateGas` (returns gas + minAmountOut without sending), and
+ * `useTraderAddressAsFrom` (forces the EOA path even for dHEDGE pools).
+ */
 export const getPoolTxOrGasEstimate = async (
   pool: Pool,
   args: any[],

package/dist/services/futures/constants.d.ts

@@ -1 +0,0 @@
-export declare const FUTURES_TRACKING = "DHEDGE";

package/dist/services/futures/index.d.ts

@@ -1,2 +0,0 @@
-export { getFuturesChangeMarginTxData } from "./margin";
-export { getFuturesChangePositionTxData } from "./trade";

package/dist/services/futures/margin.d.ts

@@ -1,2 +0,0 @@
-import { ethers } from "../..";
-export declare function getFuturesChangeMarginTxData(amount: ethers.BigNumber | string): string;

package/dist/services/futures/trade.d.ts

@@ -1,3 +0,0 @@
-import { Pool, ethers } from "../..";
-export declare function getFuturesChangePositionTxData(amount: ethers.BigNumber | string, market: string, pool: Pool): Promise<string>;
-export declare function getFuturesCancelOrderTxData(pool: Pool): Promise<string>;

package/dist/services/ramses/vesting.d.ts

@@ -1,4 +0,0 @@
-import { BigNumber } from "ethers";
-export declare function getCreateVestTxData(amount: BigNumber | string): string;
-export declare function getExitVestTxData(vestId: number): string;
-export declare function getRewardsTxDta(tokenId: string, rewards: string[]): string;

package/dist/services/uniswap/V3Trade.d.ts

@@ -1,3 +0,0 @@
-import { ethers } from "ethers";
-import { Pool } from "../..";
-export declare function getUniswapV3SwapTxData(pool: Pool, assetA: string, assetB: string, amountIn: string | ethers.BigNumber, slippage: number, feeAmount: number): Promise<any>;

package/dist/test/utils/futures.d.ts

@@ -1,2 +0,0 @@
-import { Pool } from "../..";
-export declare function getDelayedOrders(market: string, pool: Pool): Promise<any>;

package/src/abi/IRamsesNonfungiblePositionManager.json

@@ -1,486 +0,0 @@
-[
-  {
-    "anonymous": false,
-    "inputs": [
-      {
-        "indexed": true,
-        "internalType": "uint256",
-        "name": "tokenId",
-        "type": "uint256"
-      },
-      {
-        "indexed": false,
-        "internalType": "address",
-        "name": "recipient",
-        "type": "address"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount0",
-        "type": "uint256"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount1",
-        "type": "uint256"
-      }
-    ],
-    "name": "Collect",
-    "type": "event"
-  },
-  {
-    "anonymous": false,
-    "inputs": [
-      {
-        "indexed": true,
-        "internalType": "uint256",
-        "name": "tokenId",
-        "type": "uint256"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint128",
-        "name": "liquidity",
-        "type": "uint128"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount0",
-        "type": "uint256"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount1",
-        "type": "uint256"
-      }
-    ],
-    "name": "DecreaseLiquidity",
-    "type": "event"
-  },
-  {
-    "anonymous": false,
-    "inputs": [
-      {
-        "indexed": true,
-        "internalType": "uint256",
-        "name": "tokenId",
-        "type": "uint256"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint128",
-        "name": "liquidity",
-        "type": "uint128"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount0",
-        "type": "uint256"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount1",
-        "type": "uint256"
-      }
-    ],
-    "name": "IncreaseLiquidity",
-    "type": "event"
-  },
-  {
-    "inputs": [
-      {
-        "internalType": "uint256",
-        "name": "tokenId",
-        "type": "uint256"
-      }
-    ],
-    "name": "burn",
-    "outputs": [],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "components": [
-          {
-            "internalType": "uint256",
-            "name": "tokenId",
-            "type": "uint256"
-          },
-          {
-            "internalType": "address",
-            "name": "recipient",
-            "type": "address"
-          },
-          {
-            "internalType": "uint128",
-            "name": "amount0Max",
-            "type": "uint128"
-          },
-          {
-            "internalType": "uint128",
-            "name": "amount1Max",
-            "type": "uint128"
-          }
-        ],
-        "internalType": "struct IRamsesNonfungiblePositionManager.CollectParams",
-        "name": "params",
-        "type": "tuple"
-      }
-    ],
-    "name": "collect",
-    "outputs": [
-      {
-        "internalType": "uint256",
-        "name": "amount0",
-        "type": "uint256"
-      },
-      {
-        "internalType": "uint256",
-        "name": "amount1",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "components": [
-          {
-            "internalType": "uint256",
-            "name": "tokenId",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint128",
-            "name": "liquidity",
-            "type": "uint128"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount0Min",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount1Min",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "deadline",
-            "type": "uint256"
-          }
-        ],
-        "internalType": "struct IRamsesNonfungiblePositionManager.DecreaseLiquidityParams",
-        "name": "params",
-        "type": "tuple"
-      }
-    ],
-    "name": "decreaseLiquidity",
-    "outputs": [
-      {
-        "internalType": "uint256",
-        "name": "amount0",
-        "type": "uint256"
-      },
-      {
-        "internalType": "uint256",
-        "name": "amount1",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "factory",
-    "outputs": [
-      {
-        "internalType": "address",
-        "name": "",
-        "type": "address"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "internalType": "uint256",
-        "name": "tokenId",
-        "type": "uint256"
-      },
-      {
-        "internalType": "address[]",
-        "name": "tokens",
-        "type": "address[]"
-      }
-    ],
-    "name": "getReward",
-    "outputs": [],
-    "stateMutability": "nonpayable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "components": [
-          {
-            "internalType": "uint256",
-            "name": "tokenId",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount0Desired",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount1Desired",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount0Min",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount1Min",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "deadline",
-            "type": "uint256"
-          }
-        ],
-        "internalType": "struct IRamsesNonfungiblePositionManager.IncreaseLiquidityParams",
-        "name": "params",
-        "type": "tuple"
-      }
-    ],
-    "name": "increaseLiquidity",
-    "outputs": [
-      {
-        "internalType": "uint128",
-        "name": "liquidity",
-        "type": "uint128"
-      },
-      {
-        "internalType": "uint256",
-        "name": "amount0",
-        "type": "uint256"
-      },
-      {
-        "internalType": "uint256",
-        "name": "amount1",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "components": [
-          {
-            "internalType": "address",
-            "name": "token0",
-            "type": "address"
-          },
-          {
-            "internalType": "address",
-            "name": "token1",
-            "type": "address"
-          },
-          {
-            "internalType": "uint24",
-            "name": "fee",
-            "type": "uint24"
-          },
-          {
-            "internalType": "int24",
-            "name": "tickLower",
-            "type": "int24"
-          },
-          {
-            "internalType": "int24",
-            "name": "tickUpper",
-            "type": "int24"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount0Desired",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount1Desired",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount0Min",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "amount1Min",
-            "type": "uint256"
-          },
-          {
-            "internalType": "address",
-            "name": "recipient",
-            "type": "address"
-          },
-          {
-            "internalType": "uint256",
-            "name": "deadline",
-            "type": "uint256"
-          },
-          {
-            "internalType": "uint256",
-            "name": "veRamTokenId",
-            "type": "uint256"
-          }
-        ],
-        "internalType": "struct IRamsesNonfungiblePositionManager.MintParams",
-        "name": "params",
-        "type": "tuple"
-      }
-    ],
-    "name": "mint",
-    "outputs": [
-      {
-        "internalType": "uint256",
-        "name": "tokenId",
-        "type": "uint256"
-      },
-      {
-        "internalType": "uint128",
-        "name": "liquidity",
-        "type": "uint128"
-      },
-      {
-        "internalType": "uint256",
-        "name": "amount0",
-        "type": "uint256"
-      },
-      {
-        "internalType": "uint256",
-        "name": "amount1",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "internalType": "uint256",
-        "name": "tokenId",
-        "type": "uint256"
-      }
-    ],
-    "name": "positions",
-    "outputs": [
-      {
-        "internalType": "uint96",
-        "name": "nonce",
-        "type": "uint96"
-      },
-      {
-        "internalType": "address",
-        "name": "operator",
-        "type": "address"
-      },
-      {
-        "internalType": "address",
-        "name": "token0",
-        "type": "address"
-      },
-      {
-        "internalType": "address",
-        "name": "token1",
-        "type": "address"
-      },
-      {
-        "internalType": "uint24",
-        "name": "fee",
-        "type": "uint24"
-      },
-      {
-        "internalType": "int24",
-        "name": "tickLower",
-        "type": "int24"
-      },
-      {
-        "internalType": "int24",
-        "name": "tickUpper",
-        "type": "int24"
-      },
-      {
-        "internalType": "uint128",
-        "name": "liquidity",
-        "type": "uint128"
-      },
-      {
-        "internalType": "uint256",
-        "name": "feeGrowthInside0LastX128",
-        "type": "uint256"
-      },
-      {
-        "internalType": "uint256",
-        "name": "feeGrowthInside1LastX128",
-        "type": "uint256"
-      },
-      {
-        "internalType": "uint128",
-        "name": "tokensOwed0",
-        "type": "uint128"
-      },
-      {
-        "internalType": "uint128",
-        "name": "tokensOwed1",
-        "type": "uint128"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "internalType": "address",
-        "name": "owner",
-        "type": "address"
-      }
-    ],
-    "name": "balanceOf",
-    "outputs": [
-      {
-        "internalType": "uint256",
-        "name": "",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  }
-]