staking_client

This client enables performing actions on staking contracts and obtaining staking information from both the contracts and subgraph.

Internally, the SDK will use one network or another according to the network ID of the web3. To use this client, you need to create a Web3 instance and configure the default account, as well as some middlewares.

Code Example

  • With Signer

from eth_typing import URI
from web3 import Web3
from web3.middleware import SignAndSendRawMiddlewareBuilder
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.staking import StakingClient

def get_w3_with_priv_key(priv_key: str):
    w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
    gas_payer = w3.eth.account.from_key(priv_key)
    w3.eth.default_account = gas_payer.address
    w3.middleware_onion.inject(
        SignAndSendRawMiddlewareBuilder.build(priv_key),
        'SignAndSendRawMiddlewareBuilder',
        layer=0,
    )
    return (w3, gas_payer)

(w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
staking_client = StakingClient(w3)

  • Without Signer (For read operations only)

Module

class human_protocol_sdk.staking.staking_client.StakingClient(w3)

Bases: object

A class used to manage staking on the HUMAN network.

__init__(w3)

Initializes a Staking instance

  • Parameters:w3 (Web3) – Web3 instance

approve_stake(amount, tx_options=None)

Approves HMT token for Staking.

  • Parameters:

    • amount (Decimal) – Amount to approve

    • tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters

  • Return type:None

  • Returns: None

  • Validate: Amount must be greater than 0

  • Example:

get_staker_info(staker_address)

Retrieves comprehensive staking information for a staker.

  • Parameters:staker_address (str) – The address of the staker

  • Return type:dict

  • Returns: A dictionary containing staker information

  • Validate:

    • Staker address must be valid

  • Example:

slash(slasher, staker, escrow_address, amount, tx_options=None)

Slashes HMT token.

  • Parameters:

    • slasher (str) – Address of the slasher

    • staker (str) – Address of the staker

    • escrow_address (str) – Address of the escrow

    • amount (Decimal) – Amount to slash

    • tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters

  • Return type:None

  • Returns: None

  • Validate:

    • Amount must be greater than 0

    • Amount must be less than or equal to the amount allocated to the escrow (on-chain)

    • Escrow address must be valid

  • Example:

stake(amount, tx_options=None)

Stakes HMT token.

  • Parameters:

    • amount (Decimal) – Amount to stake

    • tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters

  • Return type:None

  • Returns: None

  • Validate:

    • Amount must be greater than 0

    • Amount must be less than or equal to the approved amount (on-chain)

    • Amount must be less than or equal to the balance of the staker (on-chain)

  • Example:

unstake(amount, tx_options=None)

Unstakes HMT token.

  • Parameters:

    • amount (Decimal) – Amount to unstake

    • tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters

  • Return type:None

  • Returns: None

  • Validate:

    • Amount must be greater than 0

    • Amount must be less than or equal to the staked amount which is not locked / allocated (on-chain)

  • Example:

withdraw(tx_options=None)

Withdraws HMT token.

  • Parameters:tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters

  • Return type:None

  • Returns: None

  • Validate:

    • There must be unstaked tokens which is unlocked (on-chain)

  • Example:

exception human_protocol_sdk.staking.staking_client.StakingClientError

Bases: Exception

Raises when some error happens when interacting with staking.

Last updated