@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
114 lines • 5.11 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.VaultModifyResponse = exports.VaultModifyRequest = void 0;
exports.vaultModify = vaultModify;
const v = __importStar(require("valibot"));
// ============================================================
// API Schemas
// ============================================================
const _schemas_js_1 = require("../../_schemas.js");
const schemas_js_1 = require("./_base/schemas.js");
/** Modify a vault's configuration. */
exports.VaultModifyRequest = (() => {
return v.pipe(v.object({
/** Action to perform. */
action: v.pipe(v.object({
/** Type of action. */
type: v.pipe(v.literal("vaultModify"), v.description("Type of action.")),
/** Vault address. */
vaultAddress: v.pipe(_schemas_js_1.Address, v.description("Vault address.")),
/** Allow deposits from followers (default: null). */
allowDeposits: v.pipe(v.optional(v.nullable(v.boolean()), null), v.description("Allow deposits from followers.")),
/** Always close positions on withdrawal (default: null). */
alwaysCloseOnWithdraw: v.pipe(v.optional(v.nullable(v.boolean()), null), v.description("Always close positions on withdrawal.")),
}), v.description("Action to perform.")),
/** Nonce (timestamp in ms) used to prevent replay attacks. */
nonce: schemas_js_1.Nonce,
/** ECDSA signature components. */
signature: schemas_js_1.Signature,
/** Expiration time of the action. */
expiresAfter: v.pipe(v.optional(_schemas_js_1.UnsignedInteger), v.description("Expiration time of the action.")),
}), v.description("Modify a vault's configuration."));
})();
/** Successful response without specific data or error response. */
exports.VaultModifyResponse = (() => {
return v.pipe(v.union([schemas_js_1.SuccessResponse, schemas_js_1.ErrorResponse]), v.description("Successful response without specific data or error response."));
})();
// ============================================================
// Execution Logic
// ============================================================
const execute_js_1 = require("./_base/execute.js");
/** Schema for user-provided action parameters (excludes system fields). */
const VaultModifyParameters = /* @__PURE__ */ (() => {
return v.omit(v.object(exports.VaultModifyRequest.entries.action.entries), ["type"]);
})();
/**
* Modify a vault's configuration.
*
* @param config - General configuration for Exchange API requests.
* @param params - Parameters specific to the API request.
* @param opts - Request execution options.
*
* @returns Successful response without specific data.
*
* @throws {ValiError} 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 { vaultModify } 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 vaultModify(
* { transport, wallet },
* {
* vaultAddress: "0x...",
* allowDeposits: true,
* alwaysCloseOnWithdraw: false,
* },
* );
* ```
*/
function vaultModify(config, params, opts) {
const action = v.parse(VaultModifyParameters, params);
return (0, execute_js_1.executeL1Action)(config, { type: "vaultModify", ...action }, opts);
}
//# sourceMappingURL=vaultModify.js.map