@dfinity/sns 0.0.18-next-2023-07-03 → 0.0.18

package/README.md

@@ -79,17 +79,11 @@ Lookup for the canister ids of a Sns and initialize the wrapper to access its fe
 | ---------------- | ---------------- |
 | `initSnsWrapper` | `InitSnsWrapper` |
 
-### :factory: SnsGovernanceCanister
-
-#### Constructors
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.ts#L33)
 
-`public`
-
-Parameters:
+### :factory: SnsGovernanceCanister
 
-- `id`
-- `service`
-- `certifiedService`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L60)
 
 #### Methods
 
@@ -130,6 +124,8 @@ 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#L66)
+
 ##### :gear: listNeurons
 
 List the neurons of the Sns
@@ -138,6 +134,8 @@ List the neurons of the Sns
 | ------------- | ----------------------------------------------------- |
 | `listNeurons` | `(params: SnsListNeuronsParams) => Promise<Neuron[]>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L80)
+
 ##### :gear: listProposals
 
 List the proposals of the Sns
@@ -146,6 +144,8 @@ List the proposals of the Sns
 | --------------- | ------------------------------------------------------------- |
 | `listProposals` | `(params: SnsListProposalsParams) => Promise<ProposalData[]>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L94)
+
 ##### :gear: getProposal
 
 Get the proposal of the Sns
@@ -154,6 +154,8 @@ Get the proposal of the Sns
 | ------------- | --------------------------------------------------------- |
 | `getProposal` | `(params: SnsGetProposalParams) => Promise<ProposalData>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L108)
+
 ##### :gear: listNervousSystemFunctions
 
 List Nervous System Functions
@@ -163,6 +165,8 @@ Neurons can follow other neurons in specific Nervous System Functions.
 | ---------------------------- | ---------------------------------------------------------------------- |
 | `listNervousSystemFunctions` | `(params: QueryParams) => Promise<ListNervousSystemFunctionsResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L127)
+
 ##### :gear: metadata
 
 Get the Sns metadata (title, description, etc.)
@@ -171,6 +175,8 @@ Get the Sns metadata (title, description, etc.)
 | ---------- | ------------------------------------------------------- |
 | `metadata` | `(params: QueryParams) => Promise<GetMetadataResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L135)
+
 ##### :gear: nervousSystemParameters
 
 Get the Sns nervous system parameters (default followees, max dissolve delay, max number of neurons, etc.)
@@ -179,6 +185,8 @@ Get the Sns nervous system parameters (default followees, max dissolve delay, ma
 | ------------------------- | ----------------------------------------------------------- |
 | `nervousSystemParameters` | `(params: QueryParams) => Promise<NervousSystemParameters>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L141)
+
 ##### :gear: getNeuron
 
 Get the neuron of the Sns
@@ -187,6 +195,8 @@ Get the neuron of the Sns
 | ----------- | ------------------------------------------------- |
 | `getNeuron` | `(params: SnsGetNeuronParams) => Promise<Neuron>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L149)
+
 ##### :gear: queryNeuron
 
 Same as `getNeuron` but returns undefined instead of raising error when not found.
@@ -195,6 +205,8 @@ Same as `getNeuron` but returns undefined instead of raising error when not foun
 | ------------- | ------------------------------------------------- |
 | `queryNeuron` | `(params: SnsGetNeuronParams) => Promise<Neuron>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L167)
+
 ##### :gear: manageNeuron
 
 Manage neuron. For advanced users.
@@ -203,6 +215,8 @@ Manage neuron. For advanced users.
 | -------------- | ---------------------------------------------------------- |
 | `manageNeuron` | `(request: ManageNeuron) => Promise<ManageNeuronResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L187)
+
 ##### :gear: addNeuronPermissions
 
 Add permissions to a neuron for a specific principal
@@ -211,6 +225,8 @@ Add permissions to a neuron for a specific principal
 | ---------------------- | ------------------------------------------------------- |
 | `addNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L200)
