Migration support (from the legacy sdk-py-* libraries to this unified library)

[popenta]

Here, we describe the main steps for migrating from the previous multiversx-sdk-* python packages to the new one.

As previously stated, this is not a completely new package, the main change is that we unified multiversx-sdk-core, multiversx-sdk-wallet and multiversx-sdk-network-providers into a single package.

If you have any questions about the migration, feel free to leave a comment.

References:

• Cookbook
• Auto-generated documentation

[popenta]

Message & MessageComputer

While this is not a breaking change, there are some changes made to the constructor of the Message class.

There are three new fields added to the class: address(the address of the signer), version(the version of the message, defaults to 1), signer(what was used to sign the message, defaults to sdk-py).

For the MessageComputer class, two new methods have been added: pack_message and unpack_message.

[popenta]

TransactionComputer

Previously, the TransactionComputer class was located in the transaction.py module, but now it's been moved to a separate module called transaction_computer.py. This may be a little breaking change for some, depending on the way it was imported.

While absolute imports can still be used, one can simply do:

from multiversx_sdk import TransactionComputer

[popenta]

Breaking Change

SmartContractTransactionsFactory & TransferTransactionsFactory

Previously, when instantiating a SmartContractTransactionsFactory object, besides the config: IConfig parameter, an additional parameter token_computer: ITokenComputer was needed.

Now, the token_computer: ITokenComputer parameter has been removed.

The same applies for the TransferTransactionsFactory class.

[popenta]

Breaking Change

TokenManagementTransactionsFactory

On the method create_transaction_for_setting_special_role_on_fungible_token a new parameter called add_role_esdt_transfer_role: bool has been added, since it was missing in the previous implementation.

This is more of a "fixing change", but nevertheless breaking.

[popenta]

SmartContractQueriesController

Previously, we used the ContractQueryBuilder to create a query, and then we needed a network provider to run the query. We have now implemented a SmartContractQueriesController that can be used to create and run the query.

Reference:

• Smart Contract queries controller #16

[popenta]

Transactions Outcome Parsers

Previouslty, we only had a single transaction parser, TokenOperationsOutcomeParser, used for parsing token management transactions. This parser is still available, but we encourage you to use the new one, TokenManagementTransactionsOutcomeParser.

In addition to this one, we now have parser for smart contract transactions (SmartContractTransactionsOutcomeParser) and delegation transactions(DelegationTransactionsOutcomeParser). These transactions parsers have also been aligned with the sdk-specs.