@microsoft/ccf-app 2.0.0-dev6 → 2.0.0-rc1

package/endpoints.d.ts

@@ -38,14 +38,46 @@ export interface Request<T extends JsonCompatible<T> = any> {
     };
     /**
      * An object mapping URL path parameter names to their values.
+     *
+     * For example `GET /app/person/bob?fields=all` matched to `/app/person/{name}` becomes `{"name": "bob"}`
      */
     params: {
         [key: string]: string;
     };
     /**
-     * The query string of the requested URL.
+     * The full original requested URL.
+     *
+     * For example `GET /app/person/bob?fields=all` becomes `"/app/person/bob?fields=all"`
+     */
+    url: string;
+    /**
+     * The path component of the requested URL.
+     *
+     * For example `GET /app/person/bob?fields=all` becomes `"/app/person/bob"`
+     */
+    path: string;
+    /**
+     * The endpoint name which matched requested URL, potentially containing path parameters.
+     *
+     * For example `GET /app/person/bob?fields=all` becomes `"/app/person/{name}"`
+     */
+    route: string;
+    /**
+     * The query component of the requested URL.
+     *
+     * For example `GET /app/person/bob?fields=all` becomes `"fields=all"`
      */
     query: string;
+    /**
+     * The HTTP method of the request.
+     *
+     * For example `GET /app/person/bob?fields=all` becomes `"GET"`
+     */
+    method: string;
+    /**
+     * Hostname extracted from Host header, or null if header is missing
+     */
+    hostname: string;
     /**
      * An object to access the request body in various ways.
      */
@@ -192,4 +224,8 @@ export declare type EndpointFn<A extends JsonCompatible<A> = any, B extends Resp
  * @inheritDoc CCF.rpc.setApplyWrites
  */
 export declare const setApplyWrites: (force: boolean) => void;
+/**
+ * @inheritDoc CCF.rpc.setClaimsDigest
+ */
+export declare const setClaimsDigest: (digest: ArrayBuffer) => void;
 export {};

package/endpoints.js

@@ -11,3 +11,7 @@ import { ccf } from "./global.js";
  * @inheritDoc CCF.rpc.setApplyWrites
  */
 export const setApplyWrites = ccf.rpc.setApplyWrites.bind(ccf.rpc);
+/**
+ * @inheritDoc CCF.rpc.setClaimsDigest
+ */
+export const setClaimsDigest = ccf.rpc.setClaimsDigest.bind(ccf.rpc);

package/global.d.ts

@@ -48,6 +48,20 @@ export interface ProofElement {
      */
     right?: string;
 }
+export interface LeafComponents {
+    /**
+     * Hex-encoded hash of transaction's write set.
+     */
+    write_set_digest: string;
+    /**
+     * Raw bytes of commit evidence.
+     */
+    commit_evidence?: string;
+    /**
+     * Hex-encoded hash of transaction's claims.
+     */
+    claims_digest?: string;
+}
 /**
  * @inheritDoc Receipt.proof
  */
@@ -66,13 +80,17 @@ export interface Receipt {
      */
     proof: Proof;
     /**
-     * Hex-encoded Merkle tree leaf hash.
+     * Hex-encoded Merkle tree leaf hash, for pre-2.x transactions.
+     */
+    leaf?: string;
+    /**
+     * Components of Merkle tree leaf hash, which digest together to replace leaf.
      */
-    leaf: string;
+    leaf_components?: LeafComponents;
     /**
      * ID of the node that signed the Merkle tree root hash.
      */
-    nodeId: string;
+    node_id: string;
 }
 /**
  * State associated with a specific historic transaction.
@@ -194,6 +212,13 @@ export interface CCFRpc {
      * The default is `false`.
      */
     setApplyWrites(force: boolean): void;
+    /**
+     * Set a claims digest to be associated with the transaction if it succeeds. This
+     * digest can later be accessed from the receipt, and expanded into a full claim.
+     *
+     * The `digest` argument must be a sha-256 ArrayBuffer, eg. produced by {@link CCF.digest}
+     */
+    setClaimsDigest(digest: ArrayBuffer): void;
 }
 export interface CCFConsensus {
     /**
@@ -239,7 +264,7 @@ export interface CCFHistorical {
      * to completely fetch and validate. The call should be repeated later with
      * the same arguments to retrieve the requested entries. This state is kept
      * until it is deleted for one of the following reasons:
-     *  - A call to {@linkcode dropCachedStateRange}
+     *  - A call to {@linkcode dropCachedStates}
      *  - `seconds_until_expiry` seconds elapse without calling this function
      *  - This handle is used to request a different seqno or range
      *

package/historical.d.ts

@@ -7,7 +7,7 @@ export declare const historicalState: import("./global.js").HistoricalState | un
  */
 export declare const getStateRange: (handle: number, startSeqno: number, endSeqno: number, secondsUntilExpiry: number) => import("./global.js").HistoricalState[] | null;
 /**
- * @inheritDoc CCFHistorical.dropCachedStateRange
+ * @inheritDoc CCFHistorical.dropCachedStates
  */
 export declare const dropCachedStates: (handle: number) => boolean;
 export { HistoricalState, Receipt, Proof, ProofElement } from "./global";

package/historical.js

@@ -37,6 +37,6 @@ export const historicalState = ccf.historicalState;
  */
 export const getStateRange = ccf.historical.getStateRange.bind(ccf.historical);
 /**
- * @inheritDoc CCFHistorical.dropCachedStateRange
+ * @inheritDoc CCFHistorical.dropCachedStates
  */
 export const dropCachedStates = ccf.historical.dropCachedStates.bind(ccf.historical);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/ccf-app",
-  "version": "2.0.0-dev6",
+  "version": "2.0.0-rc1",
   "description": "CCF app support package",
   "main": "index.js",
   "files": [
@@ -19,15 +19,16 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@types/chai": "^4.2.15",
-    "@types/mocha": "^8.2.2",
-    "@types/node": "14.17.27",
-    "@types/node-forge": "^0.9.7",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^17.0.8",
+    "@types/node-forge": "^1.0.0",
     "chai": "^4.3.4",
+    "colors": "1.4.0",
     "cross-env": "^7.0.3",
     "mocha": "^9.1.3",
-    "node-forge": "^0.10.0",
-    "ts-node": "^9.1.1",
-    "typedoc": "^0.20.34",
-    "typescript": "4.2.4"
+    "node-forge": "^1.2.0",
+    "ts-node": "^10.4.0",
+    "typedoc": "^0.22.7",
+    "typescript": "^4.2.4"
   }
 }

package/polyfill.js

@@ -86,6 +86,9 @@ class CCFPolyfill {
             setApplyWrites(force) {
                 throw new Error("Not implemented");
             },
+            setClaimsDigest(digest) {
+                throw new Error("Not implemented");
+            },
         };
         this.crypto = {
             verifySignature(algorithm, key, signature, data) {