@agoric/internal 0.3.3-dev-bd0b2a9.0 → 0.3.3-dev-2837beb.0

package/README.md

@@ -10,11 +10,11 @@ Like all `@agoric` packages it follows Semantic Versioning. Unlike the others, i
 
 # Design
 
-It is meant to be a home for modules that have no Agoric-specific dependencies themselves. It does depend on a these other @agoric packages but they are all destined to migrate out of the repo,
+It is meant to be a home for modules that have no dependencies on other packages in this repository, except for the following packages that do not theirselves depend upon any other @agoric packages and may be destined for migration elsewhere:
 
-- base-zone
-- store
-- assert
+- [base-zone](../base-zone)
+- [store](../store)
+- [cosmic-proto](../cosmic-proto)
 
 This package may not take dependencies on any others in this repository.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/internal",
-  "version": "0.3.3-dev-bd0b2a9.0+bd0b2a9",
+  "version": "0.3.3-dev-2837beb.0+2837beb",
   "description": "Externally unsupported utilities internal to agoric-sdk",
   "type": "module",
   "main": "src/index.js",
@@ -20,7 +20,7 @@
     "lint:types": "tsc"
   },
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-dev-bd0b2a9.0+bd0b2a9",
+    "@agoric/base-zone": "0.1.1-dev-2837beb.0+2837beb",
     "@endo/common": "^1.2.7",
     "@endo/errors": "^1.2.7",
     "@endo/far": "^1.1.8",
@@ -34,6 +34,7 @@
     "jessie.js": "^0.3.4"
   },
   "devDependencies": {
+    "@agoric/cosmic-proto": "0.4.1-dev-2837beb.0+2837beb",
     "@endo/exo": "^1.5.6",
     "@endo/init": "^1.1.6",
     "ava": "^5.3.0",
@@ -57,7 +58,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 93.42
+    "atLeast": 93.22
   },
-  "gitHead": "bd0b2a9f67af973d5bd789894e723251b83a8dff"
+  "gitHead": "2837beb6d7350aa6976923f1dbbb35edfa8906d6"
 }

package/src/action-types.d.ts

@@ -1,18 +1,61 @@
+/**
+ * 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
+ */
+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";
+}
 export const AG_COSMOS_INIT: "AG_COSMOS_INIT";
-export const SWING_STORE_EXPORT: "SWING_STORE_EXPORT";
 export const BEGIN_BLOCK: "BEGIN_BLOCK";
-export const CALCULATE_FEES_IN_BEANS: "CALCULATE_FEES_IN_BEANS";
-export const CORE_EVAL: "CORE_EVAL";
-export const DELIVER_INBOUND: "DELIVER_INBOUND";
 export const END_BLOCK: "END_BLOCK";
 export const COMMIT_BLOCK: "COMMIT_BLOCK";
 export const AFTER_COMMIT_BLOCK: "AFTER_COMMIT_BLOCK";
+export const SWING_STORE_EXPORT: "SWING_STORE_EXPORT";
+/**
+ * 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
+ */
+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";
+}
+export const CORE_EVAL: "CORE_EVAL";
+export const DELIVER_INBOUND: "DELIVER_INBOUND";
 export const IBC_EVENT: "IBC_EVENT";
+export const INSTALL_BUNDLE: "INSTALL_BUNDLE";
 export const PLEASE_PROVISION: "PLEASE_PROVISION";
 export const VBANK_BALANCE_UPDATE: "VBANK_BALANCE_UPDATE";
 export const WALLET_ACTION: "WALLET_ACTION";
 export const WALLET_SPEND_ACTION: "WALLET_SPEND_ACTION";
-export const INSTALL_BUNDLE: "INSTALL_BUNDLE";
+export const CALCULATE_FEES_IN_BEANS: "CALCULATE_FEES_IN_BEANS";
 export const VTRANSFER_IBC_EVENT: "VTRANSFER_IBC_EVENT";
 export const KERNEL_UPGRADE_EVENTS: "KERNEL_UPGRADE_EVENTS";
 //# sourceMappingURL=action-types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"action-types.d.ts","sourceRoot":"","sources":["action-types.js"],"names":[],"mappings":"AAEA,8CAA+C;AAC/C,sDAAuD;AACvD,wCAAyC;AACzC,gEAAiE;AACjE,oCAAqC;AACrC,gDAAiD;AACjD,oCAAqC;AACrC,0CAA2C;AAC3C,sDAAuD;AACvD,oCAAqC;AACrC,kDAAmD;AACnD,0DAA2D;AAC3D,4CAA6C;AAC7C,wDAAyD;AACzD,8CAA+C;AAC/C,wDAAyD;AACzD,4DAA6D"}
+{"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;;;;;;;;;;;;;;;;;;;AA0BlE,gEAAiE;AACjE,wDAAyD;AACzD,4DAA6D"}

package/src/action-types.js

@@ -1,19 +1,76 @@
 // @jessie-check
 
