# HyperliquidStaker

HyperliquidStaker - TypeScript SDK for Hyperliquid staking operations

This class provides the functionality to stake, delegate, and manage staking on Hyperliquid. It uses the Hyperliquid REST API for both read and write operations, with EIP-712 signing for transactions.

## Table of contents

### Constructors

* [constructor](#constructor)

### Methods

* [getAddressDerivationFn](#getaddressderivationfn)
* [getStakingSummary](#getstakingsummary)
* [getDelegations](#getdelegations)
* [getDelegatorRewards](#getdelegatorrewards)
* [getDelegatorHistory](#getdelegatorhistory)
* [getSpotBalances](#getspotbalances)
* [buildSpotToStakingTx](#buildspottostakingtx)
* [buildWithdrawFromStakingTx](#buildwithdrawfromstakingtx)
* [buildStakeTx](#buildstaketx)
* [buildUnstakeTx](#buildunstaketx)
* [sign](#sign)
* [broadcast](#broadcast)

## Constructors

### constructor

• **new HyperliquidStaker**(`«destructured»`): [`HyperliquidStaker`](/api-reference/stakers/hyperliquid_src.hyperliquidstaker.md)

Creates a HyperliquidStaker instance.

chain - The Hyperliquid chain to use ('Mainnet' or 'Testnet')

#### Parameters

| Name             | Type               |
| ---------------- | ------------------ |
| `«destructured»` | `Object`           |
| › `chain`        | `HyperliquidChain` |

#### Returns

[`HyperliquidStaker`](/api-reference/stakers/hyperliquid_src.hyperliquidstaker.md)

An instance of HyperliquidStaker.

## Methods

### getAddressDerivationFn

▸ **getAddressDerivationFn**(): (`publicKey`: `Uint8Array`) => `Promise`<`string`\[]>

This **static** method is used to derive an address from a public key.

It can be used for signer initialization, e.g. `FireblocksSigner` or `LocalSigner`.

#### Returns

`fn`

Returns an array containing the derived address with '0x' prefix.

▸ (`publicKey`): `Promise`<`string`\[]>

**Parameters**

| Name        | Type         |
| ----------- | ------------ |
| `publicKey` | `Uint8Array` |

**Returns**

`Promise`<`string`\[]>

***

### getStakingSummary

▸ **getStakingSummary**(`params`): `Promise`<{ `delegated?`: `string` ; `undelegated?`: `string` ; `totalPendingWithdrawal?`: `string` ; `nPendingWithdrawals?`: `number` }>

Gets the staking summary for a delegator.

#### Parameters

| Name                      | Type     | Description             |
| ------------------------- | -------- | ----------------------- |
| `params`                  | `Object` | Query parameters        |
| `params.delegatorAddress` | `string` | The delegator's address |

#### Returns

`Promise`<{ `delegated?`: `string` ; `undelegated?`: `string` ; `totalPendingWithdrawal?`: `string` ; `nPendingWithdrawals?`: `number` }>

A promise that resolves to the delegator's staking summary, including delegated and undelegated amounts

***

### getDelegations

▸ **getDelegations**(`params`): `Promise`<{ `amount?`: `string` ; `validator?`: `string` ; `lockedUntilTimestamp?`: `number` }\[]>

Gets all active delegations for a delegator.

#### Parameters

| Name                      | Type     | Description             |
| ------------------------- | -------- | ----------------------- |
| `params`                  | `Object` | Query parameters        |
| `params.delegatorAddress` | `string` | The delegator's address |

#### Returns

`Promise`<{ `amount?`: `string` ; `validator?`: `string` ; `lockedUntilTimestamp?`: `number` }\[]>

A promise that resolves to an array of active delegations

***

### getDelegatorRewards

▸ **getDelegatorRewards**(`params`): `Promise`<{ `totalAmount?`: `string` ; `source?`: `"delegation"` | `"commission"` ; `time?`: `number` }\[]>

Gets the staking rewards history for a delegator.

#### Parameters

| Name                      | Type     | Description             |
| ------------------------- | -------- | ----------------------- |
| `params`                  | `Object` | Query parameters        |
| `params.delegatorAddress` | `string` | The delegator's address |

#### Returns

`Promise`<{ `totalAmount?`: `string` ; `source?`: `"delegation"` | `"commission"` ; `time?`: `number` }\[]>

A promise that resolves to an array of staking rewards

***

### getDelegatorHistory

▸ **getDelegatorHistory**(`params`): `Promise`<{ `hash?`: `string` ; `time?`: `number` ; `delta?`: { `delegate?`: { `amount?`: `string` ; `validator?`: `string` ; `isUndelegate?`: `boolean` } } | { `cDeposit?`: { `amount?`: `string` } } | { `withdrawal?`: { `amount?`: `string` ; `phase?`: `string` } } }\[]>

Gets the delegation history for a delegator.

#### Parameters

| Name                      | Type     | Description             |
| ------------------------- | -------- | ----------------------- |
| `params`                  | `Object` | Query parameters        |
| `params.delegatorAddress` | `string` | The delegator's address |

#### Returns

`Promise`<{ `hash?`: `string` ; `time?`: `number` ; `delta?`: { `delegate?`: { `amount?`: `string` ; `validator?`: `string` ; `isUndelegate?`: `boolean` } } | { `cDeposit?`: { `amount?`: `string` } } | { `withdrawal?`: { `amount?`: `string` ; `phase?`: `string` } } }\[]>

A promise that resolves to an array of delegation history events

***

### getSpotBalances

▸ **getSpotBalances**(`params`): `Promise`<{ `balances`: { `total?`: `string` ; `coin?`: `string` ; `token?`: `number` ; `hold?`: `string` ; `entryNtl?`: `string` }\[] }>

Gets the spot account balances for a user.

#### Parameters

| Name                      | Type     | Description        |
| ------------------------- | -------- | ------------------ |
| `params`                  | `Object` | Query parameters   |
| `params.delegatorAddress` | `string` | The user's address |

#### Returns

`Promise`<{ `balances`: { `total?`: `string` ; `coin?`: `string` ; `token?`: `number` ; `hold?`: `string` ; `entryNtl?`: `string` }\[] }>

A promise that resolves to an array of spot balances for different assets(e.g. HYPE, USDC)

***

### buildSpotToStakingTx

▸ **buildSpotToStakingTx**(`params`): `Promise`<{ `tx`: `UnsignedTx` }>

Builds a transaction to move tokens from spot account to staking balance.

#### Parameters

| Name            | Type     | Description                             |
| --------------- | -------- | --------------------------------------- |
| `params`        | `Object` | Transaction parameters                  |
| `params.amount` | `string` | Amount to deposit in HYPE (e.g., "1.5") |

#### Returns

`Promise`<{ `tx`: `UnsignedTx` }>

Returns a promise that resolves to a DepositToStakingAction

***

### buildWithdrawFromStakingTx

▸ **buildWithdrawFromStakingTx**(`params`): `Promise`<{ `tx`: `UnsignedTx` }>

Builds a transaction to withdraw tokens from staking balance to spot account. Note: Withdrawals go through a 7-day unstaking queue.

#### Parameters

| Name            | Type     | Description                                |
| --------------- | -------- | ------------------------------------------ |
| `params`        | `Object` | Transaction parameters                     |
| `params.amount` | `string` | Amount to withdraw in tokens (e.g., "1.5") |

#### Returns

`Promise`<{ `tx`: `UnsignedTx` }>

Returns a promise that resolves to a WithdrawFromStakingAction

***

### buildStakeTx

▸ **buildStakeTx**(`params`): `Promise`<{ `tx`: `UnsignedTx` }>

Builds a transaction to delegate tokens to a validator. Note: Delegations have a 1-day lockup period per validator.

#### Parameters

| Name                      | Type            | Description                                                                                 |
| ------------------------- | --------------- | ------------------------------------------------------------------------------------------- |
| `params`                  | `Object`        | Transaction parameters                                                                      |
| `params.validatorAddress` | \`0x${string}\` | Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000 |
| `params.amount`           | `string`        | Amount to delegate in HYPE (e.g., "1.5")                                                    |

#### Returns

`Promise`<{ `tx`: `UnsignedTx` }>

Returns a promise that resolves to a DelegateAction

***

### buildUnstakeTx

▸ **buildUnstakeTx**(`params`): `Promise`<{ `tx`: `UnsignedTx` }>

Builds a transaction to undelegate tokens from a validator. Note: Undelegations have a 1-day lockup period.

#### Parameters

| Name                      | Type            | Description                                                                                 |
| ------------------------- | --------------- | ------------------------------------------------------------------------------------------- |
| `params`                  | `Object`        | Transaction parameters                                                                      |
| `params.validatorAddress` | \`0x${string}\` | Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000 |
| `params.amount`           | `string`        | Amount to undelegate in HYPE (e.g., "1.5")                                                  |

#### Returns

`Promise`<{ `tx`: `UnsignedTx` }>

Returns a promise that resolves to a DelegateAction

***

### sign

▸ **sign**(`params`): `Promise`<{ `signedTx`: `string` }>

Signs a transaction using EIP-712 structured data signing.

#### Parameters

| Name                   | Type         | Description               |
| ---------------------- | ------------ | ------------------------- |
| `params`               | `Object`     | Signing parameters        |
| `params.signer`        | `Signer`     | The signer instance       |
| `params.signerAddress` | `string`     | The address of the signer |
| `params.tx`            | `UnsignedTx` | The unsigned transaction  |

#### Returns

`Promise`<{ `signedTx`: `string` }>

A promise that resolves to the signed transaction

***

### broadcast

▸ **broadcast**(`params`): `Promise`<{ `txHash`: `string` }>

Broadcasts a signed transaction to the Hyperliquid network.

Uses a request queue to ensure transactions are sent sequentially, preventing network-level race conditions that could cause out-of-order nonce errors.

#### Parameters

| Name                      | Type            | Description                          |
| ------------------------- | --------------- | ------------------------------------ |
| `params`                  | `Object`        | Broadcasting parameters              |
| `params.signedTx`         | `string`        | The signed transaction (JSON string) |
| `params.delegatorAddress` | \`0x${string}\` | -                                    |

#### Returns

`Promise`<{ `txHash`: `string` }>

A promise that resolves to the transaction hash


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://sdk.chorus.one/api-reference/stakers/hyperliquid_src.hyperliquidstaker.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.