@dfinity/nns 0.1.5 → 0.1.6

package/candid/governance.certified.did

@@ -0,0 +1,12 @@
+# The candid to interact with the governance canister using update calls in place of queries for additional security.
+
+type KnownNeuron = record {
+  id : opt NeuronId;
+  known_neuron_data : opt KnownNeuronData;
+};
+type KnownNeuronData = record { name : text; description : opt text };
+type ListKnownNeuronsResponse = record { known_neurons : vec KnownNeuron };
+type NeuronId = record { id : nat64 };
+service : {
+  list_known_neurons : () -> (ListKnownNeuronsResponse);
+}

package/candid/governance.certified.idl.d.ts

@@ -0,0 +1,2 @@
+import type { IDL } from "@dfinity/candid";
+export const idlFactory: IDL.InterfaceFactory;

package/candid/governance.certified.idl.js

@@ -0,0 +1,18 @@
+export const idlFactory = ({ IDL }) => {
+  const NeuronId = IDL.Record({ 'id' : IDL.Nat64 });
+  const KnownNeuronData = IDL.Record({
+    'name' : IDL.Text,
+    'description' : IDL.Opt(IDL.Text),
+  });
+  const KnownNeuron = IDL.Record({
+    'id' : IDL.Opt(NeuronId),
+    'known_neuron_data' : IDL.Opt(KnownNeuronData),
+  });
+  const ListKnownNeuronsResponse = IDL.Record({
+    'known_neurons' : IDL.Vec(KnownNeuron),
+  });
+  return IDL.Service({
+    'list_known_neurons' : IDL.Func([], [ListKnownNeuronsResponse], []),
+  });
+};
+export const init = ({ IDL }) => { return []; };

package/candid/governance.did

@@ -0,0 +1,10 @@
+type KnownNeuron = record {
+  id : opt NeuronId;
+  known_neuron_data : opt KnownNeuronData;
+};
+type KnownNeuronData = record { name : text; description : opt text };
+type ListKnownNeuronsResponse = record { known_neurons : vec KnownNeuron };
+type NeuronId = record { id : nat64 };
+service : {
+  list_known_neurons : () -> (ListKnownNeuronsResponse) query;
+}

package/candid/governance.idl.d.ts

@@ -0,0 +1,5 @@
+import type { IDL } from "@dfinity/candid";
+export const idlFactory: IDL.InterfaceFactory;
+
+import { _SERVICE } from "./governanceTypes";
+export { _SERVICE as GovernanceService };

package/candid/governance.idl.js

@@ -0,0 +1,18 @@
+export const idlFactory = ({ IDL }) => {
+  const NeuronId = IDL.Record({ 'id' : IDL.Nat64 });
+  const KnownNeuronData = IDL.Record({
+    'name' : IDL.Text,
+    'description' : IDL.Opt(IDL.Text),
+  });
+  const KnownNeuron = IDL.Record({
+    'id' : IDL.Opt(NeuronId),
+    'known_neuron_data' : IDL.Opt(KnownNeuronData),
+  });
+  const ListKnownNeuronsResponse = IDL.Record({
+    'known_neurons' : IDL.Vec(KnownNeuron),
+  });
+  return IDL.Service({
+    'list_known_neurons' : IDL.Func([], [ListKnownNeuronsResponse], ['query']),
+  });
+};
+export const init = ({ IDL }) => { return []; };

package/candid/governanceTypes.d.ts

@@ -0,0 +1,16 @@
+import type { Principal } from '@dfinity/principal';
+export interface KnownNeuron {
+  'id' : [] | [NeuronId],
+  'known_neuron_data' : [] | [KnownNeuronData],
+}
+export interface KnownNeuronData {
+  'name' : string,
+  'description' : [] | [string],
+}
+export interface ListKnownNeuronsResponse {
+  'known_neurons' : Array<KnownNeuron>,
+}
+export interface NeuronId { 'id' : bigint }
+export interface _SERVICE {
+  'list_known_neurons' : () => Promise<ListKnownNeuronsResponse>,
+}

package/dist/governance.d.ts

@@ -0,0 +1,30 @@
+import { Agent } from "@dfinity/agent";
+import { Principal } from "@dfinity/principal";
+import { GovernanceService } from "../candid/governance.idl";
+declare type NeuronId = bigint;
+export declare type KnownNeuron = {
+    id: NeuronId;
+    name: string;
+    description: string | undefined;
+};
+export interface GovernanceCanisterOptions {
+    agent?: Agent;
+    canisterId?: Principal;
+    serviceOverride?: GovernanceService;
+    certifiedServiceOverride?: GovernanceService;
+}
+export declare class GovernanceCanister {
+    private readonly service;
+    private readonly certifiedService;
+    private constructor();
+    static create(options?: GovernanceCanisterOptions): GovernanceCanister;
+    /**
+     * Returns the list of neurons who have been approved by the community to
+     * appear as the default followee options.
+     *
+     * If `certified` is true, the request is fetched as an update call, otherwise
+     * it is fetched using a query call.
+     */
+    listKnownNeurons: (certified?: boolean) => Promise<KnownNeuron[]>;
+}
+export {};

