Merge branch 'main' into spofford/0.33.0

.github/workflows/e2e.yml

@@ -14,9 +14,9 @@ jobs:
         dfx: [ '0.8.4', '0.9.2', '0.10.1', '0.11.1' ]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Cache Cargo
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry

.github/workflows/fmt.yml

@@ -11,10 +11,10 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Cache Cargo
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry

.github/workflows/ic-ref.yml

@@ -19,19 +19,19 @@ jobs:
             os: ubuntu-latest
 
     steps:
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Install dfx
         uses: dfinity/setup-dfx@main
         with:
-          dfx-version: "0.15.3-largewasm.0"
+          dfx-version: "0.16.1"
 
       - name: Cargo cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry

.github/workflows/lint.yml

@@ -11,9 +11,9 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry

.github/workflows/netlify.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
-    - uses: actions/cache@v2
+    - uses: actions/cache@v4
       with:
         path: |
           ~/.cargo/registry

.github/workflows/release.yml

@@ -25,7 +25,7 @@ jobs:
             binary_path: target/x86_64-apple-darwin/release
             binary_files: icx
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v4
 
     - name: Setup environment variables
       run: |

.github/workflows/shellcheck.yml

@@ -17,7 +17,7 @@ jobs:
     # ubuntu-latest has shellcheck 0.4.6, while macos-latest has 0.7.1
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install shellcheck
         run: |
           mkdir $HOME/bin

.github/workflows/test.yml

@@ -14,9 +14,9 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Changed the return type of `stored_chunks` to a struct.
 * Added a prime256v1-based `Identity` impl to complement the ed25519 and secp256k1 `Identity` impls.
+* Added serde and candid serialization traits to the `Status` type.
+* Changed the type of `InstallMode.skip_pre_upgrade` from `bool` to `Option<bool>` to match the interface specification.
 
 ## [0.32.0] - 2024-01-18
 

ic-agent/Cargo.toml

@@ -76,6 +76,7 @@ web-sys = { version = "0.3", features = ["Window"], optional = true }
 
 [dev-dependencies]
 serde_json = "1.0.79"
+candid = { workspace = true, features = ["value"]}
 
 [target.'cfg(not(target_family = "wasm"))'.dev-dependencies]
 tokio = { version = "1.24.2", features = ["full"] }

ic-agent/src/agent/status.rs

@@ -1,11 +1,15 @@
 //! Types for interacting with the status endpoint of a replica. See [`Status`] for details.
 
+use candid::{CandidType, Deserialize};
+use serde::Serialize;
 use std::{collections::BTreeMap, fmt::Debug};
 
 /// Value returned by the status endpoint of a replica. This is a loose mapping to CBOR values.
 /// Because the agent should not return [`serde_cbor::Value`] directly across API boundaries,
 /// we reimplement it as [`Value`] here.
