multiversx_sdk.token_management package

Submodules

multiversx_sdk.token_management.token_management_controller module

class multiversx_sdk.token_management.token_management_controller.INetworkProvider(*args, **kwargs)

Bases: Protocol

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

class multiversx_sdk.token_management.token_management_controller.TokenManagementController(chain_id: str, network_provider: INetworkProvider)

Bases: object

await_completed_add_quantity(transaction_hash: str | bytes) → list[AddQuantityOutcome]

await_completed_burn_quantity(transaction_hash: str | bytes) → list[BurnQuantityOutcome]

await_completed_create_nft(transaction_hash: str | bytes) → list[NFTCreateOutcome]

await_completed_freeze(transaction_hash: str | bytes) → list[FreezeOutcome]

await_completed_issue_fungible(transaction_hash: str | bytes) → list[IssueFungibleOutcome]

await_completed_issue_non_fungible(transaction_hash: str | bytes) → list[IssueNonFungibleOutcome]

await_completed_issue_semi_fungible(transaction_hash: str | bytes) → list[IssueSemiFungibleOutcome]

await_completed_local_burn(transaction_hash: str | bytes) → list[BurnOutcome]

await_completed_local_mint(transaction_hash: str | bytes) → list[MintOutcome]

await_completed_pause(transaction_hash: str | bytes) → list[PauseOutcome]

await_completed_register_and_set_all_roles(transaction_hash: str | bytes) → list[RegisterAndSetAllRolesOutcome]

await_completed_register_meta_esdt(transaction_hash: str | bytes) → list[RegisterMetaEsdtOutcome]

await_completed_set_burn_role_globally(transaction_hash: str | bytes)

await_completed_set_special_role_on_fungible_token(transaction_hash: str | bytes) → list[SetSpecialRoleOutcome]

await_completed_set_special_role_on_non_fungible_token(transaction_hash: str | bytes) → list[SetSpecialRoleOutcome]

await_completed_set_special_role_on_semi_fungible_token(transaction_hash: str | bytes) → list[SetSpecialRoleOutcome]

await_completed_unfreeze(transaction_hash: str | bytes) → list[UnFreezeOutcome]

await_completed_unpause(transaction_hash: str | bytes) → list[UnPauseOutcome]

await_completed_unset_burn_role_globally(transaction_hash: str | bytes)

await_completed_update_attributes(transaction_hash: str | bytes) → list[UpdateAttributesOutcome]

await_completed_wipe(transaction_hash: str | bytes) → list[WipeOutcome]