+
 ##### :gear: removeNeuronPermissions
 
 Remove permissions to a neuron for a specific principal
@@ -219,6 +235,8 @@ Remove permissions to a neuron for a specific principal
 | ------------------------- | ------------------------------------------------------- |
 | `removeNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L210)
+
 ##### :gear: splitNeuron
 
 Split neuron
@@ -227,6 +245,8 @@ Split neuron
 | ------------- | ----------------------------------------------------- |
 | `splitNeuron` | `(params: SnsSplitNeuronParams) => Promise<NeuronId>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L220)
+
 ##### :gear: disburse
 
 Disburse neuron on Account
@@ -235,6 +255,8 @@ Disburse neuron on Account
 | ---------- | ---------------------------------------------------- |
 | `disburse` | `(params: SnsDisburseNeuronParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L251)
+
 ##### :gear: startDissolving
 
 Start dissolving process of a neuron
@@ -243,6 +265,8 @@ Start dissolving process of a neuron
 | ----------------- | --------------------------------------- |
 | `startDissolving` | `(neuronId: NeuronId) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L259)
+
 ##### :gear: stopDissolving
 
 Stop dissolving process of a neuron
@@ -251,6 +275,8 @@ Stop dissolving process of a neuron
 | ---------------- | --------------------------------------- |
 | `stopDissolving` | `(neuronId: NeuronId) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L267)
+
 ##### :gear: stakeMaturity
 
 Stake the maturity of a neuron.
@@ -264,6 +290,8 @@ Parameters:
 - `neuronId`: The id of the neuron for which to stake the maturity
 - `percentageToStake`: Optional. Percentage of the current maturity to stake. If not provided, all of the neuron's current maturity will be staked.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L279)
+
 ##### :gear: autoStakeMaturity
 
 Changes auto-stake maturity for a Neuron.
@@ -277,6 +305,8 @@ Parameters:
 - `neuronId`: The id of the neuron for which to request a change of the auto stake feature
 - `autoStake`: `true` to enable the auto-stake maturity for this neuron, `false` to turn it off
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L299)
+
 ##### :gear: setDissolveTimestamp
 
 Increase dissolve delay of a neuron
@@ -285,6 +315,8 @@ Increase dissolve delay of a neuron
 | ---------------------- | ---------------------------------------------------------- |
 | `setDissolveTimestamp` | `(params: SnsSetDissolveTimestampParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L309)
+
 ##### :gear: increaseDissolveDelay
 
 Increase dissolve delay of a neuron
@@ -293,6 +325,8 @@ Increase dissolve delay of a neuron
 | ----------------------- | ----------------------------------------------------------- |
 | `increaseDissolveDelay` | `(params: SnsIncreaseDissolveDelayParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L319)
+
 ##### :gear: setTopicFollowees
 
 Sets followees of a neuron for a specific Nervous System Function (topic)
@@ -301,6 +335,8 @@ Sets followees of a neuron for a specific Nervous System Function (topic)
 | ------------------- | ------------------------------------------------- |
 | `setTopicFollowees` | `(params: SnsSetTopicFollowees) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L329)
+
 ##### :gear: registerVote
 
 Registers vote for a proposal from the neuron passed.
@@ -309,6 +345,8 @@ Registers vote for a proposal from the neuron passed.
 | -------------- | -------------------------------------------------- |
 | `registerVote` | `(params: SnsRegisterVoteParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L337)
+
 ##### :gear: refreshNeuron
 
 Refresh neuron
@@ -317,6 +355,8 @@ Refresh neuron
 | --------------- | --------------------------------------- |
 | `refreshNeuron` | `(neuronId: NeuronId) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L345)
+
 ##### :gear: claimNeuron
 
 Claim neuron
@@ -325,17 +365,11 @@ Claim neuron
 | ------------- | -------------------------------------------------------------------------------- |
 | `claimNeuron` | `({ memo, controller, subaccount, }: SnsClaimNeuronParams) => Promise<NeuronId>` |
 
