Revise chain parameters #343

td202 · 2025-10-15T12:47:56Z

Purpose

Closes COR-775

Revise the ChainParameters type to expose all fields as optional, rather than through multiple variants.

Changes

Replaced ChainParameters with a new struct, and introduced helpers and conversions.
Add testing for conversions from protobuf types.
Migration guide.

Checklist

My code follows the style of this project.
The code compiles without warnings.
I have performed a self-review of the changes.
I have documented my code, in particular the intent of the
hard-to-understand areas.
(If necessary) I have updated the CHANGELOG.

…parameters

allanbrondum · 2025-10-17T13:17:14Z

CHANGELOG.md

  - Type `Event`/`BakerPoolInfo` field `open_status` is now wrapped in `Upward`.
  - Bubble `Upward` from new variants of `VerifyKey` to `Upward<AccountCredentialWithoutProofs<...>>` in `AccountInfo::account_credentials`.

+- BREAKING: Remove types associated with discontinued V1 API:


What does V1 and V2 API mean in the current codebase?

Isn't V2 the gPRC/protobuf API?

And the types used by the gRPC/protobuf API (the non-protobuf types that we convert to from the generated protobuf types) are also located in types and not necessarility in v2? (just to align on where we put types)

V2 is the current gRPC/protobuf API, yes. V1 was the old API that was often JSON inside protobuf (it was removed in Node version 6.2.1). It could make sense to move ChainParameters from v2 to types (and the associated definitions), since that's largely where the types belong. It's a little bit confused because there were two ChainParameters types (one in types and one in v2).

Shouldn't we put all the new types in types and not in v2 then? It seems a bit confusing to add types in v2 module?

src/types/queries.rs

src/v2/mod.rs

…rdium-rust-sdk into revise-chain-parameters

…in only optional items).

allanbrondum · 2025-10-21T09:20:52Z

CHANGELOG.md

  - Bubble `Upward` from new variants of `VerifyKey` to `Upward<AccountCredentialWithoutProofs<...>>` in `AccountInfo::account_credentials`.

+- BREAKING: Remove types associated with discontinued V1 API:
+  - `types::BlockSummary`;


Is the removal of BlockSummary and the related types in UpdateQueue unrelated to the other changes? It seems it could have been a separate PR (just for another time)

allanbrondum · 2025-10-21T09:34:30Z

src/v2/mod.rs

