@agoric/internal 0.3.3-dev-e87ca23.0.e87ca23 → 0.3.3-dev-35107d8.0.35107d8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/internal",
-  "version": "0.3.3-dev-e87ca23.0.e87ca23",
+  "version": "0.3.3-dev-35107d8.0.35107d8",
   "description": "Externally unsupported utilities internal to agoric-sdk",
   "type": "module",
   "main": "src/index.js",
@@ -20,7 +20,7 @@
     "lint:types": "yarn run -T tsc"
   },
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-dev-e87ca23.0.e87ca23",
+    "@agoric/base-zone": "0.1.1-dev-35107d8.0.35107d8",
     "@endo/cache-map": "^1.1.0",
     "@endo/common": "^1.2.13",
     "@endo/compartment-mapper": "^1.6.3",
@@ -39,7 +39,7 @@
     "jessie.js": "^0.3.4"
   },
   "devDependencies": {
-    "@agoric/cosmic-proto": "0.4.1-dev-e87ca23.0.e87ca23",
+    "@agoric/cosmic-proto": "0.4.1-dev-35107d8.0.35107d8",
     "@endo/exo": "^1.5.12",
     "@endo/init": "^1.1.12",
     "@endo/ses-ava": "^1.3.2",
@@ -67,5 +67,5 @@
   "typeCoverage": {
     "atLeast": 92.89
   },
-  "gitHead": "e87ca231a5d69ff2c5de914250079e9c0dc80bac"
+  "gitHead": "35107d8a0c85cc363e80568e5226f663e29cf6ab"
 }

package/src/action-types.d.ts

@@ -11,14 +11,28 @@
  * - ../../cosmic-swingset/src/launch-chain.js
  */
 export type SwingsetMessageType = (typeof SwingsetMessageType)[keyof typeof SwingsetMessageType];
-export namespace SwingsetMessageType {
-    let AG_COSMOS_INIT: "AG_COSMOS_INIT";
-    let BEGIN_BLOCK: "BEGIN_BLOCK";
-    let END_BLOCK: "END_BLOCK";
-    let COMMIT_BLOCK: "COMMIT_BLOCK";
-    let AFTER_COMMIT_BLOCK: "AFTER_COMMIT_BLOCK";
-    let SWING_STORE_EXPORT: "SWING_STORE_EXPORT";
-}
+/**
+ * Types of messages used for communication between a cosmos-sdk blockchain node
+ * and its paired swingset VM, especially for the ABCI lifecycle. See:
+ *
+ * - https://github.com/tendermint/tendermint/blob/v0.34.x/spec/abci/abci.md#block-execution
+ * - ../../../golang/cosmos/vm/action.go
+ * - ../../../golang/cosmos/app/app.go
+ * - ../../../golang/cosmos/x/swingset/abci.go
+ * - ../../../golang/cosmos/x/swingset/keeper/swing_store_exports_handler.go
+ * - ../../cosmic-swingset/src/chain-main.js
+ * - ../../cosmic-swingset/src/launch-chain.js
+ *
+ * @enum {(typeof SwingsetMessageType)[keyof typeof SwingsetMessageType]}
+ */
+export const SwingsetMessageType: import("./keyMirror.js").KeyMirrorResult<{
+    AG_COSMOS_INIT: null;
+    BEGIN_BLOCK: null;
+    END_BLOCK: null;
+    COMMIT_BLOCK: null;
+    AFTER_COMMIT_BLOCK: null;
+    SWING_STORE_EXPORT: null;
+}>;
 export const AG_COSMOS_INIT: "AG_COSMOS_INIT";
 export const BEGIN_BLOCK: "BEGIN_BLOCK";
 export const END_BLOCK: "END_BLOCK";
@@ -37,18 +51,31 @@ export const SWING_STORE_EXPORT: "SWING_STORE_EXPORT";
  * - ../../../golang/cosmos/x/vibc/types/ibc_module.go
  */
 export type QueuedActionType = (typeof QueuedActionType)[keyof typeof QueuedActionType];