-### :factory: SnsRootCanister
-
-#### Constructors
-
-`public`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L355)
 
-Parameters:
+### :factory: SnsRootCanister
 
-- `id`
-- `service`
-- `certifiedService`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L10)
 
 #### Methods
 
@@ -348,6 +382,8 @@ Parameters:
 | -------- | ------------------------------------------------------------ |
 | `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsRootCanister` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L11)
+
 ##### :gear: listSnsCanisters
 
 List the canisters that are part of the Sns.
@@ -358,17 +394,11 @@ Source code: https://github.com/dfinity/ic/blob/master/rs/sns/root/src/lib.rs
 | ------------------ | --------------------------------------------------------------------------------- |
 | `listSnsCanisters` | `({ certified, }: { certified?: boolean; }) => Promise<ListSnsCanistersResponse>` |
 
-### :factory: SnsSwapCanister
-
-#### Constructors
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L32)
 
-`public`
-
-Parameters:
+### :factory: SnsSwapCanister
 
-- `id`
-- `service`
-- `certifiedService`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L30)
 
 #### Methods
 
@@ -389,6 +419,8 @@ Parameters:
 | -------- | ------------------------------------------------------------ |
 | `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsSwapCanister` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L31)
+
 ##### :gear: state
 
 Get the state of the swap
@@ -397,6 +429,8 @@ Get the state of the swap
 | ------- | ---------------------------------------------------- |
 | `state` | `(params: QueryParams) => Promise<GetStateResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L45)
+
 ##### :gear: notifyPaymentFailure
 
 Notify of the payment failure to remove the ticket
@@ -405,6 +439,8 @@ Notify of the payment failure to remove the ticket
 | ---------------------- | ----------------------- |
 | `notifyPaymentFailure` | `() => Promise<Ticket>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L51)
+
 ##### :gear: notifyParticipation
 
 Notify of the user participating in the swap
@@ -413,6 +449,8 @@ Notify of the user participating in the swap
 | --------------------- | ---------------------------------------------------------------------------- |
 | `notifyParticipation` | `(params: RefreshBuyerTokensRequest) => Promise<RefreshBuyerTokensResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L61)
+
 ##### :gear: getUserCommitment
 
 Get user commitment
@@ -421,6 +459,8 @@ Get user commitment
 | ------------------- | ----------------------------------------------------------------------- |
 | `getUserCommitment` | `(params: GetBuyerStateRequest and QueryParams) => Promise<BuyerState>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L69)
+
 ##### :gear: getDerivedState
 
 Get sale buyers state
@@ -429,6 +469,8 @@ Get sale buyers state
 | ----------------- | ------------------------------------------------------------------- |
 | `getDerivedState` | `({ certified, }: QueryParams) => Promise<GetDerivedStateResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L81)
+
 ##### :gear: getSaleParameters
 
 Get sale parameters
@@ -437,6 +479,8 @@ Get sale parameters
 | ------------------- | --------------------------------------------------------------------- |
 | `getSaleParameters` | `({ certified, }: QueryParams) => Promise<GetSaleParametersResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L90)
+
 ##### :gear: getOpenTicket
 
 Return a sale ticket if created and not yet removed (payment flow)
@@ -445,6 +489,8 @@ Return a sale ticket if created and not yet removed (payment flow)
 | --------------- | ------------------------------------------ |
 | `getOpenTicket` | `(params: QueryParams) => Promise<Ticket>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L99)
+
 ##### :gear: newSaleTicket
 
 Create a sale ticket (payment flow)
@@ -453,6 +499,8 @@ Create a sale ticket (payment flow)
 | --------------- | -------------------------------------------------- |
 | `newSaleTicket` | `(params: NewSaleTicketParams) => Promise<Ticket>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L116)
+
 ##### :gear: getLifecycle
 
 Get sale lifecycle state
