@dfinity/nns 2.0.0 → 2.1.0

package/README.md

@@ -9,13 +9,6 @@ A library for interfacing with the Internet Computer's Network Nervous System.
 - [Installation](#installation)
 - [Usage](#usage)
 - [Features](#features)
-  - [AccountIdentifier](#factory-accountidentifier)
-  - [SubAccount](#factory-subaccount)
-  - [GenesisTokenCanister](#factory-genesistokencanister)
-  - [ICP](#factory-icp)
-  - [LedgerCanister](#factory-ledgercanister)
-  - [GovernanceCanister](#factory-governancecanister)
-  - [SnsWasmCanister](#factory-snswasmcanister)
 
 ## Installation
 
@@ -33,28 +26,23 @@ npm i @dfinity/agent @dfinity/candid @dfinity/principal @dfinity/utils @dfinity/
 
 ## Usage
 
-Most features are provided through the use of classes. e.g. querying the `ledger` for an account balance in a NodeJS context can be developed as following:
+Most features are provided through the use of classes. For example, querying the list of neurons controlled by the caller with the `governance` canister:
 
 ```ts
-import { AccountIdentifier, LedgerCanister } from "@dfinity/nns";
+import { GovernanceCanister } from "@dfinity/nns";
+import { createAgent } from "@dfinity/utils";
 
-// If not running in browser, add polyfill of `window.fetch` for agent-js to work.
-import fetch from "cross-fetch";
-global.fetch = fetch;
+const agent = await createAgent({
+  identity,
+  host: HOST,
+});
 
-const main = async () => {
-  const ledger = LedgerCanister.create();
+const { listNeurons } = GovernanceCanister.create({
+  agent,
+  canisterId: MY_GOVERNANCE_CANISTER_ID,
+});
 
-  const accountIdentifier = AccountIdentifier.fromHex(
-    "efa01544f509c56dd85449edf2381244a48fad1ede5183836229c00ab00d52df",
-  );
-
-  const balance = await ledger.accountBalance({ accountIdentifier });
-
-  console.log(`Balance: ${balance}`);
-};
-
-await main();
+const myNeurons = await listNeurons({ certified: false });
 ```
 
 ## Features

package/dist/candid/genesis_token.did

@@ -1,4 +1,4 @@
-// Generated from IC repo commit b9fc66eafca530e997313aa68aaac31d41e6a875 'rs/nns/gtc/canister/gtc.did' by import-candid
+// Generated from IC repo commit 1a01f85fc1994e69dd5ba72b4d87fe9f9c4093ee 'rs/nns/gtc/canister/gtc.did' by import-candid
 type AccountState = record {
   authenticated_principal_id : opt principal;
   successfully_transferred_neurons : vec TransferredNeuron;