@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
110 lines (109 loc) • 3.9 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
/**
* Send spot assets to another address.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#core-spot-transfer
*/ export const SpotSendRequest = /* @__PURE__ */ (()=>{
return v.object({
/** Action to perform. */ action: v.object({
/** Type of action. */ type: v.literal("spotSend"),
/** Chain ID in hex format for EIP-712 signing. */ signatureChainId: Hex,
/** Hyperliquid network type. */ hyperliquidChain: v.picklist([
"Mainnet",
"Testnet"
]),
/** Destination address. */ destination: Address,
/** Token identifier. */ token: v.string(),
/** Amount to send (not in wei). */ 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 SpotSendActionSchema = /* @__PURE__ */ (()=>{
return v.omit(v.object(SpotSendRequest.entries.action.entries), [
"signatureChainId",
"hyperliquidChain",
"time"
]);
})();
/** EIP-712 types for the {@linkcode spotSend} function. */ export const SpotSendTypes = {
"HyperliquidTransaction:SpotSend": [
{
name: "hyperliquidChain",
type: "string"
},
{
name: "destination",
type: "string"
},
{
name: "token",
type: "string"
},
{
name: "amount",
type: "string"
},
{
name: "time",
type: "uint64"
}
]
};
/**
* Send spot assets to another address.
*
* 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 { spotSend } 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 spotSend({ transport, wallet }, {
* destination: "0x...",
* token: "USDC:0xeb62eee3685fc4c43992febcd9e75443",
* amount: "1",
* });
* ```
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#core-spot-transfer
*/ export function spotSend(config, params, opts) {
const action = canonicalize(SpotSendActionSchema, parse(SpotSendActionSchema, {
type: "spotSend",
...params
}));
return executeUserSignedAction(config, action, SpotSendTypes, opts);
}
//# sourceMappingURL=spotSend.js.map