Staking

Staking

class Staking(**kwargs)

Implements the staking api endpoints.

get_staking_info(**kwargs) → pystratis.api.staking.responsemodels.getstakinginfomodel.GetStakingInfoModel

Gets current staking information.

Parameters:**kwargs – Extra keyword arguments.
Returns:Information about current staking status.
Return type:GetStakingInfoModel
Raises:APIError – Error thrown by node API. See message for details.
start_multistaking(wallet_credentials: List[pystratis.core.walletsecret.WalletSecret], **kwargs) → None

Start staking for multiple wallets simultaneously

Parameters:
  • wallet_credentials (List[WalletSecret]) – A list of wallet credentials to launch staking of multiple wallets with one command.
  • **kwargs – Extra keyword arguments.
Returns:

None

Raises:

APIError – Error thrown by node API. See message for details.

start_staking(name: str, password: str, **kwargs) → None

Start staking

Parameters:
  • name (str) – The wallet name.
  • password (str) – The wallet password.
  • **kwargs – Extra keyword arguments.
Returns:

None

Raises:

APIError – Error thrown by node API. See message for details.

stop_staking(**kwargs) → None

Stop staking.

Parameters:**kwargs – Extra keyword arguments.
Returns:None
Raises:APIError – Error thrown by node API. See message for details.

GetStakingInfoModel

class GetStakingInfoModel

A pydantic model for staking information.