Pysui

Breaking changes

Added

- `description`, `image_url` and `project_url` ValidatorMetadata in SystemState result as per SUI 0.22.0
- `epoch` optional arguments added to InspectTransaction and InspectMoveCall builders as per SUI 0.22.0
- GetCheckpointContents builder added as per SUI 0.22.0
- GetCheckpointContentsBySequence builder added as per SUI 0.22.0
- GetCheckpointSummary builder added as per SUI 0.22.0
- GetLatestCheckpointSequence builder added as per SUI 0.22.0
- ChangeEpocTx added to transaction execution result as per SUI 0.21.0
- GenesisTx added to transaction execution result as per SUI 0.21.0

Fixed

- arguments from transaction 'Call' event supports empty list, list strings or int arrays

Changed

- Code refactoring for most builders in `builders/exec_builders.py` (BatchTransaction is the exception)
- SuiConfig: documentation
- Wallet: SUI RPC API version printed with SDK version `wallet -v`
- pending_delegations and pending_withdraws in StakingPool changed to TableVec from list of obsolete structures.
- DelegatedStakes: Built out result type (from GetDelegatedStakes builder)

Removed

- `sig_scheme` and `pubkey` from ExecuteTransaction builder as per SUI 0.22.0
- `switch_pool_token_amount` from RequestSwitchDelegation builder as per SUI 0.22.0
- `principal_withdraw_amount` from RequestWithdrawDelegation builder as per SUI 0.22.0
- `chain_id` from result of GetSystemState as per SUI 0.22.0

BREAKING CHANGES (Keys)

Added

- Utility `keys_to_0210.py` [about](utility/README.md)
- GetDelegatedStakes builder and return types supporting **new** SUI RPC API (0.21.0)
- GetValidators builder and return types supporting **new** SUI RPC API (0.21.0)
- RequestAddDelegation builder supporting **new** SUI RPC API (0.21.0)
- RequestSwitchDelegation builder supporting **new** SUI RPC API (0.21.0)
- RequestWithdrawDelegation builder supporting **new** SUI RPC API (0.21.0)

Fixed

- GetObjectsOwnedByObject result parsing [bug](https://github.com/FrankC01/pysui/issues/58)

Changed

- Keystring processing as per [sui 0.21.0 change](https://github.com/MystenLabs/sui/pull/6989)
- GetTxn now references result dataclass. Updated samples/cmd.py to use new result.
- Code refactoring for all builders in `builders/get_builders.py`
- Added 'lockedUntilEpoch`field to`SuiCoinObject` results (Sui 0.21.0)

Removed

- `unique` from SuiKeyPairED25519 and SuiKeyPairSECP256K1

Breaking changes

Added

- async_gas and async_sub support calling with `--local path/file to non-standard client.yaml`
- Prelim subscription docs
- Elaborated subscription doc with examples
- **StakeSubsidy** added to SuiSystemState result from GetSuiSystemState [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **delegator_staked_sui_id** field added to PendingDelegator result from GetSuiSystemState [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **SuiTransactionBuilderMode** enum added in support of executing `sui_batchTransaction` and `sui_moveCall` [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **GetAllCoinBalances** builder [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **GetAllCoins** builder [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **GetDynamicFieldObject** builder [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **GetDynamicFields** builder [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **InspectTransaction** builder [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **InspectMoveCall** builder [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- **consensus_address, worker_address and worker_pubkey_bytes** fields added to ValidatorMetaData

Fixed

- Signature on subscription handlers (typing Callable)

Changed

- Workaround for [sui defect](https://github.com/MystenLabs/sui/issues/7052)
- Using new 'temporary' gas retrival API to optimize `async_gas` [discussion](https://github.com/FrankC01/pysui/discussions/50). Targetting
[milestone](https://github.com/FrankC01/pysui/milestone/5) with [enhancement](https://github.com/FrankC01/pysui/issues/54)
- Dataclasses for result of calling `sui_getSuiSystemState`
- GetCoinTypeBalance (`sui_getBalance`) now returns a single SuiCoinBalance instead of SuiCoinBalance**s** (array of SuiCoinBalance). See above, in Added, GetAllCoinBalances support [0.20.0](https://github.com/FrankC01/pysui/issues/55)
- request_type: SuiRequestType to constructors of sync and async SuiClients. Defaults to WAITFORLOCALEXECUTION

Removed

- IMMEDIATERETURN and WAITFORTXCERT removed from `SuiRequestType` for txn execution [0.20.0](https://github.com/FrankC01/pysui/issues/55)

Added

- New Provider: SuiClient in `sui.sui_clients.subscribe.py` [enhancement](https://github.com/FrankC01/pysui/issues/40)

Fixed

- ObjectRead supporting dynamic field type representation
- SuiParameterReference supporting str or dict in `reference_to` for scalar types
- Samples: `wallet objects -a ...` was ignoring address

Changed

BIG BREAKING CHANGES!

- Refactored `sui.sui_types` as a package [breaking changes](https://github.com/FrankC01/pysui/issues/48)
- Refactored `sui.sui_builders` as a package [breaking changes](https://github.com/FrankC01/pysui/issues/48)
- Refactored `sui.sui_txresults` as a package [breaking changes](https://github.com/FrankC01/pysui/issues/48)
- Refactored `sui.sui_rpc` as a package (`sui.sui_clients`) [breaking changes](https://github.com/FrankC01/pysui/issues/48)
- Renamed `SuiAsynchClient` to `SuiClient` [breaking changes](https://github.com/FrankC01/pysui/issues/48)

Removed

- faux_wallet.py in samples package

Added

- Builders section to documentation

Fixed

- [bug](https://github.com/FrankC01/pysui/issues/47)

Changed

Removed

Added

- Support for `sui_getBalance` [enhancement](https://github.com/FrankC01/pysui/issues/46). This returns
total balance per coin type (i.e. `0x2::sui::SUI`) for owner (SuiAddress) and is more efficient than getting all coins and
totalling.
- Support for `sui_getCoins` [enhancement](https://github.com/FrankC01/pysui/issues/46). This returns
address coins for coin type (i.e. `0x2::sui::SUI`) and is more efficient than getting all coin descriptors and
sui_getObject for each descriptor.
- Support for `sui_getTotalSupply` [enhancement](https://github.com/FrankC01/pysui/issues/46). This returns the
total supply of coin_type (i.e. `0x2::sui::SUI`).
- Support for `sui_getSuiSystemState` [enhancement](https://github.com/FrankC01/pysui/issues/46). This returns
SUI system state information.
- Support for `sui_getTransactionsInRange` [enhancement](https://github.com/FrankC01/pysui/issues/46). This returns a list of transaction digests strings within the queried transaction sequence range: `start` (inclusive) and `end` (exclusive).

Fixed

- [bug] (https://github.com/FrankC01/pysui/issues/46)

Changed

Removed