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.
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.
Summary
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.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 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.Breaking change: ProofV1 JSON
iota-sdk-typesrenamed several serde variants without aliases (CancelledTransactionstoCanceledTransactions,UnchangedSharedKind::Cancelled,ExecutionCancelledDueTo*,MoveAuthenticationError). Proof JSON that contains them does not deserialize across this upgrade in either direction. That covers every consensus commit prologue proof and proofs of canceled transactions or of failed transactions with the renamed errors. Proofs of ordinary programmable transactions are unaffected (byte-identical output before and after on testnet).Backwards compatibility is not provided, so
proof.rsand both Proof of Inclusion READMEs now state that the format is not stable before 1.0. The frozen V1 fixtures stay green because they contain none of the renamed variants.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.Testing
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, 24 unit tests, 6 Node examples.Not run: release-mode builds and Windows (CI covers both). All localnet proofs are in epoch 0, so the committee walk across an epoch change is covered by the poi-rs tests only.
Release
@iota/proof-of-inclusion(npm): 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.Seen while testing, unrelated to this PR
mainas well (2clone_on_copyin wasm-bindgen getters), so that job will likely stay red.Move.history.json, andnpm run grpc:generatein poi_wasm reformats the committed generated TypeScript.