chore(rust): Bump ic cdk #129

bitdivine · 2025-09-25T16:09:13Z

Motivation

A newer ICP runtime is available. A new ic_cdk i needed to use the updated canister API, and the runtimes (pocketic and dfx) need to be updated to provide that new API.

This necessarily requires some fairly deep incisions, so thorough testing is advised.

Changes

Update pocket-ic from version 5.0.0 to version 10.0.0
Update dfx from version 0.25.0 to 0.29.1
Update ic_cdk from version 0.17.2 to 0.18.7
Update code to work with this new runtime.
- Update the ledger canister bindings to use the new Call::unbounded_wait builder instead of the deprecated ic_cdk::call.
  - Note: We should probably switch to bounded wait calls. Unbounded wait is used now to minimize the already substantial changes in this PR.

Tests

Functionality should not have changed, so existing tests should suffice.

bitdivine · 2025-09-25T19:30:59Z

SECURITY.md

The changes here are from the formatter.

bitdivine · 2025-09-25T19:31:19Z

README.md

@@ -21,15 +21,15 @@ The following cryptocurrencies are currently supported:
 | ICP Cycles | XDR    | The native utility token of the Internet Computer, tied in price to the IMF XDR basket of currencies. |


The changes here are from the formatter.

bitdivine · 2025-09-25T19:32:30Z

didc.toml


+[didc.rust]
+target = "custom"
+template = "didc.hbs"


didc still generates bindings for the old ic_cdk API. We need our own template to generate bindings for the new API.

bitdivine · 2025-09-25T19:35:15Z

dfx.json

      "package": "example_paid_service",
      "type": "rust",
      "optimize": "cycles",
      "gzip": true,


The formatter at work.

bitdivine · 2025-09-25T19:35:37Z

dfx.json

@@ -1,15 +1,13 @@
 {
-  "dfx": "0.25.0",
+  "dfx": "0.29.1",


This updates dfx so that it provides the new runtime.

bitdivine · 2025-09-25T19:36:50Z

dev-tools.json

+    "method": "curl",
+    "version": "0.5.1",
+    "url": "https://github.com/dfinity/candid/releases/download/2025-08-04/didc-linux64"
+  },


This installs the latest didc, used to generate bindings.

bitdivine · 2025-09-25T19:56:59Z

.github/workflows/check.yml

@@ -112,7 +112,6 @@ jobs:
        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
        with:


This is just the formatter at work.

bitdivine · 2025-09-25T19:58:26Z

src/api/src/caller.rs

 }

-pub type TokenAmount = u64;
+pub type TokenAmount = u128;


In the new cdk, cycle amounts are u128 instead of u64.

bitdivine · 2025-09-25T19:59:32Z

scripts/setup

+    target="$HOME/.local/bin/$tool"
+    mkdir -p "$(dirname "$target")"
+    curl -Lf "$url" | "$pipe" | install -m 755 /dev/stdin "$target"
+    ;;


This is the install mechanism for didc, used to generate the updated code.

bitdivine · 2025-09-25T20:00:47Z

src/example/app_backend/src/lib.rs

-            .await
-            .unwrap();
-    ans
+    Call::unbounded_wait(canister_id, &method)


Note: I picked unbounded_wait to minimize changes, but we should think hard about switching to bounded_wait almost immediately. E.g. in the very next PR.

bitdivine · 2025-09-25T20:02:22Z

src/example/paid_service/tests/it/util/cycles_depositor.rs


 use candid::{self, CandidType, Deserialize, Principal};
-use ic_cdk::api::call::CallResult as Result;
+use ic_cdk::call::{Call, CallResult as Result};


ic_cdk::api::call::CallResult is now deprecated.

bitdivine · 2025-09-25T20:03:51Z

src/example/paid_service/tests/it/util/cycles_depositor.rs

    /// The ID of this canister.
    fn canister_id(&self) -> Principal {
-        self.canister_id.clone()
+        self.canister_id


clippy: Principal implements the Copy trait.

bitdivine · 2025-09-25T20:04:22Z

src/example/paid_service/tests/it/util/cycles_ledger.rs

-use ic_cdk::api::call::CallResult;
-use pocket_ic::{PocketIc, WasmResult};
+use ic_cdk::call::{Call, CallResult};
+use pocket_ic::PocketIc;


Stop using deprecated types & methods.

bitdivine · 2025-09-25T20:05:02Z

src/example/paid_service/tests/it/util/cycles_ledger.rs

    Blob(serde_bytes::ByteBuf),
    Text(String),
-    Array(Vec<Box<Value>>),
+    Array(Vec<Value>),


Clippy: The Vec is already on the heap, so the box is pointless.

bitdivine · 2025-09-25T20:05:34Z

src/example/paid_service/tests/it/util/cycles_ledger.rs

+        Ok(Call::unbounded_wait(self.0, "create_canister")
+            .with_args(&(arg0,))
+            .await?
+            .candid()?)


New bindings generated with didc.

bitdivine · 2025-09-25T20:06:56Z

src/example/paid_service/tests/it/util/cycles_ledger.rs

+            .candid()?)
    }
