@microsoft/ccf-app 2.0.0-dev5 → 2.0.0-rc0

package/consensus.js

@@ -2,9 +2,7 @@
 // Licensed under the Apache 2.0 License.
 /**
  * The `consensus` module provides access to consensus information
- * as observed by the local node. While the information will converge
- * on all nodes in a healthy network, it is derived from distributed
- * state rather than distributed itself.
+ * as observed by the local node.
  *
  * @module
  */
@@ -12,12 +10,12 @@ import { ccf } from "./global.js";
 /**
  * @inheritDoc CCFConsensus.getLastCommittedTxId;
  */
-export const getLastCommittedTxId = ccf.consensus.getLastCommittedTxId;
+export const getLastCommittedTxId = ccf.consensus.getLastCommittedTxId.bind(ccf.consensus);
 /**
  * @inheritDoc CCFConsensus.getStatusForTxId;
  */
-export const getStatusForTxId = ccf.consensus.getStatusForTxId;
+export const getStatusForTxId = ccf.consensus.getStatusForTxId.bind(ccf.consensus);
 /**
  * @inheritDoc CCFConsensus.getViewForSeqno;
  */
-export const getViewForSeqno = ccf.consensus.getViewForSeqno;
+export const getViewForSeqno = ccf.consensus.getViewForSeqno.bind(ccf.consensus);

package/endpoints.d.ts

@@ -46,6 +46,10 @@ export interface Request<T extends JsonCompatible<T> = any> {
      * The query string of the requested URL.
      */
     query: string;
+    /**
+     * The request path of the requested URL.
+     */
+    path: string;
     /**
      * An object to access the request body in various ways.
      */
@@ -192,4 +196,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

@@ -194,6 +194,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 {
     /**
@@ -202,9 +209,24 @@ export interface CCFConsensus {
     getLastCommittedTxId(): TransactionId;
     /**
      * Get the status of a transaction by ID, provided as a view+seqno pair.
-     * This is a node-local property - while it will converge on all nodes in
-     * a healthy network, it is derived from distributed state rather than
-     * distributed itself.
+     *
+     * Note that this value is the node's local understanding of the status
+     * of that transaction in the network at call time. For a given TxID, the
+     * initial status is always UNKNOWN, and eventually becomes COMMITTED or
+     * INVALID. See the documentation section titled "Verifying Transactions"
+     * for more detail.
+     *
+     *         UNKNOWN [Initial status]
+     *          v  ^
+     *        PENDING
+     *        v     v
+     *  COMMITTED INVALID [Final statuses]
+     *
+     * This status is not sampled atomically per handler: if this is called
+     * multiple times in a transaction handler, later calls may see more up to
+     * date values than earlier calls. Once a final state (COMMITTED or INVALID)
+     * has been reached, no further changes are possible.
+     *
      */
     getStatusForTxId(view: number, seqno: number): TransactionStatus;
     /**
@@ -224,7 +246,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

@@ -35,8 +35,8 @@ export const historicalState = ccf.historicalState;
 /**
  * @inheritDoc CCFHistorical.getStateRange
  */
-export const getStateRange = ccf.historical.getStateRange;
+export const getStateRange = ccf.historical.getStateRange.bind(ccf.historical);
 /**
- * @inheritDoc CCFHistorical.dropCachedStateRange
+ * @inheritDoc CCFHistorical.dropCachedStates
  */
-export const dropCachedStates = ccf.historical.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-dev5",
+  "version": "2.0.0-rc0",
   "description": "CCF app support package",
   "main": "index.js",
   "files": [
@@ -13,23 +13,22 @@
     "build": "tsc",
     "test": "cross-env TS_NODE_PROJECT=test/tsconfig.json mocha --loader=ts-node/esm test/**/*.test.ts",
     "docs": "typedoc",
-    "docs:serve": "rm -rf html && concurrently \"typedoc --watch --preserveWatchOutput\" \"serve html\""
+    "docs:watch": "rm -rf html && typedoc --watch --preserveWatchOutput"
   },
   "author": "Microsoft",
   "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",
-    "concurrently": "^6.0.0",
+    "colors": "1.4.0",
     "cross-env": "^7.0.3",
-    "mocha": "^8.3.2",
-    "node-forge": "^0.10.0",
-    "serve": "^11.3.2",
-    "ts-node": "^9.1.1",
-    "typedoc": "^0.20.34",
-    "typescript": "4.2.4"
+    "mocha": "^9.1.3",
+    "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) {