Add ability to produce a request ID from a request

js-user-library/jest.config.js

@@ -1,7 +1,14 @@
 module.exports = {
   bail: false,
+  setupFiles: [
+    "./test-setup",
+  ],
   setupFilesAfterEnv: [
     "jest-expect-message",
   ],
-  testEnvironment: "jsdom"
+  testEnvironment: "jsdom",
+  testPathIgnorePatterns: [
+    "/node_modules/",
+    "/out/",
+  ]
 };

js-user-library/package.json

@@ -25,6 +25,7 @@
     "@babel/core": "^7.6.0",
     "@babel/preset-env": "^7.6.0",
     "@babel/preset-typescript": "^7.6.0",
+    "@trust/webcrypto": "^0.9.2",
     "@types/jest": "^24.0.18",
     "babel-jest": "^24.9.0",
     "borc": "^2.1.1",

js-user-library/src/blob.ts

@@ -1,10 +1,14 @@
 import { Buffer } from "buffer/";
 import { Hex } from "./hex";
 
-export const fromHex = (hex: Hex): Uint8Array => {
-  return new Uint8Array(Buffer.from(hex, "hex").buffer);
+// Named `BinaryBlob` as opposed to `Blob` so not to conflict with
+// https://developer.mozilla.org/en-US/docs/Web/API/Blob
+export type BinaryBlob = Uint8Array & { __blob__: void };
+
+export const fromHex = (hex: Hex): BinaryBlob => {
+  return new Uint8Array(Buffer.from(hex, "hex").buffer) as BinaryBlob;
 };
 
-export const toHex = (blob: Uint8Array): string => {
+export const toHex = (blob: BinaryBlob): string => {
   return Buffer.from(blob).toString("hex");
 };

js-user-library/src/canisterId.ts

@@ -0,0 +1,16 @@
+import { Hex } from "./hex";
+import { Int } from "./int";
+import * as int from "./int";
+
+// FIXME
+// The current implementation of the client expects canister IDs to be
+// represented as u64. This `Int` type will not be sufficient for u64 but may be
+// good enough for now.
+
+// export type CanisterId = BinaryBlob & { __canisterId__: void };
+export type CanisterId = Int & { __canisterId__: void };
+
+// export const fromHex = (hex: Hex): CanisterId => {
+//   return blob.fromHex(hex) as CanisterId;
+// };
+export const fromHex = (hex: Hex): CanisterId => int.fromHex(hex) as CanisterId;

js-user-library/src/cbor.test.ts

@@ -1,19 +1,20 @@
-import { toHex } from "./blob";
+import { BinaryBlob } from "./blob";
+import * as blob from "./blob";
 import { CborValue, decode, encode } from "./cbor";
 import { Int } from "./int";
 
 test("round trip", () => {
   interface Data extends Record<string, CborValue> {
     a: Int;
     b: string;
-    c: Uint8Array;
+    c: BinaryBlob;
     d: { four: string };
   }
 
   const input: Data = {
     a: 1 as Int,
     b: "two",
-    c: Uint8Array.from([3]),
+    c: Uint8Array.from([3]) as BinaryBlob,
     d: { four: "four" },
   };
 
@@ -24,5 +25,5 @@ test("round trip", () => {
   const { c: inputC, ...inputRest } = input;
   const { c: outputC, ...outputRest } = output;
   expect(outputRest).toEqual(inputRest);
-  expect(toHex(outputC)).toBe(toHex(inputC));
+  expect(blob.toHex(outputC)).toBe(blob.toHex(inputC));
 });

js-user-library/src/cbor.ts

@@ -1,6 +1,7 @@
 // tslint:disable-next-line: max-line-length
 // https://github.com/dfinity-lab/dfinity/blob/9bca65f8edd65701ea6bdb00e0752f9186bbc893/docs/spec/public/index.adoc#cbor-encoding-of-requests-and-responses
 import borc from "borc";
+import { BinaryBlob } from "./blob";
 import { Int } from "./int";
 
 const SEMANTIC_TAG = 55799;
@@ -12,7 +13,7 @@ export type CborValue
   = string
 
   // Blobs: Major type 2 (“Byte string”)
-  | Uint8Array
+  | BinaryBlob
 
   // Integer numbers: Major type 0 or 1 (“Unsigned/signed integer”) if small
   // enough to fit that type, else the Bignum format is used.
@@ -21,11 +22,11 @@ export type CborValue
   // Nested records: Major type 5 followed by string keys.
   | CborRecord;
 
-export const encode = (value: CborValue): Uint8Array => {
+export const encode = (value: CborValue): BinaryBlob => {
   const buffer = borc.encode(
     new borc.Tagged(SEMANTIC_TAG, value),
   );
-  return new Uint8Array(buffer);
+  return new Uint8Array(buffer) as BinaryBlob;
 };
 
 export const decode = (input: Uint8Array): CborValue => {

js-user-library/src/int.ts

@@ -1 +1,7 @@
+import { Hex } from "./hex";
+
 export type Int = number & { __int__: void };
+
+export const fromHex = (hex: Hex) => parseInt(hex, 16);
+
+export const toHex = (int: Int): Hex => int.toString(16) as Hex;

js-user-library/src/readRequest.ts

@@ -0,0 +1,5 @@
+// The types of values allowed in the `request_type` field for read requests.
+export enum ReadRequestType {
+  Query = "query",
+  RequestStatus = "request-status",
+}

js-user-library/src/request.ts

@@ -0,0 +1,15 @@
+import { BinaryBlob } from "./blob";
+import { RequestType } from "./requestType";
+
+// Common request fields.
+export interface Request extends Record<string, any> {
+  request_type: RequestType;
+  // expiry?:;
+  // NOTE: `nonce` is optional in the spec, but we provide it so that requests
+  // are unique and we avoid a bug in the client when the same request is
+  // submitted more than once: https://dfinity.atlassian.net/browse/DFN-895
+  nonce?: BinaryBlob;
+  // sender:;
+  sender_pubkey: BinaryBlob;
+  sender_sig: BinaryBlob;
+}