Skip to content

Commit 71bd947

Browse files
committed
Merge branch 'mraszyk/canister-history-ic00-types' into 'master'
rename fields in canister history types This MR renames fields in canister history Candid types according to the latest Interface specification [MR](dfinity/interface-spec#103) discussed in the Interface specification meeting. This chage is still safe to do at this point because values of those Candid types are not yet produced/consumed by the replica's public interface. See merge request dfinity-lab/public/ic!12644
2 parents eb3be45 + c5bb344 commit 71bd947

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

rs/types/ic00_types/src/lib.rs

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -146,20 +146,20 @@ pub struct CanisterChangeFromCanisterRecord {
146146
/// `CandidType` for `CanisterChangeOrigin`
147147
/// ```text
148148
/// variant {
149-
/// canister_change_from_user : record {
149+
/// from_user : record {
150150
/// user_id : principal;
151151
/// };
152-
/// canister_change_from_canister : record {
152+
/// from_canister : record {
153153
/// canister_id : principal;
154154
/// canister_version : opt nat64;
155155
/// };
156156
/// }
157157
/// ```
158158
#[derive(CandidType, Deserialize, Clone, Debug, PartialEq, Eq)]
159159
pub enum CanisterChangeOrigin {
160-
#[serde(rename = "canister_change_from_user")]
160+
#[serde(rename = "from_user")]
161161
CanisterChangeFromUser(CanisterChangeFromUserRecord),
162-
#[serde(rename = "canister_change_from_canister")]
162+
#[serde(rename = "from_canister")]
163163
CanisterChangeFromCanister(CanisterChangeFromCanisterRecord),
164164
}
165165

@@ -241,28 +241,28 @@ impl CanisterControllersChangeRecord {
241241
/// `CandidType` for `CanisterChangeDetails`
242242
/// ```text
243243
/// variant {
244-
/// canister_creation : record {
244+
/// creation : record {
245245
/// controllers : vec principal;
246246
/// };
247-
/// canister_code_uninstall;
248-
/// canister_code_deployment : record {
247+
/// code_uninstall;
248+
/// code_deployment : record {
249249
/// mode : variant {install; reinstall; upgrade};
250250
/// module_hash : blob;
251251
/// };
252-
/// canister_controllers_change : record {
252+
/// controllers_change : record {
253253
/// controllers : vec principal;
254254
/// };
255255
/// }
256256
/// ```
257257
#[derive(CandidType, Deserialize, Clone, Debug, PartialEq, Eq)]
258258
pub enum CanisterChangeDetails {
259-
#[serde(rename = "canister_creation")]
259+
#[serde(rename = "creation")]
260260
CanisterCreation(CanisterCreationRecord),
261-
#[serde(rename = "canister_code_uninstall")]
261+
#[serde(rename = "code_uninstall")]
262262
CanisterCodeUninstall,
263-
#[serde(rename = "canister_code_deployment")]
263+
#[serde(rename = "code_deployment")]
264264
CanisterCodeDeployment(CanisterCodeDeploymentRecord),
265-
#[serde(rename = "canister_controllers_change")]
265+
#[serde(rename = "controllers_change")]
266266
CanisterControllersChange(CanisterControllersChangeRecord),
267267
}
268268

@@ -309,30 +309,30 @@ impl CanisterChangeDetails {
309309
/// record {
310310
/// timestamp_nanos : nat64;
311311
/// canister_version : nat64;
312-
/// change_origin : canister_change_origin;
313-
/// change_details : canister_change_details;
312+
/// origin : change_origin;
313+
/// details : change_details;
314314
/// }
315315
/// ```
316316
#[derive(CandidType, Deserialize, Clone, Debug, PartialEq, Eq)]
317317
pub struct CanisterChange {
318318
timestamp_nanos: u64,
319319
canister_version: u64,
320-
change_origin: CanisterChangeOrigin,
321-
change_details: CanisterChangeDetails,
320+
origin: CanisterChangeOrigin,
321+
details: CanisterChangeDetails,
322322
}
323323

324324
impl CanisterChange {
325325
pub fn new(
326326
timestamp_nanos: u64,
327327
canister_version: u64,
328-
change_origin: CanisterChangeOrigin,
329-
change_details: CanisterChangeDetails,
328+
origin: CanisterChangeOrigin,
329+
details: CanisterChangeDetails,
330330
) -> CanisterChange {
331331
CanisterChange {
332332
timestamp_nanos,
333333
canister_version,
334-
change_origin,
335-
change_details,
334+
origin,
335+
details,
336336
}
337337
}
338338

@@ -341,7 +341,7 @@ impl CanisterChange {
341341
/// is counted separately because the controllers are stored on heap
342342
/// and thus not accounted for in `size_of::<CanisterChange>()`.
343343
pub fn count_bytes(&self) -> NumBytes {
344-
let controllers_memory_size = match &self.change_details {
344+
let controllers_memory_size = match &self.details {
345345
CanisterChangeDetails::CanisterCreation(canister_creation) => {
346346
canister_creation.controllers().len() * size_of::<PrincipalId>()
347347
}
@@ -490,8 +490,8 @@ impl From<&CanisterChange> for pb_canister_state_bits::CanisterChange {
490490
Self {
491491
timestamp_nanos: item.timestamp_nanos,
492492
canister_version: item.canister_version,
493-
change_origin: Some((&item.change_origin).into()),
494-
change_details: Some((&item.change_details).into()),
493+
change_origin: Some((&item.origin).into()),
494+
change_details: Some((&item.details).into()),
495495
}
496496
}
497497
}
@@ -500,13 +500,13 @@ impl TryFrom<pb_canister_state_bits::CanisterChange> for CanisterChange {
500500
type Error = ProxyDecodeError;
501501

502502
fn try_from(value: pb_canister_state_bits::CanisterChange) -> Result<Self, Self::Error> {
503-
let change_origin = try_from_option_field(value.change_origin, "change_origin")?;
504-
let change_details = try_from_option_field(value.change_details, "change_details")?;
503+
let origin = try_from_option_field(value.change_origin, "origin")?;
504+
let details = try_from_option_field(value.change_details, "details")?;
505505
Ok(Self {
506506
timestamp_nanos: value.timestamp_nanos,
507507
canister_version: value.canister_version,
508-
change_origin,
509-
change_details,
508+
origin,
509+
details,
510510
})
511511
}
512512
}

0 commit comments

Comments
 (0)