opentool 0.8.0 → 0.8.3

package/README.md

@@ -26,8 +26,8 @@ npm install opentool
 ```bash
 mkdir my-opentool-project
 cd my-opentool-project
-npm init -y
 npm install opentool
+npx opentool init
 ```
 
 ### 2. Create your first tool

package/dist/adapters/hyperliquid/index.d.ts

@@ -62,7 +62,7 @@ type ExchangeSignature = {
     v: 27 | 28;
 };
 type HyperliquidExchangeResponse<T = unknown> = {
-    status: "ok";
+    status: string;
     response?: {
         type: string;
         data?: T;
@@ -168,7 +168,16 @@ declare class HyperliquidExchangeClient {
         token: string;
         amount: string | number | bigint;
     }): Promise<HyperliquidExchangeResponse<unknown>>;
+    setPortfolioMargin(params: {
+        enabled: boolean;
+        user?: `0x${string}`;
+    }): Promise<HyperliquidExchangeResponse<unknown>>;
 }
+declare function setHyperliquidPortfolioMargin(options: {
+    wallet: WalletFullContext;
+    enabled: boolean;
+    user?: `0x${string}`;
+} & CommonActionOptions): Promise<HyperliquidExchangeResponse<unknown>>;
 declare function cancelHyperliquidOrders(options: {
     wallet: WalletFullContext;
     cancels: CancelInput[];
@@ -411,4 +420,4 @@ declare const __hyperliquidInternals: {
     splitSignature: typeof splitSignature;
 };
 
-export { HyperliquidApiError, type HyperliquidApproveBuilderFeeOptions, type HyperliquidApproveBuilderFeeResponse, HyperliquidBuilderApprovalError, type HyperliquidBuilderApprovalRecordInput, type HyperliquidBuilderFee, type HyperliquidClearinghouseState, type HyperliquidDepositResult, type HyperliquidEnvironment, HyperliquidExchangeClient, type HyperliquidExchangeResponse, type HyperliquidGrouping, HyperliquidGuardError, HyperliquidInfoClient, type HyperliquidOrderIntent, type HyperliquidOrderOptions, type HyperliquidOrderResponse, type HyperliquidOrderStatus, HyperliquidTermsError, type HyperliquidTermsRecordInput, type HyperliquidTriggerOptions, type HyperliquidTriggerType, type HyperliquidWithdrawResult, type NonceSource, __hyperliquidInternals, approveHyperliquidBuilderFee, batchModifyHyperliquidOrders, cancelAllHyperliquidOrders, cancelHyperliquidOrders, cancelHyperliquidOrdersByCloid, cancelHyperliquidTwapOrder, createHyperliquidSubAccount, createMonotonicNonceFactory, depositToHyperliquidBridge, fetchHyperliquidAssetCtxs, fetchHyperliquidClearinghouseState, fetchHyperliquidFrontendOpenOrders, fetchHyperliquidHistoricalOrders, fetchHyperliquidMeta, fetchHyperliquidMetaAndAssetCtxs, fetchHyperliquidOpenOrders, fetchHyperliquidOrderStatus, fetchHyperliquidPreTransferCheck, fetchHyperliquidSpotAssetCtxs, fetchHyperliquidSpotClearinghouseState, fetchHyperliquidSpotMeta, fetchHyperliquidSpotMetaAndAssetCtxs, fetchHyperliquidUserFills, fetchHyperliquidUserFillsByTime, fetchHyperliquidUserRateLimit, getHyperliquidMaxBuilderFee, modifyHyperliquidOrder, placeHyperliquidOrder, placeHyperliquidTwapOrder, recordHyperliquidBuilderApproval, recordHyperliquidTermsAcceptance, reserveHyperliquidRequestWeight, scheduleHyperliquidCancel, sendHyperliquidSpot, transferHyperliquidSubAccount, updateHyperliquidIsolatedMargin, updateHyperliquidLeverage, withdrawFromHyperliquid };
+export { HyperliquidApiError, type HyperliquidApproveBuilderFeeOptions, type HyperliquidApproveBuilderFeeResponse, HyperliquidBuilderApprovalError, type HyperliquidBuilderApprovalRecordInput, type HyperliquidBuilderFee, type HyperliquidClearinghouseState, type HyperliquidDepositResult, type HyperliquidEnvironment, HyperliquidExchangeClient, type HyperliquidExchangeResponse, type HyperliquidGrouping, HyperliquidGuardError, HyperliquidInfoClient, type HyperliquidOrderIntent, type HyperliquidOrderOptions, type HyperliquidOrderResponse, type HyperliquidOrderStatus, HyperliquidTermsError, type HyperliquidTermsRecordInput, type HyperliquidTriggerOptions, type HyperliquidTriggerType, type HyperliquidWithdrawResult, type NonceSource, __hyperliquidInternals, approveHyperliquidBuilderFee, batchModifyHyperliquidOrders, cancelAllHyperliquidOrders, cancelHyperliquidOrders, cancelHyperliquidOrdersByCloid, cancelHyperliquidTwapOrder, createHyperliquidSubAccount, createMonotonicNonceFactory, depositToHyperliquidBridge, fetchHyperliquidAssetCtxs, fetchHyperliquidClearinghouseState, fetchHyperliquidFrontendOpenOrders, fetchHyperliquidHistoricalOrders, fetchHyperliquidMeta, fetchHyperliquidMetaAndAssetCtxs, fetchHyperliquidOpenOrders, fetchHyperliquidOrderStatus, fetchHyperliquidPreTransferCheck, fetchHyperliquidSpotAssetCtxs, fetchHyperliquidSpotClearinghouseState, fetchHyperliquidSpotMeta, fetchHyperliquidSpotMetaAndAssetCtxs, fetchHyperliquidUserFills, fetchHyperliquidUserFillsByTime, fetchHyperliquidUserRateLimit, getHyperliquidMaxBuilderFee, modifyHyperliquidOrder, placeHyperliquidOrder, placeHyperliquidTwapOrder, recordHyperliquidBuilderApproval, recordHyperliquidTermsAcceptance, reserveHyperliquidRequestWeight, scheduleHyperliquidCancel, sendHyperliquidSpot, setHyperliquidPortfolioMargin, transferHyperliquidSubAccount, updateHyperliquidIsolatedMargin, updateHyperliquidLeverage, withdrawFromHyperliquid };

package/dist/adapters/hyperliquid/index.js

@@ -307,6 +307,37 @@ async function signApproveBuilderFee(args) {
   });
   return splitSignature(signatureHex);
 }
