Class BlockfrostRewardsProvider

Hierarchy

BlockfrostProvider
- BlockfrostRewardsProvider

Implements

RewardsProvider

Index

Constructors

Properties

Methods

accountRewards healthCheck request rewardAccountBalance rewardsHistory toProviderError

Constructors

constructor

new BlockfrostRewardsProvider(client: BlockfrostClient, logger: Logger): BlockfrostRewardsProvider
Parameters
- client: BlockfrostClient
- logger: Logger
Returns BlockfrostRewardsProvider
Overrides BlockfrostProvider.constructor
- Defined in packages/cardano-services-client/src/RewardsProvider/BlockfrostRewardsProvider.ts:11

Properties

`Private` #client

#client: BlockfrostClient

`Protected` logger

logger: Logger

Methods

`Protected` accountRewards

accountRewards(stakeAddress: RewardAccount, __namedParameters?: Range<EpochNo>): Promise<Reward[]>
Parameters
- stakeAddress: RewardAccount
- __namedParameters: Range<EpochNo> = {}
Returns Promise<Reward[]>
- Defined in packages/cardano-services-client/src/RewardsProvider/BlockfrostRewardsProvider.ts:26

healthCheck

healthCheck(): Promise<HealthCheckResponse>
Returns Promise<HealthCheckResponse>
Implementation of RewardsProvider.healthCheck

Inherited from BlockfrostProvider.healthCheck
- Defined in packages/cardano-services-client/src/blockfrost/BlockfrostProvider.ts:54

`Protected` request

request<T>(endpoint: string, requestInit?: RequestInit): Promise<T>
Throws
Type Parameters
- T
Parameters
- endpoint: string
  
  e.g. 'blocks/latest'
- Optional requestInit: RequestInit
  
  request options
Returns Promise<T>
Inherited from BlockfrostProvider.request
- Defined in packages/cardano-services-client/src/blockfrost/BlockfrostProvider.ts:42

rewardAccountBalance

rewardAccountBalance(__namedParameters: RewardAccountBalanceArgs): Promise<bigint>
Parameters
- __namedParameters: RewardAccountBalanceArgs
Returns Promise<bigint>
Implementation of RewardsProvider.rewardAccountBalance
- Defined in packages/cardano-services-client/src/RewardsProvider/BlockfrostRewardsProvider.ts:15

rewardsHistory

rewardsHistory(__namedParameters: RewardsHistoryArgs): Promise<Map<RewardAccount, Reward[]>>
Parameters
- __namedParameters: RewardsHistoryArgs
Returns Promise<Map<RewardAccount, Reward[]>>
Implementation of RewardsProvider.rewardsHistory
- Defined in packages/cardano-services-client/src/RewardsProvider/BlockfrostRewardsProvider.ts:53

`Protected` toProviderError

toProviderError(error: unknown): ProviderError<unknown>
Parameters
- error: unknown
Returns ProviderError<unknown>
Inherited from BlockfrostProvider.toProviderError
- Defined in packages/cardano-services-client/src/blockfrost/BlockfrostProvider.ts:63

Generated using TypeDoc