Class Award

Hierarchy

Award

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Award(addresses: AwardAddresses, award: AwardInfo, vault: AssociatedToken): Award

- Defined in rewards/award.ts:115
Creates an instance of Award.

memberof
Award

Parameters
- addresses: AwardAddresses
- award: AwardInfo
- vault: AssociatedToken
Returns Award

Properties

addresses

addresses: AwardAddresses

award

award: AwardInfo

vault

vault: AssociatedToken

Methods

Static derive

derive(stakeAccount: PublicKey, seed: string): AwardAddresses

- Defined in rewards/award.ts:82
Derive the award account and vault token account PDAs

static
memberof
Award

Parameters
- stakeAccount: PublicKey
- seed: string
Returns AwardAddresses

Static load

load(rewardsProgram: Program<RewardsIdl>, stakeAccount: PublicKey, seed: string): Promise<Award>

- Defined in rewards/award.ts:98
Load the award account and its vault

static
memberof
Award

Parameters
- rewardsProgram: Program<RewardsIdl>
- stakeAccount: PublicKey
- seed: string
Returns Promise<Award>

Static use

use(rewardsProgram: undefined | Program<RewardsIdl>, stakeAccount: undefined | PublicKey, seed: string): undefined | Award

- Defined in rewards/award.ts:127
React hook to use the award account and its vault

static
memberof
Award

Parameters
- rewardsProgram: undefined | Program<RewardsIdl>
- stakeAccount: undefined | PublicKey
- seed: string
Returns undefined | Award

Generated using TypeDoc