@dfinity/nns 0.4.2 → 0.4.3

package/README.md

@@ -27,3 +27,5 @@ async function main() {
 
 main();
 ```
+
+# [How-To](/HOWTO.md)

package/dist/candid/payloads.did

@@ -1,4 +1,5 @@
-// Generated by running `cargo run --bin nns_functions_candid_gen`
+// Initially generated by running `cargo run --bin nns_functions_candid_gen`
+// See HOWTO.md / How-To Update `payloads.did` Manually
 
 // Exceptions (in rs files but not in did)
 type CanisterAction = variant { Start; Stop };
@@ -16,15 +17,16 @@ type UpdateIcpXdrConversionRatePayload = record {
   timestamp_seconds : nat64;
 };
 
-
-// updated https://github.com/dfinity/ic/commit/620692ef649876447646ffeed16aa3579d3ec3a8
+// Source: ic/master/rs/registry/canister/canister/registry.did
+// Commit: https://github.com/dfinity/ic/commit/3b8c3db8acbb1fa5d3f751a53ee9638264062808
 type AddFirewallRulesPayload = record {
   expected_hash : text;
-  scope : text;
+  scope : FirewallRulesScope;
   positions : vec int32;
   rules : vec FirewallRule;
 };
 type AddNodeOperatorPayload = record {
+  ipv6 : opt text;
   node_operator_principal_id : opt principal;
   node_allowance : nat64;
   rewardable_nodes : vec record { text; nat32 };
@@ -50,7 +52,11 @@ type AddOrRemoveDataCentersProposalPayload = record {
   data_centers_to_add : vec DataCenterRecord;
   data_centers_to_remove : vec text;
 };
-type BitcoinFeature = variant { Paused; Enabled; Disabled };
+type BitcoinFeature = record {
+  status : BitcoinFeatureStatus;
+  network : Network;
+};
+type BitcoinFeatureStatus = variant { Paused; Enabled; Disabled; Syncing };
 type BlessReplicaVersionPayload = record {
   node_manager_sha256_hex : text;
   release_package_url : text;
@@ -60,6 +66,11 @@ type BlessReplicaVersionPayload = record {
   node_manager_binary_url : text;
   binary_url : text;
 };
+type CanisterIdRange = record { end : principal; start : principal };
+type CompleteCanisterMigrationPayload = record {
+  canister_id_ranges : vec CanisterIdRange;
+  migration_trace : vec principal;
+};
 type CreateSubnetPayload = record {
   unit_delay_millis : nat64;
   max_instructions_per_round : nat64;
@@ -121,8 +132,16 @@ type FirewallRule = record {
   ipv6_prefixes : vec text;
   ports : vec nat32;
 };
+type FirewallRulesScope = variant {
+  Node : principal;
+  ReplicaNodes;
+  Subnet : principal;
+  Global;
+};
 type Gps = record { latitude : float32; longitude : float32 };
+type Network = variant { Mainnet; Testnet };
 type NodeOperatorRecord = record {
+  ipv6 : opt text;
   node_operator_principal_id : vec nat8;
   node_allowance : nat64;
   rewardable_nodes : vec record { text; nat32 };
@@ -134,17 +153,23 @@ type NodeProvidersMonthlyXdrRewards = record {
 };
 type NodeRewardRate = record { xdr_permyriad_per_node_per_month : nat64 };
 type NodeRewardRates = record { rates : vec record { text; NodeRewardRate } };
+type PrepareCanisterMigrationPayload = record {
+  canister_id_ranges : vec CanisterIdRange;
+  source_subnet : principal;
+  destination_subnet : principal;
+};
 type RecoverSubnetPayload = record {
   height : nat64;
   replacement_nodes : opt vec principal;
   subnet_id : principal;
   registry_store_uri : opt record { text; text; nat64 };
+  ecdsa_config : opt EcdsaInitialConfig;
   state_hash : vec nat8;
   time_ns : nat64;
 };
 type RemoveFirewallRulesPayload = record {
   expected_hash : text;
-  scope : text;
+  scope : FirewallRulesScope;
   positions : vec int32;
 };
 type RemoveNodeDirectlyPayload = record { node_id : principal };
@@ -152,18 +177,18 @@ type RemoveNodeOperatorsPayload = record {
   node_operators_to_remove : vec vec nat8;
 };
 type RemoveNodesPayload = record { node_ids : vec principal };
-type RerouteCanisterRangePayload = record {
-  range_end_inclusive : principal;
-  range_start_inclusive : principal;
+type RerouteCanisterRangesPayload = record {
+  source_subnet : principal;
+  reassigned_canister_ranges : vec CanisterIdRange;
   destination_subnet : principal;
 };
 type Result = variant { Ok : principal; Err : text };
-type Result_1 = variant {
+type Result_1 = variant { Ok; Err : text };
+type Result_2 = variant {
   Ok : vec record { DataCenterRecord; NodeOperatorRecord };
   Err : text;
 };
-type Result_2 = variant { Ok : NodeProvidersMonthlyXdrRewards; Err : text };
-type Result_3 = variant { Ok; Err : text };
+type Result_3 = variant { Ok : NodeProvidersMonthlyXdrRewards; Err : text };
 type SetFirewallConfigPayload = record {
   ipv4_prefixes : vec text;
   firewall_config : text;
@@ -172,7 +197,7 @@ type SetFirewallConfigPayload = record {
 type SubnetFeatures = record {
   canister_sandboxing : bool;
   http_requests : bool;
-  bitcoin_testnet_feature : opt BitcoinFeature;
+  bitcoin : opt BitcoinFeature;
   ecdsa_signatures : bool;
 };
 type SubnetType = variant { application; verified_application; system };
@@ -185,6 +210,8 @@ type UpdateNodeOperatorConfigDirectlyPayload = record {
 };
 type UpdateNodeOperatorConfigPayload = record {
   node_operator_id : opt principal;
+  set_ipv6_to_none : opt bool;
+  ipv6 : opt text;
   node_provider_id : opt principal;
   node_allowance : opt nat64;
   rewardable_nodes : vec record { text; nat32 };
@@ -204,6 +231,7 @@ type UpdateSubnetPayload = record {
   subnet_id : principal;
   max_ingress_bytes_per_message : opt nat64;
   dkg_dealings_per_block : opt nat64;
+  ecdsa_key_signing_disable : opt vec EcdsaKeyId;
   max_block_payload_size : opt nat64;
   max_instructions_per_install_code : opt nat64;
   start_as_nns : opt bool;
@@ -234,13 +262,14 @@ type UpdateUnassignedNodesConfigPayload = record {
   ssh_readonly_access : opt vec text;
 };
 service : {
-  // Exceptions (in rs files but not in did)
+  // EXCEPTIONS (in rs files but not in did)
   set_authorized_subnetwork_list : (SetAuthorizedSubnetworkListArgs) -> ();
   stop_or_start_nns_canister : (StopOrStartNnsCanisterProposalPayload) -> ();
   update_icp_xdr_conversion_rate : (UpdateIcpXdrConversionRatePayload) -> ();
 
 
-  // updated https://github.com/dfinity/ic/commit/620692ef649876447646ffeed16aa3579d3ec3a8
+  // Source: ic/master/rs/registry/canister/canister/registry.did
+  // Commit: https://github.com/dfinity/ic/commit/3b8c3db8acbb1fa5d3f751a53ee9638264062808
   add_firewall_rules : (AddFirewallRulesPayload) -> ();
   add_node : (AddNodePayload) -> (Result);
   add_node_operator : (AddNodeOperatorPayload) -> ();
@@ -248,21 +277,25 @@ service : {
   add_or_remove_data_centers : (AddOrRemoveDataCentersProposalPayload) -> ();
   bless_replica_version : (BlessReplicaVersionPayload) -> ();
   clear_provisional_whitelist : () -> ();
+  complete_canister_migration : (CompleteCanisterMigrationPayload) -> (
+      Result_1,
+    );
   create_subnet : (CreateSubnetPayload) -> ();
   delete_subnet : (DeleteSubnetPayload) -> ();
   get_build_metadata : () -> (text) query;
-  get_node_operators_and_dcs_of_node_provider : (principal) -> (Result_1) query;
-  get_node_providers_monthly_xdr_rewards : () -> (Result_2) query;
+  get_node_operators_and_dcs_of_node_provider : (principal) -> (Result_2) query;
+  get_node_providers_monthly_xdr_rewards : () -> (Result_3) query;
+  prepare_canister_migration : (PrepareCanisterMigrationPayload) -> (Result_1);
   recover_subnet : (RecoverSubnetPayload) -> ();
   remove_firewall_rules : (RemoveFirewallRulesPayload) -> ();
   remove_node_directly : (RemoveNodeDirectlyPayload) -> ();
   remove_node_operators : (RemoveNodeOperatorsPayload) -> ();
   remove_nodes : (RemoveNodesPayload) -> ();
   remove_nodes_from_subnet : (RemoveNodesPayload) -> ();
-  reroute_canister_range : (RerouteCanisterRangePayload) -> (Result_3);
+  reroute_canister_ranges : (RerouteCanisterRangesPayload) -> (Result_1);
   set_firewall_config : (SetFirewallConfigPayload) -> ();
   update_firewall_rules : (AddFirewallRulesPayload) -> ();
-  update_node_directly : (UpdateNodeDirectlyPayload) -> (Result_3);
+  update_node_directly : (UpdateNodeDirectlyPayload) -> (Result_1);
   update_node_operator_config : (UpdateNodeOperatorConfigPayload) -> ();
   update_node_operator_config_directly : (
       UpdateNodeOperatorConfigDirectlyPayload,

package/dist/candid/payloads.idl.d.ts

@@ -1,5 +1,6 @@
 import type { IDL } from "@dfinity/candid";
 
+export const FirewallRulesScope: IDL.RecordClass;
 export const FirewallRule: IDL.RecordClass;
 export const AddFirewallRulesPayload: IDL.RecordClass;
 export const AddNodePayload: IDL.RecordClass;
@@ -10,6 +11,11 @@ export const Gps: IDL.RecordClass;
 export const DataCenterRecord: IDL.RecordClass;
 export const AddOrRemoveDataCentersProposalPayload: IDL.RecordClass;
 export const BlessReplicaVersionPayload: IDL.RecordClass;
+export const CanisterIdRange: IDL.RecordClass;
+export const CompleteCanisterMigrationPayload: IDL.RecordClass;
+export const Result_1: IDL.RecordClass;
+export const BitcoinFeatureStatus: IDL.RecordClass;
+export const Network: IDL.RecordClass;
 export const BitcoinFeature: IDL.RecordClass;
 export const SubnetFeatures: IDL.RecordClass;
 export const EcdsaCurve: IDL.RecordClass;
@@ -20,16 +26,16 @@ export const SubnetType: IDL.RecordClass;
 export const CreateSubnetPayload: IDL.RecordClass;
 export const DeleteSubnetPayload: IDL.RecordClass;
 export const NodeOperatorRecord: IDL.RecordClass;
-export const Result_1: IDL.RecordClass;
-export const NodeProvidersMonthlyXdrRewards: IDL.RecordClass;
 export const Result_2: IDL.RecordClass;
+export const NodeProvidersMonthlyXdrRewards: IDL.RecordClass;
+export const Result_3: IDL.RecordClass;
+export const PrepareCanisterMigrationPayload: IDL.RecordClass;
 export const RecoverSubnetPayload: IDL.RecordClass;
 export const RemoveFirewallRulesPayload: IDL.RecordClass;
 export const RemoveNodeDirectlyPayload: IDL.RecordClass;
 export const RemoveNodeOperatorsPayload: IDL.RecordClass;
 export const RemoveNodesPayload: IDL.RecordClass;
-export const RerouteCanisterRangePayload: IDL.RecordClass;
-export const Result_3: IDL.RecordClass;
+export const RerouteCanisterRangesPayload: IDL.RecordClass;
 export const SetAuthorizedSubnetworkListArgs: IDL.RecordClass;
 export const SetFirewallConfigPayload: IDL.RecordClass;
 export const CanisterAction: IDL.RecordClass;

package/dist/candid/payloads.idl.js

@@ -4,6 +4,12 @@
 
 import { IDL } from "@dfinity/candid";
 
+export const FirewallRulesScope = IDL.Variant({
+  Node: IDL.Principal,
+  ReplicaNodes: IDL.Null,
+  Subnet: IDL.Principal,
+  Global: IDL.Null,
+});
 export const FirewallRule = IDL.Record({
   ipv4_prefixes: IDL.Vec(IDL.Text),
   action: IDL.Int32,
@@ -13,7 +19,7 @@ export const FirewallRule = IDL.Record({
 });
 export const AddFirewallRulesPayload = IDL.Record({
   expected_hash: IDL.Text,
-  scope: IDL.Text,
+  scope: FirewallRulesScope,
   positions: IDL.Vec(IDL.Int32),
   rules: IDL.Vec(FirewallRule),
 });
@@ -30,6 +36,7 @@ export const AddNodePayload = IDL.Record({
 });
 export const Result = IDL.Variant({ Ok: IDL.Principal, Err: IDL.Text });
 export const AddNodeOperatorPayload = IDL.Record({
+  ipv6: IDL.Opt(IDL.Text),
   node_operator_principal_id: IDL.Opt(IDL.Principal),
   node_allowance: IDL.Nat64,
   rewardable_nodes: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Nat32)),
@@ -63,15 +70,30 @@ export const BlessReplicaVersionPayload = IDL.Record({
   node_manager_binary_url: IDL.Text,
   binary_url: IDL.Text,
 });
-export const BitcoinFeature = IDL.Variant({
+export const CanisterIdRange = IDL.Record({
+  end: IDL.Principal,
+  start: IDL.Principal,
+});
+export const CompleteCanisterMigrationPayload = IDL.Record({
+  canister_id_ranges: IDL.Vec(CanisterIdRange),
+  migration_trace: IDL.Vec(IDL.Principal),
+});
+export const Result_1 = IDL.Variant({ Ok: IDL.Null, Err: IDL.Text });
+export const BitcoinFeatureStatus = IDL.Variant({
   Paused: IDL.Null,
   Enabled: IDL.Null,
   Disabled: IDL.Null,
+  Syncing: IDL.Null,
+});
+export const Network = IDL.Variant({ Mainnet: IDL.Null, Testnet: IDL.Null });
+export const BitcoinFeature = IDL.Record({
+  status: BitcoinFeatureStatus,
+  network: Network,
 });
 export const SubnetFeatures = IDL.Record({
   canister_sandboxing: IDL.Bool,
   http_requests: IDL.Bool,
-  bitcoin_testnet_feature: IDL.Opt(BitcoinFeature),
+  bitcoin: IDL.Opt(BitcoinFeature),
   ecdsa_signatures: IDL.Bool,
 });
 export const EcdsaCurve = IDL.Variant({ secp256k1: IDL.Null });
@@ -126,34 +148,41 @@ export const DeleteSubnetPayload = IDL.Record({
   subnet_id: IDL.Opt(IDL.Principal),
 });
 export const NodeOperatorRecord = IDL.Record({
+  ipv6: IDL.Opt(IDL.Text),
   node_operator_principal_id: IDL.Vec(IDL.Nat8),
   node_allowance: IDL.Nat64,
   rewardable_nodes: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Nat32)),
   node_provider_principal_id: IDL.Vec(IDL.Nat8),
   dc_id: IDL.Text,
 });
-export const Result_1 = IDL.Variant({
+export const Result_2 = IDL.Variant({
   Ok: IDL.Vec(IDL.Tuple(DataCenterRecord, NodeOperatorRecord)),
   Err: IDL.Text,
 });
 export const NodeProvidersMonthlyXdrRewards = IDL.Record({
   rewards: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Nat64)),
 });
-export const Result_2 = IDL.Variant({
+export const Result_3 = IDL.Variant({
   Ok: NodeProvidersMonthlyXdrRewards,
   Err: IDL.Text,
 });
+export const PrepareCanisterMigrationPayload = IDL.Record({
+  canister_id_ranges: IDL.Vec(CanisterIdRange),
+  source_subnet: IDL.Principal,
+  destination_subnet: IDL.Principal,
+});
 export const RecoverSubnetPayload = IDL.Record({
   height: IDL.Nat64,
   replacement_nodes: IDL.Opt(IDL.Vec(IDL.Principal)),
   subnet_id: IDL.Principal,
   registry_store_uri: IDL.Opt(IDL.Tuple(IDL.Text, IDL.Text, IDL.Nat64)),
+  ecdsa_config: IDL.Opt(EcdsaInitialConfig),
   state_hash: IDL.Vec(IDL.Nat8),
   time_ns: IDL.Nat64,
 });
 export const RemoveFirewallRulesPayload = IDL.Record({
   expected_hash: IDL.Text,
-  scope: IDL.Text,
+  scope: FirewallRulesScope,
   positions: IDL.Vec(IDL.Int32),
 });
 export const RemoveNodeDirectlyPayload = IDL.Record({ node_id: IDL.Principal });
@@ -163,12 +192,11 @@ export const RemoveNodeOperatorsPayload = IDL.Record({
 export const RemoveNodesPayload = IDL.Record({
   node_ids: IDL.Vec(IDL.Principal),
 });
-export const RerouteCanisterRangePayload = IDL.Record({
-  range_end_inclusive: IDL.Principal,
-  range_start_inclusive: IDL.Principal,
+export const RerouteCanisterRangesPayload = IDL.Record({
+  source_subnet: IDL.Principal,
+  reassigned_canister_ranges: IDL.Vec(CanisterIdRange),
   destination_subnet: IDL.Principal,
 });
-export const Result_3 = IDL.Variant({ Ok: IDL.Null, Err: IDL.Text });
 export const SetAuthorizedSubnetworkListArgs = IDL.Record({
   who: IDL.Opt(IDL.Principal),
   subnets: IDL.Vec(IDL.Principal),
@@ -193,6 +221,8 @@ export const UpdateNodeDirectlyPayload = IDL.Record({
 });
 export const UpdateNodeOperatorConfigPayload = IDL.Record({
   node_operator_id: IDL.Opt(IDL.Principal),
+  set_ipv6_to_none: IDL.Opt(IDL.Bool),
+  ipv6: IDL.Opt(IDL.Text),
   node_provider_id: IDL.Opt(IDL.Principal),
   node_allowance: IDL.Opt(IDL.Nat64),
   rewardable_nodes: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Nat32)),
@@ -226,6 +256,7 @@ export const UpdateSubnetPayload = IDL.Record({
   subnet_id: IDL.Principal,
   max_ingress_bytes_per_message: IDL.Opt(IDL.Nat64),
   dkg_dealings_per_block: IDL.Opt(IDL.Nat64),
+  ecdsa_key_signing_disable: IDL.Opt(IDL.Vec(EcdsaKeyId)),
   max_block_payload_size: IDL.Opt(IDL.Nat64),
   max_instructions_per_install_code: IDL.Opt(IDL.Nat64),
   start_as_nns: IDL.Opt(IDL.Bool),