@agoric/vats 0.15.2-dev-228f08b.0 → 0.15.2-dev-4054171.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/vats",
-  "version": "0.15.2-dev-228f08b.0+228f08b",
+  "version": "0.15.2-dev-4054171.0+4054171",
   "description": "Agoric's Vat library",
   "type": "module",
   "main": "./index.js",
@@ -22,19 +22,19 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/cosmic-proto": "0.4.1-dev-228f08b.0+228f08b",
-    "@agoric/ertp": "0.16.3-dev-228f08b.0+228f08b",
-    "@agoric/governance": "0.10.4-dev-228f08b.0+228f08b",
-    "@agoric/internal": "0.3.3-dev-228f08b.0+228f08b",
-    "@agoric/network": "0.1.1-dev-228f08b.0+228f08b",
-    "@agoric/notifier": "0.6.3-dev-228f08b.0+228f08b",
-    "@agoric/store": "0.9.3-dev-228f08b.0+228f08b",
-    "@agoric/swingset-vat": "0.32.3-dev-228f08b.0+228f08b",
-    "@agoric/time": "0.3.3-dev-228f08b.0+228f08b",
-    "@agoric/vat-data": "0.5.3-dev-228f08b.0+228f08b",
-    "@agoric/vow": "0.1.1-dev-228f08b.0+228f08b",
-    "@agoric/zoe": "0.26.3-dev-228f08b.0+228f08b",
-    "@agoric/zone": "0.2.3-dev-228f08b.0+228f08b",
+    "@agoric/cosmic-proto": "0.4.1-dev-4054171.0+4054171",
+    "@agoric/ertp": "0.16.3-dev-4054171.0+4054171",
+    "@agoric/governance": "0.10.4-dev-4054171.0+4054171",
+    "@agoric/internal": "0.3.3-dev-4054171.0+4054171",
+    "@agoric/network": "0.1.1-dev-4054171.0+4054171",
+    "@agoric/notifier": "0.6.3-dev-4054171.0+4054171",
+    "@agoric/store": "0.9.3-dev-4054171.0+4054171",
+    "@agoric/swingset-vat": "0.32.3-dev-4054171.0+4054171",
+    "@agoric/time": "0.3.3-dev-4054171.0+4054171",
+    "@agoric/vat-data": "0.5.3-dev-4054171.0+4054171",
+    "@agoric/vow": "0.1.1-dev-4054171.0+4054171",
+    "@agoric/zoe": "0.26.3-dev-4054171.0+4054171",
+    "@agoric/zone": "0.2.3-dev-4054171.0+4054171",
     "@endo/errors": "^1.2.10",
     "@endo/far": "^1.1.11",
     "@endo/import-bundle": "^1.4.0",
@@ -47,7 +47,7 @@
     "jessie.js": "^0.3.4"
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-dev-228f08b.0+228f08b",
+    "@agoric/swingset-liveslots": "0.10.3-dev-4054171.0+4054171",
     "@endo/bundle-source": "^4.0.0",
     "@endo/init": "^1.1.9",
     "ava": "^5.3.0",
@@ -79,5 +79,5 @@
   "typeCoverage": {
     "atLeast": 90.43
   },
-  "gitHead": "228f08bb97e0f237e67e0d98115713770f25926a"
+  "gitHead": "4054171a6a562a8bad1824b0151d103b8fe2f502"
 }

package/src/proposals/terminate-governed-instance.d.ts

@@ -0,0 +1,24 @@
+export function terminateGoverned({ consume: { board, governedContractKits, zoe } }: BootstrapPowers, { options: { targetSpecifiers } }: {
+    options: {
+        targetSpecifiers: string[];
+    };
+}): Promise<void>;
+export function getManifest(_powers: object, targetSpecifiers: string[]): {
+    manifest: {
+        [terminateGoverned.name]: {
+            consume: {
+                board: boolean;
+                governedContractKits: boolean;
+                zoe: boolean;
+            };
+        };
+    };
+    options: {
+        targetSpecifiers: string[];
+    };
+};
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder: import("@agoric/deploy-script-support/src/externalTypes.js").CoreEvalBuilder;
+declare const _default: (homeP: Promise<import("@agoric/deploy-script-support/src/externalTypes.js").CommonHome>, endowments: import("@agoric/deploy-script-support/src/externalTypes.js").DeployScriptEndownments) => Promise<void>;
+export default _default;
+//# sourceMappingURL=terminate-governed-instance.d.ts.map