@@ -461,12 +509,16 @@ Get sale lifecycle state
 | -------------- | -------------------------------------------------------- |
 | `getLifecycle` | `(params: QueryParams) => Promise<GetLifecycleResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L141)
+
 ### :factory: SnsWrapper
 
 Sns wrapper - notably used by NNS-dapp - ease the access to a particular Sns.
 It knows all the Sns' canisters, wrap and enhance their available features.
 A wrapper either performs query or update calls.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L82)
+
 #### Constructors
 
 `public`: Constructor to instantiate a Sns
@@ -525,78 +577,104 @@ Parameters:
 | ------------- | ------------------------------------------------------------------------ |
 | `listNeurons` | `(params: Omit<SnsListNeuronsParams, "certified">) => Promise<Neuron[]>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L128)
+
 ##### :gear: listProposals
 
 | Method          | Type                                                                             |
 | --------------- | -------------------------------------------------------------------------------- |
 | `listProposals` | `(params: Omit<SnsListProposalsParams, "certified">) => Promise<ProposalData[]>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L132)
+
 ##### :gear: getProposal
 
 | Method        | Type                                                                         |
 | ------------- | ---------------------------------------------------------------------------- |
 | `getProposal` | `(params: Omit<SnsGetProposalParams, "certified">) => Promise<ProposalData>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L137)
+
 ##### :gear: listNervousSystemFunctions
 
 | Method                       | Type                                                                                      |
 | ---------------------------- | ----------------------------------------------------------------------------------------- |
 | `listNervousSystemFunctions` | `(params: Omit<QueryParams, "certified">) => Promise<ListNervousSystemFunctionsResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L142)
+
 ##### :gear: metadata
 
 | Method     | Type                                                                                                    |
 | ---------- | ------------------------------------------------------------------------------------------------------- |
 | `metadata` | `(params: Omit<QueryParams, "certified">) => Promise<[GetMetadataResponse, IcrcTokenMetadataResponse]>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L147)
+
 ##### :gear: nervousSystemParameters
 
 | Method                    | Type                                                                           |
 | ------------------------- | ------------------------------------------------------------------------------ |
 | `nervousSystemParameters` | `(params: Omit<QueryParams, "certified">) => Promise<NervousSystemParameters>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L155)
+
 ##### :gear: ledgerMetadata
 
 | Method           | Type                                                                             |
 | ---------------- | -------------------------------------------------------------------------------- |
 | `ledgerMetadata` | `(params: Omit<QueryParams, "certified">) => Promise<IcrcTokenMetadataResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L160)
+
 ##### :gear: transactionFee
 
 | Method           | Type                                                          |
 | ---------------- | ------------------------------------------------------------- |
 | `transactionFee` | `(params: Omit<QueryParams, "certified">) => Promise<bigint>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L165)
+
 ##### :gear: totalTokensSupply
 
 | Method              | Type                                                          |
 | ------------------- | ------------------------------------------------------------- |
 | `totalTokensSupply` | `(params: Omit<QueryParams, "certified">) => Promise<bigint>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L170)
+
 ##### :gear: balance
 
 | Method    | Type                                                            |
 | --------- | --------------------------------------------------------------- |
 | `balance` | `(params: Omit<BalanceParams, "certified">) => Promise<bigint>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L175)
+
 ##### :gear: transfer
 
 | Method     | Type                                          |
 | ---------- | --------------------------------------------- |
 | `transfer` | `(params: TransferParams) => Promise<bigint>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L179)
+
 ##### :gear: getNeuron
 
 | Method      | Type                                                                 |
 | ----------- | -------------------------------------------------------------------- |
 | `getNeuron` | `(params: Omit<SnsGetNeuronParams, "certified">) => Promise<Neuron>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L182)
+
 ##### :gear: queryNeuron
 
 | Method        | Type                                                                 |
 | ------------- | -------------------------------------------------------------------- |
 | `queryNeuron` | `(params: Omit<SnsGetNeuronParams, "certified">) => Promise<Neuron>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L186)
+
 ##### :gear: nextNeuronAccount
 
 Returns the subaccount of the next neuron to be created.
