Pysui

Added

- [enhancement](https://github.com/FrankC01/pysui/issues/92) SuiTransaction builder supports Optional in move_call arguments for Sui unsigned integer types
- `libtool` in README dependencies list

Fixed

- Mutable flag on ObjectRead of ownertype Shared [bug](https://github.com/FrankC01/pysui/issues/97)
- Pure string encoding [bug](https://github.com/FrankC01/pysui/issues/91)
- Exclude simple types from SuiTransaction `make_move_vec` [bug](https://github.com/FrankC01/pysui/issues/93)
- Simple empty list as `arguments` was failing [bug](https://github.com/FrankC01/pysui/issues/94)
- bcs.Address conversion of strings of varying lengths [bug](https://github.com/FrankC01/pysui/issues/95)

Changed

- `sui-base` to `suibase` in documentation

Removed

Breaking Changes

Added

- Handling move call argument nested lists/vectors
- More documentation on SuiTransaction (programmable transactions)
- GetLoadedChildObjects builder and reponse supporting Sui RPC API `sui_getLoadedChildObjects` in 0.33.0

Fixed

- On testnet code has changes in `rpc.discover` making required field optional on method parameters.
- Nested types [bug](https://github.com/FrankC01/pysui/issues/90)

Changed

Removed

- **Breaking Change** `additional_signature`, other than sender and sponsor, are not supported by the tx processor in Sui. Removed
the property in `SignerBlock`

Breaking Changes

Added

- **Breaking Change** Assertion on SuiTransaction that will fail operations on it if it's been executed already
- Implemented NameServiceAddress and NameServiceNames builders and results for supporing `suix_resolveNameServiceAddress` and `suix_resolveNameServiceNames` respectivly.
- `merge_gas_budget` to SuiTransaction constructor. When attempting to find available gas coin for transaction, this flag if true,
allows a merge of coins to meet budget demand. Defaults to False

Fixed

- Field declaration in Effects result.
- Bug in SuiTransaction builder argument resolution method.

Changed

- Extended CompiledPackage to hold blake2b digest to match chain digest calculation. Used in package upgrades in SuiTransaction.
- Introspection on SuiTransaction `move_call` target function to better return reusuable command results
- **Breaking Change** SuiTransaction constructor and execute methods simplified while making signing more powerful
- **Breaking Change** SuiTransaction `split_coin` now takes list of amounts and returns list of results.
- **Breaking Change** SuiTransaction `move_call` now takes target string in form: `"package_id::module_name::function_name"`
- **Breaking Change** `build_for_execute` method made private on SuiTransaction

Removed

- **Breaking Change** `gasses` property from SuiTransaction

We've started to 'deprecate' various functions, classes and methods to provide early warnings where
your usage of `pysui` should consider changing.

Added

- `split_coin_equal` to SuiTransaction (a.k.a. Transaction Builder)
- Support for signing with MultiSig in SuiTransaction
- Support for running locally using [sui-base](https://github.com/sui-base/sui-base). The advantages are
the availabbility of highly configurable local nodes, management of different versions of Sui and consistent
wallet addresses across configuration.
- New pytests leveraging `sui-base`

Fixed

Changed

- Changed methods for loading a configuration. Choices are now:
1. `SuiClient.default_config()` (default configuration loading)
2. `SuiClient.sui_base_config()` (if running sui-base locally)

Removed

Added

- Added missing options for querying transactions
- Implemented QueryTransactions [enhancement](https://github.com/FrankC01/pysui/issues/84) builder and results supporing `suix_queryTransactions`
- MultiSig added [enhancement](https://github.com/FrankC01/pysui/issues/75)
- Implemented pysui.sui.sui_clients.Transaction/Transaction builder supporting Programmable Transactions [enhancement](https://github.com/FrankC01/pysui/issues/83)
- Documentation for Programmable Transaction in read-the-docs

Fixed

- GetTotalTxCount underlying RPC API method [fixed](https://github.com/FrankC01/pysui/issues/82)
- GetMultipleTx was calling obsolete RPC API method.
- Result type from calling faucet
- Added default dependency IDs for 0x1 and 0x2 in sui_utils.py for publishing

Changed

- _**Most, if not all, integer values as arguments to RPC methods have been changes in Sui 0.31.0 to strings
to support bigger integers for platforms without arbitrarily large numbers (ALN). This has resulted in
changes to many `pysui` Builder and result types.**_
- Gas requirements for transactions have increased 1000x on devnet. Use `GetReferenceGasPrice` and `DryRunTransaction` often until you get used to the [changes](https://docs.sui.io/devnet/build/sui-gas-charges).
- Increased default RPC timeout from 30 to 120 seconds on synch and asynch SuiClients.

Removed

- GetTxs aligning to dropped methods in RPC API 0.29.1
- GetTransactionsInRange aligning to dropped methods in RPC API 0.29.1

Added

- Added `get_objects` to synchronous and asynchronous SuiClients
- Address SignatureType in constant pool (base_deserailizers.py - deserialize_constants)
- GetCheckpoint builder and Checkpoint result for `sui_getCheckpoint` as per Sui 0.28.0
- GetCheckpoints builder and Checkpoint paginated results for `sui_getCheckpoints` as per Sui 0.28.1
- GetLatestSuiSystemState builder and results for `sui_getLatestSuiSystemState` as per Sui 0.28.0
- GetMultipleTx builder and TxResponseArray result for `sui_multiGetTransactions` as per Sui 0.28.0
- GetMultipleObjects builder for `sui_multiGetObjects` as per Sui 0.28.0
- QueryEvents builder for `sui_queryEvents` as per Sui 0.28.0

Fixed

- [bug](https://github.com/FrankC01/pysui/issues/76)
- [bug](https://github.com/FrankC01/pysui/issues/78)
- [bug](https://github.com/FrankC01/pysui/issues/67)

Changed

- **Breaking Change** Addresses are now 32 bytes (as apposed to 20) and are generated from keys using `blake2b` instead of `sha3_256`
- **Breaking Change** Prior 'module build' functions in `sui_utils.py` to support publishing have been replaced with `publish_build`. At the moment this will only prepare the core package modules. We will follow up with publishing unpublished dependencies in a later release. If you need that capabilit, use `sui client publish ...` from command line.
- **Breaking Change** event filters for QueryEvents and SubscribeEvents moved to `sui_types/event_filter.py`. Note that per Sui 0.28.0 the filters have changed.
- **Breaking Change** TxEffectResult renamed to TxResponse and restructured as per Sui 0.28.0
- **Breaking Change** Sui has moved from 20 byte address to 32 byte addresses. This changes all SuiAddress and ObjectID constructs.
- **Breaking Change** ValidatorMetaData changes as per Sui 0.28.0
- **Breaking Change** DelegatedStake changes as per Sui 0.28.0
- **Breaking Change** Added DryRunTxResult for new result definition as per Sui 0.28.0
- **Breaking Change** GetDynamicFieldObject now takes a mapping for name as per Sui 0.28.0
- **Breaking Change** GetTx result changes as per Sui 0.28.0
- **Breaking Change** GetObject options and result changes as per Sui 0.28.0
- **Breaking Change** ExecuteTransaction now takes a list of signatures as per Sui 0.28.0
- **Breaking Change** Result types (TxResult, TxInspectionResult and DryRunTxResult) changes as per Sui 0.28.0
- **Breaking Change** Pay and PaySui now takes a list of SuiStrings for amounts as per Sui 0.28.0
- **Breaking Change** GetEvents now take a transaction digest as parameter as per Sui 0.28.0. See Added above for QueryEvent for old behavior.
- Subscribing to events now only gets events emitted by a module as per Sui 0.28.0
- Renamed GetDelegatedStakes builder to GetStakes aligning with `sui_getStakes` as per Sui 0.28.1
- Renamed RequestAddDelegation builder to RequestAddStake aligning with `sui_requestAddStake` as per Sui 0.28.0
- Renamed RequestWithdrawDelegation builder to RequestWithdrawStake, aligning with `sui_requestWithdrawStake` as per Sui 0.28.0
- All transaction RPC API calls (Batch,Publish,MoveCall,PayXX,SplitXX,MergeXX,StakeXX) now invoke `unsafe_<NAME>` as per Sui 0.28.0 in light of the new ProgrammableTransaction.
- async_client and sync_client now take optional `additional_signers` towards support Sui multi-sign
- async_client and sync_client "execute_no_sign" now returns a PreExecutionResult data object in SuiRpcResult
- GetObject now takes flag options on what to include or not in result
- Removed `protocol_version` field from CommitteeInfo results as per Sui 0.28.0
- InspectTransaction results now include eveents as per Sui 0.28.0
- Renamed `bcs_from_rpcresult` to `bcs_struct_from_rpcresult` in

Removed

- **Breaking Change** GetTxAuthSignatures removed for `sui_getTransactionAuthSigners` removed as per Sui 0.28.0
- **Breaking Change** RequestSwitchDelegation removed for `sui_requestSwitchDelegation` removed as per Sui 0.28.0
- **Breaking Change** GetRawObject removed for `sui_getRawObject` removed as per Sui 0.28.0. Raw information is now part of GetObject
- **Breaking Change** GetSuiSystemState removed for `sui_getSuiSystemState` as per Sui 0.28.0. Use GetLatestSuiSystemState instead.
- **Breaking Change** ExecuteSerializedTransaction removed for `sui_executeTransactionSerializedSig` as per Sui 0.28.0
- **Breaking Change** GetCheckpointContentsByDigest, GetCheckpointSummary,GetCheckpointSummaryByDigest as per Sui 0.28.0
- **Breaking Change** Removed `get_address_object_descriptors` from synchronous and asynchronous SuiClients