Cardanoex.StakePool (cardanoex v0.4.0)

The stake pool module let's you manage stake pools.

Link to this section Summary

Functions

Estimate fee for joining or leaving a stake pool. Note that it is an estimation because a delegation induces a transaction for which coins have to be selected randomly within the wallet. Because of this randomness, fees can only be estimated.

Delegate all (current and future) addresses from the given wallet to the given stake pool.

List all known stake pools ordered by descending non_myopic_member_rewards. The non_myopic_member_rewards — and thus the ordering — depends on the stake parameter.

List stake-keys relevant to the wallet, and how much ada is associated with each.

Stop delegating completely. The wallet's stake will become inactive.

Performs maintenance actions on stake pools, such as triggering metadata garbage collection.

Returns the current status of the stake pools maintenance actions.

Link to this section Functions

Link to this function

estimate_fee(wallet_id)

Estimate fee for joining or leaving a stake pool. Note that it is an estimation because a delegation induces a transaction for which coins have to be selected randomly within the wallet. Because of this randomness, fees can only be estimated.

Options

  • wallet_id - hex based string. 40 characters
Link to this function

join(wallet_id, stake_pool_id, passphrase)

Delegate all (current and future) addresses from the given wallet to the given stake pool.

Note: Bech32-encoded stake pool identifiers can vary in length.

Options

  • wallet_id - hex based string. 40 characters
  • stake_pool_id - hex|bech32 string
  • passphrase - Wallet passphrase

List all known stake pools ordered by descending non_myopic_member_rewards. The non_myopic_member_rewards — and thus the ordering — depends on the stake parameter.

Some pools may also have metadata attached to them.

Options

  • stake - The stake the user intends to delegate in Lovelace. Required.
Link to this function

list_stake_keys(wallet_id)

List stake-keys relevant to the wallet, and how much ada is associated with each.

Options

  • wallet_id - hex based string. 40 characters
Link to this function

quit(wallet_id, passphrase)

Stop delegating completely. The wallet's stake will become inactive.

Options

  • wallet_id - hex based string. 40 characters
  • passphrase - Wallet passphrase
Link to this function

trigger_maintenance_action(action)

Performs maintenance actions on stake pools, such as triggering metadata garbage collection.

Actions may not be instantaneous.

Link to this function

view_maintenance_actions()

Returns the current status of the stake pools maintenance actions.