@dfinity/sns 0.0.2 → 0.0.3-next-2022-08-08

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

@@ -1,13 +1,38 @@
-import type { Neuron, _SERVICE as SnsGovernanceCanister } from "../candid/sns_governance";
+import type { GetMetadataResponse, ManageNeuron, ManageNeuronResponse, Neuron, _SERVICE as SnsGovernanceService } from "../candid/sns_governance";
 import { Canister } from "./services/canister";
-import type { CanisterOptions } from "./types/canister.options";
-import type { ListNeuronsParams } from "./types/governance.params";
+import type { SnsCanisterOptions } from "./types/canister.options";
+import type { SnsGetNeuronParams, SnsListNeuronsParams, SnsNeuronPermissionsParams } from "./types/governance.params";
 import type { QueryParams } from "./types/query.params";
-export declare class GovernanceCanister extends Canister<SnsGovernanceCanister> {
-    static create(options: CanisterOptions<SnsGovernanceCanister>): GovernanceCanister;
+export declare class SnsGovernanceCanister extends Canister<SnsGovernanceService> {
+    static create(options: SnsCanisterOptions<SnsGovernanceService>): SnsGovernanceCanister;
     /**
      * List the neurons of the Sns
      */
-    listNeurons: (params: ListNeuronsParams) => Promise<Neuron[]>;
-    metadata: (params: QueryParams) => Promise<string>;
+    listNeurons: (params: SnsListNeuronsParams) => Promise<Neuron[]>;
+    /**
+     * Get the Sns metadata (title, description, etc.)
+     */
+    metadata: (params: QueryParams) => Promise<GetMetadataResponse>;
+    /**
+     * Get the neuron of the Sns
+     */
+    getNeuron: (params: SnsGetNeuronParams & QueryParams) => Promise<Neuron>;
+    /**
+     * Manage neuron. For advanced users.
+     */
+    manageNeuron: (request: ManageNeuron) => Promise<ManageNeuronResponse>;
+    /**
+     * Add permissions to a neuron for a specific principal
+     */
+    addNeuronPermissions: (params: SnsNeuronPermissionsParams) => Promise<void>;
+    /**
+     * Remove permissions to a neuron for a specific principal
+     */
+    removeNeuronPermissions: (params: SnsNeuronPermissionsParams) => Promise<void>;
+    /**
+     *
+     * @param response ManageNeuronResponse
+     * @throws SnsGovernanceError
+     */
+    private assertManageNeuronError;
 }

package/dist/types/index.d.ts

@@ -1,13 +1,16 @@
-export type { Neuron as SnsNeuron, NeuronId as SnsNeuronId, } from "../candid/sns_governance";
+export type { GetMetadataResponse as SnsGetMetadataResponse, ManageNeuron as SnsManageNeuron, ManageNeuronResponse as SnsManageNeuronResponse, Neuron as SnsNeuron, NeuronId as SnsNeuronId, } from "../candid/sns_governance";
 export type { CanisterStatusResultV2 as SnsCanisterStatus } from "../candid/sns_root";
-export type { BuyerState as SnsSwapBuyerState, DerivedState as SnsSwapDerivedState, Init as SnsSwapInit, State as SnsSwapState, Swap as SnsSwap, TimeWindow as SnsSwapTimeWindow, } from "../candid/sns_swap";
+export type { BuyerState as SnsSwapBuyerState, DerivedState as SnsSwapDerivedState, GetBuyerStateRequest as SnsGetBuyerStateRequest, GetBuyerStateResponse as SnsGetBuyerStateResponse, Init as SnsSwapInit, State as SnsSwapState, Swap as SnsSwap, TimeWindow as SnsSwapTimeWindow, } from "../candid/sns_swap";
+export * from "./enums/governance.enums";
 export * from "./enums/swap.enums";
-export { GovernanceCanister } from "./governance.canister";
-export { LedgerCanister } from "./ledger.canister";
-export { RootCanister } from "./root.canister";
+export * from "./errors/governance.errors";
+export { SnsGovernanceCanister } from "./governance.canister";
+export { SnsLedgerCanister } from "./ledger.canister";
+export { SnsRootCanister } from "./root.canister";
 export * from "./sns";
 export * from "./sns.wrapper";
-export { SwapCanister } from "./swap.canister";
-export type { CanisterOptions } from "./types/canister.options";
-export type { ListNeuronsParams } from "./types/governance.params";
+export { SnsSwapCanister } from "./swap.canister";
+export type { SnsCanisterOptions } from "./types/canister.options";
+export type { SnsGetNeuronParams, SnsListNeuronsParams, } from "./types/governance.params";
+export * from "./types/ledger.responses";
 export type { QueryParams } from "./types/query.params";

package/dist/types/ledger.canister.d.ts

@@ -1,6 +1,12 @@
-import type { _SERVICE as SnsLedgerCanister } from "../candid/ledger";
+import type { _SERVICE as SnsLedgerService } from "../candid/icrc1_ledger";
 import { Canister } from "./services/canister";
-import type { CanisterOptions } from "./types/canister.options";
-export declare class LedgerCanister extends Canister<SnsLedgerCanister> {
-    static create(options: CanisterOptions<SnsLedgerCanister>): LedgerCanister;
+import type { SnsCanisterOptions } from "./types/canister.options";
+import type { SnsTokenMetadataResponse } from "./types/ledger.responses";
+import type { QueryParams } from "./types/query.params";
+export declare class SnsLedgerCanister extends Canister<SnsLedgerService> {
+    static create(options: SnsCanisterOptions<SnsLedgerService>): SnsLedgerCanister;
+    /**
+     * The token metadata (name, symbol, etc.).
+     */
+    metadata: (params: QueryParams) => Promise<SnsTokenMetadataResponse>;
 }

package/dist/types/root.canister.d.ts

@@ -1,8 +1,8 @@
-import type { ListSnsCanistersResponse, _SERVICE as SnsRootCanister } from "../candid/sns_root";
+import type { ListSnsCanistersResponse, _SERVICE as SnsRootService } from "../candid/sns_root";
 import { Canister } from "./services/canister";
-import type { CanisterOptions } from "./types/canister.options";
-export declare class RootCanister extends Canister<SnsRootCanister> {
-    static create(options: CanisterOptions<SnsRootCanister>): RootCanister;
+import type { SnsCanisterOptions } from "./types/canister.options";
+export declare class SnsRootCanister extends Canister<SnsRootService> {
+    static create(options: SnsCanisterOptions<SnsRootService>): SnsRootCanister;
     /**
      * List the canisters that are part of the Sns.
      *

package/dist/types/sns.d.ts

@@ -1,7 +1,7 @@
 import type { Agent } from "@dfinity/agent";
-import type { _SERVICE as SnsRootCanister } from "../candid/sns_root";
+import type { _SERVICE as SnsRootService } from "../candid/sns_root";
 import { SnsWrapper } from "./sns.wrapper";
-import type { CanisterOptions } from "./types/canister.options";
+import type { SnsCanisterOptions } from "./types/canister.options";
 import type { QueryParams } from "./types/query.params";
 /**
  * Options to discover and initialize all canisters of a Sns.
@@ -10,7 +10,7 @@ export interface InitSnsCanistersOptions extends QueryParams {
     /** An agent that can be used to override the default agent. Useful to target another environment that mainnet. */
     agent?: Agent;
     /** The options that will be used to instantiate the actors of the root canister of the particular Sns. */
-    rootOptions: Omit<CanisterOptions<SnsRootCanister>, "agent">;
+    rootOptions: Omit<SnsCanisterOptions<SnsRootService>, "agent">;
 }
 export interface InitSnsWrapper {
     (options: InitSnsCanistersOptions): Promise<SnsWrapper>;

package/dist/types/sns.wrapper.d.ts

@@ -1,21 +1,22 @@
 import type { Principal } from "@dfinity/principal";
-import type { Neuron } from "../candid/sns_governance";
-import type { GetStateResponse } from "../candid/sns_swap";
-import type { GovernanceCanister } from "./governance.canister";
-import type { LedgerCanister } from "./ledger.canister";
-import type { RootCanister } from "./root.canister";
-import type { SwapCanister } from "./swap.canister";
-import type { ListNeuronsParams } from "./types/governance.params";
+import type { GetMetadataResponse, Neuron } from "../candid/sns_governance";
+import type { BuyerState, GetBuyerStateRequest, GetStateResponse, RefreshBuyerTokensRequest } from "../candid/sns_swap";
+import type { SnsGovernanceCanister } from "./governance.canister";
+import type { SnsLedgerCanister } from "./ledger.canister";
+import type { SnsRootCanister } from "./root.canister";
+import type { SnsSwapCanister } from "./swap.canister";
+import type { SnsGetNeuronParams, SnsListNeuronsParams, SnsNeuronPermissionsParams } from "./types/governance.params";
+import type { SnsTokenMetadataResponse } from "./types/ledger.responses";
 import type { QueryParams } from "./types/query.params";
 interface SnsWrapperOptions {
     /** The wrapper for the "root" canister of the particular Sns */
-    root: RootCanister;
+    root: SnsRootCanister;
     /** The wrapper for the "governance" canister of the particular Sns */
-    governance: GovernanceCanister;
+    governance: SnsGovernanceCanister;
     /** The wrapper for the "ledger" canister of the particular Sns */
-    ledger: LedgerCanister;
+    ledger: SnsLedgerCanister;
     /** The wrapper for the "swap" canister of the particular Sns */
-    swap: SwapCanister;
+    swap: SnsSwapCanister;
     /** The wrapper has been instantiated and should perform query or update calls */
     certified: boolean;
 }
@@ -41,10 +42,16 @@ export declare class SnsWrapper {
         rootCanisterId: Principal;
         ledgerCanisterId: Principal;
         governanceCanisterId: Principal;
+        swapCanisterId: Principal;
     };
-    listNeurons: (params: Omit<ListNeuronsParams, "certified">) => Promise<Neuron[]>;
-    metadata: (params: Omit<QueryParams, "certified">) => Promise<string>;
+    listNeurons: (params: Omit<SnsListNeuronsParams, "certified">) => Promise<Neuron[]>;
+    metadata: (params: Omit<QueryParams, "certified">) => Promise<[GetMetadataResponse, SnsTokenMetadataResponse]>;
+    getNeuron: (params: Omit<SnsGetNeuronParams, "certified">) => Promise<Neuron>;
+    addNeuronPermissions: (params: SnsNeuronPermissionsParams) => Promise<void>;
+    removeNeuronPermissions: (params: SnsNeuronPermissionsParams) => Promise<void>;
     swapState: (params: Omit<QueryParams, "certified">) => Promise<GetStateResponse>;
+    notifyParticipation: (params: RefreshBuyerTokensRequest) => Promise<void>;
+    getUserCommitment: (params: GetBuyerStateRequest) => Promise<BuyerState | undefined>;
     private mergeParams;
 }
 export {};

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

@@ -1,11 +1,19 @@
-import type { GetStateResponse, _SERVICE as SnsSwapCanister } from "../candid/sns_swap";
+import type { BuyerState, GetBuyerStateRequest, GetStateResponse, RefreshBuyerTokensRequest, _SERVICE as SnsSwapService } from "../candid/sns_swap";
 import { Canister } from "./services/canister";
-import type { CanisterOptions } from "./types/canister.options";
+import type { SnsCanisterOptions } from "./types/canister.options";
 import type { QueryParams } from "./types/query.params";
-export declare class SwapCanister extends Canister<SnsSwapCanister> {
-    static create(options: CanisterOptions<SnsSwapCanister>): SwapCanister;
+export declare class SnsSwapCanister extends Canister<SnsSwapService> {
+    static create(options: SnsCanisterOptions<SnsSwapService>): SnsSwapCanister;
     /**
      * Get the state of the swap
      */
     state: (params: QueryParams) => Promise<GetStateResponse>;
+    /**
+     * Notify of the user participating in the swap
+     */
+    notifyParticipation: (params: RefreshBuyerTokensRequest) => Promise<void>;
+    /**
+     * Get user commitment
+     */
+    getUserCommitment: (params: GetBuyerStateRequest & QueryParams) => Promise<BuyerState | undefined>;
 }

package/dist/types/types/canister.options.d.ts

@@ -1,8 +1,5 @@
-import type { ActorSubclass, Agent } from "@dfinity/agent";
 import type { Principal } from "@dfinity/principal";
-export interface CanisterOptions<T> {
-    agent?: Agent;
+import type { CanisterOptions } from "@dfinity/utils";
+export interface SnsCanisterOptions<T> extends Omit<CanisterOptions<T>, "canisterId"> {
     canisterId: Principal;
-    serviceOverride?: ActorSubclass<T>;
-    certifiedServiceOverride?: ActorSubclass<T>;
 }

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

@@ -1,10 +1,11 @@
 import type { Principal } from "@dfinity/principal";
 import type { NeuronId } from "../../candid/sns_governance";
+import type { SnsNeuronPermissionType } from "../enums/governance.enums";
 import type { QueryParams } from "./query.params";
 /**
  * The parameters available to list Sns neurons
  */
-export interface ListNeuronsParams extends QueryParams {
+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` */
@@ -12,3 +13,17 @@ export interface ListNeuronsParams extends QueryParams {
     /** Index the search to returns a list that starts after specified neuron id */
     beforeNeuronId?: NeuronId;
 }
+/**
+ * The parameters to get an sns neuron
+ */
+export interface SnsGetNeuronParams extends QueryParams {
+    neuronId: NeuronId;
+}
+/**
+ * Parametes to add permissions to a neuron
+ */
+export interface SnsNeuronPermissionsParams {
+    principal: Principal;
+    neuronId: NeuronId;
+    permissions: SnsNeuronPermissionType[];
+}

package/dist/types/types/ledger.responses.d.ts

@@ -0,0 +1,11 @@
+import type { Value } from "../../candid/icrc1_ledger";
+export declare enum SnsMetadataResponseEntries {
+    SYMBOL = "icrc1:symbol",
+    NAME = "icrc1:name",
+    DECIMALS = "icrc1:decimals",
+    FEE = "icrc1:fee"
+}
+export declare type SnsTokenMetadataResponse = [
+    string | SnsMetadataResponseEntries,
+    Value
+][];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/sns",
-  "version": "0.0.2",
+  "version": "0.0.3-next-2022-08-08",
   "description": "A library for interfacing with a Service Nervous System (SNS) project.",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.cjs.js",
@@ -18,7 +18,6 @@
     "prepack": "npm run build",
     "test": "jest"
   },
-  "dependencies": {},
   "devDependencies": {},
   "repository": {
     "type": "git",
@@ -36,5 +35,8 @@
     "service nervous system",
     "service-nervous-system",
     "sns"
-  ]
-}
+  ],
+  "peerDependencies": {
+    "@dfinity/utils": "^0.0.1-next"
+  }
+}

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

@@ -1,97 +0,0 @@
-/* Do not edit.  Compiled with ./scripts/compile-idl-js from packages/sns/candid/ledger.did */
-export const idlFactory = ({ IDL }) => {
-  const BlockIndex = IDL.Nat64;
-  const GetBlocksArgs = IDL.Record({
-    'start' : BlockIndex,
-    'length' : IDL.Nat64,
-  });
-  const Memo = IDL.Nat64;
-  const AccountIdentifier = IDL.Vec(IDL.Nat8);
-  const Tokens = IDL.Record({ 'e8s' : IDL.Nat64 });
-  const Operation = IDL.Variant({
-    'Burn' : IDL.Record({ 'from' : AccountIdentifier, 'amount' : Tokens }),
-    'Mint' : IDL.Record({ 'to' : AccountIdentifier, 'amount' : Tokens }),
-    'Transfer' : IDL.Record({
-      'to' : AccountIdentifier,
-      'fee' : Tokens,
-      'from' : AccountIdentifier,
-      'amount' : Tokens,
-    }),
-  });
-  const TimeStamp = IDL.Record({ 'timestamp_nanos' : IDL.Nat64 });
-  const Transaction = IDL.Record({
-    'memo' : Memo,
-    'operation' : IDL.Opt(Operation),
-    'created_at_time' : TimeStamp,
-  });
-  const Block = IDL.Record({
-    'transaction' : Transaction,
-    'timestamp' : TimeStamp,
-    'parent_hash' : IDL.Opt(IDL.Vec(IDL.Nat8)),
-  });
-  const BlockRange = IDL.Record({ 'blocks' : IDL.Vec(Block) });
-  const QueryArchiveError = IDL.Variant({
-    'BadFirstBlockIndex' : IDL.Record({
-      'requested_index' : BlockIndex,
-      'first_valid_index' : BlockIndex,
-    }),
-    'Other' : IDL.Record({
-      'error_message' : IDL.Text,
-      'error_code' : IDL.Nat64,
-    }),
-  });
-  const QueryArchiveResult = IDL.Variant({
-    'Ok' : BlockRange,
-    'Err' : QueryArchiveError,
-  });
-  const QueryArchiveFn = IDL.Func([GetBlocksArgs], [QueryArchiveResult], []);
-  const QueryBlocksResponse = IDL.Record({
-    'certificate' : IDL.Opt(IDL.Vec(IDL.Nat8)),
-    'blocks' : IDL.Vec(Block),
-    'chain_length' : IDL.Nat64,
-    'first_block_index' : BlockIndex,
-    'archived_blocks' : IDL.Vec(
-      IDL.Record({
-        'callback' : QueryArchiveFn,
-        'start' : BlockIndex,
-        'length' : IDL.Nat64,
-      })
-    ),
-  });
-  const AccountBalanceArgs = IDL.Record({ 'account' : AccountIdentifier });
-  const Archive = IDL.Record({ 'canister_id' : IDL.Principal });
-  const Archives = IDL.Record({ 'archives' : IDL.Vec(Archive) });
-  const SubAccount = IDL.Vec(IDL.Nat8);
-  const TransferArgs = IDL.Record({
-    'to' : AccountIdentifier,
-    'fee' : Tokens,
-    'memo' : Memo,
-    'from_subaccount' : IDL.Opt(SubAccount),
-    'created_at_time' : IDL.Opt(TimeStamp),
-    'amount' : Tokens,
-  });
-  const TransferError = IDL.Variant({
-    'TxTooOld' : IDL.Record({ 'allowed_window_nanos' : IDL.Nat64 }),
-    'BadFee' : IDL.Record({ 'expected_fee' : Tokens }),
-    'TxDuplicate' : IDL.Record({ 'duplicate_of' : BlockIndex }),
-    'TxCreatedInFuture' : IDL.Null,
-    'InsufficientFunds' : IDL.Record({ 'balance' : Tokens }),
-  });
-  const TransferResult = IDL.Variant({
-    'Ok' : BlockIndex,
-    'Err' : TransferError,
-  });
-  const TransferFeeArg = IDL.Record({});
-  const TransferFee = IDL.Record({ 'transfer_fee' : Tokens });
-  return IDL.Service({
-    '_blocks' : IDL.Func([GetBlocksArgs], [QueryBlocksResponse], []),
-    'account_balance' : IDL.Func([AccountBalanceArgs], [Tokens], []),
-    'archives' : IDL.Func([], [Archives], []),
-    'decimals' : IDL.Func([], [IDL.Record({ 'decimals' : IDL.Nat32 })], []),
-    'name' : IDL.Func([], [IDL.Record({ 'name' : IDL.Text })], []),
-    'symbol' : IDL.Func([], [IDL.Record({ 'symbol' : IDL.Text })], []),
-    'transfer' : IDL.Func([TransferArgs], [TransferResult], []),
-    'transfer_fee' : IDL.Func([TransferFeeArg], [TransferFee], []),
-  });
-};
-export const init = ({ IDL }) => { return []; };

package/dist/candid/ledger.d.ts

@@ -1,106 +0,0 @@
-import type { Principal } from "@dfinity/principal";
-export interface AccountBalanceArgs {
-  account: AccountIdentifier;
-}
-export type AccountIdentifier = Array<number>;
-export interface Archive {
-  canister_id: Principal;
-}
-export interface Archives {
-  archives: Array<Archive>;
-}
-export interface Block {
-  transaction: Transaction;
-  timestamp: TimeStamp;
-  parent_hash: [] | [Array<number>];
-}
-export type BlockIndex = bigint;
-export interface BlockRange {
-  blocks: Array<Block>;
-}
-export interface GetBlocksArgs {
-  start: BlockIndex;
-  length: bigint;
-}
-export type Memo = bigint;
-export type Operation =
-  | {
-      Burn: { from: AccountIdentifier; amount: Tokens };
-    }
-  | { Mint: { to: AccountIdentifier; amount: Tokens } }
-  | {
-      Transfer: {
-        to: AccountIdentifier;
-        fee: Tokens;
-        from: AccountIdentifier;
-        amount: Tokens;
-      };
-    };
-export type QueryArchiveError =
-  | {
-      BadFirstBlockIndex: {
-        requested_index: BlockIndex;
-        first_valid_index: BlockIndex;
-      };
-    }
-  | { Other: { error_message: string; error_code: bigint } };
-export type QueryArchiveFn = (
-  arg_0: GetBlocksArgs
-) => Promise<QueryArchiveResult>;
-export type QueryArchiveResult =
-  | { Ok: BlockRange }
-  | { Err: QueryArchiveError };
-export interface QueryBlocksResponse {
-  certificate: [] | [Array<number>];
-  blocks: Array<Block>;
-  chain_length: bigint;
-  first_block_index: BlockIndex;
-  archived_blocks: Array<{
-    callback: QueryArchiveFn;
-    start: BlockIndex;
-    length: bigint;
-  }>;
-}
-export type SubAccount = Array<number>;
-export interface TimeStamp {
-  timestamp_nanos: bigint;
-}
-export interface Tokens {
-  e8s: bigint;
-}
-export interface Transaction {
-  memo: Memo;
-  operation: [] | [Operation];
-  created_at_time: TimeStamp;
-}
-export interface TransferArgs {
-  to: AccountIdentifier;
-  fee: Tokens;
-  memo: Memo;
-  from_subaccount: [] | [SubAccount];
-  created_at_time: [] | [TimeStamp];
-  amount: Tokens;
-}
-export type TransferError =
-  | {
-      TxTooOld: { allowed_window_nanos: bigint };
-    }
-  | { BadFee: { expected_fee: Tokens } }
-  | { TxDuplicate: { duplicate_of: BlockIndex } }
-  | { TxCreatedInFuture: null }
-  | { InsufficientFunds: { balance: Tokens } };
-export interface TransferFee {
-  transfer_fee: Tokens;
-}
-export type TransferFeeArg = {};
-export type TransferResult = { Ok: BlockIndex } | { Err: TransferError };
-export interface _SERVICE {
-  account_balance: (arg_0: AccountBalanceArgs) => Promise<Tokens>;
-  archives: () => Promise<Archives>;
-  decimals: () => Promise<{ decimals: number }>;
-  name: () => Promise<{ name: string }>;
-  query_blocks: (arg_0: GetBlocksArgs) => Promise<QueryBlocksResponse>;
-  symbol: () => Promise<{ symbol: string }>;
-  transfer: (arg_0: TransferArgs) => Promise<TransferResult>;
-  transfer_fee: (arg_0: TransferFeeArg) => Promise<TransferFee>;
-}