Skip to content

chore: bump iota to v1.35.2 and iota-rust-sdk to 1.0.0-rc.2 - #355

Draft
eike-hass wants to merge 1 commit into
mainfrom
chore/bump-iota-v1.35.2
Draft

eike-hass wants to merge 1 commit into
mainfrom
chore/bump-iota-v1.35.2

Conversation

@eike-hass

Copy link
Copy Markdown
Collaborator

Summary

Moves the workspace, the examples and the three WASM bindings to iota v1.35.2 (the current mainnet release) and to the crates.io releases of the iota-rust-sdk crates (iota-sdk-types, iota-sdk-grpc-client and iota-sdk-move-types 1.0.0-rc.2, iota-sdk-grpc-types 1.0.0-rc.1), the set iota v1.35.2 depends on.

Depends on iotaledger/product-core#153. product-core is referenced by branch (chore/bump-iota-v1.35.2) until it is released, which is why this is a draft.

Breaking change: ProofV1 JSON

iota-sdk-types renamed several serde variants without aliases (CancelledTransactions to CanceledTransactions, 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.rs and 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

  • poi-rs: gRPC source ported to the builder-style GrpcClient API, TransactionEffects and TransactionEvents taken from iota-sdk-types, TransactionEnvelope and OwnedObjectReference changes followed.
  • audit-trail-rs, notarization-rs: the Move framework mirrors (UID, ID, VecMap, VecSet, LinkedTable, Node, Field) moved from iota-types to iota_sdk_move_types::iota_framework. LinkedTable now carries its value type (LinkedTable<u64, Record>, LinkedTable<ObjectId, u64>).
  • examples and WASM bindings: same renames.

Testing

CI steps reproduced against an iota v1.35.2 localnet started from the release binaries:

  • Move tests: Notarization 32/32, Audit Trails 97/97.
  • cargo test --workspace -- --test-threads=1: 214 passed (Audit Trails e2e 84, Notarization e2e 25, poi-rs 71).
  • All 32 Rust examples.
  • WASM: npm ci and npm run build for all three bindings, poi_wasm unit tests 24/24, Node examples Notarization 10, Audit Trails 15, Proof of Inclusion 6/6.
  • Proof of Inclusion against live networks with the poi CLI: proofs created by the old and the new build cross-verify on testnet (protocol 40), and a devnet consensus commit prologue proof is created and verified (protocol 40 with validator attestation).

Not run: Cypress browser tests, Rust tests in release mode.

Before merge

  • Release product-core and replace branch = "chore/bump-iota-v1.35.2" with the tag (root Cargo.toml and both notarization_wasm and audit_trail_wasm manifests), then cargo update -p product_common.

Seen while testing, unrelated to this PR

  • Clippy with Rust 1.100.0 fails the WASM bindings on main as well (clone_on_copy in wasm-bindgen getters, inherent_to_string), so the clippy job will likely be red here too.
  • WASM builds rewrite the key order of Move.history.json, and npm run grpc:generate in poi_wasm reformats the committed generated TypeScript.

Move the workspace and the WASM bindings to iota v1.35.2 and to the
crates.io releases of the iota-rust-sdk crates (iota-sdk-types,
iota-sdk-grpc-client and iota-sdk-move-types 1.0.0-rc.2,
iota-sdk-grpc-types 1.0.0-rc.1), the set iota v1.35.2 depends on.

product-core comes from its chore/bump-iota-v1.35.2 branch, which ports it
to the same versions. Switch to a product-core release tag before merging.

- poi-rs: port the gRPC source to the builder-style GrpcClient API, take
  TransactionEffects and TransactionEvents from iota-sdk-types, and follow
  the TransactionEnvelope and OwnedObjectReference changes.
- audit-trail-rs, notarization-rs: take the Move framework mirrors (UID,
  ID, VecMap, VecSet, LinkedTable, Node, Field) from
  iota_sdk_move_types::iota_framework. LinkedTable now carries its value
  type.
- examples and WASM bindings: follow the same renames.

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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant