multiversx_sdk.delegation package

Submodules

multiversx_sdk.delegation.delegation_controller module

class multiversx_sdk.delegation.delegation_controller.DelegationController(chain_id: str, network_provider: INetworkProvider)

Bases: object

await_completed_create_new_delegation_contract(transaction_hash: str | bytes) → list[CreateNewDelegationContractOutcome]

create_transaction_for_adding_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], signed_messages: Sequence[bytes], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_changing_service_fee(sender: IAccount, nonce: int, delegation_contract: Address, service_fee: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_claiming_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_delegating(sender: IAccount, nonce: int, delegation_contract: Address, amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_modifying_delegation_cap(sender: IAccount, nonce: int, delegation_contract: Address, delegation_cap: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_new_delegation_contract(sender: IAccount, nonce: int, total_delegation_cap: int, service_fee: int, amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_redelegating_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_removing_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_automatic_activation(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_cap_check_on_redelegate_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_metadata(sender: IAccount, nonce: int, delegation_contract: Address, name: str, website: str, identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_staking_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unbonding_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_undelegating(sender: IAccount, nonce: int, delegation_contract: Address, amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unjailing_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unsetting_automatic_activation(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unsetting_cap_check_on_redelegate_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unstaking_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_withdrawing(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

parse_create_new_delegation_contract(transaction_on_network: TransactionOnNetwork) → list[CreateNewDelegationContractOutcome]

class multiversx_sdk.delegation.delegation_controller.INetworkProvider(*args, **kwargs)

Bases: Protocol

await_transaction_completed(transaction_hash: str | bytes, options: AwaitingOptions | None = None) → TransactionOnNetwork

multiversx_sdk.delegation.delegation_transactions_factory module

class multiversx_sdk.delegation.delegation_transactions_factory.DelegationTransactionsFactory(config: TransactionsFactoryConfig)

Bases: object

create_transaction_for_adding_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], signed_messages: Sequence[bytes]) → Transaction

create_transaction_for_changing_service_fee(sender: Address, delegation_contract: Address, service_fee: int) → Transaction

create_transaction_for_claiming_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_delegating(sender: Address, delegation_contract: Address, amount: int) → Transaction

create_transaction_for_modifying_delegation_cap(sender: Address, delegation_contract: Address, delegation_cap: int) → Transaction

create_transaction_for_new_delegation_contract(sender: Address, total_delegation_cap: int, service_fee: int, amount: int) → Transaction

create_transaction_for_redelegating_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_removing_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_setting_automatic_activation(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_setting_cap_check_on_redelegate_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_setting_metadata(sender: Address, delegation_contract: Address, name: str, website: str, identifier: str) → Transaction

create_transaction_for_staking_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_unbonding_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_undelegating(sender: Address, delegation_contract: Address, amount: int) → Transaction

create_transaction_for_unjailing_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], amount: int) → Transaction

create_transaction_for_unsetting_automatic_activation(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_unsetting_cap_check_on_redelegate_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_unstaking_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_withdrawing(sender: Address, delegation_contract: Address) → Transaction

multiversx_sdk.delegation.delegation_transactions_outcome_parser module

class multiversx_sdk.delegation.delegation_transactions_outcome_parser.DelegationTransactionsOutcomeParser

Bases: object

parse_create_new_delegation_contract(transaction: TransactionOnNetwork) → list[CreateNewDelegationContractOutcome]

multiversx_sdk.delegation.delegation_transactions_outcome_parser_types module

class multiversx_sdk.delegation.delegation_transactions_outcome_parser_types.CreateNewDelegationContractOutcome(contract_address: multiversx_sdk.core.address.Address)

Bases: object

contract_address: Address

multiversx_sdk.delegation.errors module

exception multiversx_sdk.delegation.errors.ListsLengthMismatchError(message: str)

Bases: Exception

Module contents

class multiversx_sdk.delegation.CreateNewDelegationContractOutcome(contract_address: multiversx_sdk.core.address.Address)

Bases: object

contract_address: Address

class multiversx_sdk.delegation.DelegationController(chain_id: str, network_provider: INetworkProvider)

Bases: object

await_completed_create_new_delegation_contract(transaction_hash: str | bytes) → list[CreateNewDelegationContractOutcome]

create_transaction_for_adding_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], signed_messages: Sequence[bytes], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_changing_service_fee(sender: IAccount, nonce: int, delegation_contract: Address, service_fee: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_claiming_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_delegating(sender: IAccount, nonce: int, delegation_contract: Address, amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_modifying_delegation_cap(sender: IAccount, nonce: int, delegation_contract: Address, delegation_cap: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_new_delegation_contract(sender: IAccount, nonce: int, total_delegation_cap: int, service_fee: int, amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_redelegating_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_removing_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_automatic_activation(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_cap_check_on_redelegate_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_metadata(sender: IAccount, nonce: int, delegation_contract: Address, name: str, website: str, identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_staking_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unbonding_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_undelegating(sender: IAccount, nonce: int, delegation_contract: Address, amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unjailing_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], amount: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unsetting_automatic_activation(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unsetting_cap_check_on_redelegate_rewards(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unstaking_nodes(sender: IAccount, nonce: int, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_withdrawing(sender: IAccount, nonce: int, delegation_contract: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

parse_create_new_delegation_contract(transaction_on_network: TransactionOnNetwork) → list[CreateNewDelegationContractOutcome]

class multiversx_sdk.delegation.DelegationTransactionsFactory(config: TransactionsFactoryConfig)

Bases: object

create_transaction_for_adding_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], signed_messages: Sequence[bytes]) → Transaction

create_transaction_for_changing_service_fee(sender: Address, delegation_contract: Address, service_fee: int) → Transaction

create_transaction_for_claiming_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_delegating(sender: Address, delegation_contract: Address, amount: int) → Transaction

create_transaction_for_modifying_delegation_cap(sender: Address, delegation_contract: Address, delegation_cap: int) → Transaction

create_transaction_for_new_delegation_contract(sender: Address, total_delegation_cap: int, service_fee: int, amount: int) → Transaction

create_transaction_for_redelegating_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_removing_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_setting_automatic_activation(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_setting_cap_check_on_redelegate_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_setting_metadata(sender: Address, delegation_contract: Address, name: str, website: str, identifier: str) → Transaction

create_transaction_for_staking_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_unbonding_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_undelegating(sender: Address, delegation_contract: Address, amount: int) → Transaction

create_transaction_for_unjailing_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey], amount: int) → Transaction

create_transaction_for_unsetting_automatic_activation(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_unsetting_cap_check_on_redelegate_rewards(sender: Address, delegation_contract: Address) → Transaction

create_transaction_for_unstaking_nodes(sender: Address, delegation_contract: Address, public_keys: Sequence[ValidatorPublicKey]) → Transaction

create_transaction_for_withdrawing(sender: Address, delegation_contract: Address) → Transaction

class multiversx_sdk.delegation.DelegationTransactionsOutcomeParser

Bases: object

parse_create_new_delegation_contract(transaction: TransactionOnNetwork) → list[CreateNewDelegationContractOutcome]