frankc01 / pysui Goto Github PK

With SUI 0.17.0 subscriptions now happen with fullnode URL

Will cover post "Cable Casing" milestone

SuiAsynchClient does not invoke new_sign_secure
Secp256k1 keypair does not implement new_sign_secure

Implement base Sui RPC transaction building, validation using rpc.discover meta data, sign and execute.

Example of SUI transactions:

• transfer
• spilt

Depends on completing #30, #31

Eliminate manual parsing of inbound descriptors from various sui_get... calls
Objectify transaction results
Objectify normalized package, modules, et.

Last review was in 0.0.1 version...

Will analyze....

Add GitHub actions for running tests including linters and actual pytest before merging PRs or before committing to main.

Fixture will utilize devnet or local and go through the entire suite of RPC API

I have no idea what I am doing here, collaboration is welcome!

There is an incredible amount of redundant/duplicate code. Side effect of pushing catch up capability with evolving SUI RPC.

Primary focus areas:

1. Builders
2. Result data classes
3. Clients (sync/async)

These changes MUST NOT break SDK class interfaces.

Unlike Coin, there is no predictable type information to infer an NFT from any other object.

Currently, the submission of a transaction, signing and executing transaction all happen in the execute Client function.

Provide an option to return the TransactionBytes to be signed later.

Change the monolithic source from title into package with multiple source.

For example, from sui_types.py to:

sui_types
    |
    --- scalars.py
    --- core.py
    --- collections.py
    ---  etc.

When more testing that all scenarios are handled by the new transaction result type, substitute strings for well know SUI Types:

• ObjectID
• Addresses
• etc.

Towards coverage

MystenLabs/sui#7423
Changes to secp256/k/r1 signing see #67

MystenLabs/sui#7790
Programmable transactions

MystenLabs/sui#7372
Deprecation of sui_devInspectMoveCall FIXED in pysui 0.11.0

MystenLabs/sui#7426
build/publish --with-unpublished-dependencies see #66

MystenLabs/sui#7237
This is causing fails in tracing back through object generations

MystenLabs/sui#7318
Dynamic 'type' and 'value' readability (Structural change to sui_getDynamicFields)

MystenLabs/sui#6989
Change to storing keys on disk (0.21.0) - FIXED in pysui 0.8.0

MystenLabs/sui#7052
This is causing fails in the deserialization of transaction events. Have temporary workaround - FIXED in pysui 0.9.0

Example:
in 0x2::dynamic_object_field module for function id has return type of Option<ID> but only seeing Option

Readying for sphinx doc

A number of new API were added.
sui_executeTransactionSerializedSig
sui_getTransactionAuthSigners

Subsciptions were also added but I'm deferring (see #40)

With the implementation of get_package (builder: GetPackage) that provides a richer result.

Enhance usability of SuiClient for basic queries (get_...) and executions (i.e. publish, call, pay etc.)

Discussed in #50

def get_gas(self, address: SuiAddress) -> list[SuiCoinObject]:
    """."""
    coin_type = SuiString("0x2::sui::SUI")
    result = self.execute(GetCoinTypeBalance(owner=address, coin_type=coin_type))
    if result.is_ok():
        limit = SuiInteger(result.result_data.items[0].coin_object_count)
        result = self.execute(GetCoins(owner=address, coin_type=coin_type, limit=limit))
        if result.is_ok():
            return result.result_data.data
    return []

Addresses: 4
Total Sui Coin Objects: 25
real	0m2.210s
user	0m0.627s
sys	0m0.079s

Addresses: 4
Total Sui Coin Objects: 25
real	0m0.966s
user	0m0.399s
sys	0m0.065s

Currently only supporting "AddressOwner" and not "ObjectOwner" and fails parse when using builder identified in title.

Stupid paste in haste of status return.

A good example is the new sui_payAllSui which is specific to SUI coin (i.e. 0x2::sui::SUI) whereas sui_pay is in any coin.

During the method execution, it inadvertently instantiates the wrong key-pair class.

1. For transactions, args are **kwargs... change to explicit argument
2. Readying for sphinx doc

Currently, transaction type builder's __init__ with **kwargs expects all arguments to be satisfied.

Change this to service the intersect of the builders specific keywords if any.

