@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
86 lines • 3.25 kB
TypeScript
/**
* This module re-exports all exchange-related API request functions and types.
*
* You can use raw functions to maximize tree-shaking in your app,
* or to access [valibot](https://github.com/fabian-hiller/valibot) schemas Request/Response.
*
* @example
* ```ts
* import { privateKeyToAccount } from "npm:viem/accounts";
* import { HttpTransport } from "@nktkas/hyperliquid";
* import { order } from "@nktkas/hyperliquid/api/exchange";
* // ^^^^^
* // same name as in `ExchangeClient`
*
* const wallet = privateKeyToAccount("0x..."); // viem or ethers
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* const data = await order(
* { transport, wallet }, // same params as in `ExchangeClient`
* {
* orders: [
* {
* a: 0,
* b: true,
* p: "30000",
* s: "0.1",
* r: false,
* t: { limit: { tif: "Gtc" } },
* c: "0x...",
* },
* ],
* grouping: "na",
* },
* );
* ```
*
* @module
*/
export type { ExchangeMultiSigConfig, ExchangeSingleWalletConfig } from "./_methods/_base/execute.js";
export { ApiRequestError } from "./_methods/_base/errors.js";
export * from "./_methods/agentEnableDexAbstraction.js";
export * from "./_methods/approveAgent.js";
export * from "./_methods/approveBuilderFee.js";
export * from "./_methods/batchModify.js";
export * from "./_methods/cancel.js";
export * from "./_methods/cancelByCloid.js";
export * from "./_methods/cDeposit.js";
export * from "./_methods/claimRewards.js";
export * from "./_methods/convertToMultiSigUser.js";
export * from "./_methods/createSubAccount.js";
export * from "./_methods/createVault.js";
export * from "./_methods/cSignerAction.js";
export * from "./_methods/cValidatorAction.js";
export * from "./_methods/cWithdraw.js";
export * from "./_methods/evmUserModify.js";
export * from "./_methods/linkStakingUser.js";
export * from "./_methods/modify.js";
export * from "./_methods/order.js";
export * from "./_methods/noop.js";
export * from "./_methods/perpDeploy.js";
export * from "./_methods/registerReferrer.js";
export * from "./_methods/reserveRequestWeight.js";
export * from "./_methods/scheduleCancel.js";
export * from "./_methods/sendAsset.js";
export * from "./_methods/setDisplayName.js";
export * from "./_methods/setReferrer.js";
export * from "./_methods/spotDeploy.js";
export * from "./_methods/spotSend.js";
export * from "./_methods/spotUser.js";
export * from "./_methods/subAccountModify.js";
export * from "./_methods/subAccountSpotTransfer.js";
export * from "./_methods/subAccountTransfer.js";
export * from "./_methods/tokenDelegate.js";
export * from "./_methods/twapCancel.js";
export * from "./_methods/twapOrder.js";
export * from "./_methods/updateIsolatedMargin.js";
export * from "./_methods/updateLeverage.js";
export * from "./_methods/usdClassTransfer.js";
export * from "./_methods/usdSend.js";
export * from "./_methods/userDexAbstraction.js";
export * from "./_methods/validatorL1Stream.js";
export * from "./_methods/vaultDistribute.js";
export * from "./_methods/vaultModify.js";
export * from "./_methods/vaultTransfer.js";
export * from "./_methods/withdraw3.js";
//# sourceMappingURL=mod.d.ts.map