@celo/contractkit › "wrappers/EpochRewards" › EpochRewardsWrapper

Class: EpochRewardsWrapper

Hierarchy

• BaseWrapper‹EpochRewards›

↳ EpochRewardsWrapper

Index

Constructors

• constructor

Properties

• eventTypes
• events
• getCommunityReward
• getRewardsMultiplierParameters
• getTargetValidatorEpochPayment
• getTargetVotingYieldParameters
• methodIds

Accessors

• address

Methods

• getCarbonOffsetting
• getConfig
• getPastEvents
• version

Constructors

constructor

+ new EpochRewardsWrapper(kit: ContractKit, contract: EpochRewards): EpochRewardsWrapper

Inherited from BaseWrapper.constructor

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:30

Parameters:

Name	Type
kit	ContractKit
contract	EpochRewards

Returns: EpochRewardsWrapper

Properties

eventTypes

• eventTypes: EventsEnum‹T› = Object.keys(this.events).reduce>( (acc, key) => ({ ...acc, [key]: key }), {} as any )

Inherited from BaseWrapper.eventTypes

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:61

---

events

• events: EpochRewards["events"] = this.contract.events

Inherited from BaseWrapper.events

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:59

---

getCommunityReward

• getCommunityReward: function = proxyCall( this.contract.methods.getCommunityRewardFraction, undefined, parseFixidity )

Defined in packages/sdk/contractkit/src/wrappers/EpochRewards.ts:28

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getRewardsMultiplierParameters

• getRewardsMultiplierParameters: function = proxyCall( this.contract.methods.getRewardsMultiplierParameters, undefined, (res) => ({ max: parseFixidity(res[0]), underspendAdjustment: parseFixidity(res[1]), overspendAdjustment: parseFixidity(res[2]), }) )

Defined in packages/sdk/contractkit/src/wrappers/EpochRewards.ts:8

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getTargetValidatorEpochPayment

• getTargetValidatorEpochPayment: function = proxyCall( this.contract.methods.targetValidatorEpochPayment, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/EpochRewards.ts:43

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getTargetVotingYieldParameters

• getTargetVotingYieldParameters: function = proxyCall( this.contract.methods.getTargetVotingYieldParameters, undefined, (res) => ({ target: parseFixidity(res[0]), max: parseFixidity(res[1]), adjustment: parseFixidity(res[2]), }) )

Defined in packages/sdk/contractkit/src/wrappers/EpochRewards.ts:18

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

methodIds

• methodIds: Record‹keyof T["methods"], string› = Object.keys(this.contract.methods).reduce, string>>( (acc, method: Methods) => { const methodABI = this.contract.options.jsonInterface.find((item) => item.name === method)

  acc[method] =
    methodABI === undefined
      ? '0x'
      : this.kit.connection.getAbiCoder().encodeFunctionSignature(methodABI)

  return acc
},
{} as any

)

Inherited from BaseWrapper.methodIds

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:66

Accessors

address

• get address(): string

Inherited from BaseWrapper.address

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:35

Contract address

Returns: string

Methods

getCarbonOffsetting

▸ getCarbonOffsetting(): Promise‹object›

Defined in packages/sdk/contractkit/src/wrappers/EpochRewards.ts:34

Returns: Promise‹object›

---

getConfig

▸ getConfig(): Promise‹object›

Defined in packages/sdk/contractkit/src/wrappers/EpochRewards.ts:49

Returns: Promise‹object›

---

getPastEvents

▸ getPastEvents(event: Events‹EpochRewards›, options: PastEventOptions): Promise‹EventLog[]›

Inherited from BaseWrapper.getPastEvents

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:55

Contract getPastEvents

Parameters:

Name	Type
event	Events‹EpochRewards›
options	PastEventOptions

Returns: Promise‹EventLog[]›

---

version

▸ version(): Promise‹NonNullable‹T["methods"] extends object ? ContractVersion<> : never››

Inherited from BaseWrapper.version

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:39

Returns: Promise‹NonNullable‹T["methods"] extends object ? ContractVersion<> : never››