Class Payroll

Hierarchy

Payroll

Index

Constructors

Properties

annualRewardsRate famineTs lastCheckpointTs rewardsPerTokenStored totalTokensDeposited

Methods

calculateRewardPerToken calculateRewardsEarned

Constructors

constructor

new Payroll(famineTs: BN, lastCheckpointTs: BN, annualRewardsRate: BN, rewardsPerTokenStored: BN, totalTokensDeposited: BN): Payroll
Parameters
- famineTs: BN
- lastCheckpointTs: BN
- annualRewardsRate: BN
- rewardsPerTokenStored: BN
- totalTokensDeposited: BN
Returns Payroll
- Defined in src/wrappers/mine/payroll.ts:12

Properties

`Readonly` annualRewardsRate

annualRewardsRate: BN

`Readonly` famineTs

famineTs: BN

`Readonly` lastCheckpointTs

lastCheckpointTs: BN

`Readonly` rewardsPerTokenStored

rewardsPerTokenStored: BN

`Readonly` totalTokensDeposited

totalTokensDeposited: BN

Methods

calculateRewardPerToken

calculateRewardPerToken(currentTs: BN): BN
Calculates the amount of tokens that this user can receive.

Returns
Parameters
- currentTs: BN
Returns BN
- Defined in src/wrappers/mine/payroll.ts:25

calculateRewardsEarned

calculateRewardsEarned(currentTs: BN, tokensDeposited: BN, rewardsPerTokenPaid: BN, rewardsEarned: BN): BN
Calculates the amount of tokens that this user can claim.

Returns
Parameters
- currentTs: BN
- tokensDeposited: BN
- rewardsPerTokenPaid: BN
- rewardsEarned: BN
Returns BN
- Defined in src/wrappers/mine/payroll.ts:51

Generated using TypeDoc