Skip to content

Commit 4654ed6

Browse files
jasonz-dfinityjasonz-dfinity
committed
refactor: rename CanisterSettingsArgs to CanisterSettings in CMC re-export
Drop the alias -- re-export CanisterSettings directly from the public crate instead of aliasing it as CanisterSettingsArgs. Update all downstream consumers.
1 parent a225a6c commit 4654ed6

File tree

6 files changed

+30
-30
lines changed

6 files changed

+30
-30
lines changed

‎rs/nervous_system/agent/src/nns/cmc.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use crate::CallCanisters;
22
use cycles_minting_canister::{
3-
CanisterSettingsArgs, CreateCanister, NotifyMintCyclesArg, NotifyMintCyclesResult,
3+
CanisterSettings, CreateCanister, NotifyMintCyclesArg, NotifyMintCyclesResult,
44
SetAuthorizedSubnetworkListArgs, SubnetSelection,
55
};
66
use ic_base_types::{CanisterId, PrincipalId, SubnetId};
@@ -11,7 +11,7 @@ pub mod requests;
1111
pub async fn create_canister<C: CallCanisters>(
1212
agent: &C,
1313
subnet_selection: Option<SubnetSelection>,
14-
settings: Option<CanisterSettingsArgs>,
14+
settings: Option<CanisterSettings>,
1515
) -> Result<CanisterId, C::Error> {
1616
let request = CreateCanister {
1717
subnet_selection,

‎rs/nns/cmc/src/lib.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#![allow(deprecated)]
2-
pub use ic_management_canister_types::CanisterSettings as CanisterSettingsArgs;
2+
pub use ic_management_canister_types::CanisterSettings;
33

44
use candid::{CandidType, Nat};
55
use ic_cdk::api::call::{CallResult, RejectionCode};
@@ -148,7 +148,7 @@ pub struct NotifyCreateCanister {
148148
pub subnet_type: Option<String>,
149149
pub subnet_selection: Option<SubnetSelection>,
150150

151-
pub settings: Option<CanisterSettingsArgs>,
151+
pub settings: Option<CanisterSettings>,
152152
}
153153

154154
/// Error for notify endpoints
@@ -173,7 +173,7 @@ pub struct CreateCanister {
173173
#[deprecated(note = "use subnet_selection instead")]
174174
pub subnet_type: Option<String>,
175175
pub subnet_selection: Option<SubnetSelection>,
176-
pub settings: Option<CanisterSettingsArgs>,
176+
pub settings: Option<CanisterSettings>,
177177
}
178178

179179
/// Error for create_canister endpoint

‎rs/nns/cmc/src/main.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1921,7 +1921,7 @@ async fn process_create_canister(
19211921
from: AccountIdentifier,
19221922
amount: Tokens,
19231923
subnet_selection: Option<SubnetSelection>,
1924-
settings: Option<CanisterSettingsArgs>,
1924+
settings: Option<CanisterSettings>,
19251925
) -> Result<CanisterId, NotifyError> {
19261926
let cycles = tokens_to_cycles(amount)?;
19271927

@@ -2169,7 +2169,7 @@ async fn do_create_canister(
21692169
controller_id: PrincipalId,
21702170
cycles: Cycles,
21712171
subnet_selection: Option<SubnetSelection>,
2172-
settings: Option<CanisterSettingsArgs>,
2172+
settings: Option<CanisterSettings>,
21732173
) -> Result<CanisterId, String> {
21742174
// Retrieve randomness from the system to use later to get a random
21752175
// permutation of subnets. Performing the asynchronous call before

‎rs/nns/integration_tests/src/cycles_minting_canister.rs‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use assert_matches::assert_matches;
22
use candid::{Decode, Encode, Nat, Principal};
33
use canister_test::Canister;
44
use cycles_minting_canister::{
5-
AuthorizedSubnetsResponse, BAD_REQUEST_CYCLES_PENALTY, CanisterSettingsArgs,
5+
AuthorizedSubnetsResponse, BAD_REQUEST_CYCLES_PENALTY, CanisterSettings,
66
ChangeSubnetTypeAssignmentArgs, CreateCanister, CreateCanisterError, MEANINGFUL_MEMOS,
77
MEMO_CREATE_CANISTER, MEMO_MINT_CYCLES, MEMO_TOP_UP_CANISTER, NotifyCreateCanister,
88
NotifyError, NotifyErrorCode, NotifyMintCyclesArg, NotifyMintCyclesSuccess, NotifyTopUp,
@@ -299,7 +299,7 @@ fn test_cmc_notify_create_with_settings() {
299299
//specify single controller
300300
let canister = notify_create_canister(
301301
&state_machine,
302-
Some(CanisterSettingsArgs {
302+
Some(CanisterSettings {
303303
// TEST_USER1 creates the canister, so to check it didn't default to the caller we use TEST_USER2
304304
controllers: Some(vec![TEST_USER2_PRINCIPAL.0]),
305305
..Default::default()
@@ -321,7 +321,7 @@ fn test_cmc_notify_create_with_settings() {
321321
specified_controllers.sort();
322322
let canister = notify_create_canister(
323323
&state_machine,
324-
Some(CanisterSettingsArgs {
324+
Some(CanisterSettings {
325325
controllers: Some(specified_controllers.iter().map(|p| p.0).collect()),
326326
..Default::default()
327327
}),
@@ -338,7 +338,7 @@ fn test_cmc_notify_create_with_settings() {
338338
//specify no controller
339339
let canister = notify_create_canister(
340340
&state_machine,
341-
Some(CanisterSettingsArgs {
341+
Some(CanisterSettings {
342342
controllers: Some(vec![]),
343343
..Default::default()
344344
}),
@@ -349,7 +349,7 @@ fn test_cmc_notify_create_with_settings() {
349349
//specify compute allocation
350350
let canister = notify_create_canister(
351351
&state_machine,
352-
Some(dbg!(CanisterSettingsArgs {
352+
Some(dbg!(CanisterSettings {
353353
compute_allocation: Some(Nat::from(7u64)),
354354
..Default::default()
355355
})),
@@ -364,7 +364,7 @@ fn test_cmc_notify_create_with_settings() {
364364
//specify freezing threshold
365365
let canister = notify_create_canister(
366366
&state_machine,
367-
Some(CanisterSettingsArgs {
367+
Some(CanisterSettings {
368368
freezing_threshold: Some(Nat::from(7u64)),
369369
..Default::default()
370370
}),
@@ -379,7 +379,7 @@ fn test_cmc_notify_create_with_settings() {
379379
//specify memory allocation
380380
let canister = notify_create_canister(
381381
&state_machine,
382-
Some(CanisterSettingsArgs {
382+
Some(CanisterSettings {
383383
memory_allocation: Some(Nat::from(7u64)),
384384
..Default::default()
385385
}),
@@ -398,7 +398,7 @@ fn test_cmc_notify_create_with_settings() {
398398
}];
399399
let canister = notify_create_canister(
400400
&state_machine,
401-
Some(CanisterSettingsArgs {
401+
Some(CanisterSettings {
402402
environment_variables: Some(
403403
env_vars
404404
.iter()
@@ -558,7 +558,7 @@ fn test_cmc_cycles_create_with_settings() {
558558
let canister = cmc_create_canister_with_cycles(
559559
&state_machine,
560560
universal_canister,
561-
Some(CanisterSettingsArgs {
561+
Some(CanisterSettings {
562562
controllers: Some(vec![TEST_USER1_PRINCIPAL.0]),
563563
..Default::default()
564564
}),
@@ -583,7 +583,7 @@ fn test_cmc_cycles_create_with_settings() {
583583
let canister = cmc_create_canister_with_cycles(
584584
&state_machine,
585585
universal_canister,
586-
Some(CanisterSettingsArgs {
586+
Some(CanisterSettings {
587587
controllers: Some(specified_controllers.iter().map(|p| p.0).collect()),
588588
..Default::default()
589589
}),
@@ -604,7 +604,7 @@ fn test_cmc_cycles_create_with_settings() {
604604
let canister = cmc_create_canister_with_cycles(
605605
&state_machine,
606606
universal_canister,
607-
Some(CanisterSettingsArgs {
607+
Some(CanisterSettings {
608608
controllers: Some(vec![]),
609609
..Default::default()
610610
}),
@@ -619,7 +619,7 @@ fn test_cmc_cycles_create_with_settings() {
619619
let canister = cmc_create_canister_with_cycles(
620620
&state_machine,
621621
universal_canister,
622-
Some(CanisterSettingsArgs {
622+
Some(CanisterSettings {
623623
controllers: Some(vec![TEST_USER1_PRINCIPAL.0]),
624624
compute_allocation: Some(Nat::from(7u64)),
625625
..Default::default()
@@ -639,7 +639,7 @@ fn test_cmc_cycles_create_with_settings() {
639639
let canister = cmc_create_canister_with_cycles(
640640
&state_machine,
641641
universal_canister,
642-
Some(CanisterSettingsArgs {
642+
Some(CanisterSettings {
643643
controllers: Some(vec![TEST_USER1_PRINCIPAL.0]),
644644
freezing_threshold: Some(Nat::from(7u64)),
645645
..Default::default()
@@ -659,7 +659,7 @@ fn test_cmc_cycles_create_with_settings() {
659659
let canister = cmc_create_canister_with_cycles(
660660
&state_machine,
661661
universal_canister,
662-
Some(CanisterSettingsArgs {
662+
Some(CanisterSettings {
663663
controllers: Some(vec![TEST_USER1_PRINCIPAL.0]),
664664
memory_allocation: Some(Nat::from(7u64)),
665665
..Default::default()
@@ -683,7 +683,7 @@ fn test_cmc_cycles_create_with_settings() {
683683
let canister = cmc_create_canister_with_cycles(
684684
&state_machine,
685685
universal_canister,
686-
Some(CanisterSettingsArgs {
686+
Some(CanisterSettings {
687687
controllers: Some(vec![TEST_USER1_PRINCIPAL.0]),
688688
environment_variables: Some(
689689
env_vars
@@ -1007,7 +1007,7 @@ fn send_transfer(env: &StateMachine, arg: &TransferArgs) -> Result<BlockIndex, T
10071007
/// subaccount of the CMC, which then tries to create a canister with the provided settings.
10081008
fn notify_create_canister(
10091009
state_machine: &StateMachine,
1010-
settings: Option<CanisterSettingsArgs>,
1010+
settings: Option<CanisterSettings>,
10111011
) -> CanisterId {
10121012
let transfer_args = TransferArgs {
10131013
memo: MEMO_CREATE_CANISTER,
@@ -1110,7 +1110,7 @@ fn cycles_ledger_balance_of(state_machine: &StateMachine, account: Account) -> u
11101110
fn cmc_create_canister_with_cycles(
11111111
state_machine: &StateMachine,
11121112
universal_canister: CanisterId,
1113-
settings: Option<CanisterSettingsArgs>,
1113+
settings: Option<CanisterSettings>,
11141114
subnet_type: Option<String>,
11151115
cycles: u128,
11161116
) -> Result<CanisterId, CreateCanisterError> {

‎rs/sns/cli/src/register_extension.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use candid_utils::{
77
};
88
use clap::Parser;
99
use core::convert::From;
10-
use cycles_minting_canister::{CanisterSettingsArgs, CreateCanister, SubnetSelection};
10+
use cycles_minting_canister::{CanisterSettings, CreateCanister, SubnetSelection};
1111
use ic_base_types::{CanisterId, PrincipalId, SubnetId};
1212
use ic_nervous_system_agent::{
1313
CallCanisters, Request, management_canister,
@@ -233,7 +233,7 @@ pub async fn create_extension_canister<C: CallCanisters>(
233233
agent,
234234
cycles_amount,
235235
subnet_selection,
236-
Some(CanisterSettingsArgs {
236+
Some(CanisterSettings {
237237
controllers: Some(controllers.into_iter().map(|p| p.0).collect()),
238238
..Default::default()
239239
}),
@@ -493,7 +493,7 @@ pub async fn cycles_ledger_create_canister<C: CallCanisters>(
493493
agent: &C,
494494
cycles_amount: u128,
495495
subnet_selection: Option<SubnetSelection>,
496-
settings: Option<CanisterSettingsArgs>,
496+
settings: Option<CanisterSettings>,
497497
) -> Result<CreateCanisterSuccess, CreateCanisterError> {
498498
let request = CreateCanisterArgs {
499499
from_subaccount: None,

‎rs/sns/cli/src/upgrade_sns_controlled_canister.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use candid_utils::{
77
};
88
use clap::Parser;
99
use core::convert::From;
10-
use cycles_minting_canister::{CanisterSettingsArgs, CreateCanister, SubnetSelection};
10+
use cycles_minting_canister::{CanisterSettings, CreateCanister, SubnetSelection};
1111
use ic_base_types::{CanisterId, PrincipalId};
1212
use ic_management_canister_types_private::CanisterInstallMode;
1313
use ic_nervous_system_agent::{
@@ -228,7 +228,7 @@ pub async fn create_canister_next_to<C: CallCanisters>(
228228
agent,
229229
cycles_amount,
230230
subnet_selection,
231-
Some(CanisterSettingsArgs {
231+
Some(CanisterSettings {
232232
controllers: Some(controllers.into_iter().map(|p| p.0).collect()),
233233
..Default::default()
234234
}),
@@ -726,7 +726,7 @@ pub async fn cycles_ledger_create_canister<C: CallCanisters>(
726726
agent: &C,
727727
cycles_amount: u128,
728728
subnet_selection: Option<SubnetSelection>,
729-
settings: Option<CanisterSettingsArgs>,
729+
settings: Option<CanisterSettings>,
730730
) -> Result<CreateCanisterSuccess, CreateCanisterError> {
731731
let request = CreateCanisterArgs {
732732
from_subaccount: None,

0 commit comments

Comments
 (0)