package/dist/governance.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GovernanceCanister = void 0;
+const agent_1 = require("@dfinity/agent");
+const principal_1 = require("@dfinity/principal");
+const governance_idl_1 = require("../candid/governance.idl");
+const governance_certified_idl_1 = require("../candid/governance.certified.idl");
+const MAINNET_GOVERNANCE_CANISTER_ID = principal_1.Principal.fromText("rrkah-fqaaa-aaaaa-aaaaq-cai");
+class GovernanceCanister {
+    constructor(service, certifiedService) {
+        this.service = service;
+        this.certifiedService = certifiedService;
+        /**
+         * Returns the list of neurons who have been approved by the community to
+         * appear as the default followee options.
+         *
+         * If `certified` is true, the request is fetched as an update call, otherwise
+         * it is fetched using a query call.
+         */
+        this.listKnownNeurons = async (certified = true) => {
+            const service = certified ? this.certifiedService : this.service;
+            const response = await service.list_known_neurons();
+            return response.known_neurons.map(n => ({
+                id: n.id[0]?.id ?? BigInt(0),
+                name: n.known_neuron_data[0]?.name ?? "",
+                description: n.known_neuron_data[0]?.description[0]
+            }));
+        };
+    }
+    static create(options = {}) {
+        const agent = options.agent ?? defaultAgent();
+        const canisterId = options.canisterId ?? MAINNET_GOVERNANCE_CANISTER_ID;
+        const service = options.serviceOverride ??
+            agent_1.Actor.createActor(governance_idl_1.idlFactory, {
+                agent,
+                canisterId,
+            });
+        const certifiedService = options.certifiedServiceOverride ??
+            agent_1.Actor.createActor(governance_certified_idl_1.idlFactory, {
+                agent,
+                canisterId,
+            });
+        return new GovernanceCanister(service, certifiedService);
+    }
+}
+exports.GovernanceCanister = GovernanceCanister;
+/**
+ * @returns The default agent to use. An agent that connects to mainnet with the anonymous identity.
+ */
+function defaultAgent() {
+    return new agent_1.HttpAgent({
+        host: "https://ic0.app",
+        identity: new agent_1.AnonymousIdentity(),
+    });
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export { GovernanceCanister, KnownNeuron } from "./governance";
 export { LedgerCanister } from "./ledger";
 export { AccountIdentifier, SubAccount } from "./account_identifier";
 export { ICP } from "./icp";

package/dist/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ICP = exports.SubAccount = exports.AccountIdentifier = exports.LedgerCanister = void 0;
+exports.ICP = exports.SubAccount = exports.AccountIdentifier = exports.LedgerCanister = exports.GovernanceCanister = void 0;
+var governance_1 = require("./governance");
+Object.defineProperty(exports, "GovernanceCanister", { enumerable: true, get: function () { return governance_1.GovernanceCanister; } });
 var ledger_1 = require("./ledger");
 Object.defineProperty(exports, "LedgerCanister", { enumerable: true, get: function () { return ledger_1.LedgerCanister; } });
 var account_identifier_1 = require("./account_identifier");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/nns",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "A library for interfacing with the Internet Computer's Network Nervous System.",
   "keywords": [
     "internet computer",
@@ -23,33 +23,47 @@
   "scripts": {
     "build": "tsc",
     "test": "jest",
+    "doc": "typedoc ./src/index.ts",
     "lint": "eslint --max-warnings 0 .",
     "format": "prettier --write .",
     "update_proto": "bash ./scripts/update_proto.sh"
   },
   "devDependencies": {
+    "@babel/preset-env": "^7.16.11",
     "@types/google-protobuf": "^3.15.5",
     "@types/jest": "^27.0.3",
     "@types/text-encoding": "^0.0.36",
     "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "babel-jest": "^27.4.6",
+    "babelify": "^10.0.0",
     "eslint": "^7.29.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
     "jest": "^27.3.1",
+    "jest-mock-extended": "^2.0.4",
     "prettier": "^2.5.0",
     "text-encoding": "^0.7.0",
     "ts-jest": "^27.0.7",
     "ts-protoc-gen": "^0.15.0",
+    "typedoc": "^0.22.11",
     "typescript": "^4.5.2",
     "whatwg-fetch": "^3.6.2"
   },
   "dependencies": {
     "@dfinity/agent": "^0.10.2",
+    "@dfinity/candid": "^0.10.2",
     "@dfinity/principal": "^0.10.2",
     "crc-32": "^1.2.0",
     "google-protobuf": "^3.19.1",
     "js-sha256": "^0.9.0"
+  },
+  "browserify": {
+    "transform": [
+      [
+        "babelify"
+      ]
+    ]
   }
 }