+async function signUserPortfolioMargin(args) {
+  const { wallet, action } = args;
+  const domain = {
+    name: "HyperliquidSignTransaction",
+    version: "1",
+    chainId: Number.parseInt(action.signatureChainId, 16),
+    verifyingContract: ZERO_ADDRESS
+  };
+  const message = {
+    enabled: action.enabled,
+    hyperliquidChain: action.hyperliquidChain,
+    user: action.user,
+    nonce: BigInt(action.nonce)
+  };
+  const types = {
+    "HyperliquidTransaction:UserPortfolioMargin": [
+      { name: "enabled", type: "bool" },
+      { name: "hyperliquidChain", type: "string" },
+      { name: "user", type: "address" },
+      { name: "nonce", type: "uint64" }
+    ]
+  };
+  const signatureHex = await wallet.walletClient.signTypedData({
+    account: wallet.account,
+    domain,
+    types,
+    primaryType: "HyperliquidTransaction:UserPortfolioMargin",
+    message
+  });
+  return splitSignature(signatureHex);
+}
 function splitSignature(signature) {
   const cleaned = signature.slice(2);
   const rHex = `0x${cleaned.slice(0, 64)}`;
@@ -507,7 +538,58 @@ var HyperliquidExchangeClient = class {
       ...params
     });
   }
+  setPortfolioMargin(params) {
+    const base = {
+      wallet: this.wallet,
+      enabled: params.enabled,
+      environment: this.environment,
+      vaultAddress: this.vaultAddress,
+      expiresAfter: this.expiresAfter,
+      nonceSource: this.nonceSource
+    };
+    return setHyperliquidPortfolioMargin(
+      params.user ? { ...base, user: params.user } : base
+    );
+  }
 };
