@agoric/cosmic-swingset 0.41.4-dev-b31bd09.0 → 0.41.4-dev-1976c50.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/cosmic-swingset",
-  "version": "0.41.4-dev-b31bd09.0+b31bd09",
+  "version": "0.41.4-dev-1976c50.0+1976c50",
   "description": "Agoric's Cosmos blockchain integration",
   "type": "module",
   "bin": {
@@ -22,15 +22,15 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/builders": "0.1.1-dev-b31bd09.0+b31bd09",
-    "@agoric/cosmos": "0.34.2-dev-b31bd09.0+b31bd09",
-    "@agoric/deploy-script-support": "0.10.4-dev-b31bd09.0+b31bd09",
-    "@agoric/internal": "0.3.3-dev-b31bd09.0+b31bd09",
-    "@agoric/store": "0.9.3-dev-b31bd09.0+b31bd09",
-    "@agoric/swing-store": "0.9.2-dev-b31bd09.0+b31bd09",
-    "@agoric/swingset-vat": "0.32.3-dev-b31bd09.0+b31bd09",
-    "@agoric/telemetry": "0.6.3-dev-b31bd09.0+b31bd09",
-    "@agoric/vm-config": "0.1.1-dev-b31bd09.0+b31bd09",
+    "@agoric/builders": "0.1.1-dev-1976c50.0+1976c50",
+    "@agoric/cosmos": "0.34.2-dev-1976c50.0+1976c50",
+    "@agoric/deploy-script-support": "0.10.4-dev-1976c50.0+1976c50",
+    "@agoric/internal": "0.3.3-dev-1976c50.0+1976c50",
+    "@agoric/store": "0.9.3-dev-1976c50.0+1976c50",
+    "@agoric/swing-store": "0.9.2-dev-1976c50.0+1976c50",
+    "@agoric/swingset-vat": "0.32.3-dev-1976c50.0+1976c50",
+    "@agoric/telemetry": "0.6.3-dev-1976c50.0+1976c50",
+    "@agoric/vm-config": "0.1.1-dev-1976c50.0+1976c50",
     "@endo/bundle-source": "^3.4.0",
     "@endo/env-options": "^1.1.6",
     "@endo/errors": "^1.2.5",
@@ -39,6 +39,7 @@
     "@endo/init": "^1.1.4",
     "@endo/marshal": "^1.5.3",
     "@endo/nat": "^5.0.10",
+    "@endo/patterns": "^1.4.3",
     "@endo/promise-kit": "^1.1.5",
     "@iarna/toml": "^2.2.3",
     "@opentelemetry/api": "~1.3.0",
@@ -70,5 +71,5 @@
   "typeCoverage": {
     "atLeast": 80.6
   },
-  "gitHead": "b31bd097f992f1a6eb83c9cba42ea97752efd061"
+  "gitHead": "1976c502bcaac2e7d21f42b30447671a61053236"
 }

package/src/chain-main.js

@@ -12,6 +12,9 @@ import { fork } from 'node:child_process';
 
 import { Fail, q } from '@endo/errors';
 import { E } from '@endo/far';
