SubstrateStaker
This class provides the functionality to stake, nominate, unbond, and withdraw funds for a Substrate-based blockchains.
It also provides the ability to retrieve staking information and rewards for a delegator.
Table of contents
Constructors
Methods
Constructors
constructor
• new SubstrateStaker(params): SubstrateStaker
This creates a new SubstrateStaker instance.
Parameters
params
Object
Initialization parameters
params.rpcUrl
string
RPC URL (e.g. wss://rpc.polkadot.io)
params.rewardDestination
Reward destination (e.g., RewardDestination.STASH or RewardDestination.CONTROLLER)
params.denomMultiplier?
string
(Optional) Multiplier to convert the base coin unit to its smallest subunit (e.g., 1000000000000 for 1 DOT = 1000000000000 Planck)
params.fee?
SubstrateFee
(Optional) Transaction fee (e.g. '0.001' for 0.001 DOT)
Returns
An instance of SusbstrateStaker.
Methods
getAddressDerivationFn
▸ getAddressDerivationFn(): (publicKey: Uint8Array, _derivationPath: string) => 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, _derivationPath): Promise<string[]>
Parameters
publicKey
Uint8Array
_derivationPath
string
Returns
Promise<string[]>
init
▸ init(): Promise<void>
Initializes the SubstrateStaker instance and connects to the blockchain.
Returns
Promise<void>
A promise which resolves once the Staker instance has been initialized.
close
▸ close(): Promise<void>
Closes the SubstrateStaker instance and disconnects from the blockchain.
Returns
Promise<void>
A promise which resolves once the Staker instance has been closed.
buildStakeTx
▸ buildStakeTx(params): Promise<{ tx: UnsignedTx }>
Builds a staking (delegation) transaction.
Parameters
params
Object
Parameters for building the transaction
params.amount
string
The amount to stake, specified in base units of the native token (e.g. DOT for Polkadot)
Returns
Promise<{ tx: UnsignedTx }>
Returns a promise that resolves to a Polkadot staking transaction.
buildNominateTx
▸ buildNominateTx(params): Promise<{ tx: UnsignedTx }>
Builds a nomination transaction - allows the user to pick trusted validators to delegate to.
Parameters
params
Object
Parameters for building the transaction
params.validatorAddresses
string[]
The list of validator addresses to nominate to
Returns
Promise<{ tx: UnsignedTx }>
Returns a promise that resolves to a Substrate nomination transaction.
buildUnstakeTx
▸ buildUnstakeTx(params): Promise<{ tx: UnsignedTx }>
Builds an unstaking (undelegation) transaction.
Parameters
params
Object
Parameters for building the transaction
params.amount
string
The amount to unstake, specified in base units of the native token (e.g. DOT for Polkadot)
Returns
Promise<{ tx: UnsignedTx }>
Returns a promise that resolves to a Substrate unstaking transaction.
buildWithdrawTx
▸ buildWithdrawTx(): Promise<{ tx: UnsignedTx }>
Builds a transaction to withdraw all unstaked funds from the validator contract.
Returns
Promise<{ tx: UnsignedTx }>
Returns a promise that resolves to a Substrate withdraw transaction.
buildBondExtraTx
▸ buildBondExtraTx(params): Promise<{ tx: UnsignedTx }>
Builds a transaction to delegate more tokens to a validator.
Parameters
params
Object
Parameters for building the transaction
params.amount
string
The amount to stake, specified in base units of the native token (e.g. DOT for Polkadot)
Returns
Promise<{ tx: UnsignedTx }>
Returns a promise that resolves to a Substrate bond extra transaction.
getStake
▸ getStake(params): Promise<{ balance: string }>
Retrieves the staking information for a specified delegator.
Parameters
params
Object
Parameters for the request
params.delegatorAddress
string
The delegator (wallet) address
params.validatorAddress?
string
(Optional) The validator address to assert the delegator is staking with
params.status?
"active" | "total"
(Optional) The status of nomination (default: 'active')
Returns
Promise<{ balance: string }>
Returns a promise that resolves to the staking information for the specified delegator.
sign
▸ sign(params): Promise<{ signedTx: GenericExtrinsic<AnyTuple> }>
Signs a transaction using the provided signer.
Parameters
params
Object
Parameters for the signing process
params.signer
Signer
Signer instance
params.signerAddress
string
The address of the signer
params.tx
UnsignedTx
The transaction to sign
params.blocks?
number
(Optional) The number of blocks until the transaction expires
Returns
Promise<{ signedTx: GenericExtrinsic<AnyTuple> }>
A promise that resolves to an object containing the signed transaction.
broadcast
▸ broadcast(params): Promise<{ txHash: string ; status: ExtrinsicStatus }>
This method is used to broadcast a signed transaction to the Substrate network.
Parameters
params
Object
Parameters for the broadcast
params.signedTx
GenericExtrinsic<AnyTuple>
The signed transaction to be broadcasted
Returns
Promise<{ txHash: string ; status: ExtrinsicStatus }>
Returns a promise that resolves to the response of the transaction that was broadcast to the network.
getTxStatus
▸ getTxStatus(params): Promise<SubstrateTxStatus>
Retrieves the status of a transaction using the transaction hash.
Parameters
params
Object
Parameters for the transaction status request
params.txHash
string
The transaction hash to query
Returns
Promise<SubstrateTxStatus>
A promise that resolves to an object containing the transaction status.
Last updated
Was this helpful?