default
Defined in: index.d.ts:296
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new default(
account,config?):SplStakePoolProtocolSolana
Defined in: index.d.ts:297
Parameters
Section titled “Parameters”account
Section titled “account”unknown
config?
Section titled “config?”Returns
Section titled “Returns”SplStakePoolProtocolSolana
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_account
Section titled “_account”
protected_account:unknown
Defined in: index.d.ts:229
Inherited from
Section titled “Inherited from”
readonlypool:StakePoolConfig
Defined in: index.d.ts:300
Methods
Section titled “Methods”_getClaimInstructions()
Section titled “_getClaimInstructions()”
protected_getClaimInstructions(ids?):Promise<{instructions:Instruction<string, readonly (AccountLookupMeta<string,string> |AccountMeta<string>)[]>[];lamports:bigint; }>
Defined in: index.d.ts:320
Parameters
Section titled “Parameters”bigint[]
Returns
Section titled “Returns”Promise<{ instructions: Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>[]; lamports: bigint; }>
_getStakeInstructions()
Section titled “_getStakeInstructions()”
protected_getStakeInstructions(lamports):Promise<{instructions:Instruction<string, readonly (AccountLookupMeta<string,string> |AccountMeta<string>)[]>[];poolTokens:bigint; }>
Defined in: index.d.ts:318
Parameters
Section titled “Parameters”lamports
Section titled “lamports”bigint
Returns
Section titled “Returns”Promise<{ instructions: Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>[]; poolTokens: bigint; }>
_getUnstakeInstructions()
Section titled “_getUnstakeInstructions()”
protected_getUnstakeInstructions(poolTokens,mode):Promise<{feeTokens:bigint;instructions:Instruction<string, readonly (AccountLookupMeta<string,string> |AccountMeta<string>)[]>[];lamportsOut:bigint;source:WithdrawSource|null;stakeAccount:string|null; }>
Defined in: index.d.ts:319
Parameters
Section titled “Parameters”poolTokens
Section titled “poolTokens”bigint
Returns
Section titled “Returns”Promise<{ feeTokens: bigint; instructions: Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>[]; lamportsOut: bigint; source: WithdrawSource | null; stakeAccount: string | null; }>
_message()
Section titled “_message()”
protected_message(instructions):object
Defined in: index.d.ts:316
The message handed to the account: compute budget, then the operation.
Parameters
Section titled “Parameters”instructions
Section titled “instructions”Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>[]
Returns
Section titled “Returns”object
instructions
Section titled “instructions”instructions:
Instruction<string, readonly (AccountLookupMeta<string,string> |AccountMeta<string>)[]>[]
version
Section titled “version”version:
0
_rpc()
Section titled “_rpc()”
protected_rpc(method,params?):Promise<any>
Defined in: index.d.ts:317
Parameters
Section titled “Parameters”method
Section titled “method”string
params?
Section titled “params?”unknown[]
Returns
Section titled “Returns”Promise<any>
awaitConfirmation()
Section titled “awaitConfirmation()”awaitConfirmation(
hash,options?):Promise<"confirmed"|"finalized">
Defined in: index.d.ts:309
Parameters
Section titled “Parameters”string
options?
Section titled “options?”intervalMs?
Section titled “intervalMs?”number
timeoutMs?
Section titled “timeoutMs?”number
Returns
Section titled “Returns”Promise<"confirmed" | "finalized">
claimWithdrawals()
Section titled “claimWithdrawals()”claimWithdrawals(
options?):Promise<ClaimWithdrawalsResult>
Defined in: index.d.ts:313
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<ClaimWithdrawalsResult>
Overrides
Section titled “Overrides”StakingProtocol.claimWithdrawals
describeActivity()
Section titled “describeActivity()”describeActivity(
tx,ctx):ActivityItem|null
Defined in: index.d.ts:299
Recognize this module’s transactions for a wallet’s history; null for anything else. Pure and synchronous.
Parameters
Section titled “Parameters”ChainTx
DescribeActivityContext
Returns
Section titled “Returns”ActivityItem | null
getApr()
Section titled “getApr()”getApr():
Promise<number>
Defined in: index.d.ts:238
Returns
Section titled “Returns”Promise<number>
Inherited from
Section titled “Inherited from”getEpochInfo()
Section titled “getEpochInfo()”getEpochInfo():
Promise<EpochInfo>
Defined in: index.d.ts:301
Returns
Section titled “Returns”Promise<EpochInfo>
getInstantLiquidity()
Section titled “getInstantLiquidity()”getInstantLiquidity():
Promise<bigint>
Defined in: index.d.ts:307
Returns
Section titled “Returns”Promise<bigint>
getNativeBalance()
Section titled “getNativeBalance()”getNativeBalance():
Promise<bigint>
Defined in: index.d.ts:304
Returns
Section titled “Returns”Promise<bigint>
getPoolData()
Section titled “getPoolData()”getPoolData():
Promise<PoolData>
Defined in: index.d.ts:303
Returns
Section titled “Returns”Promise<PoolData>
getRewards()
Section titled “getRewards()”getRewards(
options?):Promise<Rewards|null>
Defined in: index.d.ts:308
Parameters
Section titled “Parameters”options?
Section titled “options?”limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<Rewards | null>
getStakedBalance()
Section titled “getStakedBalance()”getStakedBalance():
Promise<StakedBalance>
Defined in: index.d.ts:237
Returns
Section titled “Returns”Promise<StakedBalance>
Inherited from
Section titled “Inherited from”StakingProtocol.getStakedBalance
getStakeParams()
Section titled “getStakeParams()”getStakeParams():
Promise<StakeParams>
Defined in: index.d.ts:302
Returns
Section titled “Returns”Promise<StakeParams>
getTokenAccount()
Section titled “getTokenAccount()”getTokenAccount():
Promise<string>
Defined in: index.d.ts:305
Returns
Section titled “Returns”Promise<string>
getTokenBalance()
Section titled “getTokenBalance()”getTokenBalance():
Promise<bigint>
Defined in: index.d.ts:306
Returns
Section titled “Returns”Promise<bigint>
getWithdrawalRequests()
Section titled “getWithdrawalRequests()”getWithdrawalRequests():
Promise<WithdrawalRequestsView>
Defined in: index.d.ts:234
Returns
Section titled “Returns”Promise<WithdrawalRequestsView>
Inherited from
Section titled “Inherited from”StakingProtocol.getWithdrawalRequests
quoteClaimWithdrawals()
Section titled “quoteClaimWithdrawals()”quoteClaimWithdrawals(
options?):Promise<{amount:bigint;fee:bigint; }>
Defined in: index.d.ts:314
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ amount: bigint; fee: bigint; }>
Overrides
Section titled “Overrides”StakingProtocol.quoteClaimWithdrawals
quoteRequestWithdrawal()
Section titled “quoteRequestWithdrawal()”quoteRequestWithdrawal(
options):Promise<{amountOut:bigint;fee:bigint;feeTokens:bigint; }>
Defined in: index.d.ts:312
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<{ amountOut: bigint; fee: bigint; feeTokens: bigint; }>
Overrides
Section titled “Overrides”StakingProtocol.quoteRequestWithdrawal
quoteStake()
Section titled “quoteStake()”quoteStake(
options):Promise<{amountOut:bigint;fee:bigint; }>
Defined in: index.d.ts:310
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<{ amountOut: bigint; fee: bigint; }>
Overrides
Section titled “Overrides”requestWithdrawal()
Section titled “requestWithdrawal()”requestWithdrawal(
options):Promise<WithdrawalRequestResult>
Defined in: index.d.ts:311
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<WithdrawalRequestResult>
Overrides
Section titled “Overrides”StakingProtocol.requestWithdrawal
stake()
Section titled “stake()”stake(
options):Promise<StakeResult>
Defined in: index.d.ts:230
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<StakeResult>