+import { makeMarshal } from '@endo/marshal';
+import { isNat } from '@endo/nat';
+import { M, mustMatch } from '@endo/patterns';
 import engineGC from '@agoric/internal/src/lib-nodejs/engine-gc.js';
 import { waitUntilQuiescent } from '@agoric/internal/src/lib-nodejs/waitUntilQuiescent.js';
 import {
@@ -25,7 +28,6 @@ import {
   makeChainStorageRoot,
   makeSerializeToStorage,
 } from '@agoric/internal/src/lib-chainStorage.js';
-import { makeMarshal } from '@endo/marshal';
 import { makeShutdown } from '@agoric/internal/src/node/shutdown.js';
 
 import * as STORAGE_PATH from '@agoric/internal/src/chain-storage-paths.js';
@@ -72,7 +74,27 @@ const toNumber = specimen => {
  * @typedef {object} CosmosSwingsetConfig
  * @property {string} [slogfile]
  * @property {number} [maxVatsOnline]
+ * @property {'debug' | 'operational'} [vatSnapshotRetention]
+ * @property {'archival' | 'operational'} [vatTranscriptRetention]
  */
+const SwingsetConfigShape = M.splitRecord(
+  // All known properties are optional, but unknown properties are not allowed.
+  {},
+  {
+    slogfile: M.string(),
+    maxVatsOnline: M.number(),
+    vatSnapshotRetention: M.or('debug', 'operational'),
+    vatTranscriptRetention: M.or('archival', 'operational'),
+  },
+  {},
+);
+const validateSwingsetConfig = swingsetConfig => {
+  mustMatch(swingsetConfig, SwingsetConfigShape);
+  const { maxVatsOnline } = swingsetConfig;
+  maxVatsOnline === undefined ||
+    (isNat(maxVatsOnline) && maxVatsOnline > 0) ||
+    Fail`maxVatsOnline must be a positive integer`;
+};
 
 /**
  * A boot message consists of cosmosInitAction fields that are subject to
@@ -100,19 +122,6 @@ const makeBootMsg = initAction => {
   };
 };
 
-/**
- * Extract local Swingset-specific configuration which is
- * not part of the consensus.
- *
- * @param {CosmosSwingsetConfig} [resolvedConfig]
- */
-const makeSwingsetConfig = resolvedConfig => {
-  const { maxVatsOnline } = resolvedConfig || {};
-  return {
-    maxVatsOnline,
-  };
-};
-
 /**
  * @template {unknown} [T=unknown]
  * @param {(req: string) => string} call
@@ -301,13 +310,24 @@ export default async function main(progname, args, { env, homedir, agcc }) {
   // here so 'sendToChainStorage' can close over the single mutable instance,
   // when we updated the 'portNums.storage' value each time toSwingSet was called.
   async function launchAndInitializeSwingSet(initAction) {
+    const { XSNAP_KEEP_SNAPSHOTS, NODE_HEAP_SNAPSHOTS = -1 } = env;
+
+    /** @type {CosmosSwingsetConfig} */
+    const swingsetConfig = harden(initAction.resolvedConfig || {});
+    validateSwingsetConfig(swingsetConfig);
+    const { slogfile, vatSnapshotRetention, vatTranscriptRetention } =
+      swingsetConfig;
+    const keepSnapshots = vatSnapshotRetention
+      ? vatSnapshotRetention !== 'operational'
+      : ['1', 'true'].includes(XSNAP_KEEP_SNAPSHOTS);
+    const keepTranscripts = vatTranscriptRetention
+      ? vatTranscriptRetention !== 'operational'
+      : false;
+
     // As a kludge, back-propagate selected configuration into environment variables.
-    const { slogfile } = initAction.resolvedConfig || {};
     // eslint-disable-next-line dot-notation
     if (slogfile) env['SLOGFILE'] = slogfile;
 
-    const swingsetConfig = makeSwingsetConfig(initAction.resolvedConfig);
-
     const sendToChainStorage = msg => chainSend(portNums.storage, msg);
     // this object is used to store the mailbox state.
     const fromBridgeMailbox = data => {
@@ -442,7 +462,6 @@ export default async function main(progname, args, { env, homedir, agcc }) {
       serviceName: TELEMETRY_SERVICE_NAME,
     });
 
-    const { XSNAP_KEEP_SNAPSHOTS, NODE_HEAP_SNAPSHOTS = -1 } = env;
     const slogSender = await makeSlogSender({
       stateDir: stateDBDir,
       env,
@@ -455,9 +474,6 @@ export default async function main(progname, args, { env, homedir, agcc }) {
       trueValue: pathResolve(stateDBDir, 'store-trace.log'),
     });
 
-    const keepSnapshots =
-      XSNAP_KEEP_SNAPSHOTS === '1' || XSNAP_KEEP_SNAPSHOTS === 'true';
-
     const nodeHeapSnapshots = Number.parseInt(NODE_HEAP_SNAPSHOTS, 10);
 
     let lastCommitTime = 0;
@@ -539,6 +555,7 @@ export default async function main(progname, args, { env, homedir, agcc }) {
       swingStoreExportCallback,
       swingStoreTraceFile,
       keepSnapshots,
+      keepTranscripts,
       afterCommitCallback,
       swingsetConfig,
     });

package/src/launch-chain.js

@@ -331,6 +331,7 @@ export async function launch({
   swingStoreTraceFile,
   swingStoreExportCallback,
   keepSnapshots,
+  keepTranscripts,
   afterCommitCallback = async () => ({}),
   swingsetConfig,
 }) {
@@ -373,6 +374,7 @@ export async function launch({
     traceFile: swingStoreTraceFile,
     exportCallback: swingStoreExportSyncCallback,
     keepSnapshots,
+    keepTranscripts,
   });
   const { kvStore, commit } = hostStorage;