@dfinity/sns 3.3.0 → 3.4.0-next-2025-03-26

package/README.md

@@ -102,9 +102,26 @@ Lookup for the canister ids of a Sns and initialize the wrapper to access its fe
 
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L65)
 
-#### Methods
+#### Static Methods
 
 - [create](#gear-create)
+
+##### :gear: create
+
+Instantiate a canister to interact with the governance of a Sns project.
+
+| Method   | Type                                                               |
+| -------- | ------------------------------------------------------------------ |
+| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsGovernanceCanister` |
+
+Parameters:
+
+- `options`: Miscellaneous options to initialize the canister. Its ID being the only mandatory parammeter.
+
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L71)
+
+#### Methods
+
 - [listNeurons](#gear-listneurons)
 - [listProposals](#gear-listproposals)
 - [listTopics](#gear-listtopics)
@@ -131,20 +148,6 @@ Lookup for the canister ids of a Sns and initialize the wrapper to access its fe
 - [refreshNeuron](#gear-refreshneuron)
 - [claimNeuron](#gear-claimneuron)
 
-##### :gear: create
-
-Instantiate a canister to interact with the governance of a Sns project.
-
-| Method   | Type                                                               |
-| -------- | ------------------------------------------------------------------ |
-| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsGovernanceCanister` |
-
-Parameters:
-
-- `options`: Miscellaneous options to initialize the canister. Its ID being the only mandatory parammeter.
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L71)
-
 ##### :gear: listNeurons
 
 List the neurons of the Sns
@@ -416,10 +419,9 @@ Claim neuron
 
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L10)
 
-#### Methods
+#### Static Methods
 
 - [create](#gear-create)
-- [listSnsCanisters](#gear-listsnscanisters)
 
 ##### :gear: create
 
@@ -429,6 +431,10 @@ Claim neuron
 
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L11)
 
+#### Methods
+
+- [listSnsCanisters](#gear-listsnscanisters)
+
 ##### :gear: listSnsCanisters
 
 List the canisters that are part of the Sns.
@@ -449,9 +455,20 @@ Parameters:
 
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L33)
 
-#### Methods
+#### Static Methods
 
 - [create](#gear-create)
+
+##### :gear: create
+
+| Method   | Type                                                         |
+| -------- | ------------------------------------------------------------ |
+| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsSwapCanister` |
+
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L34)
+
+#### Methods
+
 - [state](#gear-state)
 - [notifyPaymentFailure](#gear-notifypaymentfailure)
 - [notifyParticipation](#gear-notifyparticipation)
@@ -463,14 +480,6 @@ Parameters:
 - [getLifecycle](#gear-getlifecycle)
 - [getFinalizationStatus](#gear-getfinalizationstatus)
 
-##### :gear: create
-
-| Method   | Type                                                         |
-| -------- | ------------------------------------------------------------ |
-| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsSwapCanister` |
-
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L34)
-
 ##### :gear: state
 
 Get the state of the swap

package/dist/candid/sns_governance.certified.idl.js

@@ -244,6 +244,9 @@ export const idlFactory = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -301,6 +304,7 @@ export const idlFactory = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -326,6 +330,7 @@ export const idlFactory = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),
@@ -988,6 +993,9 @@ export const init = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -1045,6 +1053,7 @@ export const init = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -1070,6 +1079,7 @@ export const init = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),

package/dist/candid/sns_governance.d.ts

@@ -13,6 +13,7 @@ export type Action =
   | { AddGenericNervousSystemFunction: NervousSystemFunction }
   | { ManageDappCanisterSettings: ManageDappCanisterSettings }
   | { RemoveGenericNervousSystemFunction: bigint }
+  | { SetTopicsForCustomProposals: SetTopicsForCustomProposals }
   | { UpgradeSnsToNextVersion: {} }
   | { RegisterDappCanisters: RegisterDappCanisters }
   | { TransferSnsTreasuryFunds: TransferSnsTreasuryFunds }
