Skip to content

feat: add hyperliquid vm #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: add hyperliquid vm #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27e286a
feat: add hyperliquid vm
lljxx1 Oct 28, 2025
ce8c6ca
feat: encode currency for sendAsset
lljxx1 Oct 28, 2025
490ba24
feat: export types
lljxx1 Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
DecodedEthereumVmWithdrawal,
DecodedSolanaVmWithdrawal,
DecodedSuiVmWithdrawal,
DecodedHyperliquidVmWithdrawal,
DepositoryWithdrawalMessage,
DepositoryWithdrawalStatus,
getDepositoryWithdrawalMessageId,
Expand Down Expand Up @@ -85,6 +86,7 @@ export {
DecodedEthereumVmWithdrawal,
DecodedSolanaVmWithdrawal,
DecodedSuiVmWithdrawal,
DecodedHyperliquidVmWithdrawal,
DepositoryWithdrawalMessage,
DepositoryWithdrawalStatus,
getDepositoryWithdrawalMessageId,
Expand Down
320 changes: 319 additions & 1 deletion src/messages/v2.1/depository-withdrawal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,47 @@ export type DecodedBitcoinVmWithdrawal = {
};
};

export type DecodedHyperliquidVmWithdrawal = {
vmType: "hyperliquid-vm";
withdrawal: {
txType: number;
parameters:
| {
type: "UsdSend";
hyperliquidChain: string;
destination: string;
amount: string;
time: string;
}
| {
type: "SpotSend";
hyperliquidChain: string;
destination: string;
token: string;
amount: string;
time: string;
}
| {
type: "SendAsset";
hyperliquidChain: string;
destination: string;
sourceDex: string;
destinationDex: string;
token: string;
amount: string;
fromSubAccount: string;
nonce: string;
};
};
};

type DecodedWithdrawal =
| DecodedEthereumVmWithdrawal
| DecodedSolanaVmWithdrawal
| DecodedSuiVmWithdrawal
| DecodedBitcoinVmWithdrawal
| DecodedTronVmWithdrawal;
| DecodedTronVmWithdrawal
| DecodedHyperliquidVmWithdrawal;

export const encodeWithdrawal = (
decodedWithdrawal: DecodedWithdrawal
Expand Down Expand Up @@ -247,6 +282,85 @@ export const encodeWithdrawal = (
return "0x" + decodedWithdrawal.withdrawal.psbt;
}

case "hyperliquid-vm": {
const { txType, parameters } = decodedWithdrawal.withdrawal;

let encodedParameters: string;

switch (parameters.type) {
case "UsdSend": {
encodedParameters = encodeAbiParameters(
parseAbiParameters([
"(string hyperliquidChain, string destination, string amount, uint64 time)"
]),
[
{
hyperliquidChain: parameters.hyperliquidChain,
destination: parameters.destination,
amount: parameters.amount,
time: BigInt(parameters.time),
}
]
);
break;
}

case "SpotSend": {
encodedParameters = encodeAbiParameters(
parseAbiParameters([
"(string hyperliquidChain, string destination, string token, string amount, uint64 time)"
]),
[
{
hyperliquidChain: parameters.hyperliquidChain,
destination: parameters.destination,
token: parameters.token,
amount: parameters.amount,
time: BigInt(parameters.time),
}
]
);
break;
}

case "SendAsset": {
encodedParameters = encodeAbiParameters(
parseAbiParameters([
"(string hyperliquidChain, string destination, string sourceDex, string destinationDex, string token, string amount, string fromSubAccount, uint64 nonce)"
]),
[
{
hyperliquidChain: parameters.hyperliquidChain,
destination: parameters.destination,
sourceDex: parameters.sourceDex,
destinationDex: parameters.destinationDex,
token: parameters.token,
amount: parameters.amount,
fromSubAccount: parameters.fromSubAccount,
nonce: BigInt(parameters.nonce),
}
]
);
break;
}

default:
throw new Error(`Unsupported Hyperliquid transaction type: ${(parameters as any).type}`);
}

return encodeAbiParameters(
parseAbiParameters([
"(uint8 txType, bytes parameters)"
]),
[
{
txType: txType,
parameters: encodedParameters as Hex,
}
]
);
}

default:
throw new Error("Unsupported vm type");
}
Expand Down Expand Up @@ -366,6 +480,102 @@ export const decodeWithdrawal = (
};
}

