diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..804cc2d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Intrinsic Technologies, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/circuit/Cargo.toml b/circuit/Cargo.toml index b67e507..264b5ea 100644 --- a/circuit/Cargo.toml +++ b/circuit/Cargo.toml @@ -2,6 +2,8 @@ name = "axiom-circuit" version = "0.1.0" edition = "2021" +description = "Lower-level API for writing Axiom compute circuits" +license = "MIT" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html @@ -22,4 +24,4 @@ num-bigint = "0.4.4" num-integer = "0.1.45" [dev-dependencies] -test-case = "*" +test-case = "3.3.1" diff --git a/readme.md b/readme.md index 9a30b5e..a56a8f4 100644 --- a/readme.md +++ b/readme.md @@ -4,7 +4,7 @@ This repository is split into 3 components: - `sdk`: User-friendly API for writing Axiom compute circuits - `circuit`: Lower-level API for writing Axiom compute circuits -- `sdk-derive`: Procedural macros to for writing circuits with axiom-sdk +- `sdk-derive`: Procedural macros for writing Axiom compute functions with axiom-sdk ## axiom-sdk @@ -12,7 +12,7 @@ This repository is split into 3 components: To install our Rust circuit SDK into a Cargo project, run: ```bash -cargo add axiom-sdk --git https://github.com/axiom-crypto/axiom-sdk-rs +cargo add axiom-sdk ``` ### Overview diff --git a/sdk-derive/Cargo.toml b/sdk-derive/Cargo.toml index 7127204..3a30ae2 100644 --- a/sdk-derive/Cargo.toml +++ b/sdk-derive/Cargo.toml @@ -2,11 +2,13 @@ name = "axiom-sdk-derive" version = "0.1.0" edition = "2021" +license = "MIT" +description = "Procedural macros for writing Axiom compute functions with axiom-sdk" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -syn = "2.0.43" +syn = {version = "2.0.43", features=["full"]} quote = "1.0.33" proc-macro2 = "1.0.72" diff --git a/sdk-derive/src/input.rs b/sdk-derive/src/input.rs index df637b9..02263d5 100644 --- a/sdk-derive/src/input.rs +++ b/sdk-derive/src/input.rs @@ -23,7 +23,7 @@ pub fn impl_new_struct(ast: &ItemStruct) -> Result { .map(|field| field.ty.to_token_stream()) .collect(); - let field_names: Vec<_> = fields + let field_names: Vec = fields .iter() .map(|field| { if let Some(ref field) = field.ident { diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml index e757460..02951b9 100644 --- a/sdk/Cargo.toml +++ b/sdk/Cargo.toml @@ -2,12 +2,15 @@ name = "axiom-sdk" version = "0.1.0" edition = "2021" +license = "MIT" +description = "User-friendly API for writing Axiom compute circuits" +readme = "../readme.md" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -axiom-circuit = { path = "../circuit" } -axiom-sdk-derive = { path = "../sdk-derive" } +axiom-circuit = { version="0.1.0", path = "../circuit" } +axiom-sdk-derive = { version="0.1.0", path = "../sdk-derive" } ethers = "2.0" anyhow = "1.0.75" serde = { version = "1.0", features = ["derive"] } diff --git a/sdk/src/lib.rs b/sdk/src/lib.rs index 0da7dcf..d6c0b2b 100644 --- a/sdk/src/lib.rs +++ b/sdk/src/lib.rs @@ -4,7 +4,7 @@ //! //! To install our Rust circuit SDK into a Cargo project, run: //! ```bash -//! cargo add axiom-sdk --git https://github.com/axiom-crypto/axiom-sdk-rs +//! cargo add axiom-sdk //! ``` //! //! ### Overview @@ -26,7 +26,7 @@ //! //! ```ignore //! #[AxiomComputeInput] -//! pub struct AccountAgeInput { +//! pub struct AccountAgeInput { //! pub addr: Address, //! pub claimed_block_number: u64, //! }