@@ -512,6 +513,7 @@ export interface Proposal {
 export interface ProposalData {
   id: [] | [ProposalId];
   payload_text_rendering: [] | [string];
+  topic: [] | [Topic];
   action: bigint;
   failure_reason: [] | [GovernanceError];
   action_auxiliary: [] | [ActionAuxiliary];
@@ -570,6 +572,9 @@ export interface SetDissolveTimestamp {
 export interface SetMode {
   mode: number;
 }
+export interface SetTopicsForCustomProposals {
+  custom_function_id_to_topic: Array<[bigint, Topic]>;
+}
 export interface SnsVersion {
   archive_wasm_hash: [] | [Uint8Array | number[]];
   root_wasm_hash: [] | [Uint8Array | number[]];

package/dist/candid/sns_governance.did

@@ -1,4 +1,4 @@
-// Generated from IC repo commit 2f02a66 (2025-02-13 tags: release-2025-02-20_10-16-disable-best-effort-messaging) 'rs/sns/governance/canister/governance.did' by import-candid
+// Generated from IC repo commit f6f5e0927d (2025-03-13 tags: release-2025-03-14_03-10-base) 'rs/sns/governance/canister/governance.did' by import-candid
 type Account = record {
   owner : opt principal;
   subaccount : opt Subaccount;
@@ -7,6 +7,7 @@ type Account = record {
 type Action = variant {
   ManageNervousSystemParameters : NervousSystemParameters;
   AddGenericNervousSystemFunction : NervousSystemFunction;
+  SetTopicsForCustomProposals : SetTopicsForCustomProposals;
   ManageDappCanisterSettings : ManageDappCanisterSettings;
   RemoveGenericNervousSystemFunction : nat64;
   UpgradeSnsToNextVersion : record {};
@@ -227,7 +228,7 @@ type GenericNervousSystemFunction = record {
   target_canister_id : opt principal;
   validator_method_name : opt text;
   target_method_name : opt text;
-  topic: opt Topic;
+  topic : opt Topic;
 };
 
 type GetMaturityModulationResponse = record {
@@ -395,6 +396,10 @@ type AdvanceSnsTargetVersion = record {
   new_target : opt SnsVersion;
 };
 
+type SetTopicsForCustomProposals = record {
+  custom_function_id_to_topic : vec record { nat64; Topic };
+};
+
 type ManageLedgerParameters = record {
   token_symbol : opt text;
   transfer_fee : opt nat64;
@@ -607,6 +612,7 @@ type ProposalData = record {
   minimum_yes_proportion_of_exercised : opt Percentage;
   is_eligible_for_rewards : bool;
   executed_timestamp_seconds : nat64;
+  topic : opt Topic;
 };
 
 type ProposalId = record {

package/dist/candid/sns_governance.idl.js

@@ -244,6 +244,9 @@ export const idlFactory = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -301,6 +304,7 @@ export const idlFactory = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -326,6 +330,7 @@ export const idlFactory = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),
@@ -1000,6 +1005,9 @@ export const init = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -1057,6 +1065,7 @@ export const init = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -1082,6 +1091,7 @@ export const init = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),

package/dist/candid/sns_governance_test.certified.idl.js

@@ -244,6 +244,9 @@ export const idlFactory = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -301,6 +304,7 @@ export const idlFactory = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -326,6 +330,7 @@ export const idlFactory = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),
@@ -1016,6 +1021,9 @@ export const init = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -1073,6 +1081,7 @@ export const init = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -1098,6 +1107,7 @@ export const init = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),

package/dist/candid/sns_governance_test.d.ts

@@ -13,6 +13,7 @@ export type Action =
   | { AddGenericNervousSystemFunction: NervousSystemFunction }
   | { ManageDappCanisterSettings: ManageDappCanisterSettings }
   | { RemoveGenericNervousSystemFunction: bigint }
+  | { SetTopicsForCustomProposals: SetTopicsForCustomProposals }
   | { UpgradeSnsToNextVersion: {} }
   | { RegisterDappCanisters: RegisterDappCanisters }
   | { TransferSnsTreasuryFunds: TransferSnsTreasuryFunds }
@@ -527,6 +528,7 @@ export interface Proposal {
 export interface ProposalData {
   id: [] | [ProposalId];
   payload_text_rendering: [] | [string];
+  topic: [] | [Topic];
   action: bigint;
   failure_reason: [] | [GovernanceError];
   action_auxiliary: [] | [ActionAuxiliary];
@@ -585,6 +587,9 @@ export interface SetDissolveTimestamp {
 export interface SetMode {
   mode: number;
 }
+export interface SetTopicsForCustomProposals {
+  custom_function_id_to_topic: Array<[bigint, Topic]>;
+}
 export interface SnsVersion {
   archive_wasm_hash: [] | [Uint8Array | number[]];
   root_wasm_hash: [] | [Uint8Array | number[]];

package/dist/candid/sns_governance_test.did

@@ -1,4 +1,4 @@
-// Generated from IC repo commit 2f02a66 (2025-02-13 tags: release-2025-02-20_10-16-disable-best-effort-messaging) 'rs/sns/governance/canister/governance_test.did' by import-candid
+// Generated from IC repo commit f6f5e0927d (2025-03-13 tags: release-2025-03-14_03-10-base) 'rs/sns/governance/canister/governance_test.did' by import-candid
 type Account = record {
   owner : opt principal;
   subaccount : opt Subaccount;
@@ -7,6 +7,7 @@ type Account = record {
 type Action = variant {
   ManageNervousSystemParameters : NervousSystemParameters;
   AddGenericNervousSystemFunction : NervousSystemFunction;
+  SetTopicsForCustomProposals : SetTopicsForCustomProposals;
   ManageDappCanisterSettings : ManageDappCanisterSettings;
   RemoveGenericNervousSystemFunction : nat64;
   UpgradeSnsToNextVersion : record {};
@@ -236,7 +237,7 @@ type GenericNervousSystemFunction = record {
   target_canister_id : opt principal;
   validator_method_name : opt text;
   target_method_name : opt text;
-  topic: opt Topic;
+  topic : opt Topic;
 };
 
 type GetMaturityModulationResponse = record {
@@ -404,6 +405,10 @@ type AdvanceSnsTargetVersion = record {
   new_target : opt SnsVersion;
 };
 
+type SetTopicsForCustomProposals = record {
+  custom_function_id_to_topic : vec record { nat64; Topic };
+};
+
 type ManageLedgerParameters = record {
   token_symbol : opt text;
   transfer_fee : opt nat64;
@@ -621,6 +626,7 @@ type ProposalData = record {
   minimum_yes_proportion_of_exercised : opt Percentage;
   is_eligible_for_rewards : bool;
   executed_timestamp_seconds : nat64;
+  topic : opt Topic;
 };
 
 type ProposalId = record {

package/dist/candid/sns_governance_test.idl.js

@@ -244,6 +244,9 @@ export const idlFactory = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -301,6 +304,7 @@ export const idlFactory = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -326,6 +330,7 @@ export const idlFactory = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),
@@ -1028,6 +1033,9 @@ export const init = ({ IDL }) => {
     'memory_allocation' : IDL.Opt(IDL.Nat64),
     'compute_allocation' : IDL.Opt(IDL.Nat64),
   });
+  const SetTopicsForCustomProposals = IDL.Record({
+    'custom_function_id_to_topic' : IDL.Vec(IDL.Tuple(IDL.Nat64, Topic)),
+  });
   const RegisterDappCanisters = IDL.Record({
     'canister_ids' : IDL.Vec(IDL.Principal),
   });
@@ -1085,6 +1093,7 @@ export const init = ({ IDL }) => {
     'AddGenericNervousSystemFunction' : NervousSystemFunction,
     'ManageDappCanisterSettings' : ManageDappCanisterSettings,
     'RemoveGenericNervousSystemFunction' : IDL.Nat64,
+    'SetTopicsForCustomProposals' : SetTopicsForCustomProposals,
     'UpgradeSnsToNextVersion' : IDL.Record({}),
     'RegisterDappCanisters' : RegisterDappCanisters,
     'TransferSnsTreasuryFunds' : TransferSnsTreasuryFunds,
@@ -1110,6 +1119,7 @@ export const init = ({ IDL }) => {
   const ProposalData = IDL.Record({
     'id' : IDL.Opt(ProposalId),
     'payload_text_rendering' : IDL.Opt(IDL.Text),
+    'topic' : IDL.Opt(Topic),
     'action' : IDL.Nat64,
     'failure_reason' : IDL.Opt(GovernanceError),
     'action_auxiliary' : IDL.Opt(ActionAuxiliary),

package/dist/candid/sns_root.did

@@ -1,4 +1,4 @@
-// Generated from IC repo commit 2f02a66 (2025-02-13 tags: release-2025-02-20_10-16-disable-best-effort-messaging) 'rs/sns/root/canister/root.did' by import-candid
+// Generated from IC repo commit f6f5e0927d (2025-03-13 tags: release-2025-03-14_03-10-base) 'rs/sns/root/canister/root.did' by import-candid
 type CanisterCallError = record {
   code : opt int32;
   description : text;

package/dist/candid/sns_swap.did

@@ -1,4 +1,4 @@
-// Generated from IC repo commit 2f02a66 (2025-02-13 tags: release-2025-02-20_10-16-disable-best-effort-messaging) 'rs/sns/swap/canister/swap.did' by import-candid
+// Generated from IC repo commit f6f5e0927d (2025-03-13 tags: release-2025-03-14_03-10-base) 'rs/sns/swap/canister/swap.did' by import-candid
 type BuyerState = record {
   icp : opt TransferableAmount;
   has_created_neuron_recipes : opt bool;