+impl TryFrom<MintDistribution> for types::MintDistributionV1 {
+    type Error = MintDistributionConversionError;
+    fn try_from(value: MintDistribution) -> Result<Self, Self::Error> {
+        let baking_reward =
+            value
+                .baking_reward
+                .ok_or(MintDistributionConversionError::MissingField(
+                    "baking_reward",
+                ))?;
+        let finalization_reward =
+            value
+                .finalization_reward
+                .ok_or(MintDistributionConversionError::MissingField(
+                    "finalization_reward",
+                ))?;
+        Ok(Self {
+            baking_reward,
+            finalization_reward,
+        })
+    }


Are the conversions into base types needed? I mean is it justified that we maintain this code and these conversions? Or do we want a general policy that you can convert SDK types into base types and just always implement the conversions?

src/v2/conversions.rs

src/types/queries.rs

allanbrondum · 2025-10-21T09:57:28Z

src/lib.md

+For signing chain updates, use [`construct_update_signer()`](v2::Level2Keys::construct_update_signer), for instance as:
+
+```rust,no_compile
+let params = client
+    .get_block_chain_parameters(&BlockIdentifier::LastFinal)
+    .await
+    .context("Could not obtain chain parameters")?;
+
+let keys = params
+    .response
+    .keys
+    .level_2_keys
+    .context("No level 2 keys in chain parameters.")?;
+
+let signer = keys
+    .construct_update_signer(
+        keys.micro_ccd_per_euro
+            .as_ref()
+            .context("Missing uCCD:EUR exchange rate update keys.")?,
+        kps,
+    )
+    .context("Invalid keys supplied.")?;
+
+let block_item: BlockItem<Payload> =
+    update::update(&signer, seq_number, effective_time, timeout, payload).into();
+```
+
+Constructing updates to the level 2 keys requires an [`AuthorizationsV1`](types::AuthorizationsV1) (or for old protocol versions, [`AuthorizationsV0`](types::AuthorizationsV0)) which can be obtained with `Level2Keys::try_into()`.


I think the instructions could be more targeted on what usages we actually expect of the SDK (too much information can make the instructions less clear or just seem overwhelming). This usage of posting an update instruction, we likely have 0 users doing that? So we could write it shorter and just say there are changes to these types.

There is also an unexplained variable kps in the example (holds the private keys).

allanbrondum · 2025-10-21T11:33:04Z

src/v2/mod.rs

+
+/// Timeout parameters for the new consensus protocol introduced in protocol
+/// version 6.
+#[derive(Debug, Clone, Default)]


I would also just add Eq, PartialEq, Hash` to the types (https://rust-lang.github.io/api-guidelines/interoperability.html#c-common-traits)

allanbrondum · 2025-10-21T11:34:25Z

src/v2/mod.rs

+}
+
+#[derive(Debug, Clone, Default)]
+pub struct ChainParameters {


Documentation on this and a few other types is missing

td202 added 10 commits October 13, 2025 16:31

Add a new common chain parameters type.

7ab2fd4

Clean up and testing.

5b08468

More testing.

4199952

Merge remote-tracking branch 'remotes/origin/main' into revise-chain-…

dbd7401

…parameters

Update base

ec62210

Suppress clippy.

cb2c71b

Clean up

2d9d5de

Update changelog

ca958ad

Merge remote-tracking branch 'remotes/origin/main' into revise-chain-…

2efa583

…parameters

Migration information.

a0d1e10

td202 requested review from DOBEN, allanbrondum, limemloh and soerenbf and removed request for limemloh October 16, 2025 12:33

td202 added 2 commits October 16, 2025 15:08

Update base

b380b9e

Update base.

ad3e52e

td202 mentioned this pull request Oct 16, 2025

Update RustSDK and support changes in ChainParameters. Concordium/concordium-scan#837

Open

5 tasks

allanbrondum reviewed Oct 17, 2025

View reviewed changes

td202 mentioned this pull request Oct 17, 2025

Update the Rust SDK. Concordium/concordium-transaction-logger#58

Open

5 tasks

limemloh reviewed Oct 20, 2025

View reviewed changes

src/types/queries.rs Outdated Show resolved Hide resolved

limemloh reviewed Oct 20, 2025

View reviewed changes

src/v2/mod.rs Show resolved Hide resolved

limemloh approved these changes Oct 20, 2025

View reviewed changes

td202 added 4 commits October 20, 2025 12:58

Box PendingUpdateEffect::AddAnonymityRevoker

e5a7f22

Merge branch 'revise-chain-parameters' of github.com:Concordium/conco…

b9ef897

…rdium-rust-sdk into revise-chain-parameters

Make sub-structures of ChainParameters non-optional (where they conta…

4382dcf

…in only optional items).

Update base.

81da81b

allanbrondum reviewed Oct 21, 2025

View reviewed changes

src/v2/conversions.rs Show resolved Hide resolved

allanbrondum reviewed Oct 21, 2025

View reviewed changes

src/types/queries.rs Show resolved Hide resolved

allanbrondum reviewed Oct 21, 2025

View reviewed changes

Revise chain parameters #343

Are you sure you want to change the base?

Revise chain parameters #343

Uh oh!

Conversation

td202 commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Changes

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allanbrondum Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allanbrondum Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allanbrondum Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

td202 commented Oct 15, 2025 •

edited

Loading

allanbrondum Oct 17, 2025 •

edited

Loading

allanbrondum Oct 21, 2025 •

edited

Loading

allanbrondum Oct 21, 2025 •

edited

Loading