Class RewardsService

Service exposing functions to interface with an eBTC incentive rewards.

Hierarchy

Service
- RewardsService

Index

Constructors

Properties

_rewards? level rewardAddresses sdk

Accessors

address connector provider rewards signer

Methods

#_log _getClaimableRewards _getTotalClaimedRewards claimAllRewards claimRewards debug error getClaimableRewards getTotalClaimedRewards info log ready submitAction warn

Constructors

constructor

new RewardsService(eBTC): RewardsService
Parameters
- eBTC: eBTC
Returns RewardsService
Overrides Service.constructor
- Defined in rewards/rewards.services.ts:21

Properties

`Private` `Optional` _rewards

_rewards?: Rewards

level

level: LogLevel

`Private` rewardAddresses

rewardAddresses: string[] = []

`Protected` sdk

sdk: eBTC

Accessors

address

get address(): undefined | string
Returns undefined | string
Inherited from Service.address
- Defined in service.ts:25

connector

get connector(): Signer | MulticallProvider
Returns Signer | MulticallProvider
Inherited from Service.connector
- Defined in service.ts:21

provider

get provider(): MulticallProvider
Returns MulticallProvider
Inherited from Service.provider
- Defined in service.ts:13

rewards

get rewards(): Rewards
Returns Rewards
- Defined in rewards/rewards.services.ts:32

signer

get signer(): undefined | Signer
Returns undefined | Signer
Inherited from Service.signer
- Defined in service.ts:17

Methods

`Private` #_log

#_log(level, message?, ...optionalParams): void
Parameters
- level: LogLevel
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.#_log
- Defined in logger.ts:28

`Private` _getClaimableRewards

_getClaimableRewards(account, totalCumulativeRewards): Promise<[string[], BigNumber[]]>
Parameters
- account: string
- totalCumulativeRewards: BigNumber[]
Returns Promise<[string[], BigNumber[]]>
- Defined in rewards/rewards.services.ts:116

`Private` _getTotalClaimedRewards

_getTotalClaimedRewards(account): Promise<[string[], BigNumber[]]>
Parameters
- account: string
Returns Promise<[string[], BigNumber[]]>
- Defined in rewards/rewards.services.ts:112

claimAllRewards

claimAllRewards(options): Promise<TransactionStatus>
Claims all rewards for an account
Parameters
- options: ClaimAllRewardsOptions
  the options for claiming all rewards
Returns Promise<TransactionStatus>
Transaction status of submitted claim operation
- Defined in rewards/rewards.services.ts:95

claimRewards

claimRewards(options): Promise<TransactionStatus>
Claims the rewards for an account
Parameters
- options: ClaimRewardsOptions
  the options for claiming rewards
Returns Promise<TransactionStatus>
Transaction status of submitted claim operation
- Defined in rewards/rewards.services.ts:71

debug

debug(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.debug
- Defined in logger.ts:12

error

error(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.error
- Defined in logger.ts:24

getClaimableRewards

getClaimableRewards(account, totalCumulativeRewards): Promise<RewardAmounts>
Returns the amount of rewards that are currently claimable by an account.
Parameters
- account: string
  The account to check
- totalCumulativeRewards: BigNumber[]
  The total amount of rewards that have been distributed to this account. This value can be obtained from the merkle tree in WEI (18 decimal bignumber)
Returns Promise<RewardAmounts>
The amount of rewards that can be claimed by the account
- Defined in rewards/rewards.services.ts:45

getTotalClaimedRewards

getTotalClaimedRewards(account): Promise<RewardAmounts>
Returns the total amount of rewards claimed by an account. This includes all cycles from the rewards contract
Parameters
- account: string
  the account
Returns Promise<RewardAmounts>
a map of the claimed reward tokens to the amount claimed
- Defined in rewards/rewards.services.ts:58

info

info(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.info
- Defined in logger.ts:16

log

log(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.log
- Defined in logger.ts:8

ready

ready(chainId): Promise<void>
Parameters
- chainId: number
Returns Promise<void>
- Defined in rewards/rewards.services.ts:25

submitAction

submitAction<T>(__namedParameters): Promise<TransactionStatus>
Type Parameters
- T extends SubmitOptions
Parameters
- __namedParameters: T
Returns Promise<TransactionStatus>
Inherited from Service.submitAction
- Defined in service.ts:29

warn

warn(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.warn
- Defined in logger.ts:20

Generated using TypeDoc