Class LivelinessStake

Hierarchy (view full)

Contract
- LivelinessStake

Index

Constructors

Properties

chainID contract env networkProvider

Methods

claimRewards getContractAddress getUserDataOut stakeRewards viewClaimableRewards viewContractConfiguration viewContractState viewRewardsState

Constructors

constructor

new LivelinessStake(env, timeout?): LivelinessStake
Parameters
- env: string
- timeout: number = 10000
Returns LivelinessStake
Overrides Contract.constructor
- Defined in liveliness-stake.ts:36

Properties

`Readonly`chainID

chainID: string

`Readonly`contract

contract: SmartContract

`Readonly`env

env: string

`Readonly`networkProvider

networkProvider: ApiNetworkProvider

Methods

claimRewards

claimRewards(senderAddress): Transaction
Builds a claimRewards transaction
Parameters
- senderAddress: IAddress
  address of the sender
Returns Transaction
- Defined in liveliness-stake.ts:199

getContractAddress

getContractAddress(): IAddress
Returns the contract address

Returns IAddress
- Defined in liveliness-stake.ts:48

getUserDataOut

getUserDataOut(address, tokenIdentifier?): Promise<{
contractDetails: LivelinessStakeConfiguration;
userData: UserData;
}>
Returns the user data out for a given address
Parameters
- address: IAddress
  address to check user data out
- tokenIdentifier: string = ...
  the token identifier of the Data Nft [default is the Data Nft token identifier based on EnvironmentsEnum]
Returns Promise<{
contractDetails: LivelinessStakeConfiguration;
userData: UserData;
}>
- Defined in liveliness-stake.ts:103

stakeRewards

stakeRewards(senderAddress, tokenIdentifier?): Transaction
Builds a stakeRewards transaction
Parameters
- senderAddress: IAddress
  address of the sender
- tokenIdentifier: string = ...
  the token identifier of the Data Nft [default is the Data Nft token identifier based on EnvironmentsEnum]
Returns Transaction
- Defined in liveliness-stake.ts:218

viewClaimableRewards

viewClaimableRewards(address, bypass_liveliness_check?): Promise<Value>
Returns a BigNumber.Value representing the claimable rewards
Parameters
- address: IAddress
  address to check claimable rewards
- bypass_liveliness_check: boolean = false
  boolean value to bypass liveliness check
Returns Promise<Value>
- Defined in liveliness-stake.ts:160

viewContractConfiguration

viewContractConfiguration(): Promise<LivelinessStakeConfiguration>
Returns the liveliness stake contract configuration

Returns Promise<LivelinessStakeConfiguration>
- Defined in liveliness-stake.ts:75

viewContractState

viewContractState(): Promise<State>
Returns the contract state as a State enum

Returns Promise<State>
- Defined in liveliness-stake.ts:55

viewRewardsState

viewRewardsState(): Promise<State>
Returns rewards state as a State enum

Returns Promise<State>
- Defined in liveliness-stake.ts:136