package/src/proposals/terminate-governed-instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminate-governed-instance.d.ts","sourceRoot":"","sources":["terminate-governed-instance.js"],"names":[],"mappings":"AA0EO,qFAPI,eAAe,qCAEvB;IAAuB,OAAO,EAC9B;QAAiC,gBAAgB,EAAzC,MAAM,EAAE;KAGlB;CAAA,iBAsFA;AAUM,qCAHI,MAAM,oBACN,MAAM,EAAE;;QAMb,CAAC,iBAAiB,CAAC,IAAI,CAAC;;;;;;UAEvB;;;;;EAMN;AAED,2FAA2F;AAC3F,qCADW,OAAO,oDAAoD,EAAE,eAAe,CAYrF;yBAGoB,uFAAK,EAAE,gGAAU"}

package/src/proposals/terminate-governed-instance.js

@@ -0,0 +1,209 @@
+/**
+ * @file Source for a core-eval to terminate governed contract instances along
+ *   with their governors by mapping a board ID to a key in the Bootstrap Powers
+ *   governedContractKits collection. Also functions as an off-chain builder
+ *   script for such core-evals:
+ *
+ *       agoric run /path/to/$0 <$instanceHandleBoardID:$instanceKitLabel>...
+ */
+
+/// <reference types="@agoric/vats/src/core/types-ambient"/>
+
+/* eslint-disable import/no-extraneous-dependencies */
+// dynamic import { makeHelpers } from '@agoric/deploy-script-support';
+// dynamic import { getSpecifier } from '@agoric/internal/src/module-utils.js';
+import { E, passStyleOf } from '@endo/far';
+import { makeTracer } from '@agoric/internal/src/debug.js';
+
+const USAGE = `Usage: agoric run /path/to/terminate-governed-instance.js \\
+  <$instanceHandleBoardID:$instanceKitLabel>...`;
+
+const repr = val =>
+  typeof val === 'string' || typeof val === 'object'
+    ? JSON.stringify(val)
+    : String(val);
+const defaultMakeError = (strings, ...subs) =>
+  Error(
+    strings.map((s, i) => `${i === 0 ? '' : repr(subs[i - 1])}${s}`).join(''),
+  );
+const makeUsageError = (strings, ...subs) => {
+  const err = defaultMakeError(strings, ...subs);
+  console.error(err.message);
+  console.error(USAGE);
+  return err;
+};
+
+const rtarget = /^(?<boardID>board[0-9]+):(?<instanceKitLabel>.+)$/;
+/**
+ * @param {string[]} args
+ * @param {(
+ *   strings: TemplateStringsArray | string[],
+ *   ...subs: unknown[]
+ * ) => Error} [makeError]
+ *   for visible errors with or without `Fail`
+ * @returns {{ boardID: string; instanceKitLabel: string }[]}
+ */
+const parseTargets = (args = [], makeError = defaultMakeError) => {
+  if (!Array.isArray(args)) throw makeError`invalid targets: ${args}`;
+  /** @type {{ boardID: string; instanceKitLabel: string }[]} */
+  const targets = [];
+  const badTargets = [];
+  for (const arg of args) {
+    const m = typeof arg === 'string' && arg.match(rtarget);
+    if (!m) {
+      badTargets.push(arg);
+      continue;
+    }
+    // @ts-expect-error cast
+    targets.push(m.groups);
+  }
+  if (badTargets.length) throw makeError`malformed target(s): ${badTargets}`;
+  if (!targets.length) throw makeError`no target(s)`;
+  return targets;
+};
+
+/**
+ * Terminate one or more governed contract instances and their governors.
+ *
+ * @param {BootstrapPowers} powers
+ * @param {object} config
+ * @param {object} config.options
+ * @param {string[]} config.options.targetSpecifiers An array of
+ *   "$instanceHandleBoardID:$instanceKitLabel" strings corresponding with vats
+ *   to terminate.
+ */
+export const terminateGoverned = async (
+  { consume: { board, governedContractKits, zoe } },
+  { options: { targetSpecifiers } },
+) => {
+  const { Fail, quote: q } = assert;
+
+  // Parse and validate the targets.
+  const targets = parseTargets(targetSpecifiers, Fail);
+  const validationResults = await Promise.allSettled(
+    targets.map(async ({ boardID, instanceKitLabel }) => {
+      const targetData = [boardID, instanceKitLabel];
+      const logLabel = q(targetData);
+      const trace = makeTracer(`terminate-governed-instance ${logLabel}`, true);
+      const contractInstanceHandle = await E(board).getValue(boardID);
+      const instanceKit = await E(governedContractKits).get(
+        // @ts-expect-error TS2345 Property '[tag]' is missing
+        contractInstanceHandle,
+      );
+      trace('alleged governed contract instance kit', instanceKit);
+
+      const { label, governor, governorCreatorFacet, governorAdminFacet } =
+        instanceKit;
+      label === instanceKitLabel ||
+        Fail`${logLabel} unexpected instanceKit label, got ${label} but wanted ${q(instanceKitLabel)}`;
+      const govTerms = /** @type {any} */ (await E(zoe).getTerms(governor));
+      trace({ govTerms });
+      (passStyleOf(govTerms?.governed) === 'copyRecord' &&
+        passStyleOf(govTerms?.governedContractInstallation) === 'remotable') ||
+        Fail`${logLabel} instanceKit governor does not appear to have the right terms shape`;
+
+      const instanceAdminFacet = await E(governorCreatorFacet).getAdminFacet();
+      trace({ instanceAdminFacet });
+      return { logLabel, trace, instanceAdminFacet, governorAdminFacet };
+    }),
+  );
+  const validationProblems = targets.flatMap(
+    ({ boardID, instanceKitLabel }, i) => {
+      if (validationResults[i].status === 'fulfilled') return [];
+      return [
+        { boardID, instanceKitLabel, error: validationResults[i].reason },
+      ];
+    },
+  );
+  if (validationProblems.length !== 0) {
+    console.error(
+      'terminate-governed-instance target validation failed',
+      validationProblems,
+    );
+    Fail`target validation failed: ${validationProblems}`;
+  }
+
+  // Terminate each target governed contract and governor.
+  const terminationResults = await Promise.allSettled(
+    validationResults.map(async settlement => {
+      assert(settlement.status === 'fulfilled');
+      const { logLabel, trace, instanceAdminFacet, governorAdminFacet } =
+        settlement.value;
+      const terminateInstanceMessage = `governed contract ${logLabel} terminated by terminate-governed-instance`;
+      await E(instanceAdminFacet).terminateContract(
+        harden(Error(terminateInstanceMessage)),
+      );
+      trace('terminated governed instance');
+
+      const terminateGovernorMessage = `governor ${logLabel} terminated by terminate-governed-instance`;
+      await E(governorAdminFacet).terminateContract(
+        harden(Error(terminateGovernorMessage)),
+      );
+      trace('terminated governor');
+    }),
+  );
+  const terminationProblems = targets.flatMap(
+    ({ boardID, instanceKitLabel }, i) => {
+      if (terminationResults[i].status === 'fulfilled') return [];
+      return [
+        { boardID, instanceKitLabel, error: terminationResults[i].reason },
+      ];
+    },
+  );
+  if (terminationProblems.length !== 0) {
+    console.error(
+      'terminate-governed-instance termination(s) failed',
+      terminationProblems,
+    );
+    Fail`termination(s) failed: ${terminationProblems}`;
+  }
+};
+harden(terminateGoverned);
+
+/**
+ * Return a manifest for terminating one or more governed contract instances and
+ * their governors.
+ *
+ * @param {object} _powers
+ * @param {string[]} targetSpecifiers
+ */
+export const getManifest = (_powers, targetSpecifiers) => {
+  parseTargets(targetSpecifiers);
+  return {
+    manifest: {
+      [terminateGoverned.name]: {
+        consume: { board: true, governedContractKits: true, zoe: true },
+      },
+    },
+    // Provide `terminateGovernors` a second argument like
+    // `{ options: { targetSpecifiers } }`.
+    options: { targetSpecifiers },
+  };
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder = async (_utils, targetSpecifiers) => {
+  parseTargets(targetSpecifiers);
+
+  // Dynamic import to avoid inclusion in the proposal bundle.
+  const { getSpecifier } = await import('@agoric/internal/src/module-utils.js');
+  const SELF = await getSpecifier(import.meta.url);
+
+  return harden({
+    sourceSpec: SELF,
+    getManifestCall: ['getManifest', targetSpecifiers],
+  });
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  const { scriptArgs } = endowments;
+  parseTargets(scriptArgs, makeUsageError);
+
+  // Dynamic import to avoid inclusion in the proposal bundle.
+  const { makeHelpers } = await import('@agoric/deploy-script-support');
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+  await writeCoreEval(terminateGoverned.name, utils =>
+    defaultProposalBuilder(utils, scriptArgs),
+  );
+};