Class RewardsProgram

Hierarchy

RewardsProgram

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RewardsProgram(algodClient: default, managerState: {}): RewardsProgram

- Defined in v1/rewardsProgram.ts:24
Constructor for RewardsProgram class

Parameters
- algodClient: default
  
  algod client
- managerState: {}
  
  state of manager application we are interested in
Returns RewardsProgram

Properties

algod

algod: default

latestRewardsTime

latestRewardsTime: number

rewardsAmount

rewardsAmount: number

rewardsAssetId

rewardsAssetId: number

rewardsPerSecond

rewardsPerSecond: number

rewardsProgramNumber

rewardsProgramNumber: number

rewardsSecondaryAssetId

rewardsSecondaryAssetId: number

rewardsSecondaryRatio

rewardsSecondaryRatio: number

Methods

getLatestRewardsTime

getLatestRewardsTime(): number

- Defined in v1/rewardsProgram.ts:56
Return latest rewards time

Returns number
latest rewards time

getRewardsAmount

getRewardsAmount(): number

- Defined in v1/rewardsProgram.ts:74
Return rewards amount

Returns number
rewards amount

getRewardsAssetId

getRewardsAssetId(): number

- Defined in v1/rewardsProgram.ts:92
Return rewards asset id

Returns number
rewards asset id

getRewardsAssetIds

getRewardsAssetIds(): number[]

- Defined in v1/rewardsProgram.ts:40
Return a list of current rewards assets

Returns number[]
rewards asset list

getRewardsPerSecond

getRewardsPerSecond(): number

- Defined in v1/rewardsProgram.ts:83
Return rewards per second

Returns number
rewards per second

getRewardsProgramNumber

getRewardsProgramNumber(): number

- Defined in v1/rewardsProgram.ts:65
Return rewards program number

Returns number
rewards program number

getRewardsSecondaryAssetId

getRewardsSecondaryAssetId(): number

- Defined in v1/rewardsProgram.ts:110
Return rewards secondary asset id

Returns number
rewards secondary asset id

getRewardsSecondaryRatio

getRewardsSecondaryRatio(): number

- Defined in v1/rewardsProgram.ts:101
Returns rewards secondary ratio

Returns number
rewards secondary ratio

getStorageUnrealizedRewards

getStorageUnrealizedRewards(storageAddress: string, manager: Manager, markets: Market[]): Promise<number[]>

- Defined in v1/rewardsProgram.ts:122
Return the projected claimable rewards for a given storage address

Parameters
- storageAddress: string
  
  storage address of unrealized rewards
- manager: Manager
  
  manager for unrealized rewards
- markets: Market[]
  
  list of markets for unrealized rewards
Returns Promise<number[]>
two element list of primary and secondary unrealized rewards

Generated using TypeDoc