feat(agent)!: use /api/v3 for query and read_state requests

CHANGELOG.md

@@ -7,6 +7,7 @@
   - Renames `v3ResponseBody` to `v4ResponseBody`
   - Renames `isV3ResponseBody` to `isV4ResponseBody`
   - Renames `HttpV3ApiNotSupportedErrorCode` to `HttpV4ApiNotSupportedErrorCode`
+- feat(agent)!: use `/api/v3` for query and read_state requests
 - feat(agent)!: supports both subnet id and canister id for certificate verification
   - The `canisterId` option has been replaced with the `principal` option in the `Certificate.create` options object
 - feat(assets)!: replaces `@dfinity/{agent,candid,principal}` deps with `@icp-sdk/core`

e2e/node/basic/__snapshots__/syncTime.test.ts.snap

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`syncTime > on async creation > should sync time on when enabled > V4 read state body one 1`] = `
+exports[`syncTime > on async creation > should sync time when enabled > V3 read state body one 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -23,7 +23,7 @@ exports[`syncTime > on async creation > should sync time on when enabled > V4 re
 }
 `;
 
-exports[`syncTime > on async creation > should sync time on when enabled > V4 read state body three 1`] = `
+exports[`syncTime > on async creation > should sync time when enabled > V3 read state body three 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -46,7 +46,7 @@ exports[`syncTime > on async creation > should sync time on when enabled > V4 re
 }
 `;
 
-exports[`syncTime > on async creation > should sync time on when enabled > V4 read state body two 1`] = `
+exports[`syncTime > on async creation > should sync time when enabled > V3 read state body two 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -116,7 +116,7 @@ exports[`syncTime > on error > should not sync time by default > V4 call body 1`
 }
 `;
 
-exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V2 read state body one 1`] = `
+exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V3 read state body one 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -139,54 +139,7 @@ exports[`syncTime > on error > should sync time when the local time does not mat
 }
 `;
 
-exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V4 call body 1`] = `
-{
-  "content": {
-    "arg": {
-      "data": [
-        68,
-        73,
-        68,
-        76,
-        0,
-        1,
-        113,
-        5,
-        119,
-        111,
-        114,
-        108,
-        100,
-      ],
-      "type": "Buffer",
-    },
-    "canister_id": {
-      "data": [
-        255,
-        255,
-        255,
-        255,
-        255,
-        144,
-        0,
-        1,
-        1,
-        1,
-      ],
-      "type": "Buffer",
-    },
-    "ingress_expiry": 1746103140000000000n,
-    "method_name": "greet",
-    "nonce": Any<Uint8Array>,
-    "request_type": "call",
-    "sender": Any<Uint8Array>,
-  },
-  "sender_pubkey": Any<Uint8Array>,
-  "sender_sig": Any<Uint8Array>,
-}
-`;
-
-exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V4 read state body three 1`] = `
+exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V3 read state body three 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -209,7 +162,7 @@ exports[`syncTime > on error > should sync time when the local time does not mat
 }
 `;
 
-exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V4 read state body two 1`] = `
+exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V3 read state body two 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -232,7 +185,7 @@ exports[`syncTime > on error > should sync time when the local time does not mat
 }
 `;
 
-exports[`syncTime > on first call > should not sync time by default > V4 call body 1`] = `
+exports[`syncTime > on error > should sync time when the local time does not match the subnet time > V4 call body 1`] = `
 {
   "content": {
     "arg": {
@@ -279,7 +232,7 @@ exports[`syncTime > on first call > should not sync time by default > V4 call bo
 }
 `;
 
-exports[`syncTime > on first call > should not sync time when explicitly disabled > V4 call body 1`] = `
+exports[`syncTime > on first call > should not sync time by default > V4 call body 1`] = `
 {
   "content": {
     "arg": {
@@ -326,7 +279,7 @@ exports[`syncTime > on first call > should not sync time when explicitly disable
 }
 `;
 
-exports[`syncTime > on first call > should sync time when enabled > V4 call body 1`] = `
+exports[`syncTime > on first call > should not sync time when explicitly disabled > V4 call body 1`] = `
 {
   "content": {
     "arg": {
@@ -373,7 +326,7 @@ exports[`syncTime > on first call > should sync time when enabled > V4 call body
 }
 `;
 
-exports[`syncTime > on first call > should sync time when enabled > V4 read state body one 1`] = `
+exports[`syncTime > on first call > should sync time when enabled > V3 read state body one 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -396,7 +349,7 @@ exports[`syncTime > on first call > should sync time when enabled > V4 read stat
 }
 `;
 
-exports[`syncTime > on first call > should sync time when enabled > V4 read state body three 1`] = `
+exports[`syncTime > on first call > should sync time when enabled > V3 read state body three 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -419,7 +372,7 @@ exports[`syncTime > on first call > should sync time when enabled > V4 read stat
 }
 `;
 
-exports[`syncTime > on first call > should sync time when enabled > V4 read state body two 1`] = `
+exports[`syncTime > on first call > should sync time when enabled > V3 read state body two 1`] = `
 {
   "content": {
     "ingress_expiry": 1746103140000000000n,
@@ -441,3 +394,50 @@ exports[`syncTime > on first call > should sync time when enabled > V4 read stat
   },
 }
 `;
+
+exports[`syncTime > on first call > should sync time when enabled > V4 call body 1`] = `
+{
+  "content": {
+    "arg": {
+      "data": [
+        68,
+        73,
+        68,
+        76,
+        0,
+        1,
+        113,
+        5,
+        119,
+        111,
+        114,
+        108,
+        100,
+      ],
+      "type": "Buffer",
+    },
+    "canister_id": {
+      "data": [
+        255,
+        255,
+        255,
+        255,
+        255,
+        144,
+        0,
+        1,
+        1,
+        1,
+      ],
+      "type": "Buffer",
+    },
+    "ingress_expiry": 1746103140000000000n,
+    "method_name": "greet",
+    "nonce": Any<Uint8Array>,
+    "request_type": "call",
+    "sender": Any<Uint8Array>,
+  },
+  "sender_pubkey": Any<Uint8Array>,
+  "sender_sig": Any<Uint8Array>,
+}
+`;

e2e/node/basic/canisterStatus.test.ts

@@ -12,7 +12,7 @@ import { getCanisterId } from '../utils/canisterid.ts';
 import {
   MockReplica,
   mockSyncTimeResponse,
-  prepareV2ReadStateSubnetResponse,
+  prepareV3ReadStateSubnetResponse,
 } from '../utils/mock-replica.ts';
 import { randomIdentity, randomKeyPair } from '../utils/identity.ts';
 
@@ -92,14 +92,14 @@ describe('canister status', () => {
         identity,
       });
 
-      const { responseBody: subnetResponseBody } = await prepareV2ReadStateSubnetResponse({
+      const { responseBody: subnetResponseBody } = await prepareV3ReadStateSubnetResponse({
         nodeIdentity,
         canisterRanges: [[canisterId.toUint8Array(), canisterId.toUint8Array()]],
         keyPair: subnetKeyPair,
         date: replicaDate,
       });
       // first try, fails
-      mockReplica.setV2ReadStateSpyImplOnce(canisterId.toString(), (_req, res) => {
+      mockReplica.setV3ReadStateSpyImplOnce(canisterId.toString(), (_req, res) => {
         res.status(200).send(subnetResponseBody);
       });
       // syncs time
@@ -124,7 +124,7 @@ describe('canister status', () => {
         expect(err.cause.code).toBeInstanceOf(CertificateTimeErrorCode);
         expect(err.message).toContain('Certificate is signed more than 5 minutes in the past');
       }
-      expect(mockReplica.getV2ReadStateSpy(canisterId.toString())).toHaveBeenCalledTimes(4);
+      expect(mockReplica.getV3ReadStateSpy(canisterId.toString())).toHaveBeenCalledTimes(4);
     });
 
     it('should sync time and succeed if the certificate is not fresh', async () => {
@@ -137,14 +137,14 @@ describe('canister status', () => {
         identity,
       });
 
-      const { responseBody: subnetResponseBody } = await prepareV2ReadStateSubnetResponse({
+      const { responseBody: subnetResponseBody } = await prepareV3ReadStateSubnetResponse({
         nodeIdentity,
         canisterRanges: [[canisterId.toUint8Array(), canisterId.toUint8Array()]],
         keyPair: subnetKeyPair,
         date: replicaDate,
       });
       // first try, fails
-      mockReplica.setV2ReadStateSpyImplOnce(canisterId.toString(), (_req, res) => {
+      mockReplica.setV3ReadStateSpyImplOnce(canisterId.toString(), (_req, res) => {
         res.status(200).send(subnetResponseBody);
       });
       // sync time, we return the replica date to make the agent sync time properly
@@ -162,7 +162,7 @@ describe('canister status', () => {
           paths: ['subnet'],
         }),
       ).resolves.not.toThrow();
-      expect(mockReplica.getV2ReadStateSpy(canisterId.toString())).toHaveBeenCalledTimes(4);
+      expect(mockReplica.getV3ReadStateSpy(canisterId.toString())).toHaveBeenCalledTimes(4);
     });
 
     it('should not sync time and succeed if the certificate is not fresh and disableTimeVerification is true', async () => {
@@ -175,13 +175,13 @@ describe('canister status', () => {
         identity,
       });
 
-      const { responseBody: subnetResponseBody } = await prepareV2ReadStateSubnetResponse({
+      const { responseBody: subnetResponseBody } = await prepareV3ReadStateSubnetResponse({
         nodeIdentity,
         canisterRanges: [[canisterId.toUint8Array(), canisterId.toUint8Array()]],
         keyPair: subnetKeyPair,
         date: replicaDate,
       });
-      mockReplica.setV2ReadStateSpyImplOnce(canisterId.toString(), (_req, res) => {
+      mockReplica.setV3ReadStateSpyImplOnce(canisterId.toString(), (_req, res) => {
         res.status(200).send(subnetResponseBody);
       });
 
@@ -193,7 +193,7 @@ describe('canister status', () => {
           disableCertificateTimeVerification: true,
         }),
       ).resolves.not.toThrow();
-      expect(mockReplica.getV2ReadStateSpy(canisterId.toString())).toHaveBeenCalledTimes(1);
+      expect(mockReplica.getV3ReadStateSpy(canisterId.toString())).toHaveBeenCalledTimes(1);
     });
   });
 });

e2e/node/basic/mainnet.test.ts

@@ -6,8 +6,8 @@ import {
   CanisterStatus,
   polling,
   requestIdOf,
-  TrustError,
-  MissingSignatureErrorCode,
+  ProtocolError,
+  DerKeyLengthMismatchErrorCode,
 } from '@icp-sdk/core/agent';
 import { IDL } from '@icp-sdk/core/candid';
 import { Ed25519KeyIdentity } from '@icp-sdk/core/identity';
@@ -206,9 +206,9 @@ test('it should allow you to set an incorrect root key', async () => {
   try {
     await actor.whoami();
   } catch (error) {
-    expect(error).toBeInstanceOf(TrustError);
-    const errorCode = (error as TrustError).cause.code;
-    expect(errorCode).toBeInstanceOf(MissingSignatureErrorCode);
+    expect(error).toBeInstanceOf(ProtocolError);
+    const errorCode = (error as ProtocolError).cause.code;
+    expect(errorCode).toBeInstanceOf(DerKeyLengthMismatchErrorCode);
     expect(errorCode.requestContext).toBeDefined();
   }
 });