@agoric/cosmic-swingset 0.41.4-dev-26cd420.0 → 0.41.4-dev-76b2796.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/cosmic-swingset",
-  "version": "0.41.4-dev-26cd420.0+26cd420",
+  "version": "0.41.4-dev-76b2796.0+76b2796",
   "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-26cd420.0+26cd420",
-    "@agoric/cosmos": "0.34.2-dev-26cd420.0+26cd420",
-    "@agoric/deploy-script-support": "0.10.4-dev-26cd420.0+26cd420",
-    "@agoric/internal": "0.3.3-dev-26cd420.0+26cd420",
-    "@agoric/store": "0.9.3-dev-26cd420.0+26cd420",
-    "@agoric/swing-store": "0.9.2-dev-26cd420.0+26cd420",
-    "@agoric/swingset-vat": "0.32.3-dev-26cd420.0+26cd420",
-    "@agoric/telemetry": "0.6.3-dev-26cd420.0+26cd420",
-    "@agoric/vm-config": "0.1.1-dev-26cd420.0+26cd420",
+    "@agoric/builders": "0.1.1-dev-76b2796.0+76b2796",
+    "@agoric/cosmos": "0.34.2-dev-76b2796.0+76b2796",
+    "@agoric/deploy-script-support": "0.10.4-dev-76b2796.0+76b2796",
+    "@agoric/internal": "0.3.3-dev-76b2796.0+76b2796",
+    "@agoric/store": "0.9.3-dev-76b2796.0+76b2796",
+    "@agoric/swing-store": "0.9.2-dev-76b2796.0+76b2796",
+    "@agoric/swingset-vat": "0.32.3-dev-76b2796.0+76b2796",
+    "@agoric/telemetry": "0.6.3-dev-76b2796.0+76b2796",
+    "@agoric/vm-config": "0.1.1-dev-76b2796.0+76b2796",
     "@endo/bundle-source": "^4.0.0",
     "@endo/env-options": "^1.1.8",
     "@endo/errors": "^1.2.10",
@@ -52,7 +52,7 @@
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@agoric/kmarshal": "0.1.1-dev-26cd420.0+26cd420",
+    "@agoric/kmarshal": "0.1.1-dev-76b2796.0+76b2796",
     "ava": "^5.3.0",
     "better-sqlite3": "^9.1.1",
     "c8": "^10.1.3"
@@ -83,5 +83,5 @@
   "typeCoverage": {
     "atLeast": 86.88
   },
-  "gitHead": "26cd420bec244f459c724a5ca83316c2ecc0187e"
+  "gitHead": "76b2796c08ea5c797f7f3374a1d5d8616e11e6dd"
 }

package/tools/inquisitor.mjs

@@ -89,7 +89,6 @@ const storeExportAPI = ['getExportRecords', 'getArtifactNames'];
  * @property {{name: string, critical: boolean}} options
  */
 
-// TODO: getVatAdminNode('v112') # scan the vatAdmin vom v2.vs.vom.* vrefs for value matching /\b${vatID}\b/
 /**
  * @param {object} opt
  * @param {Database} opt.db
@@ -102,6 +101,7 @@ export const makeHelpers = ({ db, EV }) => {
   const kvGet = key => sqlKVGet.get(key);
   const kvGetJSON = key => JSON.parse(/** @type {string} */ (kvGet(key)));
 
+  /** @typedef {{key: string, value: string}} KVEntry */
   const sqlKVByRange = db.prepare(
     `SELECT key, value FROM kvStore WHERE key >= :a AND key < :b AND ${[
       '(:keySuffix IS NULL OR substr(key, -length(:keySuffix)) = :keySuffix)',
@@ -116,9 +116,26 @@ export const makeHelpers = ({ db, EV }) => {
       '(:valueGlob IS NULL OR value GLOB :valueGlob)',
     ].join(' AND ')}`,
   );