I had assumed that other numeric types would be forthcoming, and they still may, however the semantics of the current type lend itself to an abstract and not concrete type.

This will change in 0.0.11 so that SuiInteger is the concrete class of type SuiNumber the abstract type.

As synchronous RPC client is maturing adding an asynchronous RPC is needed.

Provide call to get gas from SUI faucet.

Example curl:

curl --location --request POST \
>   'http://faucet.devnet.sui.io/gas' \
>   --header 'Content-Type: application/json' \
>   --data-raw '{
>     "FixedAmountRequest": {
>       "recipient": "<ADDRESS>"
>     }
>   }'

While it updates the general 'address' str to SuiAddress dictionary, it neglected to update the 'address' str to keypair dictionary.

Poetry seems like a better alternative instead of using pure venvs manage the dev-requirements, requirements and publishing the package to pypi. It even uses pyproject.toml which is supported by new versions of python for management of config and dependencies. Also it's dependency resolver is very good. I'm willing to contribute to poetry migration too.

Discussed in #10

If we initiate SuiAsynchClient before running the main event loop or in different task, it raised the nested event loop error due to asyncio.get_event_loop() and loop.run_until_complete() method being used from asyncio. The code I've mentioned is used in

class SuiAsynchClient(_ClientMixin):
    """Sui Asyncrhonous Client."""

    def __init__(self, config: SuiConfig) -> None:
        """Client initializer."""
        super().__init__(config)
        self._client = httpx.AsyncClient(http2=True)
        self._rpc_api = {}
        self._schema_dict = {}
        loop = asyncio.get_event_loop()
        loop.run_until_complete(self._build_api_descriptors())

Using the synchronous version of self_build_api_descriptors() rather than loop.run_until_complete() will fix this issue as the risk of creation of multiple loops will be gone. Also the get_event_loop() method is deprecated too.

Remove cache dependencies on existing package lookups.

Quite a few changes are introduced with 0.20.0 including new and modified RPC API

The default SDK behavior is to create Rpc connection with devnet.

Extend to support alternate URL points, such as sui-node's 127.0.0.1:9000 to interface with

Readying for sphinx doc

Currently generating a new 'address' uses default derivation path and generates the seed mnemonic.

1. Provide support providing derivation paths and validate alignment to ed25519 and secp256k1 base paths
2. Provide support for key recovery from mnemonics with optional derivation path

With reference to feature

Caveats

1. Without sui binaries the publish capability is somewhat impossible in that the user would have to somehow build the binaries of the move package and pysui re-builds the source move code to ensure no test bits are included
   2. Need sui keytool for signing with MultiSign pending Roaring Bitmap sourcing

Note: The publish will fail at the RPC level if the base64 encoded binaries contain test bits

Removing redundancies and over complications

Update has two flavors:

1. Change breaks return value types, immediate fix: coin balance (pushed in 0.4.1)
2. Various other breaking changes: Will address in 0.4.2 weekend of Dec 17th, 2022

• The main issue is in transactions submitted for execution have a new data structure that needs to be encapsulated with the txbytes from the Builder execution. It also requires serializing/deserializing the txbytes using BCS.
• Other minor changes

2. New API altogether to add support in Builders and RPC interfaces

And a link to pastebin, in case you need it https://pastebin.com/9CsYNr44

I have to tell you right away that I have the SUI binaries installed.

1. I clone from the git to my computer
2. Setup environment
   python3 -m venv pysuienv
3. Activate
   source pysuienv/bin/activate
4. And try to load packages, but all that happens is that there are errors

Right now, only sui_getNormalizedMoveModulesByPackage is supported.

Need to cover:

sui_getMoveFunctionArgTypes
sui_getNormalizedMoveFunction
sui_getNormalizedMoveModule
sui_getNormalizedMoveStruct

Currently random seed is used. Want to use mnemonics for key recovery as well.

Support existing, new and emerging SUI RPC API

The former produces a 64 byte signature (python secp256k1) whereas the latter produces 65 bytes (rust fastcrypto)

Not sure why they are different. If can't resolve I will fall back to invoking sui keytool ... and scrapping resulting signature.

Missing coverage causes display of result to fail

Occurs during the type string parsing as it has a package type that wasn't accounted for...