modules/staking.StakingPoolService
Abstraction over staking pool smart contract
- checkReward
- getContributionLimit
- getEnd
- getHardCap
- getRatio
- getStake
- getStart
- getTotalStaked
- partialWithdraw
- putStake
- withdraw
• new StakingPoolService(signerService
, address
)
Name | Type |
---|---|
signerService |
SignerService |
address |
string |
▸ checkReward(): Promise
<BigNumber
>
Accumulated reward
Promise
<BigNumber
>
▸ getContributionLimit(): Promise
<BigNumber
>
Promise
<BigNumber
>
▸ getEnd(): Promise
<BigNumber
>
Promise
<BigNumber
>
▸ getHardCap(): Promise
<BigNumber
>
Promise
<BigNumber
>
▸ getRatio(): Promise
<BigNumber
>
Promise
<BigNumber
>
▸ getStake(): Promise
<Stake
>
Promise
<Stake
>
Stake
▸ getStart(): Promise
<BigNumber
>
Promise
<BigNumber
>
▸ getTotalStaked(): Promise
<BigNumber
>
Promise
<BigNumber
>
▸ partialWithdraw(value
): Promise
<ContractReceipt
>
Name | Type |
---|---|
value |
number | BigNumber |
Promise
<ContractReceipt
>
Description
▸ putStake(stake
): Promise
<void
>
Name | Type |
---|---|
stake |
number | BigNumber |
Promise
<void
>
Description
Locks stake and starts accumulating reward
Emits
StakingPool.StakePut
▸ withdraw(): Promise
<void
>
Promise
<void
>
Description
pays back stake with accumulated reward.