-export namespace QueuedActionType {
-    let CORE_EVAL: "CORE_EVAL";
-    let DELIVER_INBOUND: "DELIVER_INBOUND";
-    let IBC_EVENT: "IBC_EVENT";
-    let INSTALL_BUNDLE: "INSTALL_BUNDLE";
-    let PLEASE_PROVISION: "PLEASE_PROVISION";
-    let VBANK_BALANCE_UPDATE: "VBANK_BALANCE_UPDATE";
-    let WALLET_ACTION: "WALLET_ACTION";
-    let WALLET_SPEND_ACTION: "WALLET_SPEND_ACTION";
-    let VTRANSFER_IBC_EVENT: "VTRANSFER_IBC_EVENT";
-    let KERNEL_UPGRADE_EVENTS: "KERNEL_UPGRADE_EVENTS";
-}
+/**
+ * Types of "action" messages consumed by the swingset VM from actionQueue or
+ * highPriorityQueue during END_BLOCK. See:
+ *
+ * - ../../../golang/cosmos/x/swingset/keeper/msg_server.go
+ * - ../../../golang/cosmos/x/swingset/keeper/proposal.go
+ * - ../../../golang/cosmos/x/vbank/vbank.go
+ * - ../../../golang/cosmos/x/vibc/handler.go
+ * - ../../../golang/cosmos/x/vibc/keeper/triggers.go
+ * - ../../../golang/cosmos/x/vibc/types/ibc_module.go
+ *
+ * @enum {(typeof QueuedActionType)[keyof typeof QueuedActionType]}
+ */
+export const QueuedActionType: import("./keyMirror.js").KeyMirrorResult<{
+    CORE_EVAL: null;
+    DELIVER_INBOUND: null;
+    IBC_EVENT: null;
+    INSTALL_BUNDLE: null;
+    PLEASE_PROVISION: null;
+    VBANK_BALANCE_UPDATE: null;
+    WALLET_ACTION: null;
+    WALLET_SPEND_ACTION: null;
+    VTRANSFER_IBC_EVENT: null;
+    KERNEL_UPGRADE_EVENTS: null;
+}>;
 export const CORE_EVAL: "CORE_EVAL";
 export const DELIVER_INBOUND: "DELIVER_INBOUND";
 export const IBC_EVENT: "IBC_EVENT";

package/src/action-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"action-types.d.ts","sourceRoot":"","sources":["action-types.js"],"names":[],"mappings":";;;;;;;;;;;;kCAcU,CAAC,OAAO,mBAAmB,EAAE,MAAM,OAAO,mBAAmB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;+BAiC9D,CAAC,OAAO,gBAAgB,EAAE,MAAM,OAAO,gBAAgB,CAAC"}
+{"version":3,"file":"action-types.d.ts","sourceRoot":"","sources":["action-types.js"],"names":[],"mappings":";;;;;;;;;;;;kCAgBU,CAAC,OAAO,mBAAmB,EAAE,MAAM,OAAO,mBAAmB,CAAC;AAZxE;;;;;;;;;;;;;GAaG;AACH;;;;;;;GAOG;;;;;;;;;;;;;;;;;;+BAwBO,CAAC,OAAO,gBAAgB,EAAE,MAAM,OAAO,gBAAgB,CAAC;AAXlE;;;;;;;;;;;;GAYG;AACH;;;;;;;;;;;GAWG"}

package/src/action-types.js

@@ -1,5 +1,7 @@
 // @jessie-check
 
+import { keyMirror } from './keyMirror.js';
+
 /**
  * Types of messages used for communication between a cosmos-sdk blockchain node
  * and its paired swingset VM, especially for the ABCI lifecycle. See:
@@ -14,13 +16,13 @@
  *
  * @enum {(typeof SwingsetMessageType)[keyof typeof SwingsetMessageType]}
  */