create_transaction_for_adding_quantity(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, quantity_to_add: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_burning_quantity(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, quantity_to_burn: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_changing_sft_to_meta_esdt(sender: IAccount, nonce: int, collection: str, num_decimals: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_creating_nft(sender: IAccount, nonce: int, token_identifier: str, initial_quantity: int, name: str, royalties: int, hash: str, attributes: bytes, uris: list[str], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_freezing(sender: IAccount, nonce: int, user: Address, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_freezing_single_nft(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_issuing_fungible(sender: IAccount, nonce: int, token_name: str, token_ticker: str, initial_supply: int, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_issuing_non_fungible(sender: IAccount, nonce: int, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_issuing_semi_fungible(sender: IAccount, nonce: int, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_local_burning(sender: IAccount, nonce: int, token_identifier: str, supply_to_burn: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_local_minting(sender: IAccount, nonce: int, token_identifier: str, supply_to_mint: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_pausing(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_registering_and_setting_roles(sender: IAccount, nonce: int, token_name: str, token_ticker: str, token_type: TokenType, num_decimals: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_registering_meta_esdt(sender: IAccount, nonce: int, token_name: str, token_ticker: str, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_burn_role_globally(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_special_role_on_fungible_token(sender: IAccount, nonce: int, user: Address, token_identifier: str, add_role_local_mint: bool, add_role_local_burn: bool, add_role_esdt_transfer_role: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_special_role_on_non_fungible_token(sender: IAccount, nonce: int, user: Address, token_identifier: str, add_role_nft_create: bool, add_role_nft_burn: bool, add_role_nft_update_attributes: bool, add_role_nft_add_uri: bool, add_role_esdt_transfer_role: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_special_role_on_semi_fungible_token(sender: IAccount, nonce: int, user: Address, token_identifier: str, add_role_nft_create: bool, add_role_nft_burn: bool, add_role_nft_add_quantity: bool, add_role_esdt_transfer_role: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_stopping_nft_creation(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_transferring_nft_create_role(sender: IAccount, nonce: int, token_identifier: str, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_transferring_ownership(sender: IAccount, nonce: int, token_identifier: str, new_owner: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unfreezing(sender: IAccount, nonce: int, user: Address, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unfreezing_single_nft(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unpausing(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unsetting_burn_role_globally(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_updating_attributes(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, attributes: bytes, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_wiping(sender: IAccount, nonce: int, user: Address, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_wiping_single_nft(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transction_for_adding_uris(sender: IAccount, nonce: int, token_identifier: str, uris: list[str], guardian: Address | None = None, relayer: Address | None = None) → Transaction

parse_add_quantity(transaction_on_network: TransactionOnNetwork) → list[AddQuantityOutcome]

parse_burn_quantity(transaction_on_network: TransactionOnNetwork) → list[BurnQuantityOutcome]

parse_create_nft(transaction_on_network: TransactionOnNetwork) → list[NFTCreateOutcome]

parse_freeze(transaction_on_network: TransactionOnNetwork) → list[FreezeOutcome]

parse_issue_fungible(transaction_on_network: TransactionOnNetwork) → list[IssueFungibleOutcome]

parse_issue_non_fungible(transaction_on_network: TransactionOnNetwork) → list[IssueNonFungibleOutcome]

parse_issue_semi_fungible(transaction_on_network: TransactionOnNetwork) → list[IssueSemiFungibleOutcome]

parse_local_burn(transaction_on_network: TransactionOnNetwork) → list[BurnOutcome]

parse_local_mint(transaction_on_network: TransactionOnNetwork) → list[MintOutcome]

parse_pause(transaction_on_network: TransactionOnNetwork) → list[PauseOutcome]

parse_register_and_set_all_roles(transaction_on_network: TransactionOnNetwork) → list[RegisterAndSetAllRolesOutcome]

parse_register_meta_esdt(transaction_on_network: TransactionOnNetwork) → list[RegisterMetaEsdtOutcome]

parse_set_burn_role_globally(transaction_on_network: TransactionOnNetwork)

parse_set_special_role_on_fungible_token(transaction_on_network: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_set_special_role_on_non_fungible_token(transaction_on_network: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_set_special_role_on_semi_fungible_token(transaction_on_network: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_unfreeze(transaction_on_network: TransactionOnNetwork) → list[UnFreezeOutcome]

parse_unpause(transaction_on_network: TransactionOnNetwork) → list[UnPauseOutcome]

parse_unset_burn_role_globally(transaction_on_network: TransactionOnNetwork)

parse_update_attributes(transaction_on_network: TransactionOnNetwork) → list[UpdateAttributesOutcome]

parse_wipe(transaction_on_network: TransactionOnNetwork) → list[WipeOutcome]

multiversx_sdk.token_management.token_management_transactions_factory module

class multiversx_sdk.token_management.token_management_transactions_factory.TokenManagementTransactionsFactory(config: TransactionsFactoryConfig)

Bases: object

create_transaction_for_adding_quantity(sender: Address, token_identifier: str, token_nonce: int, quantity_to_add: int) → Transaction

create_transaction_for_burning_quantity(sender: Address, token_identifier: str, token_nonce: int, quantity_to_burn: int) → Transaction

create_transaction_for_changing_sft_to_meta_esdt(sender: Address, collection: str, num_decimals: int) → Transaction

create_transaction_for_changing_token_to_dynamic(sender: Address, token_identifier: str) → Transaction

The following token types cannot be changed to dynamic: FungibleESDT, NonFungibleESDT, NonFungibleESDTv2

create_transaction_for_creating_nft(sender: Address, token_identifier: str, initial_quantity: int, name: str, royalties: int, hash: str, attributes: bytes, uris: list[str]) → Transaction

create_transaction_for_freezing(sender: Address, user: Address, token_identifier: str) → Transaction

Can be used for FungibleESDT

create_transaction_for_freezing_single_nft(sender: Address, token_identifier: str, token_nonce: int, user: Address) → Transaction

create_transaction_for_issuing_fungible(sender: Address, token_name: str, token_ticker: str, initial_supply: int, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_issuing_non_fungible(sender: Address, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_issuing_semi_fungible(sender: Address, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_local_burning(sender: Address, token_identifier: str, supply_to_burn: int) → Transaction

create_transaction_for_local_minting(sender: Address, token_identifier: str, supply_to_mint: int) → Transaction

create_transaction_for_modifying_creator(sender: Address, token_identifier: str, token_nonce: int) → Transaction

create_transaction_for_modifying_royalties(sender: Address, token_identifier: str, token_nonce: int, new_royalties: int) → Transaction

create_transaction_for_nft_metadata_recreate(sender: Address, token_identifier: str, token_nonce: int, new_token_name: str, new_royalties: int, new_hash: str, new_attributes: bytes, new_uris: list[str]) → Transaction

create_transaction_for_pausing(sender: Address, token_identifier: str) → Transaction

create_transaction_for_registering_and_setting_roles(sender: Address, token_name: str, token_ticker: str, token_type: TokenType, num_decimals: int) → Transaction

create_transaction_for_registering_dynamic_and_setting_roles(sender: Address, token_name: str, token_ticker: str, token_type: TokenType, denominator: int | None = None) → Transaction

create_transaction_for_registering_dynamic_token(sender: Address, token_name: str, token_ticker: str, token_type: TokenType, denominator: int | None = None) → Transaction

create_transaction_for_registering_meta_esdt(sender: Address, token_name: str, token_ticker: str, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_setting_burn_role_globally(sender: Address, token_identifier: str) → Transaction

create_transaction_for_setting_new_uris(sender: Address, token_identifier: str, token_nonce: int, new_uris: list[str]) → Transaction

create_transaction_for_setting_special_role_on_fungible_token(sender: Address, user: Address, token_identifier: str, add_role_local_mint: bool, add_role_local_burn: bool, add_role_esdt_transfer_role: bool) → Transaction

create_transaction_for_setting_special_role_on_non_fungible_token(sender: Address, user: Address, token_identifier: str, add_role_nft_create: bool = False, add_role_nft_burn: bool = False, add_role_nft_update_attributes: bool = False, add_role_nft_add_uri: bool = False, add_role_esdt_transfer_role: bool = False, add_role_nft_update: bool = False, add_role_esdt_modify_royalties: bool = False, add_role_esdt_set_new_uri: bool = False, add_role_esdt_modify_creator: bool = False, add_role_nft_recreate: bool = False) → Transaction

create_transaction_for_setting_special_role_on_semi_fungible_token(sender: Address, user: Address, token_identifier: str, add_role_nft_create: bool = False, add_role_nft_burn: bool = False, add_role_nft_add_quantity: bool = False, add_role_esdt_transfer_role: bool = False, add_role_nft_update: bool = False, add_role_esdt_modify_royalties: bool = False, add_role_esdt_set_new_uri: bool = False, add_role_esdt_modify_creator: bool = False, add_role_nft_recreate: bool = False) → Transaction

create_transaction_for_stopping_nft_creation(sender: Address, token_identifier: str) → Transaction

create_transaction_for_transferring_nft_create_role(sender: Address, token_identifier: str, user: Address) → Transaction

This role can be transferred only if the canTransferNFTCreateRole property of the token is set to true.

create_transaction_for_transferring_ownership(sender: Address, token_identifier: str, new_owner: Address) → Transaction

create_transaction_for_unfreezing(sender: Address, user: Address, token_identifier: str) → Transaction

Can be used for FungibleESDT

create_transaction_for_unfreezing_single_nft(sender: Address, token_identifier: str, token_nonce: int, user: Address) → Transaction

create_transaction_for_unpausing(sender: Address, token_identifier: str) → Transaction

create_transaction_for_unsetting_burn_role_globally(sender: Address, token_identifier: str) → Transaction

create_transaction_for_unsetting_special_role_on_fungible_token(sender: Address, user: Address, token_identifier: str, remove_role_local_mint: bool, remove_role_local_burn: bool, remove_role_esdt_transfer_role: bool) → Transaction

create_transaction_for_unsetting_special_role_on_non_fungible_token(sender: Address, user: Address, token_identifier: str, remove_role_nft_burn: bool = False, remove_role_nft_update_attributes: bool = False, remove_role_nft_remove_uri: bool = False, remove_role_esdt_transfer_role: bool = False, remove_role_nft_update: bool = False, remove_role_esdt_modify_royalties: bool = False, remove_role_esdt_set_new_uri: bool = False, remove_role_esdt_modify_creator: bool = False, remove_role_nft_recreate: bool = False) → Transaction

create_transaction_for_unsetting_special_role_on_semi_fungible_token(sender: Address, user: Address, token_identifier: str, remove_role_nft_burn: bool = False, remove_role_nft_add_quantity: bool = False, remove_role_esdt_transfer_role: bool = False, remove_role_nft_update: bool = False, remove_role_esdt_modify_royalties: bool = False, remove_role_esdt_set_new_uri: bool = False, remove_role_esdt_modify_creator: bool = False, remove_role_nft_recreate: bool = False) → Transaction

create_transaction_for_updating_attributes(sender: Address, token_identifier: str, token_nonce: int, attributes: bytes) → Transaction

create_transaction_for_updating_metadata(sender: Address, token_identifier: str, token_nonce: int, new_token_name: str, new_royalties: int, new_hash: str, new_attributes: bytes, new_uris: list[str]) → Transaction

create_transaction_for_updating_token_id(sender: Address, token_identifier: str) → Transaction

create_transaction_for_wiping(sender: Address, user: Address, token_identifier: str) → Transaction

create_transaction_for_wiping_single_nft(sender: Address, token_identifier: str, token_nonce: int, user: Address) → Transaction

create_transction_for_adding_uris(sender: Address, token_identifier: str, uris: list[str]) → Transaction

class multiversx_sdk.token_management.token_management_transactions_factory.TokenType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

FNG = 'FNG'

META = 'META'

NFT = 'NFT'

SFT = 'SFT'

multiversx_sdk.token_management.token_management_transactions_outcome_parser module

class multiversx_sdk.token_management.token_management_transactions_outcome_parser.TokenManagementTransactionsOutcomeParser

Bases: object

parse_add_quantity(transaction: TransactionOnNetwork) → list[AddQuantityOutcome]

parse_burn_quantity(transaction: TransactionOnNetwork) → list[BurnQuantityOutcome]

parse_freeze(transaction: TransactionOnNetwork) → list[FreezeOutcome]

parse_issue_fungible(transaction: TransactionOnNetwork) → list[IssueFungibleOutcome]

parse_issue_non_fungible(transaction: TransactionOnNetwork) → list[IssueNonFungibleOutcome]

parse_issue_semi_fungible(transaction: TransactionOnNetwork) → list[IssueSemiFungibleOutcome]

parse_local_burn(transaction: TransactionOnNetwork) → list[BurnOutcome]

parse_local_mint(transaction: TransactionOnNetwork) → list[MintOutcome]

parse_nft_create(transaction: TransactionOnNetwork) → list[NFTCreateOutcome]

parse_pause(transaction: TransactionOnNetwork) → list[PauseOutcome]

parse_register_and_set_all_roles(transaction: TransactionOnNetwork) → list[RegisterAndSetAllRolesOutcome]

parse_register_meta_esdt(transaction: TransactionOnNetwork) → list[RegisterMetaEsdtOutcome]

parse_set_burn_role_globally(transaction: TransactionOnNetwork) → None

parse_set_special_role(transaction: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_unfreeze(transaction: TransactionOnNetwork) → list[UnFreezeOutcome]

parse_unpause(transaction: TransactionOnNetwork) → list[UnPauseOutcome]

parse_unset_burn_role_globally(transaction: TransactionOnNetwork) → None

parse_update_attributes(transaction: TransactionOnNetwork) → list[UpdateAttributesOutcome]

parse_wipe(transaction: TransactionOnNetwork) → list[WipeOutcome]

multiversx_sdk.token_management.token_management_transactions_outcome_parser_types module

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.AddQuantityOutcome(token_identifier: str, nonce: int, added_quantity: int)

Bases: object

added_quantity: int

nonce: int

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.BurnOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, burnt_supply: int)

Bases: object

burnt_supply: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.BurnQuantityOutcome(token_identifier: str, nonce: int, burnt_quantity: int)

Bases: object

burnt_quantity: int

nonce: int

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.FreezeOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, balance: int)

Bases: object

balance: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.IssueFungibleOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.IssueNonFungibleOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.IssueSemiFungibleOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.MintOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, minted_supply: int)

Bases: object

minted_supply: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.NFTCreateOutcome(token_identifier: str, nonce: int, initial_quantity: int)

Bases: object

initial_quantity: int

nonce: int

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.PauseOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.RegisterAndSetAllRolesOutcome(token_identifier: str, roles: list[str])

Bases: object

roles: list[str]

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.RegisterMetaEsdtOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.SetSpecialRoleOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, roles: list[str])

Bases: object

roles: list[str]

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.UnFreezeOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, balance: int)

Bases: object

balance: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.UnPauseOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.UpdateAttributesOutcome(token_identifier: str, nonce: int, attributes: bytes)

Bases: object

attributes: bytes

nonce: int

token_identifier: str

class multiversx_sdk.token_management.token_management_transactions_outcome_parser_types.WipeOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, balance: int)

Bases: object

balance: int

nonce: int

token_identifier: str

user_address: Address

Module contents

class multiversx_sdk.token_management.AddQuantityOutcome(token_identifier: str, nonce: int, added_quantity: int)

Bases: object

added_quantity: int

nonce: int

token_identifier: str

class multiversx_sdk.token_management.BurnOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, burnt_supply: int)

Bases: object

burnt_supply: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.BurnQuantityOutcome(token_identifier: str, nonce: int, burnt_quantity: int)

Bases: object

burnt_quantity: int

nonce: int

token_identifier: str

class multiversx_sdk.token_management.FreezeOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, balance: int)

Bases: object

balance: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.IssueFungibleOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.IssueNonFungibleOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.IssueSemiFungibleOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.MintOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, minted_supply: int)

Bases: object

minted_supply: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.NFTCreateOutcome(token_identifier: str, nonce: int, initial_quantity: int)

Bases: object

initial_quantity: int

nonce: int

token_identifier: str

class multiversx_sdk.token_management.PauseOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.RegisterAndSetAllRolesOutcome(token_identifier: str, roles: list[str])

Bases: object

roles: list[str]

token_identifier: str

class multiversx_sdk.token_management.RegisterMetaEsdtOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.SetSpecialRoleOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, roles: list[str])

Bases: object

roles: list[str]

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.TokenManagementController(chain_id: str, network_provider: INetworkProvider)

Bases: object

await_completed_add_quantity(transaction_hash: str | bytes) → list[AddQuantityOutcome]

await_completed_burn_quantity(transaction_hash: str | bytes) → list[BurnQuantityOutcome]

await_completed_create_nft(transaction_hash: str | bytes) → list[NFTCreateOutcome]

await_completed_freeze(transaction_hash: str | bytes) → list[FreezeOutcome]

await_completed_issue_fungible(transaction_hash: str | bytes) → list[IssueFungibleOutcome]

await_completed_issue_non_fungible(transaction_hash: str | bytes) → list[IssueNonFungibleOutcome]

await_completed_issue_semi_fungible(transaction_hash: str | bytes) → list[IssueSemiFungibleOutcome]

await_completed_local_burn(transaction_hash: str | bytes) → list[BurnOutcome]

await_completed_local_mint(transaction_hash: str | bytes) → list[MintOutcome]

await_completed_pause(transaction_hash: str | bytes) → list[PauseOutcome]

await_completed_register_and_set_all_roles(transaction_hash: str | bytes) → list[RegisterAndSetAllRolesOutcome]

await_completed_register_meta_esdt(transaction_hash: str | bytes) → list[RegisterMetaEsdtOutcome]

await_completed_set_burn_role_globally(transaction_hash: str | bytes)

await_completed_set_special_role_on_fungible_token(transaction_hash: str | bytes) → list[SetSpecialRoleOutcome]

await_completed_set_special_role_on_non_fungible_token(transaction_hash: str | bytes) → list[SetSpecialRoleOutcome]

await_completed_set_special_role_on_semi_fungible_token(transaction_hash: str | bytes) → list[SetSpecialRoleOutcome]

await_completed_unfreeze(transaction_hash: str | bytes) → list[UnFreezeOutcome]

await_completed_unpause(transaction_hash: str | bytes) → list[UnPauseOutcome]

await_completed_unset_burn_role_globally(transaction_hash: str | bytes)

await_completed_update_attributes(transaction_hash: str | bytes) → list[UpdateAttributesOutcome]

await_completed_wipe(transaction_hash: str | bytes) → list[WipeOutcome]

create_transaction_for_adding_quantity(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, quantity_to_add: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_burning_quantity(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, quantity_to_burn: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_changing_sft_to_meta_esdt(sender: IAccount, nonce: int, collection: str, num_decimals: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_creating_nft(sender: IAccount, nonce: int, token_identifier: str, initial_quantity: int, name: str, royalties: int, hash: str, attributes: bytes, uris: list[str], guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_freezing(sender: IAccount, nonce: int, user: Address, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_freezing_single_nft(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_issuing_fungible(sender: IAccount, nonce: int, token_name: str, token_ticker: str, initial_supply: int, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_issuing_non_fungible(sender: IAccount, nonce: int, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_issuing_semi_fungible(sender: IAccount, nonce: int, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_local_burning(sender: IAccount, nonce: int, token_identifier: str, supply_to_burn: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_local_minting(sender: IAccount, nonce: int, token_identifier: str, supply_to_mint: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_pausing(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_registering_and_setting_roles(sender: IAccount, nonce: int, token_name: str, token_ticker: str, token_type: TokenType, num_decimals: int, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_registering_meta_esdt(sender: IAccount, nonce: int, token_name: str, token_ticker: str, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_burn_role_globally(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_special_role_on_fungible_token(sender: IAccount, nonce: int, user: Address, token_identifier: str, add_role_local_mint: bool, add_role_local_burn: bool, add_role_esdt_transfer_role: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_special_role_on_non_fungible_token(sender: IAccount, nonce: int, user: Address, token_identifier: str, add_role_nft_create: bool, add_role_nft_burn: bool, add_role_nft_update_attributes: bool, add_role_nft_add_uri: bool, add_role_esdt_transfer_role: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_setting_special_role_on_semi_fungible_token(sender: IAccount, nonce: int, user: Address, token_identifier: str, add_role_nft_create: bool, add_role_nft_burn: bool, add_role_nft_add_quantity: bool, add_role_esdt_transfer_role: bool, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_stopping_nft_creation(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_transferring_nft_create_role(sender: IAccount, nonce: int, token_identifier: str, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_transferring_ownership(sender: IAccount, nonce: int, token_identifier: str, new_owner: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unfreezing(sender: IAccount, nonce: int, user: Address, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unfreezing_single_nft(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unpausing(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_unsetting_burn_role_globally(sender: IAccount, nonce: int, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_updating_attributes(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, attributes: bytes, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_wiping(sender: IAccount, nonce: int, user: Address, token_identifier: str, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transaction_for_wiping_single_nft(sender: IAccount, nonce: int, token_identifier: str, token_nonce: int, user: Address, guardian: Address | None = None, relayer: Address | None = None) → Transaction

create_transction_for_adding_uris(sender: IAccount, nonce: int, token_identifier: str, uris: list[str], guardian: Address | None = None, relayer: Address | None = None) → Transaction

parse_add_quantity(transaction_on_network: TransactionOnNetwork) → list[AddQuantityOutcome]

parse_burn_quantity(transaction_on_network: TransactionOnNetwork) → list[BurnQuantityOutcome]

parse_create_nft(transaction_on_network: TransactionOnNetwork) → list[NFTCreateOutcome]

parse_freeze(transaction_on_network: TransactionOnNetwork) → list[FreezeOutcome]

parse_issue_fungible(transaction_on_network: TransactionOnNetwork) → list[IssueFungibleOutcome]

parse_issue_non_fungible(transaction_on_network: TransactionOnNetwork) → list[IssueNonFungibleOutcome]

parse_issue_semi_fungible(transaction_on_network: TransactionOnNetwork) → list[IssueSemiFungibleOutcome]

parse_local_burn(transaction_on_network: TransactionOnNetwork) → list[BurnOutcome]

parse_local_mint(transaction_on_network: TransactionOnNetwork) → list[MintOutcome]

parse_pause(transaction_on_network: TransactionOnNetwork) → list[PauseOutcome]

parse_register_and_set_all_roles(transaction_on_network: TransactionOnNetwork) → list[RegisterAndSetAllRolesOutcome]

parse_register_meta_esdt(transaction_on_network: TransactionOnNetwork) → list[RegisterMetaEsdtOutcome]

parse_set_burn_role_globally(transaction_on_network: TransactionOnNetwork)

parse_set_special_role_on_fungible_token(transaction_on_network: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_set_special_role_on_non_fungible_token(transaction_on_network: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_set_special_role_on_semi_fungible_token(transaction_on_network: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_unfreeze(transaction_on_network: TransactionOnNetwork) → list[UnFreezeOutcome]

parse_unpause(transaction_on_network: TransactionOnNetwork) → list[UnPauseOutcome]

parse_unset_burn_role_globally(transaction_on_network: TransactionOnNetwork)

parse_update_attributes(transaction_on_network: TransactionOnNetwork) → list[UpdateAttributesOutcome]

parse_wipe(transaction_on_network: TransactionOnNetwork) → list[WipeOutcome]

class multiversx_sdk.token_management.TokenManagementTransactionsFactory(config: TransactionsFactoryConfig)

Bases: object

create_transaction_for_adding_quantity(sender: Address, token_identifier: str, token_nonce: int, quantity_to_add: int) → Transaction

create_transaction_for_burning_quantity(sender: Address, token_identifier: str, token_nonce: int, quantity_to_burn: int) → Transaction

create_transaction_for_changing_sft_to_meta_esdt(sender: Address, collection: str, num_decimals: int) → Transaction

create_transaction_for_changing_token_to_dynamic(sender: Address, token_identifier: str) → Transaction

The following token types cannot be changed to dynamic: FungibleESDT, NonFungibleESDT, NonFungibleESDTv2

create_transaction_for_creating_nft(sender: Address, token_identifier: str, initial_quantity: int, name: str, royalties: int, hash: str, attributes: bytes, uris: list[str]) → Transaction

create_transaction_for_freezing(sender: Address, user: Address, token_identifier: str) → Transaction

Can be used for FungibleESDT

create_transaction_for_freezing_single_nft(sender: Address, token_identifier: str, token_nonce: int, user: Address) → Transaction

create_transaction_for_issuing_fungible(sender: Address, token_name: str, token_ticker: str, initial_supply: int, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_issuing_non_fungible(sender: Address, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_issuing_semi_fungible(sender: Address, token_name: str, token_ticker: str, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_local_burning(sender: Address, token_identifier: str, supply_to_burn: int) → Transaction

create_transaction_for_local_minting(sender: Address, token_identifier: str, supply_to_mint: int) → Transaction

create_transaction_for_modifying_creator(sender: Address, token_identifier: str, token_nonce: int) → Transaction

create_transaction_for_modifying_royalties(sender: Address, token_identifier: str, token_nonce: int, new_royalties: int) → Transaction

create_transaction_for_nft_metadata_recreate(sender: Address, token_identifier: str, token_nonce: int, new_token_name: str, new_royalties: int, new_hash: str, new_attributes: bytes, new_uris: list[str]) → Transaction

create_transaction_for_pausing(sender: Address, token_identifier: str) → Transaction

create_transaction_for_registering_and_setting_roles(sender: Address, token_name: str, token_ticker: str, token_type: TokenType, num_decimals: int) → Transaction

create_transaction_for_registering_dynamic_and_setting_roles(sender: Address, token_name: str, token_ticker: str, token_type: TokenType, denominator: int | None = None) → Transaction

create_transaction_for_registering_dynamic_token(sender: Address, token_name: str, token_ticker: str, token_type: TokenType, denominator: int | None = None) → Transaction

create_transaction_for_registering_meta_esdt(sender: Address, token_name: str, token_ticker: str, num_decimals: int, can_freeze: bool, can_wipe: bool, can_pause: bool, can_transfer_nft_create_role: bool, can_change_owner: bool, can_upgrade: bool, can_add_special_roles: bool) → Transaction

create_transaction_for_setting_burn_role_globally(sender: Address, token_identifier: str) → Transaction

create_transaction_for_setting_new_uris(sender: Address, token_identifier: str, token_nonce: int, new_uris: list[str]) → Transaction

create_transaction_for_setting_special_role_on_fungible_token(sender: Address, user: Address, token_identifier: str, add_role_local_mint: bool, add_role_local_burn: bool, add_role_esdt_transfer_role: bool) → Transaction

create_transaction_for_setting_special_role_on_non_fungible_token(sender: Address, user: Address, token_identifier: str, add_role_nft_create: bool = False, add_role_nft_burn: bool = False, add_role_nft_update_attributes: bool = False, add_role_nft_add_uri: bool = False, add_role_esdt_transfer_role: bool = False, add_role_nft_update: bool = False, add_role_esdt_modify_royalties: bool = False, add_role_esdt_set_new_uri: bool = False, add_role_esdt_modify_creator: bool = False, add_role_nft_recreate: bool = False) → Transaction

create_transaction_for_setting_special_role_on_semi_fungible_token(sender: Address, user: Address, token_identifier: str, add_role_nft_create: bool = False, add_role_nft_burn: bool = False, add_role_nft_add_quantity: bool = False, add_role_esdt_transfer_role: bool = False, add_role_nft_update: bool = False, add_role_esdt_modify_royalties: bool = False, add_role_esdt_set_new_uri: bool = False, add_role_esdt_modify_creator: bool = False, add_role_nft_recreate: bool = False) → Transaction

create_transaction_for_stopping_nft_creation(sender: Address, token_identifier: str) → Transaction

create_transaction_for_transferring_nft_create_role(sender: Address, token_identifier: str, user: Address) → Transaction

This role can be transferred only if the canTransferNFTCreateRole property of the token is set to true.

create_transaction_for_transferring_ownership(sender: Address, token_identifier: str, new_owner: Address) → Transaction

create_transaction_for_unfreezing(sender: Address, user: Address, token_identifier: str) → Transaction

Can be used for FungibleESDT

create_transaction_for_unfreezing_single_nft(sender: Address, token_identifier: str, token_nonce: int, user: Address) → Transaction

create_transaction_for_unpausing(sender: Address, token_identifier: str) → Transaction

create_transaction_for_unsetting_burn_role_globally(sender: Address, token_identifier: str) → Transaction

create_transaction_for_unsetting_special_role_on_fungible_token(sender: Address, user: Address, token_identifier: str, remove_role_local_mint: bool, remove_role_local_burn: bool, remove_role_esdt_transfer_role: bool) → Transaction

create_transaction_for_unsetting_special_role_on_non_fungible_token(sender: Address, user: Address, token_identifier: str, remove_role_nft_burn: bool = False, remove_role_nft_update_attributes: bool = False, remove_role_nft_remove_uri: bool = False, remove_role_esdt_transfer_role: bool = False, remove_role_nft_update: bool = False, remove_role_esdt_modify_royalties: bool = False, remove_role_esdt_set_new_uri: bool = False, remove_role_esdt_modify_creator: bool = False, remove_role_nft_recreate: bool = False) → Transaction

create_transaction_for_unsetting_special_role_on_semi_fungible_token(sender: Address, user: Address, token_identifier: str, remove_role_nft_burn: bool = False, remove_role_nft_add_quantity: bool = False, remove_role_esdt_transfer_role: bool = False, remove_role_nft_update: bool = False, remove_role_esdt_modify_royalties: bool = False, remove_role_esdt_set_new_uri: bool = False, remove_role_esdt_modify_creator: bool = False, remove_role_nft_recreate: bool = False) → Transaction

create_transaction_for_updating_attributes(sender: Address, token_identifier: str, token_nonce: int, attributes: bytes) → Transaction

create_transaction_for_updating_metadata(sender: Address, token_identifier: str, token_nonce: int, new_token_name: str, new_royalties: int, new_hash: str, new_attributes: bytes, new_uris: list[str]) → Transaction

create_transaction_for_updating_token_id(sender: Address, token_identifier: str) → Transaction

create_transaction_for_wiping(sender: Address, user: Address, token_identifier: str) → Transaction

create_transaction_for_wiping_single_nft(sender: Address, token_identifier: str, token_nonce: int, user: Address) → Transaction

create_transction_for_adding_uris(sender: Address, token_identifier: str, uris: list[str]) → Transaction

class multiversx_sdk.token_management.TokenManagementTransactionsOutcomeParser

Bases: object

parse_add_quantity(transaction: TransactionOnNetwork) → list[AddQuantityOutcome]

parse_burn_quantity(transaction: TransactionOnNetwork) → list[BurnQuantityOutcome]

parse_freeze(transaction: TransactionOnNetwork) → list[FreezeOutcome]

parse_issue_fungible(transaction: TransactionOnNetwork) → list[IssueFungibleOutcome]

parse_issue_non_fungible(transaction: TransactionOnNetwork) → list[IssueNonFungibleOutcome]

parse_issue_semi_fungible(transaction: TransactionOnNetwork) → list[IssueSemiFungibleOutcome]

parse_local_burn(transaction: TransactionOnNetwork) → list[BurnOutcome]

parse_local_mint(transaction: TransactionOnNetwork) → list[MintOutcome]

parse_nft_create(transaction: TransactionOnNetwork) → list[NFTCreateOutcome]

parse_pause(transaction: TransactionOnNetwork) → list[PauseOutcome]

parse_register_and_set_all_roles(transaction: TransactionOnNetwork) → list[RegisterAndSetAllRolesOutcome]

parse_register_meta_esdt(transaction: TransactionOnNetwork) → list[RegisterMetaEsdtOutcome]

parse_set_burn_role_globally(transaction: TransactionOnNetwork) → None

parse_set_special_role(transaction: TransactionOnNetwork) → list[SetSpecialRoleOutcome]

parse_unfreeze(transaction: TransactionOnNetwork) → list[UnFreezeOutcome]

parse_unpause(transaction: TransactionOnNetwork) → list[UnPauseOutcome]

parse_unset_burn_role_globally(transaction: TransactionOnNetwork) → None

parse_update_attributes(transaction: TransactionOnNetwork) → list[UpdateAttributesOutcome]

parse_wipe(transaction: TransactionOnNetwork) → list[WipeOutcome]

class multiversx_sdk.token_management.TokenType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

FNG = 'FNG'

META = 'META'

NFT = 'NFT'

SFT = 'SFT'

class multiversx_sdk.token_management.UnFreezeOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, balance: int)

Bases: object

balance: int

nonce: int

token_identifier: str

user_address: Address

class multiversx_sdk.token_management.UnPauseOutcome(token_identifier: str)

Bases: object

token_identifier: str

class multiversx_sdk.token_management.UpdateAttributesOutcome(token_identifier: str, nonce: int, attributes: bytes)

Bases: object

attributes: bytes

nonce: int

token_identifier: str

class multiversx_sdk.token_management.WipeOutcome(user_address: multiversx_sdk.core.address.Address, token_identifier: str, nonce: int, balance: int)

Bases: object

balance: int

nonce: int

token_identifier: str

user_address: Address