# ChangeLog

## Unreleased

## 3.1.0 - 2026-02-11

### Added

- iterative account key storage retrieval
- fail check and log check
- keystore JSON wallet support for account loading and wallet generation
- keystore folder accounts loading (load all keystores from a folder)
- Claude Code configuration for AI-assisted development
- adaptive progress logging for slow account cloning operations (activates after 5s)
- embedded docker-compose for the chain-simulator with service selection (`--services`, `--exclude`, `--no-auto-deps`)

### Changed

- upgraded smart contract SDK (multiversx-sc) from 0.63.3 to 0.64.1
- migrated all shell scripts to use `uv run` prefix

### Fixed

- Tokens are now correctly visible when cloned in the chain-simulator
- Account cloning now uses rate limiting and exponential backoff to avoid 429 errors when fetching token data from Elasticsearch
- ESDT token data from Elasticsearch is now cached to speed up subsequent cloning operations
- Token insertion into local Elasticsearch now uses bulk API for faster cloning
- Storage key iteration now uses dynamic batch sizing to avoid timeouts on large contracts
- Storage state setting on chain-simulator now uses batched requests to avoid timeouts on large accounts

## 3.0.2 - 2025-04-18

### Fixed

- Single pem account instantiation not detected
- Ignore external account transaction signature when on chain-simulator
- Unused package dependencies moved to dev dependencies

## 3.0.1 - 2025-04-15

### Fixed

- Ledger account instantiation not detected
- Missing ledger dependencies
- Missing hash signing option when using ledger account

### Added

- Documentation page for the chain-simulator

## 3.0.0 - 2025-04-04

### Fixed

- Inconsistent data path due the snap packages
- Remove deprecated help description files and use direct descriptors
- ReadTheDocs build with uv
- Untracked permissions for executable file in the git repository
- Remove non-output prints
- use blake2b for wasm code hash
- missing code hash update when upgrading a contract
- wrapping integration test on devnet

### Added

- the data save path of `MxOps` is now configurable through the config var `DATA_PATH`
- chain-simulator network and adapted transaction schema (forward chain until transaction completion)
- `FileFuzzerStep`
- Account's addresses are now saved within the scenario data at load time. They can be referenced to with "%account_id.address"
- `SetVarsStep`
- `GenerateWalletsStep`
- `R3D4FaucetStep`
- `ChainSimulatorFaucetStep`
- `LoopStep` can now directly use a list from the Scenario data
- `ChainSimulatorFaucetStep` and `R3D4FaucetStep` can now directly use a list from the Scenario data as targets
- `WaitStep`
- classes for smart values to rationalize the conversion of smart values
- Formulas can be directly supplied as arguments within MxOps scenes
- chain-simulator can be started and stopped from MxOps
- results for smart-contract calls can now be saved too
- skip simulator transaction signature when the sender account is unknown
- `AccountCloneStep`
- a file cache system per network
- account cloning now use the cache system
- id can now be given to any account
- user accounts are now auto reloaded from scenario data (no need to supply them at each execution)
- SceneStep can now be repeated
- SceneStep can now target a folder of scenes
- User can now evaluate an expression with the data CLI
- logs are now saved to the MxOps data folder and scenario folders
- `SetSeedStep`
- `AssertStep`
- `LogStep`

### Changed

