Class Distribution

Hierarchy

Distribution

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Distribution(addresses: DistributionAddresses, distribution: DistributionInfo, vault: AssociatedToken): Distribution

- Defined in rewards/distribution.ts:284
Creates an instance of Distribution.

memberof
Distribution

Parameters
- addresses: DistributionAddresses
- distribution: DistributionInfo
- vault: AssociatedToken
Returns Distribution

Properties

addresses

addresses: DistributionAddresses

distribution

distribution: DistributionInfo

vault

vault: AssociatedToken

Methods

isActive

isActive(now: BN): boolean

- Defined in rewards/distribution.ts:323
TODO:

memberof
Distribution

Parameters
- now: BN
Returns boolean

Static create

create(rewardsProgram: Program<RewardsIdl>, provider: AnchorProvider, targetAccount: PublicKey, tokenMint: PublicKey, params: DistributionCreateParams): Promise<string>

- Defined in rewards/distribution.ts:251
TODO:

static
memberof
Distribution

Parameters
- rewardsProgram: Program<RewardsIdl>
- provider: AnchorProvider
- targetAccount: PublicKey
- tokenMint: PublicKey
- params: DistributionCreateParams
Returns Promise<string>

Static createForStakePool

createForStakePool(rewardsProgram: Program<RewardsIdl>, provider: AnchorProvider, distributionTarget: StakePool, params: DistributionCreateParams): Promise<void>

- Defined in rewards/distribution.ts:229
TODO:

static
memberof
Distribution

Parameters
- rewardsProgram: Program<RewardsIdl>
- provider: AnchorProvider
- distributionTarget: StakePool
- params: DistributionCreateParams
Returns Promise<void>

Static derive

derive(seed: string): DistributionAddresses
derive(seed: number[], seedLen: number): DistributionAddresses

- Defined in rewards/distribution.ts:143
Derive the distribution account and its vault PDA

static
memberof
Distribution

Parameters
- seed: string
Returns DistributionAddresses
{DistributionAddresses}
- Defined in rewards/distribution.ts:152
Derive the distribution account and its vault PDA

static
memberof
Distribution

Parameters
- seed: number[]
- seedLen: number
Returns DistributionAddresses

Static estimateCombinedYield

estimateCombinedYield(distributions: Distribution[], totalDeposits: number, totalShares: number, usersShares: number): DistributionYield

- Defined in rewards/distribution.ts:381
TODO:

static
memberof
Distribution

Parameters
- distributions: Distribution[]
- totalDeposits: number
- totalShares: number
- usersShares: number
Returns DistributionYield

Static estimateYield

estimateYield(dist: Distribution, totalDeposits: number, totalShares: number, usersShares: number): DistributionYield

- Defined in rewards/distribution.ts:344
TODO:

static
memberof
Distribution

Parameters
- dist: Distribution
- totalDeposits: number
- totalShares: number
- usersShares: number
Returns DistributionYield

Static load

load(rewardsProgram: Program<RewardsIdl>, seed: string): Promise<Distribution>

- Defined in rewards/distribution.ts:174
Load the distribution account and its vault

static
memberof
Distribution

Parameters
- rewardsProgram: Program<RewardsIdl>
- seed: string
Returns Promise<Distribution>

Static loadAll

loadAll(rewardsProgram: Program<RewardsIdl>): Promise<Distribution[]>

- Defined in rewards/distribution.ts:192
TODO:

static
memberof
Distribution

Parameters
- rewardsProgram: Program<RewardsIdl>
Returns Promise<Distribution[]>

Static use

use(rewardsProgram: undefined | Program<RewardsIdl>, seed: string): undefined | Distribution

- Defined in rewards/distribution.ts:298
React hook to load the distribution account and its vault

static
memberof
Distribution

Parameters
- rewardsProgram: undefined | Program<RewardsIdl>
- seed: string
Returns undefined | Distribution

Static useAll

useAll(rewardsProgram: undefined | Program<RewardsIdl>): undefined | Distribution[]

- Defined in rewards/distribution.ts:312
React hook to load all the distribution accounts and their vaults

static
memberof
Distribution

Parameters
- rewardsProgram: undefined | Program<RewardsIdl>
Returns undefined | Distribution[]

Generated using TypeDoc