Class Airdrop

Hierarchy

Airdrop

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Airdrop(airdropAddress: PublicKey, rewardsVaultAddress: PublicKey, airdrop: AirdropInfo, rewardsVault: AssociatedToken): Airdrop

- Defined in rewards/airdrop.ts:267
Creates an instance of Airdrop.

memberof
Airdrop

Parameters
- airdropAddress: PublicKey
- rewardsVaultAddress: PublicKey
- airdrop: AirdropInfo
- rewardsVault: AssociatedToken
Returns Airdrop

Properties

airdrop

airdrop: AirdropInfo

airdropAddress

airdropAddress: PublicKey

rewardsVault

rewardsVault: AssociatedToken

rewardsVaultAddress

rewardsVaultAddress: PublicKey

targetInfo

targetInfo: AirdropTargetInfo

Methods

getRecipient

getRecipient(wallet: PublicKey): undefined | AirdropTarget

- Defined in rewards/airdrop.ts:318
TODO:

memberof
Airdrop

Parameters
- wallet: PublicKey
Returns undefined | AirdropTarget

Static claim

claim(rewardsProgram: Program<RewardsIdl>, airdrop: Airdrop, stakePool: StakePool, owner: PublicKey): Promise<TransactionInstruction[]>

- Defined in rewards/airdrop.ts:382
TODO:

static
memberof
Airdrop

Parameters
- rewardsProgram: Program<RewardsIdl>
- airdrop: Airdrop
- stakePool: StakePool
- owner: PublicKey
Returns Promise<TransactionInstruction[]>

Static deriveRewardsVault

deriveRewardsVault(airdrop: PublicKey): PublicKey

- Defined in rewards/airdrop.ts:185
Derives the reward vault for the airdrop

static
memberof
Airdrop

Parameters
- airdrop: PublicKey
Returns PublicKey

Static load

load(rewardsProgram: Program<RewardsIdl>, airdropAddress: PublicKey): Promise<Airdrop>

- Defined in rewards/airdrop.ts:198
Loads the airdrop account and its reward vault

static
memberof
Airdrop

Parameters
- rewardsProgram: Program<RewardsIdl>
- airdropAddress: PublicKey
Returns Promise<Airdrop>

Static loadAll

loadAll(rewardsProgram: Program<RewardsIdl>, stakePoolVault: PublicKey): Promise<Airdrop[]>

- Defined in rewards/airdrop.ts:217
Loads the airdrop accounts associating with the stake pool vault

static
memberof
Airdrop

Parameters
- rewardsProgram: Program<RewardsIdl>
- stakePoolVault: PublicKey
Returns Promise<Airdrop[]>

Static use

use(rewardsProgram: undefined | Program<RewardsIdl>, airdrop: undefined | PublicKey): undefined | Airdrop

- Defined in rewards/airdrop.ts:285
React hook to use the airdrop account and its hook

static
memberof
Airdrop

Parameters
- rewardsProgram: undefined | Program<RewardsIdl>
- airdrop: undefined | PublicKey
Returns undefined | Airdrop

Static useAll

useAll(rewardsProgram: undefined | Program<RewardsIdl>, stakePoolVault: undefined | PublicKey): undefined | Airdrop[]

- Defined in rewards/airdrop.ts:301
TODO:

static
memberof
Airdrop

Parameters
- rewardsProgram: undefined | Program<RewardsIdl>
- stakePoolVault: undefined | PublicKey
Returns undefined | Airdrop[]

Static withClaim

withClaim(instructions: TransactionInstruction[], rewardsProgram: Program<RewardsIdl>, airdrop: Airdrop, stakePool: StakePool, owner: PublicKey): Promise<void>

- Defined in rewards/airdrop.ts:333
TODO:

static
memberof
Airdrop

Parameters
- instructions: TransactionInstruction[]
- rewardsProgram: Program<RewardsIdl>
- airdrop: Airdrop
- stakePool: StakePool
- owner: PublicKey
Returns Promise<void>

Generated using TypeDoc