@agoric/casting 0.3.5-pismo-dev-0d5327f.0 → 0.4.1-dev-bf4b59f.0

package/CHANGELOG.md

@@ -3,6 +3,40 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/casting@0.3.2...@agoric/casting@0.4.0) (2023-05-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* emit smallcaps-format data in all marshallers
+* **AMM:**  remove the AMM and cleanup bootstrap etc. dependencies (#7074)
+* rename 'fit' to 'mustMatch'
+
+### Features
+
+* **internal:** makeFakeStorageKit supports "get" and "entries" ([6a69aab](https://github.com/Agoric/agoric-sdk/commit/6a69aab5cb54faae5af631bbc2281e4fc4ede8e0))
+* emit smallcaps-format data in all marshallers ([1753df8](https://github.com/Agoric/agoric-sdk/commit/1753df83465785b5ee71b250770c9b012d750ffc)), closes [#6822](https://github.com/Agoric/agoric-sdk/issues/6822)
+* **AMM:**  remove the AMM and cleanup bootstrap etc. dependencies ([#7074](https://github.com/Agoric/agoric-sdk/issues/7074)) ([ed5ee58](https://github.com/Agoric/agoric-sdk/commit/ed5ee58a276fce3c55f19e4f6f662ed579896c2c)), closes [#7047](https://github.com/Agoric/agoric-sdk/issues/7047)
+* **casting:** handle noData value encoding ([530bc41](https://github.com/Agoric/agoric-sdk/commit/530bc41854cc7f5e5749e97e87fabc6163a17864))
+* assertNetworkConfig ([9762b19](https://github.com/Agoric/agoric-sdk/commit/9762b19b25ebcb4678faa389d39c4bab91e0c25c))
+* getEachIterable skip height fetch ([77b1bb5](https://github.com/Agoric/agoric-sdk/commit/77b1bb589e90462bc7514347b8c62c236d72922e))
+* getLatestIterable skip height fetch ([aff3354](https://github.com/Agoric/agoric-sdk/commit/aff335417d9553182d50a5b84a4aa7c7fb6ae430))
+* getReverseIterable skip height fetch ([edbc8ec](https://github.com/Agoric/agoric-sdk/commit/edbc8ec2fab4a71e2675f5cc608f25d27b43b524))
+* vstorageKeySpecToPath ([9db1fbb](https://github.com/Agoric/agoric-sdk/commit/9db1fbb1328c28282db972b3e130e2ee3515b87d))
+
+
+### Bug Fixes
+
+* **casting:** use new subscriber tools ([cb1f739](https://github.com/Agoric/agoric-sdk/commit/cb1f739c36c28befa2ab097bfc9b86686dbe57c3))
+* require chainName ([5c5e661](https://github.com/Agoric/agoric-sdk/commit/5c5e661f444add3e1544c931c475a3a266a080de))
+
+
+### Miscellaneous Chores
+
+* rename 'fit' to 'mustMatch' ([9fa3232](https://github.com/Agoric/agoric-sdk/commit/9fa32324f84bfb85de9e99e0c9ad277b8017b50e)), closes [#6844](https://github.com/Agoric/agoric-sdk/issues/6844)
+
+
+
 ### [0.3.4](https://github.com/Agoric/agoric-sdk/compare/@agoric/casting@0.3.3...@agoric/casting@0.3.4) (2023-02-17)
 
 **Note:** Version bump only for package @agoric/casting

package/README.md

@@ -44,7 +44,7 @@ The `followerOpts` argument in `makeFollower(leader, key, followerOpts)` provide
 - the `unserializer` option can be
   - (default) - release unserialized objects using `@agoric/marshal`'s `makeMarshal()`
   - `null` - don't additionally unserialize data before releasing it
-  - any unserializer object supporting `E(unserializer).unserialize(data)`
+  - any unserializer object supporting `E(unserializer).fromCapData(data)`
 - the `crasher` option can be
   - `null` (default) follower failures only propagate an exception/rejection
   - any crasher object supporting `E(crasher).crash(reason)`

package/jsconfig.build.json

@@ -0,0 +1,12 @@
+{
+    "extends": "./jsconfig.json",
+    "compilerOptions": {
+        "noEmit": false,
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "declarationMap": true
+    },
+    "exclude": [
+        "test/"
+    ]
+}

package/jsconfig.json

@@ -1,20 +1,6 @@
 // This file can contain .js-specific Typescript compiler config.
 {
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "esnext",
-
-    "noEmit": true,
-/*
-    // The following flags are for creating .d.ts files:
-    "noEmit": false,
-    "declaration": true,
-    "emitDeclarationOnly": true,
-*/
-    "downlevelIteration": true,
-    "strictNullChecks": true,
-    "moduleResolution": "node",
-  },
+  "extends": "../../tsconfig.json",
   "include": [
     "*.js",
     "public/**/*.js",

package/node-fetch-shim.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=node-fetch-shim.d.ts.map

package/node-fetch-shim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-fetch-shim.d.ts","sourceRoot":"","sources":["node-fetch-shim.js"],"names":[],"mappings":""}

package/node-fetch-shim.js

@@ -1,4 +1,7 @@
+// @jessie-check
+
 /* global globalThis */
 import fetch from 'node-fetch';
 
+// @ts-expect-error node-fetch does not exactly match W3C Fetch
 globalThis.fetch = fetch;

package/package.json

@@ -1,42 +1,47 @@
 {
   "name": "@agoric/casting",
-  "version": "0.3.5-pismo-dev-0d5327f.0+0d5327f",
+  "version": "0.4.1-dev-bf4b59f.0+bf4b59f",
   "description": "Agoric's OCap broadcasting system",
   "type": "module",
   "main": "src/main.js",
   "repository": "https://github.com/Agoric/agoric-sdk",
   "scripts": {
     "build": "exit 0",
+    "prepack": "tsc --build jsconfig.build.json",
+    "postpack": "git clean -f '*.d.ts*'",
     "demo": "node -e 'import(\"./test/fake-rpc-server.js\").then(ns => ns.develop())'",
     "test": "ava",
     "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc --maxNodeModuleJsDepth 4 -p jsconfig.json",
+    "lint:types": "tsc -p jsconfig.json",
     "lint:eslint": "eslint --ext .js,.ts ."
   },
   "keywords": [],
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/notifier": "0.5.2-pismo-dev-0d5327f.0+0d5327f",
-    "@agoric/spawner": "0.6.6-pismo-dev-0d5327f.0+0d5327f",
-    "@cosmjs/encoding": "0.29.0",
-    "@cosmjs/proto-signing": "0.29.0",
-    "@cosmjs/stargate": "0.29.0",
-    "@cosmjs/tendermint-rpc": "0.29.0",
-    "@endo/far": "^0.2.11",
-    "@endo/init": "^0.5.49",
-    "@endo/lockdown": "^0.1.21",
-    "@endo/marshal": "^0.7.5",
-    "@endo/promise-kit": "^0.2.49",
+    "@agoric/internal": "0.3.1-dev-bf4b59f.0+bf4b59f",
+    "@agoric/notifier": "0.6.1-dev-bf4b59f.0+bf4b59f",
+    "@agoric/spawner": "0.6.7-dev-bf4b59f.0+bf4b59f",
+    "@agoric/store": "0.9.1-dev-bf4b59f.0+bf4b59f",
+    "@cosmjs/encoding": "^0.30.1",
+    "@cosmjs/proto-signing": "^0.30.1",
+    "@cosmjs/stargate": "^0.30.1",
+    "@cosmjs/tendermint-rpc": "^0.30.1",
+    "@endo/far": "^0.2.18",
+    "@endo/init": "^0.5.56",
+    "@endo/lockdown": "^0.1.28",
+    "@endo/marshal": "^0.8.5",
+    "@endo/promise-kit": "^0.2.56",
     "node-fetch": "^2.6.0"
   },
   "devDependencies": {
-    "@endo/ses-ava": "^0.2.33",
-    "ava": "^4.3.1",
-    "c8": "^7.7.2",
+    "@endo/ses-ava": "^0.2.40",
+    "@types/node-fetch": "^2.6.2",
+    "ava": "^5.2.0",
+    "c8": "^7.13.0",
     "express": "^4.17.1",
     "ws": "^7.2.0"
   },
@@ -53,5 +58,5 @@
     "timeout": "20m",
     "workerThreads": false
   },
-  "gitHead": "0d5327f87310cf523834853b0546d0e217f37009"
+  "gitHead": "bf4b59f2128aca73d786429c6ef4a7c9cdfb6700"
 }

package/src/casting-spec.d.ts

@@ -0,0 +1,16 @@
+export function vstorageKeySpecToPath({ storeName, storeSubkey }: VStorageKey): string;
+/**
+ * @param {string} storagePath
+ * @param {string} [storeName]
+ * @returns {import('./types').CastingSpec}
+ */
+export function DEFAULT_PATH_CONVERTER(storagePath: string, storeName?: string | undefined): import('./types').CastingSpec;
+/**
+ * @type {Record<string, (path: string) => import('./types').CastingSpec>}
+ */
+export const pathPrefixToConverters: Record<string, (path: string) => import('./types').CastingSpec>;
+export function makeCastingSpecFromString(specString: string): import('./types').CastingSpec;
+export function makeCastingSpecFromObject(specObj: any): import('./types').CastingSpec;
+export function makeCastingSpecFromRef(specCap: ERef<any>): Promise<import('./types').CastingSpec>;
+export function makeCastingSpec(sourceP: ERef<unknown>): Promise<import('./types').CastingSpec>;
+//# sourceMappingURL=casting-spec.d.ts.map

package/src/casting-spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"casting-spec.d.ts","sourceRoot":"","sources":["casting-spec.js"],"names":[],"mappings":"AA+CO,kEAHI,WAAW,GACT,MAAM,CAYlB;AAlCD;;;;GAIG;AACH,oDAJW,MAAM,mCAEJ,OAAO,SAAS,EAAE,WAAW,CAazC;AAsBD;;GAEG;AACH,2DAFgC,MAAM,KAAK,OAAO,SAAS,EAAE,WAAW,EAMrE;AAMI,sDAHI,MAAM,GACJ,OAAO,SAAS,EAAE,WAAW,CAczC;AAQM,mDAHI,GAAG,GACD,OAAO,SAAS,EAAE,WAAW,CAmCzC;AAMM,gDAHI,KAAK,GAAG,CAAC,GACP,QAAQ,OAAO,SAAS,EAAE,WAAW,CAAC,CAKlD;AAQM,yCAHI,KAAK,OAAO,CAAC,GACX,QAAQ,OAAO,SAAS,EAAE,WAAW,CAAC,CAgBlD"}

package/src/casting-spec.js

@@ -1,4 +1,3 @@
-// @ts-check
 import * as encodingStar from '@cosmjs/encoding';
 import { E, getInterfaceOf } from '@endo/far';
 
@@ -16,8 +15,11 @@ const swingsetPathToCastingSpec = storagePath =>
     storeSubkey: toAscii(`swingset/data:${storagePath}`),
   });
 
+// See details of encoding in golang/cosmos/x/vstorage/types/path_keys.go
+const KEY_SEPARATOR_BYTE = 0;
 const PATH_SEPARATOR_BYTE = '.'.charCodeAt(0);
 const DATA_PREFIX_BYTES = new Uint8Array([0]);
+const NO_DATA_VALUE = new Uint8Array([255]);
 
 /**
  * @param {string} storagePath
@@ -29,11 +31,32 @@ const vstoragePathToCastingSpec = (storagePath, storeName = 'vstorage') => {
   const buf = toAscii(`${elems.length}.${storagePath}`);
   return harden({
     storeName,
-    storeSubkey: buf.map(b => (b === PATH_SEPARATOR_BYTE ? 0 : b)),
+    storeSubkey: buf.map(b =>
+      b === PATH_SEPARATOR_BYTE ? KEY_SEPARATOR_BYTE : b,
+    ),
     dataPrefixBytes: DATA_PREFIX_BYTES,
+    noDataValue: NO_DATA_VALUE,
   });
 };
 
+// TODO make a similar castingSpecToPath.
+// This one uses VStorageKey which has storeSubkey:string, not UInt8Array
+/**
+ * @param {VStorageKey} vstorageKey
+ * @returns {string}
+ */
+export const vstorageKeySpecToPath = ({ storeName, storeSubkey }) => {
+  assert.equal(storeName, 'vstorage');
+  const firstSeperator = storeSubkey.indexOf(
+    String.fromCharCode(KEY_SEPARATOR_BYTE),
+  );
+  const published = storeSubkey.slice(firstSeperator);
+  const elements = published.split(String.fromCharCode(KEY_SEPARATOR_BYTE));
+  // drop the empty
+  elements.shift();
+  return `vstorage:${elements.join('.')}`;
+};
+
 export const DEFAULT_PATH_CONVERTER = vstoragePathToCastingSpec;
 
 /**
@@ -41,7 +64,7 @@ export const DEFAULT_PATH_CONVERTER = vstoragePathToCastingSpec;
  */
 export const pathPrefixToConverters = harden({
   'swingset:': swingsetPathToCastingSpec,
-  'vstore:': vstoragePathToCastingSpec,
+  'vstorage:': vstoragePathToCastingSpec,
   ':': DEFAULT_PATH_CONVERTER,
 });
 
@@ -70,8 +93,14 @@ const te = new TextEncoder();
  * @returns {import('./types').CastingSpec}
  */
 export const makeCastingSpecFromObject = specObj => {
-  const { storeName, storeSubkey, dataPrefixBytes, subscription, notifier } =
-    specObj;
+  const {
+    storeName,
+    storeSubkey,
+    dataPrefixBytes,
+    noDataValue,
+    subscription,
+    notifier,
+  } = specObj;
   if (subscription || notifier) {
     return harden({
       subscription,
@@ -86,10 +115,15 @@ export const makeCastingSpecFromObject = specObj => {
   if (typeof dataPrefixBytes === 'string') {
     dataPrefix = te.encode(dataPrefixBytes);
   }
+  let noData = noDataValue;
+  if (typeof noDataValue === 'string') {
+    noData = te.encode(noDataValue);
+  }
   return harden({
     storeName,
     storeSubkey: subkey,
     dataPrefixBytes: dataPrefix,
+    noDataValue: noData,
   });
 };
 
@@ -123,4 +157,3 @@ export const makeCastingSpec = async sourceP => {
   }
   assert.fail(`CastingSpec ${spec} is not a string, object, or ref`);
 };
-/** @typedef {ReturnType<typeof makeCastingSpec>} CastingSpec */

package/src/change-follower.d.ts

@@ -0,0 +1,2 @@
+export function makePollingChangeFollower(leader: import('./types').Leader): Promise<import('./types.js').Follower<import('./types').CastingChange>>;
+//# sourceMappingURL=change-follower.d.ts.map

package/src/change-follower.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"change-follower.d.ts","sourceRoot":"","sources":["change-follower.js"],"names":[],"mappings":"AASO,kDAHI,OAAO,SAAS,EAAE,MAAM,GACtB,QAAQ,OAAO,YAAY,EAAE,QAAQ,CAAC,OAAO,SAAS,EAAE,aAAa,CAAC,CAAC,CA6CnF"}

package/src/change-follower.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { E, Far } from '@endo/far';
 import { DEFAULT_KEEP_POLLING } from './defaults.js';
 

package/src/defaults.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Default to the local chain.
+ */
+export const DEFAULT_BOOTSTRAP: "http://localhost:26657";
+export const DEFAULT_JITTER_SECONDS: 5;
+export const DEFAULT_POLL_WITH_EVENTS_SECONDS: 600;
+export const DEFAULT_KEEP_POLLING_SECONDS: 5;
+export function delay(ms: number): Promise<void>;
+export function randomBackoff(range: number, cap?: number | undefined): number;
+export function exponentialBackoff(attempt?: number | undefined, base?: number | undefined, cap?: number | undefined): number;
+export function DEFAULT_JITTER(where: string): Promise<void>;
+export function DEFAULT_RETRY_CALLBACK(where: string, err: any, attempt?: number | undefined): Promise<void>;
+export function DEFAULT_KEEP_POLLING(): Promise<boolean>;
+export function MAKE_DEFAULT_DECODER(): (str: any) => any;
+/**
+ * Unserialize the JSONable data.
+ *
+ * @type {() => import('./types').Unserializer}
+ */
+export const MAKE_DEFAULT_UNSERIALIZER: () => import('./types').Unserializer;
+//# sourceMappingURL=defaults.d.ts.map

package/src/defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["defaults.js"],"names":[],"mappings":"AAIA;;GAEG;AACH,yDAA0D;AAE1D,uCAAwC;AAExC,mDAAoD;AAEpD,6CAA8C;AAUvC,0BAHI,MAAM,GACJ,QAAQ,IAAI,CAAC,CAEgD;AAMnE,qCAHI,MAAM,oCAKhB;AAOM,8HAEN;AAQM,sCAHI,MAAM,GACJ,QAAQ,IAAI,CAAC,CAMzB;AAUM,8CALI,MAAM,OACN,GAAG,iCAED,QAAQ,IAAI,CAAC,CASzB;AAOM,wCAFM,QAAQ,OAAO,CAAC,CAGgD;AAEtE,0DAaN;AAED;;;;GAIG;AACH,wCAFU,MAAM,OAAO,SAAS,EAAE,YAAY,CA2B5C"}

package/src/defaults.js

@@ -1,4 +1,3 @@
-// @ts-check
 /* global setTimeout */
 import { Far } from '@endo/far';
 import { makeMarshal } from '@endo/marshal';
@@ -88,7 +87,7 @@ export const MAKE_DEFAULT_DECODER = () => {
     try {
       return harden(JSON.parse(str));
     } catch (error) {
-      throw new Error(`Cannot decode alleged JSON (${error.message}): ${str}`);
+      throw Error(`Cannot decode alleged JSON (${error.message}): ${str}`);
     }
   });
 };
@@ -115,6 +114,12 @@ export const MAKE_DEFAULT_UNSERIALIZER = () => {
     return obj;
   };
   return Far('marshal unserializer', {
-    unserialize: makeMarshal(undefined, slotToVal).unserialize,
+    fromCapData: makeMarshal(undefined, slotToVal, {
+      serializeBodyFormat: 'smallcaps',
+    }).fromCapData,
+    /** @deprecated use fromCapData */
+    unserialize: makeMarshal(undefined, slotToVal, {
+      serializeBodyFormat: 'smallcaps',
+    }).fromCapData,
   });
 };

package/src/follower-cosmjs.d.ts

@@ -0,0 +1,12 @@
+export function makeCosmjsFollower<T>(sourceP: any, leaderOrMaker?: import("./types.js").LeaderOrMaker | undefined, options?: import("./types.js").FollowerOptions | undefined): ValueFollower<T>;
+export type ValueFollower<T> = import('./types.js').Follower<import('./types.js').ValueFollowerElement<T>>;
+/**
+ * The response of an ABCI query to Tendermint.
+ * This is a subset of `tendermint34.AbciQueryResponse` in order
+ * to abstract away Tendermint versions.
+ */
+export type QueryStoreResponse = {
+    readonly value: Uint8Array;
+    readonly height: number;
+};
+//# sourceMappingURL=follower-cosmjs.d.ts.map

package/src/follower-cosmjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"follower-cosmjs.d.ts","sourceRoot":"","sources":["follower-cosmjs.js"],"names":[],"mappings":"AAiGO,+CALI,GAAG,gJAyeb;+BAnjByB,OAAO,YAAY,EAAE,QAAQ,CAAC,OAAO,YAAY,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;;;;;;iCAIxF;IACZ,QAAY,CAAC,KAAK,EAAE,UAAU,CAAC;IAC/B,QAAY,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB"}