IStakingProtocol
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:32
Interface
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IStakingProtocol():
IStakingProtocol
Returns
Section titled “Returns”IStakingProtocol
Methods
Section titled “Methods”claimWithdrawals()
Section titled “claimWithdrawals()”claimWithdrawals(
_options?):Promise<ClaimWithdrawalsResult>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:91
Claims finalized withdrawal requests — native tokens land on the account.
Parameters
Section titled “Parameters”_options?
Section titled “_options?”The claim’s options.
Returns
Section titled “Returns”Promise<ClaimWithdrawalsResult>
The claim’s result.
getApr()
Section titled “getApr()”getApr():
Promise<number>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:119
Returns the protocol’s current staking APR, in percent.
Returns
Section titled “Returns”Promise<number>
The APR (e.g. 2.7 for 2.7%).
getStakedBalance()
Section titled “getStakedBalance()”getStakedBalance():
Promise<StakedBalance>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:110
Returns the account’s staked position.
Returns
Section titled “Returns”Promise<StakedBalance>
The staked balances.
getWithdrawalRequests()
Section titled “getWithdrawalRequests()”getWithdrawalRequests():
Promise<WithdrawalRequestsView>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:81
Returns the account’s live withdrawal queue: open requests, what is still pending and what is ready to claim.
Returns
Section titled “Returns”Promise<WithdrawalRequestsView>
The queue view.
quoteClaimWithdrawals()
Section titled “quoteClaimWithdrawals()”quoteClaimWithdrawals(
_options?):Promise<Omit<ClaimWithdrawalsResult,"hash">>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:101
Quotes the costs of a claim operation.
Parameters
Section titled “Parameters”_options?
Section titled “_options?”The claim’s options.
Returns
Section titled “Returns”Promise<Omit<ClaimWithdrawalsResult, "hash">>
The claim’s costs.
quoteRequestWithdrawal()
Section titled “quoteRequestWithdrawal()”quoteRequestWithdrawal(
_options):Promise<Omit<WithdrawalRequestResult,"hash"|"approveHash">>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:71
Quotes the costs of a withdrawal request.
Parameters
Section titled “Parameters”_options
Section titled “_options”The request’s options.
Returns
Section titled “Returns”Promise<Omit<WithdrawalRequestResult, "hash" | "approveHash">>
The request’s costs.
quoteStake()
Section titled “quoteStake()”quoteStake(
_options):Promise<Omit<StakeResult,"hash">>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:49
Quotes the costs of a stake operation.
Parameters
Section titled “Parameters”_options
Section titled “_options”The stake’s options.
Returns
Section titled “Returns”Promise<Omit<StakeResult, "hash">>
The stake’s costs.
requestWithdrawal()
Section titled “requestWithdrawal()”requestWithdrawal(
_options):Promise<WithdrawalRequestResult>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:61
Queues staked tokens for withdrawal. The request finalizes out of band; once IStakingProtocol#getWithdrawalRequests reports it claimable, IStakingProtocol#claimWithdrawals exchanges it for native tokens.
Parameters
Section titled “Parameters”_options
Section titled “_options”The request’s options.
Returns
Section titled “Returns”Promise<WithdrawalRequestResult>
The request’s result.
stake()
Section titled “stake()”stake(
_options):Promise<StakeResult>
Defined in: protocol-staking-ssv-evm/src/staking-protocol.ts:39
Stakes native tokens into the protocol; staked tokens land on the account.
Parameters
Section titled “Parameters”_options
Section titled “_options”The stake’s options.
Returns
Section titled “Returns”Promise<StakeResult>
The stake’s result.