Pull upstream changes

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
   workflow_dispatch:
   schedule: [cron: "40 1 * * *"]
 
@@ -43,18 +44,18 @@ jobs:
       - name: Install latest nightly
         run: rustup toolchain install nightly --component rustfmt --allow-downgrade
 
-      - name: feature compatibility
-        run: make check-features
-
       - name: rustfmt
-        run: cargo +nightly fmt -- --check
+        run: make check-fmt
 
       - name: clippy
         run: make clippy
 
       - name: rustdoc
         run: make doc
 
+      - name: feature compatibility
+        run: make check-features
+
   wasm:
     runs-on: ubuntu-latest
 
@@ -64,6 +65,7 @@ jobs:
 
       - name: rust version
         run: |
+          rustup default 1.82.0
           rustc --version
           cargo --version
 
@@ -74,3 +76,56 @@ jobs:
 
       - name: Run tests in wasm
         run: make wasm
+
+  run_tests_with_network:
+    runs-on: ubuntu-latest
+    env:
+      EPOCH_DURATION_MS: 10000
+    services:
+      postgres: # we need this postgres instance for running a local network with indexer and graphql
+        image: postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgrespw
+          POSTGRES_DB: iota_indexer_v2
+          POSTGRES_HOST_AUTH_METHOD: trust
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: rust version
+        run: |
+          rustc --version
+          cargo --version
+
+      - uses: taiki-e/install-action@cargo-nextest
+
+      - name: Get the IOTA testnet binary and start a local network
+        shell: bash
+        env:
+          IOTA_BINARY_VERSION: "v0.12.0-rc" # used for downloading a specific IOTA binary version that matches the GraphQL schema for local network tests
+        run: |
+          ASSET_NAME="iota-$IOTA_BINARY_VERSION-linux-x86_64.tgz"
+          download_url="https://github.com/iotaledger/iota/releases/download/$IOTA_BINARY_VERSION/$ASSET_NAME"
+
+          echo "Downloading testnet binary from $download_url"
+          wget -q $download_url -O iota.tgz
+          tar -zxvf iota.tgz ./iota
+          chmod +x ./iota
+          echo "Starting local network with a faucet, an indexer (port 5432) and GraphQL. Epoch duration is set to $EPOCH_DURATION_MS ms"
+          echo "$(pwd)" >> $GITHUB_PATH # we need it on the path for calling iota move build for some tests
+          ./iota start --force-regenesis --with-faucet --with-indexer --with-graphql --pg-port 5432 --pg-db-name iota_indexer_v2 --epoch-duration-ms $EPOCH_DURATION_MS &
+
+      - name: Run tests that require local network (GraphQL Client and Tx Builder)
+        env:
+          NETWORK: "local" # other expected options are mainnet, testnet, or devnet, or an actual URL to a GraphQL server: http://localhost:port
+        run: |
+          sleep $((EPOCH_DURATION_MS / 1000)) # wait for the network to get to epoch #2
+          make test-with-localnet

.github/workflows/rustdoc.yml

@@ -2,7 +2,7 @@ name: rustdoc
 
 on:
   push:
-    branches: [main]
+    branches: [develop]
   workflow_dispatch:
 
 env:

Makefile

@@ -1,46 +1,64 @@
 # Set the default target of this Makefile
 .PHONY: all
-all:: ci
+all:: ci ## Default target, runs the CI process
 
 .PHONY: check-features
-check-features:
-	$(MAKE) -C crates/iota-rust-sdk check-features
+check-features: ## Check feature flags for crates
+	$(MAKE) -C crates/iota-sdk-types check-features
+	$(MAKE) -C crates/iota-crypto check-features
 
 .PHONY: check-fmt
-check-fmt:
-	cargo fmt -- --check
+check-fmt: ## Check code formatting
+	cargo +nightly fmt -- --check
+
+.PHONY: fmt
+fmt: ## Format code
+	cargo +nightly fmt
 
 .PHONY: clippy
-clippy:
+clippy: ## Run Clippy linter
 	cargo clippy --all-features --all-targets
 
 .PHONY: test
-test:
-	cargo nextest run --all-features
+test: ## Run unit tests
+	cargo nextest run --all-features -p iota-sdk-types -p iota-crypto
 	cargo test --doc
 
