Migration Issue: V1 to V2

[popenta]

V2 is a major release that introduces several important changes.

New GasLimitEstimator component

In response to the Barnard release, where gas limit overestimation dropped from 10x to 2x, we’ve added the GasLimitEstimator.
This component simulates a transaction to compute the required gas limit and allows an optional multiplier (e.g. 1.1) for safety margins.
It can be passed to any TransactionFactory, Controller or Entrypoint.

Removal of deprecated code

Several previously deprecated classes and methods have been removed to streamline the codebase.

⚠️ This release includes breaking changes. Please review the list below to ensure a smooth upgrade from v1.

[popenta]

Estimating gas limit using GasLimitEstimator

When creating transaction factories or controllers, we can pass an additional argument, a gas limit estimator. This gas estimator simulates the transaction before being sent and computes the gasLimit that it will require. The GasLimitEstimator can be initialized with a multiplier, so that the estimated value will be multiplied by the specified value. It is recommended to use a small multiplier (e.g. 1.1) to cover any possible changes that may occur from the time the transaction is simulated to the time it is actually sent and processed on-chain. The gas limit estimator can be provided to any factory or controller available.

from multiversx_sdk import ApiNetworkProvider, GasLimitEstimator, TransferTransactionsFactory, TransactionsFactoryConfig

api = ApiNetworkProvider("https://devnet-api.multiversx.com")
gas_estimator = GasLimitEstimator(network_provider=api) # create a gas limit estimator with default multiplier of 1.0
gas_estimator = GasLimitEstimator(network_provider=api, gas_multiplier=1.1) # create a gas limit estimator with a multiplier of 1.1

config = TransactionsFactoryConfig(chain_id="D")
transfers_factory = TransferTransactionsFactory(config=config, gas_limit_estimator=gas_estimator)

Factories or controllers created through the entrypoints can use the GasLimitEstimator as well:

from multiversx_sdk import DevnetEntrypoint

entrypoint = DevnetEntrypoint(with_gas_limit_estimator=True, gas_limit_multiplier=1.1)

transfers_controller = entrypoint.create_transfers_controller() # will create the controller using the GasLimitEstimator with a 1.1 multiplier
transfers_factory = entrypoint.create_transfers_transactions_factory() # will create the factory using the GasLimitEstimator with a 1.1 multiplier

[popenta]

Breaking changes

Changed parameters order for SmartContractController

Due to adding the new GasLimitEstimator, the gas_limit argument of the methods has become optional. In order to make this argument optional we needed to change the order of the parameters, so the gas_limit and function arguments have switched places. Even though this is a breaking change, if you we're calling the method using named parameters you shouldn't be impacted.

The new header of the function looks like this:

def create_transaction_for_execute(
        self,
        sender: IAccount,
        nonce: int,
        contract: Address,
        function: str,
        gas_limit: Optional[int] = None,
        arguments: Sequence[Any] = [],
        native_transfer_amount: int = 0,
        token_transfers: list[TokenTransfer] = [],
        gas_price: Optional[int] = None,
        guardian: Optional[Address] = None,
        relayer: Optional[Address] = None,
    ) -> Transaction:

[popenta]

Removed deprecated code

Relayed V1 & Relayed V2

Relayed V1 and Relayed V2 transactions will be very soon deactivated, thus we've removed RelayedTransactionsFactory and RelayedController. Instead, RelayedV3 should be used.

[popenta]

Removed deprecated methods of the Address class

The Address class contained some old, deprecated methods that have been removed. Please use the recommended replacements bellow:

• Removed Address.from_bech32()
  → Use Address.new_from_bech32() instead

• Removed Address.from_hex()
  → Use Address.new_from_hex() instead

• Removed address.bech32()
  → Use address.to_bech32() instead

• Removed address.hex()
  → Use address.to_hex() instead

[popenta]

Changed parameters order for MultisigTransactionsFactory

Due to the same reason as stated above for the SmartContractController, the order of the parameters changed a bit for the create_transaction_for_propose_contract_deploy_from_source method. The parameters gas_limit and contract_to_copy have switched places.

The new method header looks like this:

def create_transaction_for_propose_contract_deploy_from_source(
        self,
        sender: Address,
        contract: Address,
        contract_to_copy: Address,
        gas_limit: Optional[int] = None,
        native_token_amount: int = 0,
        arguments: Optional[list[Any]] = None,
        is_upgradeable: bool = True,
        is_readable: bool = True,
        is_payable: bool = False,
        is_payable_by_sc: bool = True,
        abi: Optional[Abi] = None,
    ) -> Transaction: