diff --git a/README.md b/README.md index 7046560..2ec01a4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,39 @@ # Sui Sdk -[![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/) +A rust Sdk for integrating with the [Sui blockchain](https://docs.sui.io/). -A WIP from-scratch rust sdk for the sui blockchain +> [!NOTE] +> This is project is under development and many features may still be under +> development or missing. + +## Overview + +This repository contains a collection of libraries for integrating with the Sui blockchain. + +A few of the project's high-level goals are as follows: + +* **Be modular** - user's should only need to pay the cost (in terms of dependencies/compilation time) for the features that they use. +* **Be light** - strive to have a minimal dependency footprint. +* **Support developers** - provide all needed types, abstractions and APIs to enable developers to build robust applications on Sui. +* **Support wasm** - where possible, libraries should be usable in wasm environments. + +## Crates + +In an effort to be modular, functionality is split between a number of crates. + +* [`sui-sdk-types`](crates/sui-sdk-types) + [![sui-sdk-types on crates.io](https://img.shields.io/crates/v/sui-sdk-types)](https://crates.io/crates/sui-sdk-types) + [![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/sui-sdk-types) + [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/) +* [`sui-crypto`](crates/sui-crypto) + [![sui-crypto on crates.io](https://img.shields.io/crates/v/sui-crypto)](https://crates.io/crates/sui-crypto) + [![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/sui-crypto) + [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://mystenlabs.github.io/sui-rust-sdk/sui_crypto/) +* [`sui-graphql-client`](crates/sui-crypto) + [![sui-graphql-client on crates.io](https://img.shields.io/crates/v/sui-graphql-client)](https://crates.io/crates/sui-graphql-client) + [![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/sui-graphql-client) + [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://mystenlabs.github.io/sui-rust-sdk/sui-graphql-client/) + +## License + +This project is available under the terms of the [Apache 2.0 license](LICENSE). diff --git a/crates/sui-crypto/CHANGELOG.md b/crates/sui-crypto/CHANGELOG.md new file mode 100644 index 0000000..31b8305 --- /dev/null +++ b/crates/sui-crypto/CHANGELOG.md @@ -0,0 +1,3 @@ +# 0.0.1 - 2024-09-25 + +Initial release diff --git a/crates/sui-crypto/Cargo.toml b/crates/sui-crypto/Cargo.toml index 8e52734..ec33f9a 100644 --- a/crates/sui-crypto/Cargo.toml +++ b/crates/sui-crypto/Cargo.toml @@ -1,10 +1,12 @@ [package] name = "sui-crypto" -version = "0.0.0" +version = "0.0.1" authors = ["Brandon Williams "] +repository = "https://github.com/mystenlabs/sui-rust-sdk/" license = "Apache-2.0" edition = "2021" -publish = false +readme = "README.md" +description = "Defines the interface for signing and verying messages in the Sui ecosystem" [package.metadata.docs.rs] # To build locally: @@ -43,7 +45,7 @@ zklogin = [ [dependencies] signature = "2.2" -sui-sdk-types = { version = "0.0.0", path = "../sui-sdk-types", default-features = false } +sui-sdk-types = { version = "0.0.1", path = "../sui-sdk-types", default-features = false } # RNG support rand_core = { version = "0.6.4", optional = true } diff --git a/crates/sui-crypto/README.md b/crates/sui-crypto/README.md new file mode 100644 index 0000000..84a02d5 --- /dev/null +++ b/crates/sui-crypto/README.md @@ -0,0 +1,8 @@ +# sui-crypto + +[![sui-crypto on crates.io](https://img.shields.io/crates/v/sui-crypto)](https://crates.io/crates/sui-crypto) +[![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/sui-crypto) +[![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://mystenlabs.github.io/sui-rust-sdk/sui_crypto/) + +The `sui-crypto` crate provides the interface for signing and verifying +transactions and messages in the Sui ecosystem. diff --git a/crates/sui-graphql-client/CHANGELOG.md b/crates/sui-graphql-client/CHANGELOG.md new file mode 100644 index 0000000..31b8305 --- /dev/null +++ b/crates/sui-graphql-client/CHANGELOG.md @@ -0,0 +1,3 @@ +# 0.0.1 - 2024-09-25 + +Initial release diff --git a/crates/sui-graphql-client/README.md b/crates/sui-graphql-client/README.md index 316b7ae..894c25b 100644 --- a/crates/sui-graphql-client/README.md +++ b/crates/sui-graphql-client/README.md @@ -1,3 +1,9 @@ +# sui-graphql-client + +[![sui-graphql-client on crates.io](https://img.shields.io/crates/v/sui-graphql-client)](https://crates.io/crates/sui-graphql-client) +[![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/sui-graphql-client) +[![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://mystenlabs.github.io/sui-rust-sdk/sui-graphql-client/) + The Sui GraphQL client is a client for interacting with the Sui blockchain via GraphQL. It provides a set of APIs for querying the blockchain for information such as chain identifier, reference gas price, protocol configuration, service configuration, checkpoint, epoch, diff --git a/crates/sui-sdk-types/CHANGELOG.md b/crates/sui-sdk-types/CHANGELOG.md new file mode 100644 index 0000000..31b8305 --- /dev/null +++ b/crates/sui-sdk-types/CHANGELOG.md @@ -0,0 +1,3 @@ +# 0.0.1 - 2024-09-25 + +Initial release diff --git a/crates/sui-sdk-types/Cargo.toml b/crates/sui-sdk-types/Cargo.toml index c0be8f8..7af10b1 100644 --- a/crates/sui-sdk-types/Cargo.toml +++ b/crates/sui-sdk-types/Cargo.toml @@ -1,12 +1,12 @@ [package] name = "sui-sdk-types" -version = "0.0.0" +version = "0.0.1" authors = ["Brandon Williams "] +repository = "https://github.com/mystenlabs/sui-rust-sdk/" license = "Apache-2.0" edition = "2021" -publish = false readme = "README.md" -description = "Sdk for the Sui Blockchain" +description = "Core types for the Sui Sdk" [package.metadata.docs.rs] # To build locally: diff --git a/crates/sui-sdk-types/README.md b/crates/sui-sdk-types/README.md new file mode 100644 index 0000000..8d4f97d --- /dev/null +++ b/crates/sui-sdk-types/README.md @@ -0,0 +1,8 @@ +# sui-sdk-types + +[![sui-sdk-types on crates.io](https://img.shields.io/crates/v/sui-sdk-types)](https://crates.io/crates/sui-sdk-types) +[![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/sui-sdk-types) +[![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/) + +The `sui-sdk-types` crate provides the definitions of the core types that are +part of the public API of the Sui blockchain.