Interface: StakeProgram

Stake program interface

Methods

all()

all(): Promise<Stake[]>;

Fetch all stake accounts

Returns

Promise<Stake[]>

---

find()

find(owner?): Promise<Stake | undefined>;

Fetch a stake account by owner address (defaults to wallet address); undefined when the owner has none

Parameters

Parameter	Type
owner?	Address

Returns

Promise<Stake | undefined>

---

get()

get(addr): Promise<Stake>;

Fetch a stake account by address

Parameters

Parameter	Type
addr	Address

Returns

Promise<Stake>

---

getAddress()

getAddress(owner?): Promise<Address>;

Derive the stake account PDA address for a given owner (defaults to wallet address)

Parameters

Parameter	Type
owner?	Address

Returns

Promise<Address>

---

getByOwner()

getByOwner(owner?): Promise<Stake>;

Fetch a stake account by owner address (defaults to wallet address)

Parameters

Parameter	Type
owner?	Address

Returns

Promise<Stake>

---

multiple()

multiple(addresses): Promise<Stake[]>;

Fetch multiple stake accounts by address

Parameters

Parameter	Type
addresses	Address[]

Returns

Promise<Stake[]>

Properties

Property	Type	Description
stake	CreateStake	Create a stake instruction for creating/initializing a stake account
topup	CreateTopup	Create the instructions that top up the wallet's existing stake account by amount (NOS base units) and keep its staking rewards in step. In order: rewards enter (only when the wallet has no rewards account yet), pools claimFee for pool (default: programs.rewardsPoolAddress), stake topup, rewards sync. Send them together in one transaction.