@deeeed/hyperliquid-node20
Version:
Unofficial Hyperliquid API SDK for all major JS runtimes, written in TypeScript. Fork with Node.js 20.18.0+ compatibility.
332 lines (331 loc) • 11.2 kB
JavaScript
"use strict";
/**
* This module contains functions for generating Hyperliquid transaction signatures
* and interfaces to various wallet implementations.
*
* @example Signing an L1 action
* ```ts
* import { actionSorter, signL1Action } from "@nktkas/hyperliquid/signing";
*
* const privateKey = "0x..."; // or `viem`, `ethers`
*
* const nonce = Date.now();
* const action = {
* type: "cancel",
* cancels: [
* { a: 0, o: 12345 },
* ],
* } as const;
*
* const signature = await signL1Action({
* wallet: privateKey,
* action: actionSorter[action.type](action),
* nonce,
* });
* ```
*
* @example Signing a user-signed action
* ```ts
* import { signUserSignedAction, userSignedActionEip712Types } from "@nktkas/hyperliquid/signing";
*
* const privateKey = "0x..."; // or `viem`, `ethers`
*
* const action = {
* type: "approveAgent",
* signatureChainId: "0x66eee",
* hyperliquidChain: "Mainnet",
* agentAddress: "0x...",
* agentName: "Agent",
* nonce: Date.now(),
* } as const;
*
* const signature = await signUserSignedAction({
* wallet: privateKey,
* action,
* types: userSignedActionEip712Types[action.type],
* });
* ```
*
* @example Signing a multi-signature action
* ```ts
* import { actionSorter, signL1Action, signMultiSigAction } from "@nktkas/hyperliquid/signing";
* import { privateKeyToAccount } from "viem/accounts";
*
* const wallet = privateKeyToAccount("0x..."); // or `ethers`, private key with address
* const multiSigUser = "0x...";
*
* const nonce = Date.now();
* const action = {
* type: "scheduleCancel",
* time: Date.now() + 10000,
* } as const;
*
* // First, create the required number of signatures
* const signature = await signL1Action({
* wallet,
* action: [multiSigUser.toLowerCase(), wallet.address.toLowerCase(), actionSorter[action.type](action)],
* nonce,
* });
*
* // Then use signatures in the multi-sig action
* const multiSigSignature = await signMultiSigAction({
* wallet,
* action: {
* signatureChainId: "0x66eee",
* signatures: [signature],
* payload: {
* multiSigUser,
* outerSigner: wallet.address,
* action,
* },
* },
* nonce,
* });
* ```
*
* @module
*/
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 __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.isValidPrivateKey = exports.isAbstractWindowEthereum = exports.isAbstractViemWalletClient = exports.isAbstractEthersV5Signer = exports.isAbstractEthersSigner = void 0;
exports.createL1ActionHash = createL1ActionHash;
exports.signL1Action = signL1Action;
exports.signUserSignedAction = signUserSignedAction;
exports.signMultiSigAction = signMultiSigAction;
const sha3_1 = require("@noble/hashes/sha3");
const secp256k1_1 = require("@noble/secp256k1");
const msgpack_1 = require("@msgpack/msgpack");
const mod_js_1 = require("./_signTypedData/mod.js");
Object.defineProperty(exports, "isAbstractEthersSigner", { enumerable: true, get: function () { return mod_js_1.isAbstractEthersSigner; } });
Object.defineProperty(exports, "isAbstractEthersV5Signer", { enumerable: true, get: function () { return mod_js_1.isAbstractEthersV5Signer; } });
Object.defineProperty(exports, "isAbstractViemWalletClient", { enumerable: true, get: function () { return mod_js_1.isAbstractViemWalletClient; } });
Object.defineProperty(exports, "isAbstractWindowEthereum", { enumerable: true, get: function () { return mod_js_1.isAbstractWindowEthereum; } });
Object.defineProperty(exports, "isValidPrivateKey", { enumerable: true, get: function () { return mod_js_1.isValidPrivateKey; } });
__exportStar(require("./_sorter.js"), exports);
/**
* Create a hash of the L1 action.
* @example
* ```ts
* import { actionSorter, createL1ActionHash } from "@nktkas/hyperliquid/signing";
*
* const action = {
* type: "cancel",
* cancels: [
* { a: 0, o: 12345 },
* ],
* } as const;
* const nonce = Date.now();
*
* const actionHash = createL1ActionHash({
* action: actionSorter[action.type](action),
* nonce,
* vaultAddress: "0x...", // optional
* expiresAfter: Date.now() + 10_000, // optional
* });
* ```
*/
function createL1ActionHash(args) {
const { action, nonce, vaultAddress, expiresAfter } = args;
// 1. Action
const actionBytes = (0, msgpack_1.encode)(action);
// 2. Nonce
const nonceBytes = toUint64Bytes(nonce);
// 3. Vault address
const vaultMarker = vaultAddress ? new Uint8Array([1]) : new Uint8Array([0]);
const vaultBytes = vaultAddress ? secp256k1_1.etc.hexToBytes(vaultAddress.slice(2)) : new Uint8Array();
// 4. Expires after
const expiresMarker = expiresAfter !== undefined ? new Uint8Array([0]) : new Uint8Array();
const expiresBytes = expiresAfter !== undefined ? toUint64Bytes(expiresAfter) : new Uint8Array();
// Create a hash
const bytes = secp256k1_1.etc.concatBytes(actionBytes, nonceBytes, vaultMarker, vaultBytes, expiresMarker, expiresBytes);
const hash = (0, sha3_1.keccak_256)(bytes);
return `0x${secp256k1_1.etc.bytesToHex(hash)}`;
}
function toUint64Bytes(n) {
const bytes = new Uint8Array(8);
new DataView(bytes.buffer).setBigUint64(0, BigInt(n));
return bytes;
}
/**
* Sign an L1 action.
* @example
* ```ts
* import { actionSorter, signL1Action } from "@nktkas/hyperliquid/signing";
*
* const privateKey = "0x..."; // or `viem`, `ethers`
*
* const nonce = Date.now();
* const action = {
* type: "cancel",
* cancels: [
* { a: 0, o: 12345 },
* ],
* } as const;
*
* const signature = await signL1Action({
* wallet: privateKey,
* action: actionSorter[action.type](action),
* nonce,
* });
*
* // Send the signed action to the Hyperliquid API
* const response = await fetch("https://api.hyperliquid.xyz/exchange", {
* method: "POST",
* headers: { "Content-Type": "application/json" },
* body: JSON.stringify({ action, signature, nonce }),
* });
* const body = await response.json();
* ```
*/
async function signL1Action(args) {
const { wallet, action, nonce, isTestnet = false, vaultAddress, expiresAfter, } = args;
const actionHash = createL1ActionHash({ action, nonce, vaultAddress, expiresAfter });
const message = {
source: isTestnet ? "b" : "a",
connectionId: actionHash,
};
return await (0, mod_js_1.signTypedData)({
wallet,
domain: {
name: "Exchange",
version: "1",
chainId: 1337, // hyperliquid requires chainId to be 1337
verifyingContract: "0x0000000000000000000000000000000000000000",
},
types: {
Agent: [
{ name: "source", type: "string" },
{ name: "connectionId", type: "bytes32" },
],
},
primaryType: "Agent",
message,
});
}
/**
* Sign a user-signed action.
* @example
* ```ts
* import { signUserSignedAction, userSignedActionEip712Types } from "@nktkas/hyperliquid/signing";
*
* const privateKey = "0x..."; // or `viem`, `ethers`
*
* const action = {
* type: "approveAgent",
* signatureChainId: "0x66eee",
* hyperliquidChain: "Mainnet",
* agentAddress: "0x...",
* agentName: "Agent",
* nonce: Date.now(),
* } as const;
*
* const signature = await signUserSignedAction({
* wallet: privateKey,
* action,
* types: userSignedActionEip712Types[action.type],
* });
*
* // Send the signed action to the Hyperliquid API
* const response = await fetch("https://api.hyperliquid.xyz/exchange", {
* method: "POST",
* headers: { "Content-Type": "application/json" },
* body: JSON.stringify({ action, signature, nonce: action.nonce }),
* });
* const body = await response.json();
* ```
*/
async function signUserSignedAction(args) {
const { wallet, action, types } = args;
return await (0, mod_js_1.signTypedData)({
wallet,
domain: {
name: "HyperliquidSignTransaction",
version: "1",
chainId: parseInt(action.signatureChainId),
verifyingContract: "0x0000000000000000000000000000000000000000",
},
types,
primaryType: Object.keys(types)[0],
message: action,
});
}
/**
* Sign a multi-signature action.
* @example
* ```ts
* import { actionSorter, signL1Action, signMultiSigAction } from "@nktkas/hyperliquid/signing";
* import { privateKeyToAccount } from "viem/accounts";
*
* const wallet = privateKeyToAccount("0x..."); // or `ethers`, private key with address
* const multiSigUser = "0x...";
*
* const nonce = Date.now();
* const action = {
* type: "scheduleCancel",
* time: Date.now() + 10000,
* } as const;
*
* // First, create the required number of signatures
* const signature = await signL1Action({
* wallet,
* action: [multiSigUser.toLowerCase(), wallet.address.toLowerCase(), actionSorter[action.type](action)],
* nonce,
* });
*
* // Then use signatures in the multi-sig action
* const multiSigSignature = await signMultiSigAction({
* wallet,
* action: {
* signatureChainId: "0x66eee",
* signatures: [signature],
* payload: {
* multiSigUser,
* outerSigner: wallet.address,
* action,
* },
* },
* nonce,
* });
* ```
*/
async function signMultiSigAction(args) {
const { wallet, action, nonce, isTestnet = false, vaultAddress, expiresAfter, } = args;
const multiSigActionHash = createL1ActionHash({ action, nonce, vaultAddress, expiresAfter });
const message = {
signatureChainId: action.signatureChainId,
hyperliquidChain: isTestnet ? "Testnet" : "Mainnet",
multiSigActionHash,
nonce,
};
return await (0, mod_js_1.signTypedData)({
wallet,
domain: {
name: "HyperliquidSignTransaction",
version: "1",
chainId: parseInt(message.signatureChainId),
verifyingContract: "0x0000000000000000000000000000000000000000",
},
types: {
"HyperliquidTransaction:SendMultiSig": [
{ name: "hyperliquidChain", type: "string" },
{ name: "multiSigActionHash", type: "bytes32" },
{ name: "nonce", type: "uint64" },
],
},
primaryType: "HyperliquidTransaction:SendMultiSig",
message,
});
}