StakingProtocol
Defined in: protocols/staking.ts:101
Base class for staking modules: holds the account and config, and throws NotImplementedError
for every method a module leaves out.
Extends
Section titled “Extends”ProtocolBase<TConfig>
Type Parameters
Section titled “Type Parameters”TConfig
Section titled “TConfig”TConfig extends object = Record<string, never>
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new StakingProtocol<
TConfig>(account,config?):StakingProtocol<TConfig>
Defined in: protocols/staking.ts:105
Parameters
Section titled “Parameters”account
Section titled “account”IWalletAccountReadOnly | IWalletAccount
config?
Section titled “config?”TConfig = ...
Returns
Section titled “Returns”StakingProtocol<TConfig>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_account
Section titled “_account”
protectedreadonly_account:IWalletAccountReadOnly|IWalletAccount
Defined in: protocols/base.ts:8
Inherited from
Section titled “Inherited from”_config
Section titled “_config”
protectedreadonly_config:TConfig
Defined in: protocols/base.ts:9
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”claimWithdrawals()
Section titled “claimWithdrawals()”claimWithdrawals(
_o?):Promise<ClaimWithdrawalsResult>
Defined in: protocols/staking.ts:113
Claim finalized requests; the native coin returns to the account.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ClaimWithdrawalsResult>
Implementation of
Section titled “Implementation of”IStakingProtocol.claimWithdrawals
describeActivity()
Section titled “describeActivity()”describeActivity(
_tx,_ctx):ActivityItem|null
Defined in: protocols/base.ts:24
Recognize one of this protocol’s own transactions in an address’s history and
describe it for the wallet’s activity feed (“Supplied 100 USDC · Aave v3”).
Return null when the transaction is not this protocol’s: the kit then asks the
next module and finally falls back to send / receive / approve / contract call.
Must be pure and synchronous: no network, no account state. The conformance
suite feeds every module its recorded fixtures through this method.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ActivityItem | null
Inherited from
Section titled “Inherited from”getApr()
Section titled “getApr()”getApr():
Promise<number>
Defined in: protocols/staking.ts:116
APR in percent: 2.5 = 2.5 % (every staking module and app reads it this way).
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getStakedBalance()
Section titled “getStakedBalance()”getStakedBalance():
Promise<StakedBalance>
Defined in: protocols/staking.ts:115
The account’s staked position.
Returns
Section titled “Returns”Promise<StakedBalance>
Implementation of
Section titled “Implementation of”IStakingProtocol.getStakedBalance
getWithdrawalRequests()
Section titled “getWithdrawalRequests()”getWithdrawalRequests():
Promise<WithdrawalRequestsView>
Defined in: protocols/staking.ts:112
The account’s open requests, and which are claimable.
Returns
Section titled “Returns”Promise<WithdrawalRequestsView>
Implementation of
Section titled “Implementation of”IStakingProtocol.getWithdrawalRequests
quoteClaimWithdrawals()
Section titled “quoteClaimWithdrawals()”quoteClaimWithdrawals(
_o?):Promise<Omit<ClaimWithdrawalsResult,"hash">>
Defined in: protocols/staking.ts:114
Network fee of IStakingProtocol.claimWithdrawals.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Omit<ClaimWithdrawalsResult, "hash">>
Implementation of
Section titled “Implementation of”IStakingProtocol.quoteClaimWithdrawals
quoteRequestWithdrawal()
Section titled “quoteRequestWithdrawal()”quoteRequestWithdrawal(
_o):Promise<Omit<WithdrawalRequestResult,"hash"|"approveHash">>
Defined in: protocols/staking.ts:111
Network fee of IStakingProtocol.requestWithdrawal.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Omit<WithdrawalRequestResult, "hash" | "approveHash">>
Implementation of
Section titled “Implementation of”IStakingProtocol.quoteRequestWithdrawal
quoteStake()
Section titled “quoteStake()”quoteStake(
_o):Promise<Omit<StakeResult,"hash">>
Defined in: protocols/staking.ts:109
Network fee of IStakingProtocol.stake; nothing is signed.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Omit<StakeResult, "hash">>
Implementation of
Section titled “Implementation of”requestWithdrawal()
Section titled “requestWithdrawal()”requestWithdrawal(
_o):Promise<WithdrawalRequestResult>
Defined in: protocols/staking.ts:110
Put staked tokens in the withdrawal queue. Sends an approval first when the protocol needs one.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<WithdrawalRequestResult>
Implementation of
Section titled “Implementation of”IStakingProtocol.requestWithdrawal
requireSigningAccount()
Section titled “requireSigningAccount()”
protectedrequireSigningAccount(methodName):IWalletAccount
Defined in: protocols/base.ts:29
The account, narrowed to a signing one, or a ReadOnlyAccountError naming the caller.
Parameters
Section titled “Parameters”methodName
Section titled “methodName”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ProtocolBase.requireSigningAccount
stake()
Section titled “stake()”stake(
_o):Promise<StakeResult>
Defined in: protocols/staking.ts:108
Stake native coin and receive the protocol’s staked token.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<StakeResult>