@dfinity/sns 6.0.1 → 7.0.0

package/dist/types/governance.params.d.ts

@@ -1,151 +0,0 @@
-import type { IcrcAccount, IcrcSubaccount, IcrcTokens } from "@dfinity/ledger-icrc";
-import type { QueryParams } from "@dfinity/utils";
-import type { Principal } from "@icp-sdk/core/principal";
-import type { NeuronId, ProposalId, Topic } from "../candid/sns_governance";
-import type { SnsNeuronPermissionType, SnsProposalDecisionStatus, SnsProposalRewardStatus, SnsVote } from "../enums/governance.enums";
-import type { E8s } from "./common";
-/**
- * The parameters available to list Sns neurons
- */
-export interface SnsListNeuronsParams extends QueryParams {
-    /** Scope the query to a particular principal */
-    principal?: Principal | undefined;
-    /** The maximum number of neurons returned by the method `list_neurons` */
-    limit?: number;
-    /** Index the search to returns a list that starts after specified neuron id */
-    beforeNeuronId?: NeuronId;
-}
-/**
- * The parameters available to list Sns proposals
- */
-export interface SnsListProposalsParams extends QueryParams {
-    includeRewardStatus?: SnsProposalRewardStatus[];
-    beforeProposal?: ProposalId;
-    limit?: number;
-    excludeType?: bigint[];
-    includeStatus?: SnsProposalDecisionStatus[];
-    includeTopics?: Array<Topic | null>;
-}
-export type SnsListTopicsParams = QueryParams;
-/**
- * The parameters to get an sns proposal
- */
-export interface SnsGetProposalParams extends QueryParams {
-    proposalId: ProposalId;
-}
-/**
- * The parameters to get a Sns neuron
- */
-export interface SnsGetNeuronParams extends QueryParams {
-    neuronId: NeuronId;
-}
-export interface SnsStakeNeuronParams extends Omit<QueryParams, "certified"> {
-    stakeE8s: IcrcTokens;
-    source: IcrcAccount;
-    controller: Principal;
-    createdAt?: bigint;
-    fee?: bigint;
-}
-export interface SnsIncreaseStakeNeuronParams extends Omit<QueryParams, "certified"> {
-    stakeE8s: IcrcTokens;
-    source: IcrcAccount;
-    neuronId: NeuronId;
-}
-export interface SnsClaimOrRefreshArgs extends Omit<QueryParams, "certified"> {
-    subaccount: Uint8Array;
-    memo?: bigint;
-    controller?: Principal;
-}
-/**
- * General neuron management request parameter interface
- */
-interface SnsNeuronManagementParams extends Omit<QueryParams, "certified"> {
-    neuronId: NeuronId;
-}
-/**
- * The parameters to add permissions to a neuron
- */
-export interface SnsNeuronPermissionsParams extends SnsNeuronManagementParams {
-    principal: Principal;
-    permissions: SnsNeuronPermissionType[];
-}
-/**
- * The parameters to split a neuron
- */
-export interface SnsSplitNeuronParams extends SnsNeuronManagementParams {
-    amount: E8s;
-    memo: bigint;
-}
-/**
- * The parameters to disburse a neuron
- */
-export interface SnsDisburseNeuronParams extends SnsNeuronManagementParams {
-    amount?: E8s;
-    toAccount?: IcrcAccount;
-}
-/**
- * The parameters to set dissolve timestamp
- */
-export interface SnsSetDissolveTimestampParams extends SnsNeuronManagementParams {
-    dissolveTimestampSeconds: bigint;
-}
-/**
- * The parameters to increase dissolve delay
- */
-export interface SnsIncreaseDissolveDelayParams extends SnsNeuronManagementParams {
-    additionalDissolveDelaySeconds: number;
-}
-/**
- * The parameters to follow by ns-function
- */
-export interface SnsSetTopicFollowees extends SnsNeuronManagementParams {
-    functionId: bigint;
-    followees: NeuronId[];
-}
-/**
- * The parameters to follow by topic
- */
-export interface SnsSetFollowingParams extends SnsNeuronManagementParams {
-    topicFollowing: Array<{
-        topic: Topic;
-        followees: Array<{
-            neuronId: NeuronId;
-            alias?: string;
-        }>;
-    }>;
-}
-/**
- * The parameters to register vote
- */
-export interface SnsRegisterVoteParams extends SnsNeuronManagementParams {
-    vote: SnsVote;
-    proposalId: ProposalId;
-}
-/**
- * The parameters to claim a neuron
- */
-export interface SnsClaimNeuronParams {
-    memo: bigint;
-    controller: Principal;
-    subaccount: IcrcSubaccount;
-}
-/**
- * The parameters to stake maturity of a neuron
- */
-export interface SnsNeuronStakeMaturityParams extends SnsNeuronManagementParams {
-    percentageToStake?: number;
-}
-/**
- * The parameters to disburse maturity of a neuron
- */
-export interface SnsNeuronDisburseMaturityParams extends SnsNeuronManagementParams {
-    toAccount?: IcrcAccount;
-    percentageToDisburse: number;
-}
-/**
- * The parameters to toggle auto stake maturity of a neuron
- */
-export interface SnsNeuronAutoStakeMaturityParams extends SnsNeuronManagementParams {
-    autoStake: boolean;
-}
-export {};

package/dist/types/governance_test.params.d.ts

@@ -1,7 +0,0 @@
-import type { QueryParams } from "@dfinity/utils";
-import type { NeuronId } from "../candid/sns_governance";
-import type { E8s } from "./common";
-export interface SnsAddMaturityParams extends QueryParams {
-    id: NeuronId;
-    amountE8s: E8s;
-}

package/dist/types/swap.params.d.ts

@@ -1,8 +0,0 @@
-import type { E8s } from "./common";
-/**
- * The parameters to create a sale ticket (payment flow)
- */
-export interface NewSaleTicketParams {
-    subaccount?: Uint8Array;
-    amount_icp_e8s: E8s;
-}

package/dist/utils/error.utils.d.ts

@@ -1,12 +0,0 @@
-/**
- * Identifies errors of method not being present in the canister.
- *
- * This is useful because SNS projects have different versions of SNS canisters.
- * Therefore, what works in the latest version might not work in the previous one.
- *
- * Error message example: "Call was rejected:
- * Request ID: 3a6ef904b35fd19721c95c3df2b0b00b8abefba7f0ad188f5c472809b772c914
- * Reject code: 3
- * Reject text: Canister 75ffu-oaaaa-aaaaa-aabbq-cai has no update method 'get_auto_finalization_status'"
- */
-export declare const isMethodNotSupportedError: (err: unknown) => boolean;

package/dist/utils/governance.utils.d.ts

@@ -1,14 +0,0 @@
-import type { IcrcSubaccount } from "@dfinity/ledger-icrc";
-import type { Principal } from "@icp-sdk/core/principal";
-/**
- * Neuron subaccount is calculated as "sha256(0x0c . “neuron-stake” . controller . i)"
- *
- * @param params
- * @param {Principal} params.newController
- * @param {number} params.index
- * @returns
- */
-export declare const neuronSubaccount: ({ index, controller, }: {
-    index: number;
-    controller: Principal;
-}) => IcrcSubaccount;