cleaning up lookup, changelog

dfinity · Sep 28, 2023 · ca8a33f · ca8a33f
1 parent ca980c0
commit ca8a33f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 13 deletions.
diff --git a/docs/generated/changelog.html b/docs/generated/changelog.html
@@ -11,7 +11,13 @@ <h1>Agent-JS Changelog</h1>
 
     <section>
       <h2>Version x.x.x</h2>
-      <ul></ul>
+      <ul>
+        <li>
+          feat!: adds certificate logic to decode subnet and node key paths from the hashtree.
+          Changes the interface for `lookup_path` to allow returning a HashTree, but also constrains
+          `lookup` response to an ArrayBuffer using a new `lookupResultToBuffer` export
+        </li>
+      </ul>
       <h2>Version 0.19.3</h2>
       <ul>
         <li>fix: Principal JSON is compatible with @dfinity/utils jsonReviver helper</li>

diff --git a/packages/agent/src/certificate.ts b/packages/agent/src/certificate.ts
@@ -207,8 +207,8 @@ export class Certificate {
     this.cert = cbor.decode(new Uint8Array(certificate));
   }
 
-  public lookup(path: Array<ArrayBuffer | string>): ArrayBuffer | HashTree | undefined {
-    return lookup_path(path, this.cert.tree);
+  public lookup(path: Array<ArrayBuffer | string>): ArrayBuffer | undefined {
+    return lookupResultToBuffer(lookup_path(path, this.cert.tree));
   }
 
   public lookup_label(label: ArrayBuffer): ArrayBuffer | HashTree | undefined {

diff --git a/packages/agent/src/polling/index.ts b/packages/agent/src/polling/index.ts
@@ -1,6 +1,6 @@
 import { Principal } from '@dfinity/principal';
 import { Agent, RequestStatusResponseStatus } from '../agent';
-import { Certificate, CreateCertificateOptions, lookupResultToBuffer } from '../certificate';
+import { Certificate, CreateCertificateOptions } from '../certificate';
 import { RequestId } from '../request_id';
 import { toHex } from '../utils/buffer';
 
@@ -41,7 +41,7 @@ export async function pollForResponse(
     canisterId: canisterId,
     blsVerify,
   });
-  const maybeBuf = lookupResultToBuffer(cert.lookup([...path, new TextEncoder().encode('status')]));
+  const maybeBuf = cert.lookup([...path, new TextEncoder().encode('status')]);
   let status;
   if (typeof maybeBuf === 'undefined') {
     // Missing requestId means we need to wait
@@ -52,7 +52,7 @@ export async function pollForResponse(
 
   switch (status) {
     case RequestStatusResponseStatus.Replied: {
-      return lookupResultToBuffer(cert.lookup([...path, 'reply']))!;
+      return cert.lookup([...path, 'reply'])!;
     }
 
     case RequestStatusResponseStatus.Received:
@@ -63,12 +63,8 @@ export async function pollForResponse(
       return pollForResponse(agent, canisterId, requestId, strategy, currentRequest);
 
     case RequestStatusResponseStatus.Rejected: {
-      const rejectCode = new Uint8Array(
-        lookupResultToBuffer(cert.lookup([...path, 'reject_code']))!,
-      )[0];
-      const rejectMessage = new TextDecoder().decode(
-        lookupResultToBuffer(cert.lookup([...path, 'reject_message']))!,
-      );
+      const rejectCode = new Uint8Array(cert.lookup([...path, 'reject_code'])!)[0];
+      const rejectMessage = new TextDecoder().decode(cert.lookup([...path, 'reject_message'])!);
       throw new Error(
         `Call was rejected:\n` +
           `  Request ID: ${toHex(requestId)}\n` +

diff --git a/packages/assets/src/index.ts b/packages/assets/src/index.ts
@@ -8,6 +8,7 @@ import {
   getDefaultAgent,
   HashTree,
   lookup_path,
+  lookupResultToBuffer,
   reconstruct,
   uint8ToBuf,
 } from '@dfinity/agent';
@@ -563,7 +564,7 @@ class Asset {
     }
 
     // Lookup hash of asset in tree
-    const treeSha = lookup_path(['http_assets', this._key], hashTree);
+    const treeSha = lookupResultToBuffer(lookup_path(['http_assets', this._key], hashTree));
 
     return !!treeSha && !!this.sha256 && compare(this.sha256.buffer, treeSha) === 0;
   }