case "hyperliquid-vm": {
const result = decodeAbiParameters(
parseAbiParameters([
"(uint8 txType, bytes parameters)"
]),
encodedWithdrawal as Hex
);

const { txType, parameters } = result[0];

switch (txType) {
case 0: { // UsdSend
const paramResult = decodeAbiParameters(
parseAbiParameters([
"(string hyperliquidChain, string destination, string amount, uint64 time)"
]),
parameters
);

const { hyperliquidChain, destination, amount, time } = paramResult[0];

return {
vmType: "hyperliquid-vm",
withdrawal: {
txType: Number(txType),
parameters: {
type: "UsdSend" as const,
hyperliquidChain,
destination,
amount,
time: time.toString(),
}
}
};
}

case 1: { // SpotSend
const paramResult = decodeAbiParameters(
parseAbiParameters([
"(string hyperliquidChain, string destination, string token, string amount, uint64 time)"
]),
parameters
);

const { hyperliquidChain, destination, token, amount, time } = paramResult[0];

return {
vmType: "hyperliquid-vm",
withdrawal: {
txType: Number(txType),
parameters: {
type: "SpotSend" as const,
hyperliquidChain,
destination,
token,
amount,
time: time.toString(),
}
}
};
}

case 2: { // SendAsset
const paramResult = decodeAbiParameters(
parseAbiParameters([
"(string hyperliquidChain, string destination, string sourceDex, string destinationDex, string token, string amount, string fromSubAccount, uint64 nonce)"
]),
parameters
);

const { hyperliquidChain, destination, sourceDex, destinationDex, token, amount, fromSubAccount, nonce } = paramResult[0];

return {
vmType: "hyperliquid-vm",
withdrawal: {
txType: Number(txType),
parameters: {
type: "SendAsset" as const,
hyperliquidChain,
destination,
sourceDex,
destinationDex,
token,
amount,
fromSubAccount,
nonce: nonce.toString(),
}
}
};
}

default:
throw new Error(`Unsupported Hyperliquid transaction type: ${txType}`);
}
}

default:
throw new Error("Unsupported vm type");
}
Expand Down Expand Up @@ -480,6 +690,85 @@ export const getDecodedWithdrawalId = (
return "0x" + sha256.create().update(encodedWithdrawal).hex();
}

case "hyperliquid-vm": {
const { parameters } = decodedWithdrawal.withdrawal;

switch (parameters.type) {
case "UsdSend": {
return hashStruct({
types: {
"HyperliquidTransaction:UsdSend": [
{ name: "hyperliquidChain", type: "string" },
{ name: "destination", type: "string" },
{ name: "amount", type: "string" },
{ name: "time", type: "uint64" },
],
},
primaryType: "HyperliquidTransaction:UsdSend",
data: {
hyperliquidChain: parameters.hyperliquidChain,
destination: parameters.destination,
amount: parameters.amount,
time: parameters.time,
},
});
}

case "SpotSend": {
return hashStruct({
types: {
"HyperliquidTransaction:SpotSend": [
{ name: "hyperliquidChain", type: "string" },
{ name: "destination", type: "string" },
{ name: "token", type: "string" },
{ name: "amount", type: "string" },
{ name: "time", type: "uint64" },
],
},
primaryType: "HyperliquidTransaction:SpotSend",
data: {
hyperliquidChain: parameters.hyperliquidChain,
destination: parameters.destination,
token: parameters.token,
amount: parameters.amount,
time: parameters.time,
},
});
}

case "SendAsset": {
return hashStruct({
types: {
"HyperliquidTransaction:SendAsset": [
{ name: "hyperliquidChain", type: "string" },
{ name: "destination", type: "string" },
{ name: "sourceDex", type: "string" },
{ name: "destinationDex", type: "string" },
{ name: "token", type: "string" },
{ name: "amount", type: "string" },
{ name: "fromSubAccount", type: "string" },
{ name: "nonce", type: "uint64" },
],
},
primaryType: "HyperliquidTransaction:SendAsset",
data: {
hyperliquidChain: parameters.hyperliquidChain,
destination: parameters.destination,
sourceDex: parameters.sourceDex,
destinationDex: parameters.destinationDex,
token: parameters.token,
amount: parameters.amount,
fromSubAccount: parameters.fromSubAccount,
nonce: parameters.nonce,
},
});
}

default:
throw new Error(`Unsupported Hyperliquid transaction type: ${(parameters as any).type}`);
}
}

default:
throw new Error("Unsupported vm type");
}
Expand Down Expand Up @@ -514,5 +803,34 @@ export const getDecodedWithdrawalCurrency = (
case "sui-vm": {
return decodedWithdrawal.withdrawal.coinType;
}

case "hyperliquid-vm": {
const { parameters } = decodedWithdrawal.withdrawal;

switch (parameters.type) {
case "UsdSend": {
return getVmTypeNativeCurrency("hyperliquid-vm");
}

case "SpotSend": {
return parameters.token;
}

case "SendAsset": {
// For SendAsset, construct currency in the format expected by solver
// Format: tokenContractAddress (34 chars) + dexName as hex
const tokenParts = parameters.token.split(':');
const tokenContract = tokenParts.length > 1 ? tokenParts[1] : parameters.token;
const dexHex = parameters.destinationDex === "spot"
? ""
: Buffer.from(parameters.destinationDex, "ascii").toString("hex");

return tokenContract + dexHex;
}

default:
throw new Error(`Unsupported Hyperliquid transaction type: ${(parameters as any).type}`);
}
}
}
};