@@ -615,6 +693,8 @@ This is how the backend can identify which neuron is being claimed.
 | ------------------- | ------------------------------------------------------------------------------ |
 | `nextNeuronAccount` | `(controller: Principal) => Promise<{ account: IcrcAccount; index: bigint; }>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L207)
+
 ##### :gear: stakeNeuron
 
 Stakes a neuron.
@@ -627,6 +707,8 @@ This is a convenient method that transfers the stake to the neuron subaccount an
 | ------------- | ------------------------------------------------------------------------------------------------ |
 | `stakeNeuron` | `({ stakeE8s, source, controller, createdAt, fee, }: SnsStakeNeuronParams) => Promise<NeuronId>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L254)
+
 ##### :gear: increaseStakeNeuron
 
 Increase the stake of a neuron.
@@ -639,90 +721,120 @@ This is a convenient method that transfers the stake to the neuron subaccount an
 | --------------------- | ---------------------------------------------------------------------------------- |
 | `increaseStakeNeuron` | `({ stakeE8s, source, neuronId, }: SnsIncreaseStakeNeuronParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L302)
+
 ##### :gear: getNeuronBalance
 
 | Method             | Type                                      |
 | ------------------ | ----------------------------------------- |
 | `getNeuronBalance` | `(neuronId: NeuronId) => Promise<bigint>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L321)
+
 ##### :gear: addNeuronPermissions
 
 | Method                 | Type                                                    |
 | ---------------------- | ------------------------------------------------------- |
 | `addNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L330)
+
 ##### :gear: refreshNeuron
 
 | Method          | Type                                    |
 | --------------- | --------------------------------------- |
 | `refreshNeuron` | `(neuronId: NeuronId) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L334)
+
 ##### :gear: claimNeuron
 
 | Method        | Type                                                  |
 | ------------- | ----------------------------------------------------- |
 | `claimNeuron` | `(params: SnsClaimNeuronParams) => Promise<NeuronId>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L338)
+
 ##### :gear: removeNeuronPermissions
 
 | Method                    | Type                                                    |
 | ------------------------- | ------------------------------------------------------- |
 | `removeNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L342)
+
 ##### :gear: splitNeuron
 
 | Method        | Type                                                  |
 | ------------- | ----------------------------------------------------- |
 | `splitNeuron` | `(params: SnsSplitNeuronParams) => Promise<NeuronId>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L347)
+
 ##### :gear: disburse
 
 | Method     | Type                                                 |
 | ---------- | ---------------------------------------------------- |
 | `disburse` | `(params: SnsDisburseNeuronParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L351)
+
 ##### :gear: startDissolving
 
 | Method            | Type                                    |
 | ----------------- | --------------------------------------- |
 | `startDissolving` | `(neuronId: NeuronId) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L355)
+
 ##### :gear: stopDissolving
 
 | Method           | Type                                    |
 | ---------------- | --------------------------------------- |
 | `stopDissolving` | `(neuronId: NeuronId) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L359)
+
 ##### :gear: setDissolveTimestamp
 
 | Method                 | Type                                                       |
 | ---------------------- | ---------------------------------------------------------- |
 | `setDissolveTimestamp` | `(params: SnsSetDissolveTimestampParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L363)
+
 ##### :gear: increaseDissolveDelay
 
 | Method                  | Type                                                        |
 | ----------------------- | ----------------------------------------------------------- |
 | `increaseDissolveDelay` | `(params: SnsIncreaseDissolveDelayParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L368)
+
 ##### :gear: setTopicFollowees
 
 | Method              | Type                                              |
 | ------------------- | ------------------------------------------------- |
 | `setTopicFollowees` | `(params: SnsSetTopicFollowees) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L373)
+
 ##### :gear: registerVote
 
 | Method         | Type                                               |
 | -------------- | -------------------------------------------------- |
 | `registerVote` | `(params: SnsRegisterVoteParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L377)
