feat: agent-js v2.0.0 (#679)

# Motivation Bump agent-js v2.0.0 ([release notes](https://github.com/dfinity/agent-js/releases/tag/v2.0.0)) and update `HttpAgent` creation accordingly. # Changes - `npm run update:agent` - Defer fetching root key to `HttpAgent.create` in the `createAgent` which per extension also improve the creation of the agent by also calling `syncTime` - For `defaultAgent` simply replace contructor call with synchronous `HttpAgent.createSync` --------- Signed-off-by: David Dal Busco <david.dalbusco@dfinity.org> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
dfinity · Aug 26, 2024 · 497c8ba · 497c8ba
1 parent e0c7606
commit 497c8ba
Show file tree

Hide file tree

Showing 14 changed files with 86 additions and 89 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,10 @@
 - Provide a new utility to convert Candid `Nat` to `BigInt`. This utility is useful for interpreting the fees provided by the SNS Aggregator.
 - Support conversion of `InstallCode`, `StopOrStartCanister` and `UpdateCanisterSettings` actions, `SetVisibility` neuron operation, and `Neuron::visibility` attribute.
 
+## Build
+
+- Upgrade `agent-js` dependencies to `v2.0.0`.
+
 # 2024.07.22-0645Z
 
 ## Overview

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/ckbtc/package.json b/packages/ckbtc/package.json
@@ -38,9 +38,9 @@
   ],
   "homepage": "https://github.com/dfinity/ic-js#readme",
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   },
   "dependencies": {

diff --git a/packages/cketh/package.json b/packages/cketh/package.json
@@ -38,9 +38,9 @@
   ],
   "homepage": "https://github.com/dfinity/ic-js#readme",
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   }
 }
diff --git a/packages/cmc/package.json b/packages/cmc/package.json
@@ -36,9 +36,9 @@
   ],
   "homepage": "https://github.com/dfinity/ic-js#readme",
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   }
 }
diff --git a/packages/ic-management/package.json b/packages/ic-management/package.json
@@ -34,9 +34,9 @@
   ],
   "homepage": "https://github.com/dfinity/ic-js#readme",
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   }
 }
diff --git a/packages/ledger-icp/package.json b/packages/ledger-icp/package.json
@@ -38,9 +38,9 @@
   ],
   "homepage": "https://github.com/dfinity/ic-js#readme",
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   }
 }
diff --git a/packages/ledger-icrc/package.json b/packages/ledger-icrc/package.json
@@ -37,9 +37,9 @@
   ],
   "homepage": "https://github.com/dfinity/ic-js#readme",
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   }
 }
diff --git a/packages/nns/package.json b/packages/nns/package.json
@@ -51,10 +51,10 @@
     "network-nervous-system"
   ],
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
     "@dfinity/ledger-icp": "^2.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   }
 }
diff --git a/packages/sns/package.json b/packages/sns/package.json
@@ -36,10 +36,10 @@
     "sns"
   ],
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
     "@dfinity/ledger-icrc": "^2.4.0",
-    "@dfinity/principal": "^1.4.0",
+    "@dfinity/principal": "^2.0.0",
     "@dfinity/utils": "^2.4.0"
   },
   "dependencies": {

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -47,8 +47,8 @@
     "service-nervous-system"
   ],
   "peerDependencies": {
-    "@dfinity/agent": "^1.4.0",
-    "@dfinity/candid": "^1.4.0",
-    "@dfinity/principal": "^1.4.0"
+    "@dfinity/agent": "^2.0.0",
+    "@dfinity/candid": "^2.0.0",
+    "@dfinity/principal": "^2.0.0"
   }
 }
diff --git a/packages/utils/src/utils/agent.utils.ts b/packages/utils/src/utils/agent.utils.ts
@@ -7,7 +7,7 @@ import { nonNullish } from "./nullish.utils";
  * @returns The default agent to use
  */
 export const defaultAgent = (): Agent =>
-  new HttpAgent({
+  HttpAgent.createSync({
     host: "https://icp-api.io",
     identity: new AnonymousIdentity(),
   });
@@ -34,16 +34,11 @@ export const createAgent = async ({
   verifyQuerySignatures?: boolean;
   retryTimes?: number;
 }): Promise<HttpAgent> => {
-  const agent: HttpAgent = new HttpAgent({
+  return await HttpAgent.create({
     identity,
     ...(nonNullish(host) && { host }),
     verifyQuerySignatures,
     ...(nonNullish(retryTimes) && { retryTimes }),
+    shouldFetchRootKey: fetchRootKey,
   });
-
-  if (fetchRootKey) {
-    await agent.fetchRootKey();
-  }
-
-  return agent;
 };
diff --git a/scripts/refreshNeuron.mjs b/scripts/refreshNeuron.mjs
@@ -4,16 +4,14 @@ import fetch from "node-fetch";
 import pkg from "../packages/nns/dist/index.cjs.js";
 const { GovernanceCanister } = pkg;
 
-const refreshNeuron = async (neuronId, fetchRotkey) => {
+const refreshNeuron = async (neuronId, shouldFetchRootKey) => {
   try {
-    const agent = new HttpAgent({
+    const agent = await HttpAgent.create({
       fetch,
       host: "https://ic0.app",
       // host: "https://nnsdapp.dfinity.network",
+      shouldFetchRootKey,
     });
-    if (fetchRotkey) {
-      await agent.fetchRootKey();
-    }
     const canister = GovernanceCanister.create({
       agent,
       canisterId: Principal.fromText("rrkah-fqaaa-aaaaa-aaaaq-cai"),

diff --git a/scripts/test-vectors/utils.ts b/scripts/test-vectors/utils.ts
@@ -17,7 +17,7 @@ import { MAINNET_GOVERNANCE_CANISTER_ID } from "../../packages/nns/src/constants
  * - Change `sender` in the `createCallRequest` to the one commented.
  *
  * In the hardware-wallet-cli
- * - `disableNonce: true` in `getAgent` when creating the `new HttpAgent(...)`.
+ * - `disableNonce: true` in `getAgent` when creating the `HttpAgent.create(...)`.
  * - `console.log(Buffer.from(blob).toString("hex"));` inside the `sign` method in LedgerIdentity
  *
  * Go to cbor.me and decode both blobs.