# EthereumStaker This class provides the functionality to stake, unstake, and withdraw for Ethereum network. It also provides the ability to retrieve staking information and rewards for an account. ## Table of contents ### Constructors * [constructor](#constructor) ### Methods * [getAddressDerivationFn](#getaddressderivationfn) * [init](#init) * [buildStakeTx](#buildstaketx) * [buildUnstakeTx](#buildunstaketx) * [buildWithdrawTx](#buildwithdrawtx) * [buildMintTx](#buildminttx) * [buildBurnTx](#buildburntx) * [getVault](#getvault) * [getStake](#getstake) * [getRewardsHistory](#getrewardshistory) * [getTxHistory](#gettxhistory) * [getUnstakeQueue](#getunstakequeue) * [getMint](#getmint) * [getMintHealth](#getminthealth) * [createValidatorBatch](#createvalidatorbatch) * [listValidatorBatches](#listvalidatorbatches) * [getValidatorBatchStatus](#getvalidatorbatchstatus) * [exportDepositData](#exportdepositdata) * [buildDepositTx](#builddeposittx) * [buildValidatorExitTx](#buildvalidatorexittx) * [sign](#sign) * [broadcast](#broadcast) * [getTxStatus](#gettxstatus) ## Constructors ### constructor • **new EthereumStaker**(`params`): [`EthereumStaker`](/api-reference/stakers/ethereum_src.ethereumstaker.md) Creates an EthereumStaker instance. #### Parameters | Name | Type | Description | | ------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | | `params` | `Object` | Initialization configuration | | `params.network` | `Networks` | The network to connect to | | `params.rpcUrl?` | `string` | (Optional) The URL of the RPC endpoint. If not provided, the public RPC URL for the network will be used. | | `params.nativeStakingApiToken?` | `string` | (Optional) API token for native staking operations. Required for native staking methods. | #### Returns [`EthereumStaker`](/api-reference/stakers/ethereum_src.ethereumstaker.md) An instance of EthereumStaker. ## 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. ▸ (`publicKey`): `Promise`<`string`\[]> **Parameters** | Name | Type | | ----------- | ------------ | | `publicKey` | `Uint8Array` | **Returns** `Promise`<`string`\[]> *** ### init ▸ **init**(): `Promise`<`void`> Initializes the EthereumStaker instance and connects to the Ethereum network. #### Returns `Promise`<`void`> A promise which resolves once the EthereumStaker instance has been initialized. *** ### buildStakeTx ▸ **buildStakeTx**(`params`): `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Builds a staking transaction. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `params` | `Object` | Parameters for building the transaction | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address to stake from | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to stake with | | `params.amount` | `string` | The amount to stake, specified in `ETH`. E.g. "1" - 1 ETH | | `params.referrer?` | \`0x${string}\` | (Optional) The address of the referrer. This is used to track the origin of transactions, providing insights into which sources or campaigns are driving activity. This can be useful for analytics and optimizing user acquisition strategies | #### Returns `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Returns a promise that resolves to an Ethereum staking transaction. *** ### buildUnstakeTx ▸ **buildUnstakeTx**(`params`): `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Builds an unstaking transaction. The unstake transaction effectively moves the user's assets into an unstake queue where they remain until they become eligible for withdrawal. This queue is a safeguard mechanism that ensures the liquidity and stability of the vault by managing the flow of assets. To check the status of these assets, use the `getUnstakeQueue` method. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ----------------------------------------------------------- | | `params` | `Object` | Parameters for building the transaction | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address that is unstaking | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to unstake from | | `params.amount` | `string` | The amount to unstake, specified in `ETH`. E.g. "1" - 1 ETH | #### Returns `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Returns a promise that resolves to an Ethereum unstaking transaction. *** ### buildWithdrawTx ▸ **buildWithdrawTx**(`params`): `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Builds a withdrawal transaction. This method is the final step in the unstaking process. Once assets in the unstake queue have reached a withdrawable state (as determined by the `getUnstakeQueue` method), the `buildWithdrawTx` method prepares the transaction data necessary for transferring these assets back into the user's wallet. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `params` | `Object` | Parameters for building the transaction | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to withdraw from | | `params.positionTickets?` | `string`\[] | (Optional) An array of position tickets to withdraw. If not provided, all withdrawable assets will be withdrawn. (see `getUnstakeQueue`) | #### Returns `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Returns a promise that resolves to an Ethereum withdrawal transaction. *** ### buildMintTx ▸ **buildMintTx**(`params`): `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Builds a mint transaction. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `params` | `Object` | Parameters for building the transaction | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to mint shares for | | `params.amount` | `string` | The amount to mint, specified in `osETH`. E.g. "1" - 1 osETH | | `params.referrer?` | \`0x${string}\` | (Optional) The address of the referrer. This is used to track the origin of transactions, providing insights into which sources or campaigns are driving activity. This can be useful for analytics and optimizing user acquisition strategies | #### Returns `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Returns a promise that resolves to an Ethereum mint transaction. *** ### buildBurnTx ▸ **buildBurnTx**(`params`): `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Builds a burn transaction. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ------------------------------------------------------------ | | `params` | `Object` | Parameters for building the transaction | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to burn shares from | | `params.amount` | `string` | The amount to burn, specified in `osETH`. E.g. "1" - 1 osETH | #### Returns `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Returns a promise that resolves to an Ethereum burn transaction. *** ### getVault ▸ **getVault**(`params`): `Promise`<{ `vault`: [`Vault`](/api-reference/types/ethereum/ethereum_src.vault.md) }> Retrieves the staking information for a specified vault, including TVL, APY, description, logo. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ----------------------------- | | `params` | `Object` | Parameters for the request | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address | #### Returns `Promise`<{ `vault`: [`Vault`](/api-reference/types/ethereum/ethereum_src.vault.md) }> Returns a promise that resolves to the staking information for the specified vault. *** ### getStake ▸ **getStake**(`params`): `Promise`<{ `balance`: `string` ; `maxUnstake`: `string` }> Retrieves the staking information for a specified delegator. The staking information includes the current balance and the maximum amount that can be unstaked. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ---------------------------------------------------------------- | | `params` | `Object` | Parameters for the request | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to gather staking information from | #### Returns `Promise`<{ `balance`: `string` ; `maxUnstake`: `string` }> Returns a promise that resolves to the staking information for the delegator. *** ### getRewardsHistory ▸ **getRewardsHistory**(`params`): `Promise`<{ `timestamp`: `number` = item.timestamp; `amount`: `string` ; `totalRewards`: `string` ; `dailyRewards`: `string` }\[]> Retrieves the rewards history for a specified delegator. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ------------------------------------------------------------------------- | | `params` | `Object` | Parameters for the request | | `params.startTime` | `number` | The start time of the rewards data to retrieve, specified in milliseconds | | `params.endTime` | `number` | The end time of the rewards data to retrieve, specified in milliseconds | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to gather rewards data from | #### Returns `Promise`<{ `timestamp`: `number` = item.timestamp; `amount`: `string` ; `totalRewards`: `string` ; `dailyRewards`: `string` }\[]> Returns a promise that resolves to the rewards data for the specified delegator. *** ### getTxHistory ▸ **getTxHistory**(`params`): `Promise`<{ `timestamp`: `number` ; `type`: `VaultActionType` = item.type; `amount`: `string` ; `txHash`: `string` }\[]> Retrieves the transaction history for a specified delegator. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ------------------------------------------------------------- | | `params` | `Object` | Parameters for the request | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to gather transaction data from | #### Returns `Promise`<{ `timestamp`: `number` ; `type`: `VaultActionType` = item.type; `amount`: `string` ; `txHash`: `string` }\[]> Returns a promise that resolves to the transaction history for the specified delegator. *** ### getUnstakeQueue ▸ **getUnstakeQueue**(`params`): `Promise`<{ `positionTicket`: `string` ; `exitQueueIndex`: `string` ; `timestamp`: `number` = item.timestamp; `isWithdrawable`: `boolean` = item.isWithdrawable; `totalAmount`: `string` ; `withdrawableAmount`: `string` ; `withdrawalTimestamp`: `number` = item.withdrawalTimestamp }\[]> Retrieves the unstake queue for a specified delegator. After initiating an unstake request using the `buildUnstakeTx` method, assets are placed into an unstake queue. The `getUnstakeQueue` method allows users to query the queue to check the current state of their unstake requests, including their positionTicket, the amount of assets that are withdrawable, and the total amount. To prepare the transaction for withdrawing these assets, use the `buildWithdrawTx` method. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | -------------------------------------------------------------- | | `params` | `Object` | Parameters for the request | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to gather the unstake queue from | #### Returns `Promise`<{ `positionTicket`: `string` ; `exitQueueIndex`: `string` ; `timestamp`: `number` = item.timestamp; `isWithdrawable`: `boolean` = item.isWithdrawable; `totalAmount`: `string` ; `withdrawableAmount`: `string` ; `withdrawalTimestamp`: `number` = item.withdrawalTimestamp }\[]> Returns a promise that resolves to the unstake queue for the specified delegator. *** ### getMint ▸ **getMint**(`params`): `Promise`<{ `balance`: `string` ; `maxMint`: `string` }> Retrieves the mint information for a specified delegator. The mint information includes the current balance of minted `osETH` and the maximum amount of that can be minted. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ------------------------------------------------------ | | `params` | `Object` | Parameters for the request | | `params.delegatorAddress` | \`0x${string}\` | The delegator (wallet) address | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address to gather mint data from | #### Returns `Promise`<{ `balance`: `string` ; `maxMint`: `string` }> Returns a promise that resolves to the mint information *** ### getMintHealth ▸ **getMintHealth**(`params`): `Promise`<{ `health`: `"healthy"` | `"risky"` }> Retrieves the mint health for a specified stake and mint amount. Position health tracks the value of osETH minted by stakers relative to the value of their ETH stake in the vault. Healthy positions have minted osETH that is well-collateralized by staked ETH. As the proportion of minted osETH increases relative to staked ETH, position health deteriorates. Factors affecting position health include yield discrepancies (APY) between the vault and osETH, which can result from: * Differences in fee structures. * Variations in attestation performance. * The ratio of unbounded ETH to the vault's total value locked (TVL). * Delays in validator activation on the Beacon Chain. * Losses due to maximal extractable value (MEV) strategies. Risky positions may enter redemption processes, while positions deemed unhealthy are subject to liquidation. #### Parameters | Name | Type | Description | | ------------------------- | --------------- | ----------------------------- | | `params` | `Object` | Parameters for the request | | `params.stakeAmount` | `string` | The amount of ETH staked | | `params.mintAmount` | `string` | The amount of osETH minted | | `params.validatorAddress` | \`0x${string}\` | The validator (vault) address | #### Returns `Promise`<{ `health`: `"healthy"` | `"risky"` }> Returns a promise that resolves to the mint health status('healthy' | 'risky' ) *** ### createValidatorBatch ▸ **createValidatorBatch**(`params`): `Promise`<`CreateBatchResponse`> Creates a batch of validators for native Ethereum staking. This method creates a new batch of validators using the Chorus One Native Staking API. Each validator requires 32 ETH to be deposited. The batch will generate deposit data that can be used to deposit validators on the Ethereum network. #### Parameters | Name | Type | Description | | --------------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------- | | `params` | `Object` | Parameters for creating the validator batch | | `params.batchId` | `string` | Unique identifier for the batch | | `params.withdrawalAddress` | \`0x${string}\` | The withdrawal address that will control the staked funds.Must be 0x02 compounding credentials for compounding validators. | | `params.feeRecipientAddress` | \`0x${string}\` | The address that will receive MEV rewards | | `params.numberOfValidators` | `number` | Number of validators to create (each requires 32 ETH) | | `params.isCompounding?` | `boolean` | (Optional) Whether to create compounding validators (0x02 withdrawal credentials). Default is false. | | `params.depositGweiPerValidator?` | `bigint` | (Optional) The deposit in gwei per validator. Default is 32000000000 gwei i.e. 32ETH. | #### Returns `Promise`<`CreateBatchResponse`> Returns a promise that resolves to the batch creation response. *** ### listValidatorBatches ▸ **listValidatorBatches**(): `Promise`<`ListBatchesResponse`> Lists all validator batches for the authenticated tenant. This method retrieves all validator batches that have been created for the current tenant. #### Returns `Promise`<`ListBatchesResponse`> Returns a promise that resolves to an array of validator batches. *** ### getValidatorBatchStatus ▸ **getValidatorBatchStatus**(`params`): `Promise`<`BatchDetailsResponse`> Gets the status of a validator batch. This method retrieves the current status of a validator batch, including the deposit data for each validator when ready. #### Parameters | Name | Type | Description | | ---------------- | -------- | ----------------------------------- | | `params` | `Object` | Parameters for getting batch status | | `params.batchId` | `string` | The batch identifier | #### Returns `Promise`<`BatchDetailsResponse`> Returns a promise that resolves to the batch information. *** ### exportDepositData ▸ **exportDepositData**(`params`): `Promise`<{ `depositData`: `BatchDetailsDepositData`\[] }> Exports deposit data in the format required by the Ethereum Staking Launchpad. This method the deposit data for each validator in the batch, which can be used to deposit validators with the oficial Ethereum Staking Launchpad or other depositing tools. #### Parameters | Name | Type | Description | | ------------------ | ---------------------- | ------------------------------------- | | `params` | `Object` | Parameters for exporting deposit data | | `params.batchData` | `BatchDetailsResponse` | Pre-fetched batch of validators | #### Returns `Promise`<{ `depositData`: `BatchDetailsDepositData`\[] }> Returns a promise that resolves to an array of deposit data objects. *** ### buildDepositTx ▸ **buildDepositTx**(`params`): `Promise`<{ `transactions`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md)\[] }> Builds deposit transactions for native Ethereum staking. This method creates transactions for depositing validators to the Ethereum deposit contract. Each validator requires exactly 32 ETH to be deposited along with the deposit data. #### Parameters | Name | Type | Description | | ------------------ | ---------------------- | -------------------------------------------- | | `params` | `Object` | Parameters for building deposit transactions | | `params.batchData` | `BatchDetailsResponse` | Pre-fetched batch of validators | #### Returns `Promise`<{ `transactions`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md)\[] }> Returns a promise that resolves to an array of deposit transactions. *** ### buildValidatorExitTx ▸ **buildValidatorExitTx**(`params`): `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Builds a withdrawal request transaction for a validator based on EIP-7002. This method creates a transaction that triggers a full validator exit through the execution layer withdrawal credentials (0x01) as specified in EIP-7002. #### Parameters | Name | Type | Description | | ------------------------ | -------- | ---------------------------------------------------------------------------- | | `params` | `Object` | Parameters for building the withdrawal transaction | | `params.validatorPubkey` | `string` | The validator public key (48 bytes) | | `params.value?` | `bigint` | (Optional) The amount of ETH to send with the transaction. Default is 1 wei. | #### Returns `Promise`<{ `tx`: [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) }> Returns a promise that resolves to a withdrawal transaction. *** ### sign ▸ **sign**(`params`): `Promise`<{ `signedTx`: \`0x${string}\` }> Signs a transaction using the provided signer. #### Parameters | Name | Type | Description | | ---------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `params` | `Object` | Parameters for the signing process | | `params.signer` | `Signer` | A signer instance. | | `params.signerAddress` | \`0x${string}\` | The address of the signer | | `params.tx` | [`Transaction`](/api-reference/types/ethereum/ethereum_src.transaction.md) | The transaction to sign | | `params.baseFeeMultiplier?` | `number` | (Optional) The multiplier for fees, which is used to manage fee fluctuations, is applied to the base fee per gas from the latest block to determine the final `maxFeePerGas`. The default value is 1.2. | | `params.defaultPriorityFee?` | `string` | (Optional) This overrides the the `maxPriorityFeePerGas` estimated by the RPC. | #### Returns `Promise`<{ `signedTx`: \`0x${string}\` }> A promise that resolves to an object containing the signed transaction. *** ### broadcast ▸ **broadcast**(`params`): `Promise`<{ `txHash`: \`0x${string}\` }> Broadcasts a signed transaction to the network. #### Parameters | Name | Type | Description | | ----------------- | --------------- | ------------------------------------ | | `params` | `Object` | Parameters for the broadcast process | | `params.signedTx` | \`0x${string}\` | The signed transaction to broadcast | #### Returns `Promise`<{ `txHash`: \`0x${string}\` }> A promise that resolves to the final execution outcome of the broadcast transaction. *** ### getTxStatus ▸ **getTxStatus**(`params`): `Promise`<`EthereumTxStatus`> Retrieves the status of a transaction using the transaction hash. #### Parameters | Name | Type | Description | | --------------- | --------------- | --------------------------------------------- | | `params` | `Object` | Parameters for the transaction status request | | `params.txHash` | \`0x${string}\` | The transaction hash to query | #### Returns `Promise`<`EthereumTxStatus`> A promise that resolves to an object containing the transaction status. --- # 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/ethereum_src.ethereumstaker.md?ask= ``` 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.