Repository navigation
Conversation
Move poi-rs into its own Cargo workspace (own Cargo.lock, excluded from the root workspace) and bump only Proof of Inclusion to iota v1.35.2 and to the crates.io releases of the iota-rust-sdk crates (iota-sdk-types and iota-sdk-grpc-client 1.0.0-rc.2, iota-sdk-grpc-types 1.0.0-rc.1). Single Notarization, Audit Trails and product-core stay on iota v1.29.0. - poi-rs: standalone manifest, gRPC source ported to the builder-style GrpcClient API, TransactionEffects and TransactionEvents taken from iota-sdk-types, TransactionEnvelope and OwnedObjectReference changes followed. - poi_wasm: same pins (iota-sdk-types pinned exactly, the package has no tracked lockfile) and renames. - examples: the Proof of Inclusion examples take the newer types through renamed dependencies (poi-iota-*) and carry the identifiers of the notarization they prove over by their bytes. - CI: check, build (all platforms), test, clippy, fmt, docs and cargo audit cover the poi-rs workspace, and the scheduled dependency refresh updates both lockfiles. poi-rs builds into the shared target dir. - Docs and housekeeping: README, fixture and CLAUDE.md commands use --manifest-path poi-rs/Cargo.toml, poi-rs/target is ignored, and the root workspace drops dependencies only poi-rs used. BREAKING CHANGE: iota-sdk-types renamed several serde variants (for example CancelledTransactions to CanceledTransactions), so ProofV1 JSON that contains them does not deserialize across this upgrade in either direction. The proof format is now documented as unstable before 1.0.
iota-sdk-types 1.0.0-rc.1 renamed six identifiers that can occur in a proof: CancelledTransactions and cancelled_transactions in the consensus commit prologue, the Cancelled kind of unchanged shared objects, the three ExecutionCancelledDueTo* errors and MoveAuthenticationError. Their BCS encoding is unchanged. Keep the documented ProofV1 compatibility contract and add a version 2 format instead: - ProofV2 has the same fields and serializes with the current names. ProofBuilder creates it. - ProofV1 reads and writes its original names through a JSON rename limited to the places where the affected types occur, so existing proofs deserialize, verify and round-trip unchanged. ProofV2::from converts a version 1 proof. - Fixtures: a version 1 consensus commit prologue proof generated on the v1.29 release that contains the old names, and a v2 directory with every v1 fixture converted. Unit tests check each renamed identifier against JSON produced by both SDK versions. - poi_wasm tests cover both versions. The docs restore the compatibility contract and describe version 2. Proofs created by this release are ProofV2, which earlier releases cannot read.
Patch and minor updates in poi-rs/Cargo.lock for current RustSec advisories, so the cargo audit step for this lockfile passes: libz-sys 1.1.33, pulldown-cmark 0.13.6, quinn-proto 0.11.19, quinn-udp 0.5.16, rustls-webpki 0.103.17, webpki-root-certs and webpki-roots 1.0.12, zstd 0.13.5, zstd-safe 7.4.1, zstd-sys 2.1.3. RUSTSEC-2026-0387 (crypto-bigint 0.5) has no patched release and is ignored repository-wide.
5 tasks done
- poi-rs and poi_wasm crates 0.2.0-alpha, @iota/proof-of-inclusion 0.2.0. The Rust API now uses IOTA v1.35.2 and iota-rust-sdk types and the builder-style gRPC client, and new proofs use format version 2, which 0.1.x cannot read. Release tags: poi-v0.2.0 and a moving poi-v0.2. - rust-version 1.95 for both crates, READMEs updated. iota-types v1.35.2 pulls in sysinfo 0.39.6, which requires Rust 1.95 (cargo +1.94 refuses the locked tree). poi_wasm alone needs 1.90 and is aligned to one number.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of change
Fast path for Proof of Inclusion: poi-rs becomes its own Cargo workspace (own
Cargo.lock, excluded from the root workspace) and moves on its own to iota v1.35.2 (the current mainnet release) and to the crates.io releases of the iota-rust-sdk crates it uses (iota-sdk-typesandiota-sdk-grpc-client1.0.0-rc.2,iota-sdk-grpc-types1.0.0-rc.1). Single Notarization, Audit Trails and product-core stay on iota v1.29.0, so this needs no product-core release.Proof of Inclusion does not depend on product-core. In the shared workspace it still had to follow product-core's iota version, because one lockfile allows one version of
iota-types. As its own workspace it can follow node and SDK releases independently, and the root workspace no longer compilestest-cluster.This is the isolated alternative to the Proof of Inclusion part of #355, which bumps the whole workspace and waits for iotaledger/product-core#153. Both change poi-rs, so whichever merges second needs a rebase. If this one goes first, #355 keeps the Single Notarization, Audit Trails and product-core bump only.
Proof format version 2
iota-sdk-types1.0.0-rc.1 renamed six identifiers that can occur in a proof:CancelledTransactionsandcancelled_transactionsin the consensus commit prologue, theCancelledkind of unchanged shared objects, the threeExecutionCancelledDueTo*errors andMoveAuthenticationError. Their binary (BCS) encoding is unchanged, so signatures and verification are unaffected, but their JSON names differ.Following the compatibility contract in
proof.rs, this adds aProofV2variant instead of changingProofV1:ProofBuildercreatesProofV2proofs, which use the current names.ProofV1proofs keep their original JSON: reading maps the six old names to the current ones and writing maps them back, limited to the places in a proof where those types occur. Existing proofs deserialize, verify and round-trip unchanged.ProofV2::fromconverts a version 1 proof.ProofV2proofs (unknown variant ProofV2), so consumers that exchange proofs with older versions need to upgrade first.The
BREAKING CHANGE:footer of the first commit predatesProofV2and is wrong now (version 1 proofs keep working). Please replace it in the squash commit message with:Changes
[workspace], explicit dependency versions, own fastcrypto patch, ownCargo.lock), gRPC source ported to the builder-styleGrpcClientAPI,TransactionEffectsandTransactionEventstaken fromiota-sdk-types,TransactionEnvelopeandOwnedObjectReferencechanges followed.iota-sdk-typesis pinned exactly because the package has no tracked lockfile.poi-iota-grpc-client,poi-iota-sdk-types,poi-iota-types) and carry the identifiers of the notarization they prove over by their bytes. The examples crate is the only place that builds both iota versions.target/doc, so the published docs keeppoi_rs) andcargo auditofpoi-rs/Cargo.lock. The scheduled dependency refresh updates both lockfiles.CLAUDE.mdcommands use--manifest-path poi-rs/Cargo.toml.poi-rs/targetis ignored. Both Proof of Inclusion READMEs describeProofV2.v2fixture directory, unit tests that check each renamed identifier against JSON produced by both SDK versions, and poi_wasm tests for both versions.poi-rsandpoi_wasmcrates0.2.0-alpha,@iota/proof-of-inclusion0.2.0.rust-version1.95 for both crates (sysinfo0.39.6 fromiota-typesrequires it), READMEs updated.poi-rs/Cargo.lock: patch updates ofquinn,rustls-webpki,webpki-roots,zstd,libz-sysandpulldown-cmarkfor current RustSec advisories, so the newcargo auditstep for this lockfile passes.Release
poi-v0.2.0and a movingpoi-v0.2, asv0.1andtrails-v0.1do for the other components.@iota/proof-of-inclusion(npm): 0.2.0, releasable after merge through the Wasm publish workflow (package: proof-of-inclusion).iota-types, andiota-configbehind theclifeature). The Rust publish workflow runs cargo-release on the root workspace and no longer includes poi-rs, which it could not publish before either.Links to any relevant issues
cargo test --workspaceno longer compilestest-cluster, CI runs all Proof of Inclusion test-cluster tests single-threaded on Ubuntu, and the epoch-transition and multi-epoch tests are unchanged.iota-sdk-crypto1.0.0-rc.2 shipsCommitteeChainVerifier(feat(crypto)!: add CommitteeChainVerifier iota-rust-sdk#1298) and is the version this PR aligns to. Delegating the epoch-close verification to it is a follow-up.main, fixed in chore: fix CI on main for Rust 1.100 and current RustSec advisories #359:clippyon the Wasm bindings (new lints in Rust 1.100),audit(current RustSec advisories, and RUSTSEC-2026-0387 from RUSTSEC-2026-0387: Multiple timing variability issues in operations intended to be constant-time #350, which upstream also ignores) the Windows build (sccache exceeds the Windows command-line limit with cargo 1.100) andformat(cargo installuses the 2022 lockfile of cargo-license-template since cargo 1.100). PR checks run on the merge withmain, so these jobs turn green here once that lands.Type of change
Rust users get IOTA v1.35.2 and iota-rust-sdk types in the public API, the builder-style gRPC client and Rust 1.95 as the minimum. Existing proofs keep working. New proofs use format version 2, which earlier releases cannot read.
How the change has been tested
CI steps reproduced against an iota v1.35.2 localnet started from the release binaries:
cargo test --workspace -- --test-threads=1(132 tests including the Single Notarization and Audit Trails e2e suites), all 32 Rust examples. The 7 Proof of Inclusion examples notarize with the v1.29 client and prove with poi-rs on v1.35.2.-D warnings, fmt, docs. ThepoiCLI creates and verifies a live testnet proof.npm ci,npm run build, 30 unit tests (both proof versions), 6 Node examples, which create and verify version 2 proofs.Not run locally: release-mode builds, Windows and macOS (CI covers them). All localnet proofs are in epoch 0, so the committee walk across an epoch change is covered by the poi-rs tests only.
To reproduce the Proof of Inclusion part:
Change checklist