-export const SwingsetMessageType = /** @type {const} */ ({
-  AG_COSMOS_INIT: 'AG_COSMOS_INIT', // used to synchronize at process launch
-  BEGIN_BLOCK: 'BEGIN_BLOCK',
-  END_BLOCK: 'END_BLOCK',
-  COMMIT_BLOCK: 'COMMIT_BLOCK',
-  AFTER_COMMIT_BLOCK: 'AFTER_COMMIT_BLOCK',
-  SWING_STORE_EXPORT: 'SWING_STORE_EXPORT', // used to synchronize data export
+export const SwingsetMessageType = keyMirror({
+  AG_COSMOS_INIT: null, // used to synchronize at process launch
+  BEGIN_BLOCK: null,
+  END_BLOCK: null,
+  COMMIT_BLOCK: null,
+  AFTER_COMMIT_BLOCK: null,
+  SWING_STORE_EXPORT: null, // used to synchronize data export
 });
 harden(SwingsetMessageType);
 
@@ -47,17 +49,17 @@ export const {
  *
  * @enum {(typeof QueuedActionType)[keyof typeof QueuedActionType]}
  */
-export const QueuedActionType = /** @type {const} */ ({
-  CORE_EVAL: 'CORE_EVAL',
-  DELIVER_INBOUND: 'DELIVER_INBOUND',
-  IBC_EVENT: 'IBC_EVENT',
-  INSTALL_BUNDLE: 'INSTALL_BUNDLE',
-  PLEASE_PROVISION: 'PLEASE_PROVISION',
-  VBANK_BALANCE_UPDATE: 'VBANK_BALANCE_UPDATE',
-  WALLET_ACTION: 'WALLET_ACTION',
-  WALLET_SPEND_ACTION: 'WALLET_SPEND_ACTION',
-  VTRANSFER_IBC_EVENT: 'VTRANSFER_IBC_EVENT',
-  KERNEL_UPGRADE_EVENTS: 'KERNEL_UPGRADE_EVENTS',
+export const QueuedActionType = keyMirror({
+  CORE_EVAL: null,
+  DELIVER_INBOUND: null,
+  IBC_EVENT: null,
+  INSTALL_BUNDLE: null,
+  PLEASE_PROVISION: null,
+  VBANK_BALANCE_UPDATE: null,
+  WALLET_ACTION: null,
+  WALLET_SPEND_ACTION: null,
+  VTRANSFER_IBC_EVENT: null,
+  KERNEL_UPGRADE_EVENTS: null,
 });
 harden(QueuedActionType);
 

package/src/config.d.ts

@@ -17,9 +17,9 @@ export namespace CosmosInitKeyToBridgeId {
     let vbankPort: "bank";
     let vibcPort: "dibc";
 }
-export namespace WalletName {
-    let depositFacet: "depositFacet";
-}
+export const WalletName: import("./keyMirror.js").KeyMirrorResult<{
+    depositFacet: null;
+}>;
 export namespace VBankAccount {
     namespace reserve {
         let module: "vbank/reserve";

package/src/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["config.js"],"names":[],"mappings":";;;uBAuCU,CAAC,OAAO,QAAQ,EAAE,MAAM,OAAO,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BANrC,OAAO,GAAG,SAAS,GAAG,SAAS"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["config.js"],"names":[],"mappings":";;;uBAyCU,CAAC,OAAO,QAAQ,EAAE,MAAM,OAAO,QAAQ,CAAC;;;;;;;;;;;;;;;;AAsBlD;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BA9BU,OAAO,GAAG,SAAS,GAAG,SAAS"}

package/src/config.js

@@ -1,6 +1,8 @@
 // @ts-check
 // @jessie-check
 
+import { keyMirror } from './keyMirror.js';
+
 /**
  * @file
  *
@@ -59,8 +61,8 @@ export const CosmosInitKeyToBridgeId = {
 };
 harden(CosmosInitKeyToBridgeId);
 
-export const WalletName = /** @type {const} */ ({
-  depositFacet: 'depositFacet',
+export const WalletName = keyMirror({
+  depositFacet: null,
 });
 harden(WalletName);
 

package/src/index.d.ts

@@ -3,6 +3,7 @@ export * from "./config.js";
 export * from "./debug.js";
 export * from "./errors.js";
 export * from "./js-utils.js";
+export * from "./keyMirror.js";
 export * from "./method-tools.js";
 export * from "./metrics.js";
 export * from "./natural-sort.js";

package/src/index.js

@@ -15,6 +15,7 @@ export * from './config.js';
 export * from './debug.js';
 export * from './errors.js';
 export * from './js-utils.js';
+export * from './keyMirror.js';
 export { pureDataMarshaller } from './marshal/pure-data.js';
 export * from './method-tools.js';
 export * from './metrics.js';

package/src/keyMirror.d.ts

@@ -0,0 +1,3 @@
+export function keyMirror<Init extends Record<string, string | null> & Record<Exclude<PropertyKey, string>, never>>(record: Init & { readonly [K in keyof Init]: Init[K] extends null ? null : K; }): KeyMirrorResult<Init>;
+export type KeyMirrorResult<Init extends Record<string, string | null> & Record<Exclude<PropertyKey, string>, never>> = { readonly [K in keyof Init]: K; };
+//# sourceMappingURL=keyMirror.d.ts.map

package/src/keyMirror.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyMirror.d.ts","sourceRoot":"","sources":["keyMirror.js"],"names":[],"mappings":"AAuBO,0BAJoF,IAAI,SAAjF,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,KAAK,CAAE,UAC/E,IAAI,GAAG,EAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,CAAC,GAAE,GACpE,eAAe,CAAC,IAAI,CAAC,CAqBjC;4BArC0F,IAAI,SAAjF,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,KAAK,CAAE,IAC7E,EAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,IAAI,GAAG,CAAC,GAAE"}

package/src/keyMirror.js

@@ -0,0 +1,45 @@
+// @ts-check
+
+const { freeze, entries } = Object;
+
+/**
+ * @template {Record<string, string | null> & Record<Exclude<PropertyKey, string>, never>} Init
+ * @typedef {{ readonly [K in keyof Init]: K }} KeyMirrorResult
+ */
+
+/**
+ * Mirror the keys of an object to string values that match the key names. This
+ * works well to define a TypeScript enum type compatible with erasable syntax:
+ *
+ *    `@enum {(typeof MyEnum)[keyof typeof MyEnum]}`
+ *
+ * The provided record must only map property names to either `null` or the
+ * property name itself. The returned object has identical keys whose values are
+ * the string form of the key.
+ *
+ * @template {Record<string, string | null> & Record<Exclude<PropertyKey, string>, never>} Init
+ * @param {Init & { readonly [K in keyof Init]: Init[K] extends null ? null : K }} record
+ * @returns {KeyMirrorResult<Init>}
+ */
+export const keyMirror = record => {
+  if (record === null || typeof record !== 'object') {
+    throw TypeError('keyMirror expects a record of string keys.');
+  }
+
+  /** @type {Record<string, string>} */
+  const mirrored = {
+    // @ts-expect-error Record confused by null prototype
+    __proto__: null,
+  };
+  for (const [key, value] of entries(record)) {
+    if (value !== null && value !== key) {
+      throw TypeError(
+        `Value for key "${key}" must be null or the key string; got ${String(value)}.`,
+      );
+    }
+    mirrored[key] = key;
+  }
+  return /** @type {KeyMirrorResult<Init>} */ (freeze(mirrored));
+};
+
+freeze(keyMirror);