+
 ##### :gear: swapState
 
 | Method      | Type                                                                    |
 | ----------- | ----------------------------------------------------------------------- |
 | `swapState` | `(params: Omit<QueryParams, "certified">) => Promise<GetStateResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L380)
+
 ##### :gear: notifyPaymentFailure
 
 Returns the ticket if a ticket was found for the caller and the ticket
@@ -735,64 +847,86 @@ Always certified
 | ---------------------- | ----------------------- |
 | `notifyPaymentFailure` | `() => Promise<Ticket>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L393)
+
 ##### :gear: notifyParticipation
 
 | Method                | Type                                                                         |
 | --------------------- | ---------------------------------------------------------------------------- |
 | `notifyParticipation` | `(params: RefreshBuyerTokensRequest) => Promise<RefreshBuyerTokensResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L397)
+
 ##### :gear: getUserCommitment
 
 | Method              | Type                                                    |
 | ------------------- | ------------------------------------------------------- |
 | `getUserCommitment` | `(params: GetBuyerStateRequest) => Promise<BuyerState>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L402)
+
 ##### :gear: getOpenTicket
 
 | Method          | Type                                                          |
 | --------------- | ------------------------------------------------------------- |
 | `getOpenTicket` | `(params: Omit<QueryParams, "certified">) => Promise<Ticket>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L407)
+
 ##### :gear: newSaleTicket
 
 | Method          | Type                                               |
 | --------------- | -------------------------------------------------- |
 | `newSaleTicket` | `(params: NewSaleTicketParams) => Promise<Ticket>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L413)
+
 ##### :gear: getLifecycle
 
 | Method         | Type                                                                        |
 | -------------- | --------------------------------------------------------------------------- |
 | `getLifecycle` | `(params: Omit<QueryParams, "certified">) => Promise<GetLifecycleResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L416)
+
 ##### :gear: getSaleParameters
 
 | Method              | Type                                                                             |
 | ------------------- | -------------------------------------------------------------------------------- |
 | `getSaleParameters` | `(params: Omit<QueryParams, "certified">) => Promise<GetSaleParametersResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L421)
+
 ##### :gear: getDerivedState
 
 | Method            | Type                                                                           |
 | ----------------- | ------------------------------------------------------------------------------ |
 | `getDerivedState` | `(params: Omit<QueryParams, "certified">) => Promise<GetDerivedStateResponse>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L426)
+
 ##### :gear: getTransactions
 
 | Method            | Type                                                                 |
 | ----------------- | -------------------------------------------------------------------- |
 | `getTransactions` | `(params: GetAccountTransactionsParams) => Promise<GetTransactions>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L432)
+
 ##### :gear: stakeMaturity
 
 | Method          | Type                                                      |
 | --------------- | --------------------------------------------------------- |
 | `stakeMaturity` | `(params: SnsNeuronStakeMaturityParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L437)
+
 ##### :gear: autoStakeMaturity
 
 | Method              | Type                                                          |
 | ------------------- | ------------------------------------------------------------- |
 | `autoStakeMaturity` | `(params: SnsNeuronAutoStakeMaturityParams) => Promise<void>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L441)
+
 <!-- TSDOC_END -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/sns",
-  "version": "0.0.18-next-2023-07-03",
+  "version": "0.0.18",
   "description": "A library for interfacing with a Service Nervous System (SNS) project.",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.cjs.js",
@@ -36,13 +36,13 @@
     "sns"
   ],
   "peerDependencies": {
-    "@dfinity/agent": "*",
-    "@dfinity/candid": "*",
-    "@dfinity/ledger": "*",
-    "@dfinity/principal": "*",
-    "@dfinity/utils": "*"
+    "@dfinity/agent": "^0.15.4",
+    "@dfinity/candid": "^0.15.4",
+    "@dfinity/ledger": "^0.0.11",
+    "@dfinity/principal": "^0.15.4",
+    "@dfinity/utils": "^0.0.18"
   },
   "dependencies": {
     "js-sha256": "^0.9.0"
   }
-}
+}