Class EarningsInterface<C>

Type parameters

C: ChainId

Hierarchy

ServiceInterface<C>
- EarningsInterface

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EarningsInterface<C>(yearn: Yearn<C>, chainId: C, ctx: Context): EarningsInterface<C>

Inherited from ServiceInterface<C>.constructor
- Defined in src/common.ts:27
Type parameters
- C: 1 | 10 | 250 | 1337 | 42161
Parameters
- yearn: Yearn<C>
- chainId: C
- ctx: Context
Returns EarningsInterface<C>

Properties

Private assetHistoricEarningsCache

assetHistoricEarningsCache: CachedFetcher<AssetHistoricEarnings[]> = ...

chainId

chainId: 1 | 10 | 250 | 1337 | 42161

ctx

events

events: Emittery<Record<string, unknown>, Record<string, unknown> & OmnipresentEventData, never>

Protected yearn

yearn: Yearn<C>

Methods

accountAssetsData

accountAssetsData(accountAddress: string): Promise<EarningsUserData>

- Defined in src/interfaces/earnings.ts:88
Parameters
- accountAddress: string
Returns Promise<EarningsUserData>

accountHistoricEarnings

accountHistoricEarnings(accountAddress: string, shareTokenAddress: string, fromDaysAgo: number, toDaysAgo?: number): Promise<AccountHistoricEarnings>

- Defined in src/interfaces/earnings.ts:278
Parameters
- accountAddress: string
- shareTokenAddress: string
- fromDaysAgo: number
- Optional toDaysAgo: number
Returns Promise<AccountHistoricEarnings>

assetEarnings

assetEarnings(assetAddress: string): Promise<AssetEarnings>

- Defined in src/interfaces/earnings.ts:67
Parameters
- assetAddress: string
Returns Promise<AssetEarnings>

assetHistoricEarnings

assetHistoricEarnings(vault: string, fromDaysAgo: number, latestBlockNumber?: number): Promise<AssetHistoricEarnings>

- Defined in src/interfaces/earnings.ts:219
Parameters
- vault: string
- fromDaysAgo: number
- Optional latestBlockNumber: number
Returns Promise<AssetHistoricEarnings>

assetsHistoricEarnings

assetsHistoricEarnings(fromDaysAgo?: number): Promise<AssetHistoricEarnings[]>

- Defined in src/interfaces/earnings.ts:191
Parameters
- fromDaysAgo: number = 30
Returns Promise<AssetHistoricEarnings[]>

Private blockOffset

blockOffset(): number

- Defined in src/interfaces/earnings.ts:434
Returns number

Private blocksPerDay

blocksPerDay(): number

- Defined in src/interfaces/earnings.ts:422
Returns number

Private getDate

getDate(daysAgo: number): Date

- Defined in src/interfaces/earnings.ts:416
Parameters
- daysAgo: number
Returns Date

protocolEarnings

protocolEarnings(): Promise<string>

- Defined in src/interfaces/earnings.ts:46
deprecated
Not able to be accurately calculated by the subgraph, this functionality will be removed in a future version

Returns Promise<string>

Private tokensValueInUsdc

tokensValueInUsdc(tokenAmount: BigNumber, tokenAddress: string, decimals: number): Promise<BigNumber>

- Defined in src/interfaces/earnings.ts:411
Parameters
- tokenAmount: BigNumber
- tokenAddress: string
- decimals: number
Returns Promise<BigNumber>

Generated using TypeDoc