-#[derive(Debug, Ord, PartialOrd, Eq, PartialEq, Clone, Hash)]
+#[derive(
+    Debug, Ord, PartialOrd, Eq, PartialEq, Clone, Hash, CandidType, Serialize, Deserialize,
+)]
 pub enum Value {
     /// See [`Null`](serde_cbor::Value::Null).
     Null,
@@ -40,7 +44,7 @@ impl std::fmt::Display for Value {
 
 /// The structure returned by [`super::Agent::status`], containing the information returned
 /// by the status endpoint of a replica.
-#[derive(Debug, Ord, PartialOrd, PartialEq, Eq)]
+#[derive(Debug, Ord, PartialOrd, PartialEq, Eq, CandidType, Deserialize, Serialize)]
 pub struct Status {
     /// Optional. The precise git revision of the Internet Computer Protocol implementation.
     pub impl_version: Option<String>,
@@ -55,6 +59,47 @@ pub struct Status {
     pub values: BTreeMap<String, Box<Value>>,
 }
 
+#[test]
+fn can_serilaize_status_as_json() {
+    let status = Status {
+        impl_version: None,
+        replica_health_status: None,
+        root_key: None,
+        values: BTreeMap::new(),
+    };
+    let expected_json =
+        r#"{"impl_version":null,"replica_health_status":null,"root_key":null,"values":{}}"#;
+    let actual_json = serde_json::to_string(&status).expect("Failed to serialize as JSON");
+    assert_eq!(expected_json, actual_json);
+}
+#[test]
+fn can_serialize_status_as_idl() {
+    use candid::types::value::IDLValue;
+    use candid::{Encode, IDLArgs, Result as CandidResult, TypeEnv};
+    let status = Status {
+        impl_version: Some("Foo".to_string()),
+        replica_health_status: None,
+        root_key: None,
+        values: BTreeMap::new(),
+    };
+    // Expresses data as IDLValue.  Then use .to_string() to convert to text-form candid.
+    // TODO: This function has been added to the Candid library and will be available in the next
+    // release.  Then, this definition here can be deleted.
+    pub fn try_from_candid_type<T>(data: &T) -> CandidResult<IDLValue>
+    where
+        T: CandidType,
+    {
+        let blob = Encode!(data)?;
+        let args = IDLArgs::from_bytes_with_types(&blob, &TypeEnv::default(), &[T::ty()])?;
+        Ok(args.args[0].clone())
+    }
+    let expected_idl = "record {\n  values = vec {};\n  replica_health_status = null;\n  impl_version = opt \"Foo\";\n  root_key = null;\n}";
+    let actual_idl = try_from_candid_type(&status)
+        .expect("Failed to convert to idl")
+        .to_string();
+    assert_eq!(expected_idl, actual_idl);
+}
+
 impl std::fmt::Display for Status {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         f.write_str("{\n")?;

ic-utils/src/interfaces/management_canister/builders.rs

@@ -33,7 +33,7 @@ pub struct CanisterSettings {
     pub controllers: Option<Vec<Principal>>,
     /// The allocation percentage (between 0 and 100 inclusive) for *guaranteed* compute capacity.
     ///
-    /// The settings update will be rejected if the IC can't commit to allocating this much compupte capacity.
+    /// The settings update will be rejected if the IC can't commit to allocating this much compute capacity.
     ///
     /// If unspecified and a canister is being created with these settings, defaults to 0, i.e. best-effort.
     pub compute_allocation: Option<Nat>,
@@ -392,7 +392,7 @@ pub enum InstallMode {
     #[serde(rename = "upgrade")]
     Upgrade {
         /// If true, skip a canister's `#[pre_upgrade]` function.
-        skip_pre_upgrade: bool,
+        skip_pre_upgrade: Option<bool>,
     },
 }
 
@@ -419,7 +419,7 @@ impl FromStr for InstallMode {
             "install" => Ok(InstallMode::Install),
             "reinstall" => Ok(InstallMode::Reinstall),
             "upgrade" => Ok(InstallMode::Upgrade {
-                skip_pre_upgrade: false,
+                skip_pre_upgrade: Some(false),
             }),
             &_ => Err(format!("Invalid install mode: {}", s)),
         }

ref-tests/tests/ic-ref.rs

@@ -162,7 +162,7 @@ mod management_canister {
             // Upgrade should succeed.
             ic00.install_code(&canister_id, &canister_wasm)
                 .with_mode(InstallMode::Upgrade {
-                    skip_pre_upgrade: false,
+                    skip_pre_upgrade: None,
                 })
                 .call_and_wait()
                 .await?;
@@ -171,7 +171,7 @@ mod management_canister {
             let result = other_ic00
                 .install_code(&canister_id, &canister_wasm)
                 .with_mode(InstallMode::Upgrade {
-                    skip_pre_upgrade: false,
+                    skip_pre_upgrade: None,
                 })
                 .call_and_wait()
                 .await;
@@ -486,7 +486,7 @@ mod management_canister {
             // Upgrade should succeed
             ic00.install_code(&canister_id, &canister_wasm)
                 .with_mode(InstallMode::Upgrade {
-                    skip_pre_upgrade: false,
+                    skip_pre_upgrade: None,
                 })
                 .call_and_wait()
                 .await?;