+package_%.json: crates/iota-transaction-builder/tests/%/Move.toml crates/iota-transaction-builder/tests/%/sources/*.move ## Generate JSON files for tests
+	cd crates/iota-transaction-builder/tests/$(*F) && iota move build --ignore-chain --dump-bytecode-as-base64 > ../../$@
+
+.PHONY: test-with-localnet
+test-with-localnet: package_test_example_v1.json package_test_example_v2.json ## Run tests with localnet
+	cargo nextest run -p iota-graphql-client -p iota-transaction-builder
+
 .PHONY: wasm
-wasm:
-	$(MAKE) -C crates/iota-rust-sdk wasm
+wasm: ## Build WASM modules
+	$(MAKE) -C crates/iota-sdk-types wasm
+	$(MAKE) -C crates/iota-crypto wasm
 
 .PHONY: doc
-doc:
+doc: ## Generate documentation
 	RUSTDOCFLAGS="--cfg=doc_cfg -Zunstable-options --generate-link-to-definition" RUSTC_BOOTSTRAP=1 cargo doc --all-features --no-deps
 
 .PHONY: doc-open
-doc-open:
+doc-open: ## Generate and open documentation
 	RUSTDOCFLAGS="--cfg=doc_cfg -Zunstable-options --generate-link-to-definition" RUSTC_BOOTSTRAP=1 cargo doc --all-features --no-deps --open
 
 .PHONY: ci
-ci: check-features check-fmt test wasm
+ci: check-features check-fmt test wasm ## Run the full CI process
 
 .PHONY: ci-full
-ci-full: ci doc
+ci-full: ci doc ## Run the full CI process and generate documentation
 
 .PHONY: clean
-clean:
+clean: ## Clean build artifacts
 	cargo clean
 
 .PHONY: clean-all
-clean-all: clean
-	git clean -dX
+clean-all: clean ## Clean all generated files, including those ignored by Git. Force removal.
+	git clean -dXf
+
+.PHONY: help
+help: ## Show this help
+	@echo "Available targets:"
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)

README.md

@@ -1,5 +1,39 @@
 # IOTA Sdk
 
-[![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://github.com/iotaledger/iota-rust-sdk/iota_sdk/)
+A Rust SDK for integrating with the [IOTA blockchain](https://docs.iota.org/).
 
-A WIP from-scratch rust sdk for the IOTA 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 IOTA 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 IOTA.
+- **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.
+
+- [`iota-sdk-types`](crates/iota-sdk-types)
+  [![iota-sdk-types on crates.io](https://img.shields.io/crates/v/iota-sdk-types)](https://crates.io/crates/iota-sdk-types)
+  [![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/iota-sdk-types)
+  [![Documentation (develop)](https://img.shields.io/badge/docs-develop-59f)](https://github.com/iotaledger/iota-rust-sdk/iota_sdk_types/)
+- [`iota-crypto`](crates/iota-crypto)
+  [![iota-crypto on crates.io](https://img.shields.io/crates/v/iota-crypto)](https://crates.io/crates/iota-crypto)
+  [![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/iota-crypto)
+  [![Documentation (develop)](https://img.shields.io/badge/docs-develop-59f)](https://github.com/iotaledger/iota-rust-sdk/iota_crypto/)
+- [`iota-graphql-client`](crates/iota-crypto)
+  [![iota-graphql-client on crates.io](https://img.shields.io/crates/v/iota-graphql-client)](https://crates.io/crates/iota-graphql-client)
+  [![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/iota-graphql-client)
+  [![Documentation (develop)](https://img.shields.io/badge/docs-develop-59f)](https://github.com/iotaledger/iota-rust-sdk/iota-graphql-client/)
+
+## License
+
+This project is available under the terms of the [Apache 2.0 license](LICENSE).

crates/iota-crypto/Cargo.toml

@@ -0,0 +1,106 @@
+[package]
+name = "iota-crypto"
+version = "0.0.0"
+authors = ["IOTA Foundation <[email protected]>"]
+edition = "2021"
+license = "Apache-2.0"
+readme = "README.md"
+repository = "https://github.com/iotaledger/iota-rust-sdk/"
+description = "Defines the interface for signing and verifying messages in the IOTA ecosystem"
+
+[package.metadata.docs.rs]
+# To build locally:
+# RUSTDOCFLAGS="--cfg=doc_cfg -Zunstable-options --generate-link-to-definition" RUSTC_BOOTSTRAP=1 cargo doc --all-features --no-deps --open
+all-features = true
+rustdoc-args = [
+  # Enable doc_cfg showing the required features.
+  "--cfg=doc_cfg",
+
+  # Generate links to definition in rustdoc source code pages
+  # https://github.com/rust-lang/rust/pull/84176
+  "-Zunstable-options",
+  "--generate-link-to-definition",
+]
+
+[features]
+default = []
+ed25519 = ["dep:ed25519-dalek", "dep:rand_core"]
+secp256r1 = ["dep:p256", "dep:rand_core"]
+passkey = ["secp256r1", "dep:sha2"]
+secp256k1 = ["dep:k256", "dep:rand_core", "signature/std"]
+zklogin = [
+  "dep:ark-bn254",
+  "dep:ark-ff",
+  "dep:ark-groth16",
+  "dep:ark-snark",
+  "dep:ark-std",
+  "dep:base64ct",
+  "dep:bnum",
+  "dep:itertools",
+  "dep:serde",
+  "dep:serde_derive",
+  "dep:serde_json",
+  "signature/std",
+]
+pem = [
+  "dep:pkcs8",
+  "dep:pem-rfc7468",
+  "ed25519-dalek?/pkcs8",
+  "p256?/pkcs8",
+  "k256?/pkcs8",
+  "ed25519-dalek?/pem",
+  "p256?/pem",
+  "k256?/pem",
+]
+
+[dependencies]
+iota-sdk-types = { version = "0.0.0", path = "../iota-sdk-types", default-features = false, features = ["hash", "serde"] }
+signature = "2.2"
+
+# RNG support
+rand_core = { version = "0.6.4", optional = true }
+
+# ed25519 support
+ed25519-dalek = { version = "2.1.1", optional = true }
+
+# secp256r1 support
+p256 = { version = "0.13.2", default-features = false, features = ["ecdsa", "std"], optional = true }
+
+# passkey verification support
+sha2 = { version = "0.10.8", optional = true }
+
+# secp256k1 support
+k256 = { version = "0.13.4", default-features = false, features = ["ecdsa"], optional = true }
+
+# zklogin verification support
+ark-bn254 = { version = "0.4.0", optional = true }
+ark-ff = { version = "0.4.2", features = ["asm"], optional = true }
+ark-groth16 = { version = "0.4.0", default-features = false, optional = true }
+ark-snark = { version = "0.4.0", optional = true }
+ark-std = { version = "0.4.0", optional = true }
+base64ct = { version = "1.6.0", features = ["alloc"], optional = true }
+bnum = { version = "0.12.0", optional = true }
+itertools = { version = "0.13.0", optional = true }
+serde = { version = "1.0.210", optional = true }
+serde_derive = { version = "1.0.210", optional = true }
+serde_json = { version = "1.0.128", optional = true }
+
+# pkcs8 der and pem support
+pem-rfc7468 = { version = "0.7", optional = true, features = ["std"] }
+pkcs8 = { version = "0.10", optional = true, features = ["std"] }
+
+[dev-dependencies]
+bcs = { version = "0.1.6" }
+hex = "0.4.3"
+serde_json = { version = "1.0.128" }
+
+# proptest support in tests
+proptest = { version = "1.6.0", default-features = false, features = ["std"] }
+test-strategy = "0.4.0"
+
+[target.wasm32-unknown-unknown.dev-dependencies]
+wasm-bindgen-test = "0.3"
+getrandom = { version = "0.2", features = ["js"] }
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(doc_cfg)'] }

crates/iota-crypto/Makefile

@@ -0,0 +1,23 @@
+# Set the default target of this Makefile
+.PHONY: all
+all:: check-features clippy test wasm
+
+.PHONY: check-features
+check-features:
+	cargo hack check --feature-powerset --no-dev-deps
+
+.PHONY: clippy
+clippy:
+	cargo clippy --all-features --all-targets
+
+.PHONY: test
+test:
+	cargo nextest run --all-features
+	cargo test --doc
+
+.PHONY: wasm
+wasm:
+	CC=clang wasm-pack test -r --node --all-features
+
+%:
+	$(MAKE) -C ../.. $@

crates/iota-crypto/README.md

@@ -0,0 +1,8 @@
+# iota-crypto
+
+[![iota-crypto on crates.io](https://img.shields.io/crates/v/iota-crypto)](https://crates.io/crates/iota-crypto)
+[![Documentation (latest release)](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.rs/iota-crypto)
+[![Documentation (develop)](https://img.shields.io/badge/docs-develop-59f)](https://github.com/iotaledger/iota-rust-sdk/iota_crypto/)
+
+The `iota-crypto` crate provides the interface for signing and verifying
+transactions and messages in the IOTA ecosystem.

crates/iota-crypto/src/bls12381.rs

@@ -0,0 +1,11 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2025 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+#[derive(Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
+pub struct Bls12381PrivateKey([u8; Self::LENGTH]);
+
+impl Bls12381PrivateKey {
+    /// The length of an bls12381 private key in bytes.
+    pub const LENGTH: usize = 32;
+}