Skip to main content

Module staking

Module staking 

Source
Expand description

HYPE staking: moves between spot and staking, delegation, validators and rewards.

Re-exports§

pub use account::PendingWithdrawal;
pub use account::REWARDS_WINDOW_MS;
pub use account::Staking;
pub use account::pending_withdrawals;
pub use account::rewards_since;
pub use account::staking;
pub use actions::CDeposit;
pub use actions::CWithdraw;
pub use actions::TokenDelegate;
pub use actions::hype_wei;
pub use plan::Balance;
pub use plan::Change;
pub use plan::Ctx;
pub use plan::Effect;
pub use plan::Plan;
pub use plan::Refused;
pub use reads::Delegation;
pub use reads::DelegatorSummary;
pub use reads::MAINNET_DELEGATION_LOCK_MS;
pub use reads::MAINNET_UNSTAKING_MS;
pub use reads::MAX_PENDING_WITHDRAWALS;
pub use reads::Reward;
pub use reads::StakeDelta;
pub use reads::StakeEvent;
pub use reads::TESTNET_DELEGATION_LOCK_MS;
pub use reads::TESTNET_UNSTAKING_MS;
pub use reads::ValidatorStats;
pub use reads::ValidatorSummary;
pub use reads::delegation_lock_ms;
pub use reads::delegations;
pub use reads::delegations_request;
pub use reads::delegator_history;
pub use reads::delegator_history_request;
pub use reads::delegator_rewards;
pub use reads::delegator_rewards_request;
pub use reads::delegator_summary;
pub use reads::delegator_summary_request;
pub use reads::locked_until;
pub use reads::unstaking_ms;
pub use reads::validator_summaries;
pub use reads::validator_summaries_request;

Modules§

account
An account’s whole stake from its four reads: the summary, each delegation, the withdrawals still in the queue (dated from the history), and a month’s rewards summed exactly.
actions
cDeposit, cWithdraw and tokenDelegate: user-signed, keys in the order @nktkas/hyperliquid 0.33.2 posts them.
plan
From a staking move’s typed values to exactly what is signed: the action, its nonce, the key it needs, the balance that should change once it lands, and when what it moved is free again.
reads
validatorSummaries, delegatorSummary, delegations, delegatorRewards, delegatorHistory. HYPE figures are decimal strings, except a validator’s stake, which is wei.