Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypernode-docs.polynode.dev/llms.txt

Use this file to discover all available pages before exploring further.

Every interaction with HyperLiquid’s L1 is expressed as a typed action. Users sign actions that are submitted through the API, batched into blocks by the proposer, and executed during consensus. This page catalogs all known action types organized by category.

​
User actions (49 types)

These are the actions available to regular users and agents.

​
Trading

Core order management and position control.
ActionDescription
orderPlace a new order (limit, market, or trigger)
cancelCancel an existing order by order ID
cancelByCloidCancel an order by client order ID
modifyModify a single existing order
batchModifyBatch modify multiple orders in a single action
scheduleCancelSchedule an order cancellation for a future time
twapOrderPlace a TWAP (time-weighted average price) order
twapCancelCancel an active TWAP order
updateLeverageChange leverage for a specific asset
updateIsolatedMarginUpdate isolated margin allocation
topUpIsolatedOnlyMarginTop up margin for strict isolated-margin positions
batchModify is the most efficient way to update multiple orders. It processes all modifications atomically in a single block action, reducing round trips and avoiding partial fills between updates.

​
Account

User account management, transfers, and configuration.
ActionDescription
usdSendSend USDC to another address on L1
sendAssetSend any asset (spot tokens, etc.) to another address
withdraw3Withdraw funds from L1 to Ethereum (bridge withdrawal)
claimRewardsClaim accumulated staking rewards
setDisplayNameSet a display name for the account
setReferrerSet a referral code
approveAgentApprove an agent wallet to trade on behalf of the account
approveBuilderFeeApprove a builder fee for a specific application
startFeeTrialStart a fee trial period
convertToMultiSigUserConvert the account to a multi-signature wallet

​
Sub-accounts

Transfer actions between sub-accounts under the same master account.
ActionDescription
subAccountTransferTransfer perp margin (USDC) between sub-accounts
subAccountSpotTransferTransfer spot tokens between sub-accounts

​
DeFi

Lending, DEX abstraction, and portfolio margin configuration.
ActionDescription
borrowLendBorrow or lend through the native BOLE system
userDexAbstractionExecute a DEX abstraction action (unified swap interface)
userSetAbstractionConfigure DEX abstraction preferences
agentSetAbstractionAgent-level DEX abstraction configuration
userPortfolioMarginConfigure portfolio margin settings

​
Vaults

Vault creation and management.
ActionDescription
createVaultCreate a new vault
vaultModifyModify vault parameters (fees, limits, etc.)
vaultTransferDeposit to or withdraw from a vault
vaultDistributeDistribute vault rewards to depositors

​
Staking

Token delegation and staking user management.
ActionDescription
tokenDelegateDelegate tokens to a validator
linkStakingUserLink a staking user identity

​
Governance

On-chain governance participation.
ActionDescription
govProposeSubmit a governance proposal
govVoteVote on an active governance proposal
voteAppHashVote on an application state hash

​
EVM

HyperEVM (chain 998) interactions from L1.
ActionDescription
evmUserModifyModify EVM user settings
sendToEvmWithDataSend a transaction to HyperEVM with arbitrary calldata
finalizeEvmContractFinalize an EVM contract deployment

​
Deployment (HIP-3)

Permissionless token and market deployment.
ActionDescription
spotDeployDeploy a new spot token through the HIP-3 pipeline
perpDeployDeploy a new perpetual futures market through HIP-3
Deploying through HIP-3 requires 500,000 HYPE staked. Deployment also requires winning a gas auction (Dutch auction) for the deployment slot.

​
Prediction markets (HIP-4)

Native L1 prediction market actions.
ActionDescription
userOutcomePrediction market action. Contains one of four sub-actions: splitOutcome (deposit collateral to mint YES + NO tokens), mergeOutcome (merge YES + NO back to collateral), mergeQuestion (merge across a multi-outcome question), or negateOutcome (flip position direction)

​
Priority

Priority transaction inclusion (not yet active on mainnet).
ActionDescription
gossipPriorityBidBid for priority transaction inclusion in a specific slot
The priority bid system is defined in the protocol but not yet active on mainnet. The action type exists and can be submitted, but the auction infrastructure is not currently processing bids.

​
Validator-only

Actions restricted to validators or the system.
ActionDescription
validatorL1VoteValidator vote on L1 state
validatorL1StreamValidator L1 stream action
registerValidatorRegister a new validator
forceIncreaseEpochForce an epoch increase
liquidateExecute a liquidation (can also be triggered by the system)
reserveRequestWeightReserve request weight allocation

​
SetGlobal actions (governance)

These actions are restricted to validators and modify global protocol parameters. They are submitted through the governance process.

​
Asset management

ActionDescription
registerAsset / registerAsset2Register a new perpetual futures asset
setOracleSet the oracle source for an asset
haltTradingHalt trading on a specific asset
setPerpAnnotationSet annotation metadata for a perp

​
Fee and margin configuration

ActionDescription
setFeeRecipientSet the fee recipient address
setFeeScaleConfigure fee scaling parameters
insertMarginTableAdd a new margin table
setMarginTableIdsAssign margin tables to assets
setMarginModesConfigure available margin modes
setOpenInterestCapsSet open interest caps per asset

​
Funding and growth

ActionDescription
setFundingMultipliersSet funding rate multipliers
setFundingInterestRatesSet funding interest rate parameters
setGrowthModesConfigure growth mode parameters

​
Deployer management

ActionDescription
setSubDeployersSet sub-deployer addresses for HIP-3
disableDexDisable the DEX for a specific asset

​
HIP-4 governance

ActionDescription
registerOutcomeRegister a new outcome market
registerTokensAndStandaloneOutcomeRegister outcome tokens and a standalone outcome market
registerNamedOutcomeRegister a named outcome variant
settleOutcomeSettle an outcome market (sets final value, auto-settles all positions)
changeOutcomeDescriptionModify an outcome market description
changeQuestionDescriptionModify a question description

​
Gas auction governance

ActionDescription
GossipPriorityGasAuctionChange::EnableAndRestartEnable or restart the priority gas auction system
SetGossipPriority::ParamsSet global priority auction parameters

​
System actions

These actions are executed internally by the protocol. They cannot be submitted by users.
ActionDescription
SystemSpotSendActionSystem-initiated spot token transfer
SystemSendAssetActionSystem-initiated asset transfer
SystemUsdClassTransferActionSystem-initiated USDC class transfer
SystemApproveBuilderFeeActionSystem-level builder fee approval
SystemAlignedQuoteSupplyDeltaActionAligned quote supply adjustment (related to token economics)
SystemBoleActionBOLE (backstop liquidation engine) system action
DeployerSendToEvmForFrozenUserActionHandle EVM sends for frozen user accounts
CSignerActionConsensus signer action, includes VoteJail for validator jailing votes
The CSignerAction::VoteJail action is how validators vote to jail other validators for liveness or performance violations. It requires consensus among multiple validators before taking effect.

​
Action submission flow

All user actions follow the same lifecycle: 
1. User signs the action with their private key
2. Action is submitted to the API
3. A non-leader validator receives and forwards it to the current leader
4. The leader includes it in the next BlockPropose
5. Validators vote on the block
6. After two-chain commit, the action is finalized
7. State changes are applied and distributed
Actions that fail validation (bad signature, insufficient margin, invalid parameters) are rejected before inclusion in a block. Actions that are included but fail execution (e.g., order rejected due to price movement) still consume a block slot but produce no state change beyond the rejection event.