-export const AG_COSMOS_INIT = 'AG_COSMOS_INIT';
-export const SWING_STORE_EXPORT = 'SWING_STORE_EXPORT';
-export const BEGIN_BLOCK = 'BEGIN_BLOCK';
+/**
+ * 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 = /** @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
+});
+harden(SwingsetMessageType);
+
+// TODO: Update all imports to use SwingsetMessageType. But until then...
+export const {
+  AG_COSMOS_INIT,
+  BEGIN_BLOCK,
+  END_BLOCK,
+  COMMIT_BLOCK,
+  AFTER_COMMIT_BLOCK,
+  SWING_STORE_EXPORT,
+} = SwingsetMessageType;
+
+/**
+ * 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 = /** @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',
+});
+harden(QueuedActionType);
+
+// TODO: Update all imports to use QueuedActionType. But until then...
+export const {
+  CORE_EVAL,
+  DELIVER_INBOUND,
+  IBC_EVENT,
+  INSTALL_BUNDLE,
+  PLEASE_PROVISION,
+  VBANK_BALANCE_UPDATE,
+  WALLET_ACTION,
+  WALLET_SPEND_ACTION,
+} = QueuedActionType;
+
 export const CALCULATE_FEES_IN_BEANS = 'CALCULATE_FEES_IN_BEANS';
-export const CORE_EVAL = 'CORE_EVAL';
-export const DELIVER_INBOUND = 'DELIVER_INBOUND';
-export const END_BLOCK = 'END_BLOCK';
-export const COMMIT_BLOCK = 'COMMIT_BLOCK';
-export const AFTER_COMMIT_BLOCK = 'AFTER_COMMIT_BLOCK';
-export const IBC_EVENT = 'IBC_EVENT';
-export const PLEASE_PROVISION = 'PLEASE_PROVISION';
-export const VBANK_BALANCE_UPDATE = 'VBANK_BALANCE_UPDATE';
-export const WALLET_ACTION = 'WALLET_ACTION';
-export const WALLET_SPEND_ACTION = 'WALLET_SPEND_ACTION';
-export const INSTALL_BUNDLE = 'INSTALL_BUNDLE';
 export const VTRANSFER_IBC_EVENT = 'VTRANSFER_IBC_EVENT';
 export const KERNEL_UPGRADE_EVENTS = 'KERNEL_UPGRADE_EVENTS';

package/src/chain-utils.d.ts

@@ -0,0 +1,24 @@
+export function makeInitMsg(initAction: any): InitMsg;
+export type NatString = `${bigint}`;
+export type BlockInfo = {
+    blockHeight: number;
+    /**
+     * POSIX Seconds Since the Epoch
+     */
+    blockTime: number;
+    params: import("@agoric/cosmic-proto/swingset/swingset.js").ParamsSDKType;
+};
+/**
+ * cosmosInitAction fields that are subject to consensus. See cosmosInitAction
+ * in {@link  ../../../golang/cosmos/app/app.go}.
+ */
+export type InitMsg = BlockInfo & {
+    type: typeof _ActionType.AG_COSMOS_INIT;
+    chainID: string;
+    supplyCoins: {
+        denom: string;
+        amount: NatString;
+    }[];
+};
+import * as _ActionType from './action-types.js';
+//# sourceMappingURL=chain-utils.d.ts.map

package/src/chain-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-utils.d.ts","sourceRoot":"","sources":["chain-utils.js"],"names":[],"mappings":"AAqCO,wCAHI,GAAG,GACD,OAAO,CAoBnB;wBAzCa,GAAG,MAAM,EAAE;;iBAIX,MAAM;;;;eACN,MAAM;YACN,OAAO,2CAA2C,EAAE,aAAa;;;;;;sBAIlE,SAAS,GAAG;IACpB,IAAI,EAAE,OAAO,WAAW,CAAC,cAAc,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,EAAE,CAAC;CACrD;6BAhByB,mBAAmB"}

package/src/chain-utils.js

@@ -0,0 +1,56 @@
+/**
+ * @file Types and utilities for supporting blockchain functionality without
+ *   risking import cycles.
+ *
+ *   TODO: Integrate (or integrate with) any/all of:
+ *
+ *   - ./action-types.js
+ *   - ./chain-storage-paths.js
+ *   - ./config.js
+ *   - ../../cosmic-proto (if comfortable co-residing with generated code)
+ */
+
+import * as _ActionType from './action-types.js';
+
+/** @typedef {`${bigint}`} NatString */
+
+/**
+ * @typedef {object} BlockInfo
+ * @property {number} blockHeight
+ * @property {number} blockTime POSIX Seconds Since the Epoch
+ * @property {import('@agoric/cosmic-proto/swingset/swingset.js').ParamsSDKType} params
+ */
+
+/**
+ * @typedef {BlockInfo & {
+ *   type: typeof _ActionType.AG_COSMOS_INIT;
+ *   chainID: string;
+ *   supplyCoins: { denom: string; amount: NatString }[];
+ * }} InitMsg
+ *   cosmosInitAction fields that are subject to consensus. See cosmosInitAction
+ *   in {@link ../../../golang/cosmos/app/app.go}.
+ */
+
+/**
+ * @param {any} initAction
+ * @returns {InitMsg}
+ */
+export const makeInitMsg = initAction => {
+  const {
+    type,
+    blockHeight,
+    blockTime,
+    chainID,
+    params,
+    // NB: resolvedConfig is independent of consensus and MUST NOT be included
+    supplyCoins,
+  } = initAction;
+  return {
+    type,
+    blockHeight,
+    blockTime,
+    chainID,
+    params,
+    supplyCoins,
+  };
+};