@nktkas/hyperliquid/esm/api/exchange/_methods/withdraw3.js

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
/**
 * Initiate a withdrawal request.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request
 */ export const Withdraw3Request = /* @__PURE__ */ (()=>{
  return v.object({
    /** Action to perform. */ action: v.object({
      /** Type of action. */ type: v.literal("withdraw3"),
      /** Chain ID in hex format for EIP-712 signing. */ signatureChainId: Hex,
      /** Hyperliquid network type. */ hyperliquidChain: v.picklist([
        "Mainnet",
        "Testnet"
      ]),
      /** Destination address. */ destination: Address,
      /** Amount to withdraw (1 = $1). */ amount: UnsignedDecimal,
      /** Nonce (timestamp in ms) used to prevent replay attacks. */ time: UnsignedInteger
    }),
    /** Nonce (timestamp in ms) used to prevent replay attacks. */ nonce: UnsignedInteger,
    /** ECDSA signature components. */ signature: v.object({
      /** First 32-byte component. */ r: v.pipe(Hex, v.length(66)),
      /** Second 32-byte component. */ s: v.pipe(Hex, v.length(66)),
      /** Recovery identifier. */ v: v.picklist([
        27,
        28
      ])
    })
  });
})();
// ============================================================
// Execution Logic
// ============================================================
import { parse } from "../../../_base.js";
import { canonicalize } from "../../../signing/mod.js";
import { executeUserSignedAction } from "./_base/mod.js";
/** Schema for action fields (excludes request-level system fields). */ const Withdraw3ActionSchema = /* @__PURE__ */ (()=>{
  return v.omit(v.object(Withdraw3Request.entries.action.entries), [
    "signatureChainId",
    "hyperliquidChain",
    "time"
  ]);
})();
/** EIP-712 types for the {@linkcode withdraw3} function. */ export const Withdraw3Types = {
  "HyperliquidTransaction:Withdraw": [
    {
      name: "hyperliquidChain",
      type: "string"
    },
    {
      name: "destination",
      type: "string"
    },
    {
      name: "amount",
      type: "string"
    },
    {
      name: "time",
      type: "uint64"
    }
  ]
};
/**
 * Initiate a withdrawal request.
 *
 * Signing: User-Signed EIP-712.
 *
 * @param config General configuration for Exchange API requests.
 * @param params Parameters specific to the API request.
 * @param opts Request execution options.
 * @return Successful response without specific data.
 *
 * @throws {ValidationError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 * @throws {ApiRequestError} When the API returns an unsuccessful response.
 *
 * @example
 * ```ts
 * import { HttpTransport } from "@nktkas/hyperliquid";
 * import { withdraw3 } from "@nktkas/hyperliquid/api/exchange";
 * import { privateKeyToAccount } from "npm:viem/accounts";
 *
 * const wallet = privateKeyToAccount("0x..."); // viem or ethers
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * await withdraw3({ transport, wallet }, {
 *   destination: "0x...",
 *   amount: "1",
 * });
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request
 */ export function withdraw3(config, params, opts) {
  const action = canonicalize(Withdraw3ActionSchema, parse(Withdraw3ActionSchema, {
    type: "withdraw3",
    ...params
  }));
  return executeUserSignedAction(config, action, Withdraw3Types, opts);
}
//# sourceMappingURL=withdraw3.js.map