@nktkas/hyperliquid
Version:
Unofficial Hyperliquid API SDK for all major JS runtimes, written in TypeScript and provided with tests
154 lines • 10 kB
TypeScript
import type { ApproveAgentRequest, ApproveBuilderFeeRequest, BatchModifyRequest, CancelByCloidRequest, CancelRequest, CDepositRequest, ClaimRewardsRequest, ConvertToMultiSigUserRequest, CreateSubAccountRequest, CreateVaultRequest, CSignerActionRequest_JailSelf, CSignerActionRequest_UnjailSelf, CValidatorActionRequest_ChangeProfile, CValidatorActionRequest_Register, CValidatorActionRequest_Unregister, CWithdrawRequest, EvmUserModifyRequest, ModifyRequest, MultiSigRequest, OrderRequest, PerpDeployRequest_RegisterAsset, PerpDeployRequest_SetOracle, PerpDexClassTransferRequest, RegisterReferrerRequest, ReserveRequestWeightRequest, ScheduleCancelRequest, SetDisplayNameRequest, SetReferrerRequest, SpotDeployRequest_Genesis, SpotDeployRequest_RegisterHyperliquidity, SpotDeployRequest_RegisterSpot, SpotDeployRequest_RegisterToken2, SpotDeployRequest_SetDeployerTradingFeeShare, SpotDeployRequest_UserGenesis, SpotSendRequest, SpotUserRequest, SubAccountSpotTransferRequest, SubAccountTransferRequest, TokenDelegateRequest, TwapCancelRequest, TwapOrderRequest, UpdateIsolatedMarginRequest, UpdateLeverageRequest, UsdClassTransferRequest, UsdSendRequest, VaultDistributeRequest, VaultModifyRequest, VaultTransferRequest, Withdraw3Request } from "../types/exchange/requests.js";
/** Action sorter for correct signature generation. */
export declare const actionSorter: {
/** Sorts and formats an `approveAgent` action. */
approveAgent: (action: ApproveAgentRequest["action"]) => ApproveAgentRequest["action"];
/** Sorts and formats an `approveBuilderFee` action. */
approveBuilderFee: (action: ApproveBuilderFeeRequest["action"]) => ApproveBuilderFeeRequest["action"];
/** Sorts and formats a `batchModify` action. */
batchModify: (action: BatchModifyRequest["action"]) => BatchModifyRequest["action"];
/** Sorts and formats a `cancel` action. */
cancel: (action: CancelRequest["action"]) => CancelRequest["action"];
/** Sorts and formats a `cancelByCloid` action. */
cancelByCloid: (action: CancelByCloidRequest["action"]) => CancelByCloidRequest["action"];
/** Sorts and formats a `cDeposit` action. */
cDeposit: (action: CDepositRequest["action"]) => CDepositRequest["action"];
/** Sorts and formats a `claimRewards` action. */
claimRewards: (action: ClaimRewardsRequest["action"]) => ClaimRewardsRequest["action"];
/** Sorts and formats a `convertToMultiSigUser` action. */
convertToMultiSigUser: (action: ConvertToMultiSigUserRequest["action"]) => ConvertToMultiSigUserRequest["action"];
/** Sorts and formats a `createSubAccount` action. */
createSubAccount: (action: CreateSubAccountRequest["action"]) => CreateSubAccountRequest["action"];
/** Sorts and formats a `createVault` action. */
createVault: (action: CreateVaultRequest["action"]) => CreateVaultRequest["action"];
/** Sorts and formats a `CSignerAction` action (jail/unjail). */
CSignerAction: (action: CSignerActionRequest_JailSelf["action"] | CSignerActionRequest_UnjailSelf["action"]) => CSignerActionRequest_JailSelf["action"] | CSignerActionRequest_UnjailSelf["action"];
/** Sorts and formats a `CValidatorAction` action (register/unregister/change profile). */
CValidatorAction: (action: CValidatorActionRequest_ChangeProfile["action"] | CValidatorActionRequest_Register["action"] | CValidatorActionRequest_Unregister["action"]) => CValidatorActionRequest_ChangeProfile["action"] | CValidatorActionRequest_Register["action"] | CValidatorActionRequest_Unregister["action"];
/** Sorts and formats a `cWithdraw` action. */
cWithdraw: (action: CWithdrawRequest["action"]) => CWithdrawRequest["action"];
/** Sorts and formats an `evmUserModify` action. */
evmUserModify: (action: EvmUserModifyRequest["action"]) => EvmUserModifyRequest["action"];
/** Sorts and formats a `modify` action. */
modify: (action: ModifyRequest["action"]) => ModifyRequest["action"];
/** Sorts and formats a `multiSig` action. */
multiSig: (action: MultiSigRequest["action"]) => MultiSigRequest["action"];
/** Sorts and formats an `order` action. */
order: (action: OrderRequest["action"]) => OrderRequest["action"];
/** Sorts and formats a `perpDeploy` action. */
perpDeploy: (action: PerpDeployRequest_RegisterAsset["action"] | PerpDeployRequest_SetOracle["action"]) => PerpDeployRequest_RegisterAsset["action"] | PerpDeployRequest_SetOracle["action"];
/** Sorts and formats a `PerpDexClassTransfer` action. */
PerpDexClassTransfer: (action: PerpDexClassTransferRequest["action"]) => PerpDexClassTransferRequest["action"];
/** Sorts and formats a `registerReferrer` action. */
registerReferrer: (action: RegisterReferrerRequest["action"]) => RegisterReferrerRequest["action"];
/** Sorts and formats a `reserveRequestWeight` action. */
reserveRequestWeight: (action: ReserveRequestWeightRequest["action"]) => ReserveRequestWeightRequest["action"];
/** Sorts and formats a `scheduleCancel` action. */
scheduleCancel: (action: ScheduleCancelRequest["action"]) => ScheduleCancelRequest["action"];
/** Sorts and formats a `setDisplayName` action. */
setDisplayName: (action: SetDisplayNameRequest["action"]) => SetDisplayNameRequest["action"];
/** Sorts and formats a `setReferrer` action. */
setReferrer: (action: SetReferrerRequest["action"]) => SetReferrerRequest["action"];
/** Sorts and formats a `spotDeploy` action. */
spotDeploy: (action: SpotDeployRequest_Genesis["action"] | SpotDeployRequest_RegisterHyperliquidity["action"] | SpotDeployRequest_RegisterSpot["action"] | SpotDeployRequest_RegisterToken2["action"] | SpotDeployRequest_SetDeployerTradingFeeShare["action"] | SpotDeployRequest_UserGenesis["action"]) => SpotDeployRequest_Genesis["action"] | SpotDeployRequest_RegisterHyperliquidity["action"] | SpotDeployRequest_RegisterSpot["action"] | SpotDeployRequest_RegisterToken2["action"] | SpotDeployRequest_SetDeployerTradingFeeShare["action"] | SpotDeployRequest_UserGenesis["action"];
/** Sorts and formats a `spotSend` action. */
spotSend: (action: SpotSendRequest["action"]) => SpotSendRequest["action"];
/** Sorts and formats a `spotUser` action. */
spotUser: (action: SpotUserRequest["action"]) => SpotUserRequest["action"];
/** Sorts and formats a `subAccountSpotTransfer` action. */
subAccountSpotTransfer: (action: SubAccountSpotTransferRequest["action"]) => SubAccountSpotTransferRequest["action"];
/** Sorts and formats a `subAccountTransfer` action. */
subAccountTransfer: (action: SubAccountTransferRequest["action"]) => SubAccountTransferRequest["action"];
/** Sorts and formats a `tokenDelegate` action. */
tokenDelegate: (action: TokenDelegateRequest["action"]) => TokenDelegateRequest["action"];
/** Sorts and formats a `twapCancel` action. */
twapCancel: (action: TwapCancelRequest["action"]) => TwapCancelRequest["action"];
/** Sorts and formats a `twapOrder` action. */
twapOrder: (action: TwapOrderRequest["action"]) => TwapOrderRequest["action"];
/** Sorts and formats an `updateIsolatedMargin` action. */
updateIsolatedMargin: (action: UpdateIsolatedMarginRequest["action"]) => UpdateIsolatedMarginRequest["action"];
/** Sorts and formats an `updateLeverage` action. */
updateLeverage: (action: UpdateLeverageRequest["action"]) => UpdateLeverageRequest["action"];
/** Sorts and formats an `usdClassTransfer` action. */
usdClassTransfer: (action: UsdClassTransferRequest["action"]) => UsdClassTransferRequest["action"];
/** Sorts and formats an `usdSend` action. */
usdSend: (action: UsdSendRequest["action"]) => UsdSendRequest["action"];
/** Sorts and formats a `vaultDistribute` action. */
vaultDistribute: (action: VaultDistributeRequest["action"]) => VaultDistributeRequest["action"];
/** Sorts and formats a `vaultModify` action. */
vaultModify: (action: VaultModifyRequest["action"]) => VaultModifyRequest["action"];
/** Sorts and formats a `vaultTransfer` action. */
vaultTransfer: (action: VaultTransferRequest["action"]) => VaultTransferRequest["action"];
/** Sorts and formats a `withdraw3` action. */
withdraw3: (action: Withdraw3Request["action"]) => Withdraw3Request["action"];
};
/** EIP-712 type definitions for user-signed actions. */
export declare const userSignedActionEip712Types: {
approveAgent: {
"HyperliquidTransaction:ApproveAgent": {
name: string;
type: string;
}[];
};
approveBuilderFee: {
"HyperliquidTransaction:ApproveBuilderFee": {
name: string;
type: string;
}[];
};
cDeposit: {
"HyperliquidTransaction:CDeposit": {
name: string;
type: string;
}[];
};
convertToMultiSigUser: {
"HyperliquidTransaction:ConvertToMultiSigUser": {
name: string;
type: string;
}[];
};
cWithdraw: {
"HyperliquidTransaction:CWithdraw": {
name: string;
type: string;
}[];
};
PerpDexClassTransfer: {
"HyperliquidTransaction:PerpDexClassTransfer": {
name: string;
type: string;
}[];
};
spotSend: {
"HyperliquidTransaction:SpotSend": {
name: string;
type: string;
}[];
};
tokenDelegate: {
"HyperliquidTransaction:TokenDelegate": {
name: string;
type: string;
}[];
};
usdClassTransfer: {
"HyperliquidTransaction:UsdClassTransfer": {
name: string;
type: string;
}[];
};
usdSend: {
"HyperliquidTransaction:UsdSend": {
name: string;
type: string;
}[];
};
withdraw3: {
"HyperliquidTransaction:Withdraw": {
name: string;
type: string;
}[];
};
};
//# sourceMappingURL=_sorter.d.ts.map