@strobelabs/perpcity-sdk 0.4.3 → 0.5.1

package/dist/index.js

@@ -36,6 +36,10 @@ __export(index_exports, {
   ErrorCategory: () => ErrorCategory,
   ErrorSource: () => ErrorSource,
   InsufficientFundsError: () => InsufficientFundsError,
+  MAX_PRICE: () => MAX_PRICE,
+  MAX_TICK: () => MAX_TICK,
+  MIN_PRICE: () => MIN_PRICE,
+  MIN_TICK: () => MIN_TICK,
   NUMBER_1E6: () => NUMBER_1E6,
   OpenPosition: () => OpenPosition,
   PERP_MANAGER_ABI: () => PERP_MANAGER_ABI,
@@ -46,6 +50,7 @@ __export(index_exports, {
   TransactionRejectedError: () => TransactionRejectedError,
   ValidationError: () => ValidationError,
   approveUsdc: () => approveUsdc,
+  calculateAlignedTicks: () => calculateAlignedTicks,
   calculateEntryPrice: () => calculateEntryPrice,
   calculateLeverage: () => calculateLeverage,
   calculateLiquidationPrice: () => calculateLiquidationPrice,
@@ -80,6 +85,7 @@ __export(index_exports, {
   parseContractError: () => parseContractError,
   priceToSqrtPriceX96: () => priceToSqrtPriceX96,
   priceToTick: () => priceToTick,
+  quoteOpenMakerPosition: () => quoteOpenMakerPosition,
   scale6Decimals: () => scale6Decimals,
   scaleFrom6Decimals: () => scaleFrom6Decimals,
   scaleFromX96: () => scaleFromX96,
@@ -668,26 +674,19 @@ var PERP_MANAGER_ABI = [
     anonymous: false,
     inputs: [
       {
-        indexed: false,
-        internalType: "contract IFees",
-        name: "feesModule",
-        type: "address"
-      }
-    ],
-    name: "FeesModuleRegistered",
-    type: "event"
-  },
-  {
-    anonymous: false,
-    inputs: [
+        indexed: true,
+        internalType: "uint8",
+        name: "moduleType",
+        type: "uint8"
+      },
       {
-        indexed: false,
-        internalType: "contract ILockupPeriod",
-        name: "lockupPeriodModule",
+        indexed: true,
+        internalType: "address",
+        name: "module",
         type: "address"
       }
     ],
-    name: "LockupPeriodModuleRegistered",
+    name: "ModuleRegistered",
     type: "event"
   },
   {
@@ -715,19 +714,6 @@ var PERP_MANAGER_ABI = [
     name: "MarginAdjusted",
     type: "event"
   },
-  {
-    anonymous: false,
-    inputs: [
-      {
-        indexed: false,
-        internalType: "contract IMarginRatios",
-        name: "marginRatiosModule",
-        type: "address"
-      }
-    ],
-    name: "MarginRatiosModuleRegistered",
-    type: "event"
-  },
   {
     anonymous: false,
     inputs: [
@@ -901,13 +887,13 @@ var PERP_MANAGER_ABI = [
       {
         indexed: false,
         internalType: "int256",
-        name: "perpDelta",
+        name: "exitPerpDelta",
         type: "int256"
       },
       {
         indexed: false,
         internalType: "int256",
-        name: "usdDelta",
+        name: "exitUsdDelta",
         type: "int256"
       },
       {
@@ -921,6 +907,42 @@ var PERP_MANAGER_ABI = [
         internalType: "int24",
         name: "tickUpper",
         type: "int24"
+      },
+      {
+        indexed: false,
+        internalType: "int256",
+        name: "netUsdDelta",
+        type: "int256"
+      },
+      {
+        indexed: false,
+        internalType: "int256",
+        name: "funding",
+        type: "int256"
+      },
+      {
+        indexed: false,
+        internalType: "uint256",
+        name: "utilizationFee",
+        type: "uint256"
+      },
+      {
+        indexed: false,
+        internalType: "uint256",
+        name: "adl",
+        type: "uint256"
+      },
+      {
+        indexed: false,
+        internalType: "uint256",
+        name: "liquidationFee",
+        type: "uint256"
+      },
+      {
+        indexed: false,
+        internalType: "int256",
+        name: "netMargin",
+        type: "int256"
       }
     ],
     name: "PositionClosed",
@@ -993,19 +1015,6 @@ var PERP_MANAGER_ABI = [
     name: "PositionOpened",
     type: "event"
   },
-  {
-    anonymous: false,
-    inputs: [
-      {
-        indexed: false,
-        internalType: "contract ISqrtPriceImpactLimit",
-        name: "sqrtPriceImpactLimitModule",
-        type: "address"
-      }
-    ],
-    name: "SqrtPriceImpactLimitModuleRegistered",
-    type: "event"
-  },
   {
     anonymous: false,
     inputs: [
@@ -1132,12 +1141,12 @@ var PERP_MANAGER_ABI = [
           },
           {
             internalType: "int256",
-            name: "perpDelta",
+            name: "usdDelta",
             type: "int256"
           },
           {
             internalType: "uint128",
-            name: "usdLimit",
+            name: "perpLimit",
             type: "uint128"
           }
         ],
@@ -1384,11 +1393,6 @@ var PERP_MANAGER_ABI = [
             internalType: "contract ISqrtPriceImpactLimit",
             name: "sqrtPriceImpactLimit",
             type: "address"
-          },
-          {
-            internalType: "uint160",
-            name: "startingSqrtPriceX96",
-            type: "uint160"
           }
         ],
         internalType: "struct IPerpManager.CreatePerpParams",
@@ -1509,69 +1513,17 @@ var PERP_MANAGER_ABI = [
   {
     inputs: [
       {
-        internalType: "contract IFees",
-        name: "",
-        type: "address"
-      }
-    ],
-    name: "isFeesRegistered",
-    outputs: [
-      {
-        internalType: "bool",
-        name: "",
-        type: "bool"
-      }
-    ],
-    stateMutability: "view",
-    type: "function"
-  },
-  {
-    inputs: [
-      {
-        internalType: "contract ILockupPeriod",
-        name: "",
-        type: "address"
-      }
-    ],
-    name: "isLockupPeriodRegistered",
-    outputs: [
-      {
-        internalType: "bool",
-        name: "",
-        type: "bool"
-      }
-    ],
-    stateMutability: "view",
-    type: "function"
-  },
-  {
-    inputs: [
-      {
-        internalType: "contract IMarginRatios",
-        name: "",
-        type: "address"
-      }
-    ],
-    name: "isMarginRatiosRegistered",
-    outputs: [
-      {
-        internalType: "bool",
-        name: "",
-        type: "bool"
-      }
-    ],
-    stateMutability: "view",
-    type: "function"
-  },
-  {
-    inputs: [
+        internalType: "uint8",
+        name: "moduleType",
+        type: "uint8"
+      },
       {
-        internalType: "contract ISqrtPriceImpactLimit",
-        name: "",
+        internalType: "address",
+        name: "module",
         type: "address"
       }
     ],
-    name: "isSqrtPriceImpactLimitRegistered",
+    name: "isModuleRegistered",
     outputs: [
       {
         internalType: "bool",
@@ -1923,14 +1875,19 @@ var PERP_MANAGER_ABI = [
         type: "int256"
       },
       {
-        internalType: "uint256",
+        internalType: "int256",
         name: "netMargin",
-        type: "uint256"
+        type: "int256"
       },
       {
         internalType: "bool",
         name: "wasLiquidated",
         type: "bool"
+      },
+      {
+        internalType: "uint256",
+        name: "notional",
+        type: "uint256"
       }
     ],
     stateMutability: "nonpayable",
@@ -2071,51 +2028,66 @@ var PERP_MANAGER_ABI = [
   {
     inputs: [
       {
-        internalType: "contract IFees",
-        name: "feesModule",
-        type: "address"
-      }
-    ],
-    name: "registerFeesModule",
-    outputs: [],
-    stateMutability: "nonpayable",
-    type: "function"
-  },
-  {
-    inputs: [
+        internalType: "PoolId",
+        name: "perpId",
+        type: "bytes32"
+      },
       {
-        internalType: "contract ILockupPeriod",
-        name: "lockupPeriodModule",
-        type: "address"
+        internalType: "bool",
+        name: "zeroForOne",
+        type: "bool"
+      },
+      {
+        internalType: "bool",
+        name: "isExactIn",
+        type: "bool"
+      },
+      {
+        internalType: "uint256",
+        name: "amount",
+        type: "uint256"
+      },
+      {
+        internalType: "uint160",
+        name: "sqrtPriceLimitX96",
+        type: "uint160"
       }
     ],
-    name: "registerLockupPeriodModule",
-    outputs: [],
-    stateMutability: "nonpayable",
-    type: "function"
-  },
-  {
-    inputs: [
+    name: "quoteSwap",
+    outputs: [
       {
-        internalType: "contract IMarginRatios",
-        name: "marginRatiosModule",
-        type: "address"
+        internalType: "bytes",
+        name: "unexpectedReason",
+        type: "bytes"
+      },
+      {
+        internalType: "int256",
+        name: "perpDelta",
+        type: "int256"
+      },
+      {
+        internalType: "int256",
+        name: "usdDelta",
+        type: "int256"
       }
     ],
-    name: "registerMarginRatiosModule",
-    outputs: [],
     stateMutability: "nonpayable",
     type: "function"
   },
   {
     inputs: [
       {
-        internalType: "contract ISqrtPriceImpactLimit",
-        name: "sqrtPriceImpactLimitModule",
+        internalType: "uint8",
+        name: "moduleType",
+        type: "uint8"
+      },
+      {
+        internalType: "address",
+        name: "module",
         type: "address"
       }
     ],
-    name: "registerSqrtPriceImpactLimitModule",
+    name: "registerModule",
     outputs: [],
     stateMutability: "nonpayable",
     type: "function"
@@ -2496,6 +2468,10 @@ async function approveUsdc(context, amount, confirmations = DEFAULT_CONFIRMATION
 var NUMBER_1E6 = 1e6;
 var BIGINT_1E6 = 1000000n;
 var Q96 = 79228162514264337593543950336n;
+var MIN_TICK = -887272;
+var MAX_TICK = 887272;
+var MIN_PRICE = 1e-6;
+var MAX_PRICE = 1e6;
 
 // src/utils/conversions.ts
 function priceToSqrtPriceX96(price) {
@@ -2528,6 +2504,11 @@ function priceToTick(price, roundDown) {
   if (price <= 0) {
     throw new Error("Price must be positive");
   }
+  if (price < MIN_PRICE || price > MAX_PRICE) {
+    throw new Error(
+      `Price ${price} is outside the representable range [${MIN_PRICE}, ${MAX_PRICE}]`
+    );
+  }
   const logPrice = Math.log(price) / Math.log(1.0001);
   return roundDown ? Math.floor(logPrice) : Math.ceil(logPrice);
 }
@@ -3566,7 +3547,6 @@ function getPerpTickSpacing(perpData) {
 var import_viem5 = require("viem");
 async function createPerp(context, params) {
   return withErrorHandling(async () => {
-    const sqrtPriceX96 = priceToSqrtPriceX96(params.startingPrice);
     const deployments = context.deployments();
     const fees = params.fees ?? deployments.feesModule;
     const marginRatios = params.marginRatios ?? deployments.marginRatiosModule;
@@ -3580,8 +3560,7 @@ async function createPerp(context, params) {
       fees,
       marginRatios,
       lockupPeriod,
-      sqrtPriceImpactLimit,
-      startingSqrtPriceX96: sqrtPriceX96
+      sqrtPriceImpactLimit
     };
     const { request } = await context.publicClient.simulateContract({
       address: context.deployments().perpManager,
@@ -3591,7 +3570,9 @@ async function createPerp(context, params) {
       account: context.walletClient.account
     });
     const txHash = await context.walletClient.writeContract(request);
-    const receipt = await context.publicClient.waitForTransactionReceipt({ hash: txHash });
+    const receipt = await context.publicClient.waitForTransactionReceipt({
+      hash: txHash
+    });
     if (receipt.status === "reverted") {
       throw new Error(`Transaction reverted. Hash: ${txHash}`);
     }
@@ -3658,7 +3639,9 @@ async function openTakerPosition(context, perpId, params) {
       account: context.walletClient.account
     });
     const txHash = await context.walletClient.writeContract(request);
-    const receipt = await context.publicClient.waitForTransactionReceipt({ hash: txHash });
+    const receipt = await context.publicClient.waitForTransactionReceipt({
+      hash: txHash
+    });
     if (receipt.status === "reverted") {
       throw new Error(`Transaction reverted. Hash: ${txHash}`);
     }
@@ -3683,6 +3666,82 @@ async function openTakerPosition(context, perpId, params) {
     return new OpenPosition(context, perpId, takerPosId, params.isLong, false, txHash);
   }, "openTakerPosition");
 }
+function buildMakerContractParams(context, marginScaled, params, alignedTickLower, alignedTickUpper, maxAmt0In, maxAmt1In) {
+  return {
+    holder: context.walletClient.account.address,
+    margin: marginScaled,
+    liquidity: params.liquidity,
+    tickLower: alignedTickLower,
+    tickUpper: alignedTickUpper,
+    maxAmt0In,
+    maxAmt1In
+  };
+}
+function calculateAlignedTicks(priceLower, priceUpper, tickSpacing) {
+  const tickLower = priceToTick(priceLower, true);
+  const tickUpper = priceToTick(priceUpper, false);
+  const alignedTickLower = Math.floor(tickLower / tickSpacing) * tickSpacing;
+  const alignedTickUpper = Math.ceil(tickUpper / tickSpacing) * tickSpacing;
+  if (alignedTickLower < MIN_TICK) {
+    throw new Error(
+      `Lower tick ${alignedTickLower} is below MIN_TICK (${MIN_TICK}). Increase priceLower.`
+    );
+  }
+  if (alignedTickUpper > MAX_TICK) {
+    throw new Error(
+      `Upper tick ${alignedTickUpper} exceeds MAX_TICK (${MAX_TICK}). Decrease priceUpper.`
+    );
+  }
+  if (alignedTickLower === alignedTickUpper) {
+    throw new Error(
+      "Price range too narrow: lower and upper ticks are equal after alignment. Widen the range."
+    );
+  }
+  return { alignedTickLower, alignedTickUpper };
+}
+function alignMakerTicks(params, tickSpacing) {
+  return calculateAlignedTicks(params.priceLower, params.priceUpper, tickSpacing);
+}
+var DEFAULT_MAKER_SLIPPAGE_TOLERANCE = 0.01;
+var MAX_UINT128 = 2n ** 128n - 1n;
+async function quoteOpenMakerPosition(context, perpId, params) {
+  return withErrorHandling(async () => {
+    if (params.margin <= 0) {
+      throw new Error("Margin must be greater than 0");
+    }
+    if (params.priceLower >= params.priceUpper) {
+      throw new Error("priceLower must be less than priceUpper");
+    }
+    const marginScaled = scale6Decimals(params.margin);
+    const perpData = await context.getPerpData(perpId);
+    const { alignedTickLower, alignedTickUpper } = alignMakerTicks(params, perpData.tickSpacing);
+    const contractParams = buildMakerContractParams(
+      context,
+      marginScaled,
+      params,
+      alignedTickLower,
+      alignedTickUpper,
+      MAX_UINT128,
+      MAX_UINT128
+    );
+    const [unexpectedReason, perpDelta, usdDelta] = await context.publicClient.readContract({
+      address: context.deployments().perpManager,
+      abi: PERP_MANAGER_ABI,
+      functionName: "quoteOpenMakerPosition",
+      args: [perpId, contractParams]
+    });
+    if (unexpectedReason !== "0x") {
+      throw new Error(`Quote failed: ${unexpectedReason}`);
+    }
+    return { perpDelta, usdDelta };
+  }, "quoteOpenMakerPosition");
+}
+function applySlippage(delta, slippageTolerance) {
+  if (delta >= 0n) return 0n;
+  const absDelta = -delta;
+  const slippageBps = BigInt(Math.ceil(slippageTolerance * 1e4));
+  return absDelta + absDelta * slippageBps / 10000n;
+}
 async function openMakerPosition(context, perpId, params) {
   return withErrorHandling(async () => {
     if (params.margin <= 0) {
@@ -3692,8 +3751,24 @@ async function openMakerPosition(context, perpId, params) {
       throw new Error("priceLower must be less than priceUpper");
     }
     const marginScaled = scale6Decimals(params.margin);
-    const maxAmt0InScaled = typeof params.maxAmt0In === "bigint" ? params.maxAmt0In : scale6Decimals(params.maxAmt0In);
-    const maxAmt1InScaled = typeof params.maxAmt1In === "bigint" ? params.maxAmt1In : scale6Decimals(params.maxAmt1In);
+    const perpData = await context.getPerpData(perpId);
+    const { alignedTickLower, alignedTickUpper } = alignMakerTicks(params, perpData.tickSpacing);
+    let maxAmt0In;
+    let maxAmt1In;
+    if (params.maxAmt0In === void 0 !== (params.maxAmt1In === void 0)) {
+      throw new Error(
+        "Both maxAmt0In and maxAmt1In must be provided together or neither. Omit both to use automatic quote-based slippage calculation."
+      );
+    }
+    if (params.maxAmt0In !== void 0 && params.maxAmt1In !== void 0) {
+      maxAmt0In = typeof params.maxAmt0In === "bigint" ? params.maxAmt0In : scale6Decimals(params.maxAmt0In);
+      maxAmt1In = typeof params.maxAmt1In === "bigint" ? params.maxAmt1In : scale6Decimals(params.maxAmt1In);
+    } else {
+      const quote = await quoteOpenMakerPosition(context, perpId, params);
+      const slippage = params.slippageTolerance ?? DEFAULT_MAKER_SLIPPAGE_TOLERANCE;
+      maxAmt0In = applySlippage(quote.perpDelta, slippage);
+      maxAmt1In = applySlippage(quote.usdDelta, slippage);
+    }
     const currentAllowance = await context.publicClient.readContract({
       address: context.deployments().usdc,
       abi: import_viem5.erc20Abi,
@@ -3704,21 +3779,15 @@ async function openMakerPosition(context, perpId, params) {
     if (currentAllowance < marginScaled) {
       await approveUsdc(context, marginScaled);
     }
-    const perpData = await context.getPerpData(perpId);
-    const tickLower = priceToTick(params.priceLower, true);
-    const tickUpper = priceToTick(params.priceUpper, false);
-    const tickSpacing = perpData.tickSpacing;
-    const alignedTickLower = Math.floor(tickLower / tickSpacing) * tickSpacing;
-    const alignedTickUpper = Math.ceil(tickUpper / tickSpacing) * tickSpacing;
-    const contractParams = {
-      holder: context.walletClient.account.address,
-      margin: marginScaled,
-      liquidity: params.liquidity,
-      tickLower: alignedTickLower,
-      tickUpper: alignedTickUpper,
-      maxAmt0In: maxAmt0InScaled,
-      maxAmt1In: maxAmt1InScaled
-    };
+    const contractParams = buildMakerContractParams(
+      context,
+      marginScaled,
+      params,
+      alignedTickLower,
+      alignedTickUpper,
+      maxAmt0In,
+      maxAmt1In
+    );
     const { request } = await context.publicClient.simulateContract({
       address: context.deployments().perpManager,
       abi: PERP_MANAGER_ABI,
@@ -3727,7 +3796,9 @@ async function openMakerPosition(context, perpId, params) {
       account: context.walletClient.account
     });
     const txHash = await context.walletClient.writeContract(request);
-    const receipt = await context.publicClient.waitForTransactionReceipt({ hash: txHash });
+    const receipt = await context.publicClient.waitForTransactionReceipt({
+      hash: txHash
+    });
     if (receipt.status === "reverted") {
       throw new Error(`Transaction reverted. Hash: ${txHash}`);
     }
@@ -3915,6 +3986,10 @@ function getUserWalletAddress(userData) {
   ErrorCategory,
   ErrorSource,
   InsufficientFundsError,
+  MAX_PRICE,
+  MAX_TICK,
+  MIN_PRICE,
+  MIN_TICK,
   NUMBER_1E6,
   OpenPosition,
   PERP_MANAGER_ABI,
@@ -3925,6 +4000,7 @@ function getUserWalletAddress(userData) {
   TransactionRejectedError,
   ValidationError,
   approveUsdc,
+  calculateAlignedTicks,
   calculateEntryPrice,
   calculateLeverage,
   calculateLiquidationPrice,
@@ -3959,6 +4035,7 @@ function getUserWalletAddress(userData) {
   parseContractError,
   priceToSqrtPriceX96,
   priceToTick,
+  quoteOpenMakerPosition,
   scale6Decimals,
   scaleFrom6Decimals,
   scaleFromX96,