modules_staking_staking_pool_service.StakingPoolService.md

Class: StakingPoolService

modules/staking/staking-pool.service.StakingPoolService

Abstraction over staking pool smart contract

Table of contents

Constructors

• constructor

Methods

• checkReward
• getContributionLimit
• getHardCap
• getStake
• putStake
• withdraw

Constructors

constructor

• new StakingPoolService(signerService, address)

Parameters

Name	Type
signerService	SignerService
address	string

Methods

checkReward

▸ checkReward(): Promise<BigNumber>

Accumulated reward

Returns

Promise<BigNumber>

---

getContributionLimit

▸ getContributionLimit(): Promise<BigNumber>

Returns

Promise<BigNumber>

---

getHardCap

▸ getHardCap(): Promise<BigNumber>

Returns

Promise<BigNumber>

---

getStake

▸ getStake(): Promise<Stake>

Returns

Promise<Stake>

Stake

---

putStake

▸ putStake(stake): Promise<void>

description Locks stake and starts accumulating reward

emits StakingPool.StakePut

Parameters

Name	Type
stake	number | BigNumber

Returns

Promise<void>

---

withdraw

▸ withdraw(): Promise<void>

description pays back stake with accumulated reward.

Returns

Promise<void>