+async function setHyperliquidPortfolioMargin(options) {
+  const env = options.environment ?? "mainnet";
+  if (!options.wallet?.account || !options.wallet.walletClient) {
+    throw new Error(
+      "Wallet with signing capability is required for portfolio margin."
+    );
+  }
+  const nonce = options.nonce ?? options.walletNonceProvider?.() ?? options.wallet.nonceSource?.() ?? options.nonceSource?.() ?? Date.now();
+  const signatureChainId = getSignatureChainId(env);
+  const hyperliquidChain = HL_CHAIN_LABEL[env];
+  const user = normalizeAddress(
+    options.user ?? options.wallet.address
+  );
+  const action = {
+    type: "userPortfolioMargin",
+    enabled: Boolean(options.enabled),
+    hyperliquidChain,
+    signatureChainId,
+    user,
+    nonce
+  };
+  const signature = await signUserPortfolioMargin({
+    wallet: options.wallet,
+    action
+  });
+  const body = {
+    action,
+    nonce,
+    signature
+  };
+  if (options.vaultAddress) {
+    body.vaultAddress = normalizeAddress(options.vaultAddress);
+  }
+  if (typeof options.expiresAfter === "number") {
+    body.expiresAfter = options.expiresAfter;
+  }
+  return postExchange(env, body);
+}
 async function cancelHyperliquidOrders(options) {
   options.cancels.forEach((c) => assertSymbol(c.symbol));
   const action = {
@@ -830,15 +912,35 @@ async function postExchange(env, body) {
     headers: { "content-type": "application/json" },
     body: JSON.stringify(body)
   });
-  const json = await response.json().catch(() => null);
-  if (!response.ok || !json) {
-    throw new HyperliquidApiError(
-      "Hyperliquid exchange action failed.",
-      json ?? { status: response.status }
-    );
+  const text = await response.text().catch(() => "");
+  const json = (() => {
+    if (!text) return null;
+    try {
+      return JSON.parse(text);
+    } catch {
+      return null;
+    }
+  })();
+  if (!response.ok) {
+    throw new HyperliquidApiError("Hyperliquid exchange action failed.", {
+      status: response.status,
+      statusText: response.statusText,
+      body: json ?? (text ? text : null)
+    });
+  }
+  if (!json) {
+    throw new HyperliquidApiError("Hyperliquid exchange action failed.", {
+      status: response.status,
+      statusText: response.statusText,
+      body: text ? text : null
+    });
   }
   if (json.status !== "ok") {
-    throw new HyperliquidApiError("Hyperliquid exchange returned error.", json);
+    throw new HyperliquidApiError("Hyperliquid exchange returned error.", {
+      status: response.status,
+      statusText: response.statusText,
+      body: json
+    });
   }
   return json;
 }
@@ -1406,6 +1508,6 @@ var __hyperliquidInternals = {
   splitSignature
 };
 
-export { HyperliquidApiError, HyperliquidBuilderApprovalError, HyperliquidExchangeClient, HyperliquidGuardError, HyperliquidInfoClient, HyperliquidTermsError, __hyperliquidInternals, approveHyperliquidBuilderFee, batchModifyHyperliquidOrders, cancelAllHyperliquidOrders, cancelHyperliquidOrders, cancelHyperliquidOrdersByCloid, cancelHyperliquidTwapOrder, createHyperliquidSubAccount, createMonotonicNonceFactory, depositToHyperliquidBridge, fetchHyperliquidAssetCtxs, fetchHyperliquidClearinghouseState, fetchHyperliquidFrontendOpenOrders, fetchHyperliquidHistoricalOrders, fetchHyperliquidMeta, fetchHyperliquidMetaAndAssetCtxs, fetchHyperliquidOpenOrders, fetchHyperliquidOrderStatus, fetchHyperliquidPreTransferCheck, fetchHyperliquidSpotAssetCtxs, fetchHyperliquidSpotClearinghouseState, fetchHyperliquidSpotMeta, fetchHyperliquidSpotMetaAndAssetCtxs, fetchHyperliquidUserFills, fetchHyperliquidUserFillsByTime, fetchHyperliquidUserRateLimit, getHyperliquidMaxBuilderFee, modifyHyperliquidOrder, placeHyperliquidOrder, placeHyperliquidTwapOrder, recordHyperliquidBuilderApproval, recordHyperliquidTermsAcceptance, reserveHyperliquidRequestWeight, scheduleHyperliquidCancel, sendHyperliquidSpot, transferHyperliquidSubAccount, updateHyperliquidIsolatedMargin, updateHyperliquidLeverage, withdrawFromHyperliquid };
+export { HyperliquidApiError, HyperliquidBuilderApprovalError, HyperliquidExchangeClient, HyperliquidGuardError, HyperliquidInfoClient, HyperliquidTermsError, __hyperliquidInternals, approveHyperliquidBuilderFee, batchModifyHyperliquidOrders, cancelAllHyperliquidOrders, cancelHyperliquidOrders, cancelHyperliquidOrdersByCloid, cancelHyperliquidTwapOrder, createHyperliquidSubAccount, createMonotonicNonceFactory, depositToHyperliquidBridge, fetchHyperliquidAssetCtxs, fetchHyperliquidClearinghouseState, fetchHyperliquidFrontendOpenOrders, fetchHyperliquidHistoricalOrders, fetchHyperliquidMeta, fetchHyperliquidMetaAndAssetCtxs, fetchHyperliquidOpenOrders, fetchHyperliquidOrderStatus, fetchHyperliquidPreTransferCheck, fetchHyperliquidSpotAssetCtxs, fetchHyperliquidSpotClearinghouseState, fetchHyperliquidSpotMeta, fetchHyperliquidSpotMetaAndAssetCtxs, fetchHyperliquidUserFills, fetchHyperliquidUserFillsByTime, fetchHyperliquidUserRateLimit, getHyperliquidMaxBuilderFee, modifyHyperliquidOrder, placeHyperliquidOrder, placeHyperliquidTwapOrder, recordHyperliquidBuilderApproval, recordHyperliquidTermsAcceptance, reserveHyperliquidRequestWeight, scheduleHyperliquidCancel, sendHyperliquidSpot, setHyperliquidPortfolioMargin, transferHyperliquidSubAccount, updateHyperliquidIsolatedMargin, updateHyperliquidLeverage, withdrawFromHyperliquid };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map