- 🚨 BREAKING CHANGE 🚨 loop variables from `LoopStep` are now saved and accessed with the symbol `%` instead of `$`
- 🚨 BREAKING CHANGE 🚨 function result are now saved and accessed with the symbol `%` instead of `$`, and the save key is provided by the user
- 🚨 BREAKING CHANGE 🚨 account's addresses can no longer be accessed with "[<account_id>]"
- scenes have now default values for allowed scenarios and allowed networks
- 🚨 BREAKING CHANGE 🚨 removed analyze feature from MxOps
- 🚨 BREAKING CHANGE 🚨 rework the data save structure and introduce versioned data structure
- 🚨 BREAKING CHANGE 🚨 upgrade to the new multiversx-sdk-py 1.0.0 and removal of MxPySerializer
- 🚨 BREAKING CHANGE 🚨 OptionalValue are mandatory now (user must input "null")
- 🚨 BREAKING CHANGE 🚨 Enums format has changed to use the one from the multiversx-sdk-py
- 🚨 BREAKING CHANGE 🚨 MultiValueEncoded format has changed to use the one from the multiversx-sdk-py
- 🚨 BREAKING CHANGE 🚨 ledger account index was dropped as it is not used by multiversx-sdk-py
- upgraded all dependencies
- use uv instead of conda for development and env tests
- 🚨 BREAKING CHANGE 🚨 new class workflow for checks, smart-values and steps
- 🚨 BREAKING CHANGE 🚨 Accounts are now saved by bech32, the name to bech32 translation is done using the storage
- 🚨 BREAKING CHANGE 🚨 ABIS are now stored using a contract bech32
- 🚨 BREAKING CHANGE 🚨 Contracts are now handled using contract bech32 by the Scenario Data
- 🚨 BREAKING CHANGE 🚨 All accounts (user, contracts, internal, external) are now defined under the same "accounts" key in scenes
- use uv for package build
- 🚨 BREAKING CHANGE 🚨 scene_path attribute of SceneStep has been renamed path
- 🚨 BREAKING CHANGE 🚨 cli and smart-values have been moved into dedicated sub-packages
- 🚨 BREAKING CHANGE 🚨 step argument `print_results` was changed to `log_results` and is set to True by default
- 🚨 BREAKING CHANGE 🚨 renamed `wasm_hash` to `code_hash`
- 🚨 BREAKING CHANGE 🚨 step argument `print_result` was changed to `log_result` and is set to True by default


## 2.2.0 - 2024-04-16

### Added

- scenario clone command
- Allowed `TransfersCheck` to dynamically evaluate sender and receiver by name

### Fixed

- Updated the name 'local-testnet' to 'localnet'

## 2.1.0 - 2024-03-01

### Added

- ABI support for smart-contract
- Added new examples for queries

## 2.0.1 - 2023-10-25

### Fixed

- wrongly converted hex arguments
- broken ledger sign

## 2.0.0 - 2023-10-20

### Fixed

- Use of missing signer for LedgerAccount
- Missing parsing of hexadecimal value as string

### Added

- Checkpoints for scenario
- `ContractUpgradeStep`
- Auto retry for empty query results
- python step class
- Value key can now of any depth for scenario data
- `SceneStep`
- `analyze` module

### Changed

- 🚨 BREAKING CHANGE 🚨 `checks` attribute has been given for all `TransactionStep`, sometimes replacing `check_success`
- 🚨 BREAKING CHANGE 🚨 `.` and `[]` are used instead of `%` to specify a scenario value key
- 🚨 BREAKING CHANGE 🚨 `data.data.py` renamed into `data.execution_data.py`
- Upgrade MultiversX python libraries
- `int` is preferred over `number` for query return type

### Fixed

- Bug with the `skip confirmation` CLI command
- Wrong token properties set during token registration

## 1.1.0 - 2023-05-11

### Added

- CLI options to clean/delete scenario data before or after execution
- steps for token transfers (eGLD, fungible & non fungible)
- steps for token issuance, roles management and minting (fungible & non fungible)
- `TransfersCheck` to verify the transfers of a `ContractCallStep`
- Networks enumerations can be parsed by their short or full names

### Modified

- Switch integration tests contracts from elrond-wasm to multiversx-sc
- Add diverse precision on contribution

### Fixed

- Error when providing absolute path for scenes
- Commit change when auto bumping changelog version
- Make the pylint test fail if a pylint error is detected

## 1.0.0 - 2023-03-09

### Added

- Check classes for `CallStep`
- External contract support for contract calls and queries (including results save)
- CI and script for bandit, flake8 and pylint
- CI for pytest tests
- CI for python package build
- CI for package publication on PYPI
- Wrapping example in the documentation

### Changed

- 🚨 BREAKING CHANGE 🚨 `contract_id` attribute renamed to `contract` for calls and queries
- 🚨 BREAKING CHANGE 🚨 Refactor check_for_errors attribute to be more general (allow more checks in the future)
- Reorganize integration tests folders, scripts and scenario names
- Convert the "Getting Started" section to a complete chapter in the documentation

## 0.1.1 - 2023-01-24

### Added

- Readthedocs yaml configuration file to fix compilation
- Full user tutorial in the sphinx documentation

## 0.1.0 - 2023-01-23

First version of MxOps.