-    pub async fn icrc_2_transfer_from(
+    pub async fn icrc2_transfer_from(


Note: The canister method is icrc2_transfer_from but the old autogenerated bindings inserted an underscore before numbers.

bitdivine · 2025-09-25T20:07:57Z

src/example/paid_service/tests/it/util/pic_canister.rs

                format!(
                    "Update call error. RejectionCode: {:?}, Error: {}",
-                    e.code, e.description
+                    e.reject_code, e.reject_message


The cdk has a new error type, so we have to update to use the equivalent fields in the new type.

bitdivine · 2025-09-25T20:08:35Z

src/example/paid_service/tests/it/util/pic_canister.rs

-            self.wasm_path
-        ))
+        fs::read(self.wasm_path.clone())
+            .unwrap_or_else(|_| panic!("Could not find the backend wasm: {}", self.wasm_path))


Clippy complained about a function in expect().

bitdivine · 2025-09-25T20:10:24Z

src/example/paid_service/tests/it/util/test_environment.rs

            .expect("Failed to approve the paid service to spend the user's ICRC-2 tokens");
    }
    /// Calls a paid service.
+    #[allow(clippy::result_large_err)]


The error type is 144 bytes. I'm not sure there is much we can do about that. It is an enum of all the different error types that can occur in the payment process, such as the canister call to the ledger failing.

bitdivine · 2025-09-25T20:10:53Z

src/example/paid_service/tests/it/attached_cycles.rs

 fn inter_canister_call_succeeds_with_sufficient_cycles_only() {
    let setup = AttachedCyclesTestSetup::default();
-    for cycles in 995u64..1005 {
+    for cycles in 995u128..1005 {


Cycles are u128 in the new runtime.

bitdivine · 2025-09-25T20:11:06Z

src/example/paid_service/tests/it/patron_pays_icrc2_cycles.rs

-            caller.to_string(),
-            patron.to_string(),
+            caller,
+            patron,


bitdivine · 2025-09-25T20:11:31Z

src/guard/src/guards/attached_cycles.rs

@@ -1,5 +1,5 @@
 use super::{PaymentError, PaymentGuardTrait};
-use ic_cdk::api::call::{msg_cycles_accept, msg_cycles_available};
+use ic_cdk::api::{msg_cycles_accept, msg_cycles_available};


Use the new methods, not the deprecated ones.

bitdivine · 2025-09-25T20:12:12Z

src/guard/Cargo.toml

 [dependencies]
 candid = { workspace = true }
-ic-cdk = "0.17.2"
+ic-cdk = { workspace = true }


This makes sure that the ic-cdk version here stays in sync with that used elsewhere in this workspace.

bitdivine · 2025-09-25T20:13:37Z

Cargo.toml

 edition = "2021"
 publish = true
-version = "0.1.1"
+version = "0.2.0-alpha.1.1"


Bump version, as this code is definitely not compatible with version 0.1.1

DecentAgeCoder

LGTM! Thanks

bitdivine added 13 commits September 25, 2025 17:22

Next alpha release

4c4aaca

Bump ic-cdk

8277280

Address some warnings

89445ad

Address more lints

00e0d72

Bump dfx

e9aa1e4

fmt

eb2d35e

Bump didc

b8dadb8

Update cycles ledger bindings

b87fbde

cargo check --tests passes

8113dfe

clippy

8145be7

unbox

b6e7fae

clippy

7e7b800

fmt

dd5ec71

bitdivine changed the title ~~Bump ic cdk~~ chore(rust): Bump ic cdk Sep 25, 2025

bitdivine added 4 commits September 25, 2025 20:55

Update pocketic to latest

dc382cf

++

2f67d39

++

fa6bc7d

clippy

78b9de8

bitdivine commented Sep 25, 2025

View reviewed changes

SECURITY.md

Copy link

Collaborator Author

bitdivine Sep 25, 2025 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes here are from the formatter.

bitdivine added 2 commits September 25, 2025 21:34

comment

2e05675

comment

f26fbfd

bitdivine commented Sep 25, 2025

View reviewed changes

bitdivine marked this pull request as ready for review September 25, 2025 19:38

bitdivine commented Sep 25, 2025

View reviewed changes

typo

af1f627

bitdivine commented Sep 25, 2025

View reviewed changes

DecentAgeCoder approved these changes Sep 29, 2025

View reviewed changes

		@@ -21,15 +21,15 @@ The following cryptocurrencies are currently supported:
		\| ICP Cycles \| XDR \| The native utility token of the Internet Computer, tied in price to the IMF XDR basket of currencies. \|

		@@ -112,7 +112,6 @@ jobs:
		uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
		with:

chore(rust): Bump ic cdk #129

Are you sure you want to change the base?

chore(rust): Bump ic cdk #129

Uh oh!

Conversation

bitdivine commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

Tests

Uh oh!

bitdivine Sep 25, 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!

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!

Choose a reason for hiding this comment

Uh oh!

bitdivine Sep 25, 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!

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!

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DecentAgeCoder left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bitdivine commented Sep 25, 2025 •

edited

Loading

bitdivine Sep 25, 2025 •

edited

Loading

bitdivine Sep 25, 2025 •

edited

Loading