-  const kvGlob = (keyGlob, valueGlob = undefined, lazy = false) => {
+  /**
+   * @template {boolean} Lazy
+   * @param {string} keyGlob
+   * @param {string} [valueGlob]
+   * @param {Lazy} [lazy]
+   * @returns {Lazy extends true ? Iterable<KVEntry> : Array<KVEntry>}
+   */
+  const kvGlob = (
+    keyGlob,
+    valueGlob = undefined,
+    lazy = /** @type {Lazy} */ (false),
+  ) => {
+    // Glob metasyntax is `*` (any substring), `?` (any one character), and
+    // `[$chars]`/`[]$chars]` (any one character from inside the brackets, with
+    // a requirement that `]` for matching is only valid immediately after the
+    // opening bracket).
     const [_keyPattern, keyPrefix, keyTail, keySuffix] =
-      /** @type {string[]} */ (/^([^*?]*)((?:[*?]([^*?]*))*)$/.exec(keyGlob));
+      /** @type {string[]} */ (
+        /^([^*?[]*)((?:(?:[*?]|\[\]?[^\]]*\])([^*?[]*))*)$/.exec(keyGlob)
+      );
     let sql = sqlKVByHalfRange;
     /** @type {Record<'a' | 'b' | 'keySuffix' | 'keyGlob' | 'valueGlob', string | null>} */
     const args = {
@@ -137,7 +154,59 @@ export const makeHelpers = ({ db, EV }) => {
     } else {
       console.warn('Warning: Unprefixed searches can be slow');
     }
-    return lazy ? sql.iterate(args) : sql.all(args);
+    return /** @type {any} */ (lazy ? sql.iterate(args) : sql.all(args));
+  };
+
+  // We need a RegExp.escape polyfill at least until our minimum supported
+  // Node.js includes it natively, however this is harmless to keep even then.
+  // It leaves leading ASCII alphanumerics untouched for readability and uses
+  // `\u00##` rather than `\x##` for simplicity, neither of which impact
+  // `scanVatStore`.
+  const needsEscape =
+    /([\^$\\.*+?()[\]{}|/])|[-,=<>#&!%:;@~''``""\s\uD800-\uDFFF]/gu;
+  const controlEscapes = {
+    '\t': '\\t',
+    '\n': '\\n',
+    '\v': '\\v',
+    '\f': '\\f',
+    '\r': '\\r',
+  };
+  const escapeChar = (ch, simple) => {
+    if (simple) return `\\${simple}`;
+    if (Object.hasOwn(controlEscapes, ch)) return controlEscapes[ch];
+    return ch
+      .split('')
+      .map(cu => `\\u${cu.charCodeAt(0).toString(16).padStart(4, '0')}`)
+      .join('');
+  };
+  const RegExpEscape = str => str.replace(needsEscape, escapeChar);
+
+  /**
+   * Return entries of a vat's KV store that mention `ref` as a distinct word.
+   * `ref` may be a vref such as "o-123", but may also be a value such as "123"
+   * or "v123" (that last case being particularly useful for finding a vat admin
+   * node in vatAdmin's KV store).
+   *
+   * @param {string} vatID
+   * @param {string} ref
+   */
+  const scanVatStore = (vatID, ref) => {
+    // Use a glob match to find candidates, then a regular expression to select
+    // only those with word boundaries around the ref (e.g., we don't want to
+    // consider "o-1234" a match for "o-123").
+    const candidates = kvGlob(
+      `${vatID}.vs.*`,
+      `*${ref.replace(/[*?[]/g, '[$&]')}*`,
+      true,
+    );
+    // The non-capturing group serves no functional purpose; it just improves
+    // readability in the event that a debugging session finds itself here.
+    const re = RegExp(String.raw`\b(?:${RegExpEscape(ref)})\b`);
+    const matches = [];
+    for (const entry of candidates) {
+      if (entry.value.match(re)) matches.push(entry);
+    }
+    return matches;
   };
 
   /**
@@ -315,7 +384,16 @@ export const makeHelpers = ({ db, EV }) => {
 
   return harden({
     runCoreEval,
-    stable: { db, getRefs, kvGet, kvGetJSON, kvGlob, vatsByID, vatsByName },
+    stable: {
+      db,
+      getRefs,
+      kvGet,
+      kvGetJSON,
+      kvGlob,
+      scanVatStore,
+      vatsByID,
+      vatsByName,
+    },
   });
 };
 /** @typedef {ReturnType<typeof makeHelpers>} Helpers */
@@ -820,7 +898,7 @@ May be used interactively, or as a recipient of piped commands, or as a module.
 Example commands:
 * stable.db.prepare("SELECT name FROM sqlite_schema WHERE type='table'").pluck().all();
 * stable.db.pragma("table_info(transcriptSpans)");
-* [vatAdminNodeRow] = stable.db.kvGlob('v2.vs.*', '*v100*');
+* [vatAdminNodeEntry] = stable.scanVatStore('v2', 'v100');
 * stable.getRefs('o+10', 'v1');
 * board = await EV.vat('bootstrap').consumeItem('board');
 * obj = await EV(board).getValue('board02963');