Skip to content

Commit

Permalink
Release 0.70.0
Browse files Browse the repository at this point in the history
  • Loading branch information
FrankC01 committed Oct 8, 2024
1 parent 743b575 commit c7cef39
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 74 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.70.0] - Unpublished
## [0.70.0] - 2024-10-08

### Added

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ Python Client SDK for Sui blockchain

**Release-0.70.0**

- Supports _SUI 1.35.x RPC API_, _SUI 1.35.x GRAPHQL (devnet)_
- Backwards compatable to _Sui 1.29.x RPC API_
- Supports _SUI 1.36.x RPC API_, _SUI 1.35.x GRAPHQL (devnet)_
- Backwards compatable to _Sui 1.30.x RPC API_

See [CHANGELOG](https://github.com/FrankC01/pysui/blob/main/CHANGELOG.md)

## PyPi current

**Release-0.68.0 - Released 2024-09-22**
**Release-0.70.0 - Released 2024-10-08**

**_BREAKING CHANGES to GraphQL multi-schema support and removal of legacy samples_**

- Supports _SUI 1.35.x RPC API_ and _SUI 1.34.x GRAPHQL_
- Backwards compatable to _Sui 1.28.x RPC API_ and _1.33.2 GraphQL schema_
- Supports _SUI 1.36.x RPC API_ and _SUI 1.35.x GRAPHQL_
- Backwards compatable to _Sui 1.30.x RPC API_ and _1.34.3 GraphQL schema_

- [Latest PyPi Version](https://pypi.org/project/pysui/)

Expand Down
4 changes: 2 additions & 2 deletions pysui/sui/sui_clients/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@ class ClientMixin(Provider):
constructor consistency as well as utility functions
"""

_RPC_MINIMAL_VERSION: str = "1.29.0"
_RPC_REQUIRED_VERSION: str = "1.35.0"
_RPC_MINIMAL_VERSION: str = "1.30.0"
_RPC_REQUIRED_VERSION: str = "1.36.0"

@versionchanged(
version="0.26.1",
Expand Down
82 changes: 16 additions & 66 deletions samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,31 @@ Samples and utilities included in both the `pysui` repo as well as when installi

## Examples:

- async-gas collects and prints all gas for all addresses found in configuration
- Sample [WalletG](#walletG) providing equivalent functionality as `sui client ...`
### Async Gas

Example demonstrating using the `pysui` asynchronus client. See [DEVELOP](../DEVELOP.md)

### Sui GraphQL Schemas

Example that takes one or more GraphQL nodes and writes schemas to folder

### WalletG

Implementation demonstrating most commands like the SUI CLI (i.e. `sui client ...`) using Sui GraphQL RPC.


**Note:** If running from cloned repo, examples are started with `python -m ....`

- `python -m samples.walletg`
- `python -m samples.async_gasg`
- `python -m samples.sgqls`
- `python -m samples.walletg`

**Note:** If running from PyPi install, examples can be started directly

- `wallet`
- `async-gas`
- `sgqls`
- `wallet`

### Async Gas

Example demonstrating using the `pysui` asynchronus client. See [DEVELOP](../DEVELOP.md)

### WalletG

Implementation demonstrating most commands like the SUI CLI (i.e. `sui client ...`) using Sui GraphQL RPC.

#### WalletG Commands
```shell
Expand Down Expand Up @@ -118,58 +123,3 @@ subcommand:
from Return transaction events from sender address.
to Return transaction events from recipient address.
```
## Run Local (wallet only)
We've changed the abbility to operate with a local running node to rely on [sui-base](https://github.com/ChainMovers/suibase).
After you've cloned and installed `suibase` you can add the `--local` flag as shown below
Note that this is different if you are swiitching between `envs` using the standard sui configuration.
### Running with `sui-base`
1. Change to your home folder `cd ~/`
2. `git clone [email protected]:ChainMovers/suibase.git`
3. `cd suibase`
4. `./install`
5. `localnet start` <= This will download sui source code and start a local node (devnet level)
6. Finally, add the `--local` switch to the command line `pysui` wallet or other samples
Example:
```bash
wallet --local gas
```
Or (if running pysui from repo clone):
```bash
python samples/wallet.py --local gas
```
### Running with standard sui configuration
If your standard configuration has `envs` that include `localnet`
1. `sui client switch --env localnet
Example:
```bash
wallet gas
```
```bash
walletg gas
```
Or (if running pysui from repo clone):
```bash
python samples/wallet.py gas
```
```bash
python samples/walletg.py gas
```

0 comments on commit c7cef39

Please sign in to comment.