agoric 0.21.2-upgrade-18-dev-6ddbef0.0 → 0.21.2-upgrade-19-dev-ae3bcff.0

package/src/install.js

@@ -1,8 +1,10 @@
 /* eslint-env node */
 import path from 'path';
 import chalk from 'chalk';
+import { execFileSync } from 'child_process';
 import { makePspawn } from './helpers.js';
 import DEFAULT_SDK_PACKAGE_NAMES from './sdk-package-names.js';
+import { listWorkspaces } from './lib/packageManager.js';
 
 const REQUIRED_AGORIC_START_PACKAGES = [
   '@agoric/solo',
@@ -30,17 +32,7 @@ export default async function installMain(progname, rawArgs, powers, opts) {
   const rimraf = file => pspawn('rm', ['-rf', file]);
 
   async function getWorktreePackagePaths(cwd = '.', map = new Map()) {
-    // run `yarn workspaces info` to get the list of directories to
-    // use, instead of a hard-coded list
-    const p = pspawn('yarn', ['workspaces', '--silent', 'info'], {
-      cwd,
-      stdio: ['inherit', 'pipe', 'inherit'],
-    });
-    const stdout = [];
-    p.childProcess.stdout.on('data', out => stdout.push(out));
-    await p;
-    const d = JSON.parse(Buffer.concat(stdout).toString('utf-8'));
-    for (const [name, { location }] of Object.entries(d)) {
+    for (const { name, location } of listWorkspaces({ execFileSync })) {
       map.set(name, path.resolve(cwd, location));
     }
     return map;
@@ -49,7 +41,7 @@ export default async function installMain(progname, rawArgs, powers, opts) {
   let subdirs;
   const workTrees = ['.'];
   let sdkWorktree;
-  /** @type {Map<string, string>} */
+  /** @type {Map<string, string | null>} */
   const sdkPackageToPath = new Map();
   const linkFolder = path.resolve(`_agstate/yarn-links`);
   const linkFlags = [];
@@ -131,7 +123,6 @@ export default async function installMain(progname, rawArgs, powers, opts) {
         // Ensure we update the package.json before exiting.
         const updatePackageJson = async () => {
           // Don't update on exit anymore.
-          // eslint-disable-next-line no-use-before-define
           process.off('beforeExit', updatePackageJsonOnExit);
           log.info(`updating ${pjson}`);
           await fs.writeFile(
@@ -170,7 +161,7 @@ export default async function installMain(progname, rawArgs, powers, opts) {
         .then(results => {
           // After all have settled, throw any errors.
           const failures = results.filter(
-            ({ status }) => status !== 'fulfilled',
+            result => result.status !== 'fulfilled',
           );
           if (failures.length) {
             throw AggregateError(
@@ -284,6 +275,10 @@ export default async function installMain(progname, rawArgs, powers, opts) {
   // Create symlinks to the SDK packages.
   await Promise.all(
     [...sdkPackageToPath.entries()].map(async ([pjName, dir]) => {
+      if (typeof dir !== 'string') {
+        throw Error(`unexpected incomplete package mapping: ${pjName}`);
+      }
+
       const SUBOPTIMAL = false;
       await null;
       if (SUBOPTIMAL) {
@@ -301,7 +296,7 @@ export default async function installMain(progname, rawArgs, powers, opts) {
       log('linking', linkName);
       return fs
         .mkdir(linkDir, { recursive: true })
-        .then(_ => fs.symlink(path.relative(linkDir, dir), linkName));
+        .then(() => fs.symlink(path.relative(linkDir, dir), linkName));
     }),
   );
 

package/src/lib/chain.js

@@ -3,6 +3,11 @@
 import { normalizeBech32 } from '@cosmjs/encoding';
 import { execFileSync as execFileSyncAmbient } from 'child_process';
 
+/**
+ * @import {MinimalNetworkConfig} from '@agoric/client-utils';
+ * @import {ParamsSDKType} from '@agoric/cosmic-proto/agoric/swingset/swingset.js';
+ */
+
 const agdBinary = 'agd';
 
 /**
@@ -34,11 +39,42 @@ export const normalizeAddressWithOptions = (
 };
 harden(normalizeAddressWithOptions);
 
+/** @typedef {number | 'auto' | ['auto', adjustment?: number | undefined]} GasLimit */
+
+/**
+ * @param {GasLimit} limit
+ * @returns {string[]}
+ */
+const makeGasOpts = limit => {
+  if (Number.isFinite(limit) || limit === 'auto') {
+    return [`--gas=${limit}`];
+  }
+  if (Array.isArray(limit) && limit.length >= 1 && limit[0] === 'auto') {
+    const gasOpts = ['--gas=auto'];
+    if (limit.length > 1) {
+      const [adjustment, ...rest] = limit.slice(1);
+      const adjustmentIsValid =
+        adjustment === undefined ||
+        (Number.isFinite(adjustment) && Number(adjustment) > 0);
+      if (rest.length !== 0 || !adjustmentIsValid) {
+        throw Error('invalid gas input');
+      }
+      if (adjustment !== undefined) {
+        gasOpts.push(`--gas-adjustment=${adjustment}`);
+      }
+    }
+    return gasOpts;
+  }
+
+  throw Error('invalid gas input');
+};
+
 /**
  * @param {ReadonlyArray<string>} swingsetArgs
- * @param {import('./rpc.js').MinimalNetworkConfig & {
+ * @param {MinimalNetworkConfig & {
  *   from: string,
  *   fees?: string,
+ *   gas?: GasLimit,
  *   dryRun?: boolean,
  *   verbose?: boolean,
  *   keyring?: {home?: string, backend: string}
@@ -50,6 +86,7 @@ export const execSwingsetTransaction = (swingsetArgs, opts) => {
   const {
     from,
     fees,
+    gas = ['auto', 1.2],
     dryRun = false,
     verbose = true,
     keyring = undefined,
@@ -67,6 +104,7 @@ export const execSwingsetTransaction = (swingsetArgs, opts) => {
     homeOpt,
     backendOpt,
     feeOpt,
+    makeGasOpts(gas),
     [`--from=${from}`, 'tx', 'swingset'],
     swingsetArgs,
   );
@@ -78,7 +116,7 @@ export const execSwingsetTransaction = (swingsetArgs, opts) => {
     stdout.write('\n');
   } else {
     const yesCmd = cmd.concat(['--yes']);
-    if (verbose) console.log('Executing ', yesCmd);
+    if (verbose) console.log('Executing ', agdBinary, yesCmd);
     const out = execFileSync(agdBinary, yesCmd, { encoding: 'utf-8' });
 
     // agd puts this diagnostic on stdout rather than stderr :-/
@@ -94,7 +132,8 @@ harden(execSwingsetTransaction);
 
 /**
  *
- * @param {import('./rpc.js').MinimalNetworkConfig} net
+ * @param {MinimalNetworkConfig} net
+ * @returns {ParamsSDKType}
  */
 // TODO fetch by HTTP instead of shelling out https://github.com/Agoric/agoric-sdk/issues/9200
 export const fetchSwingsetParams = net => {
@@ -114,7 +153,7 @@ export const fetchSwingsetParams = net => {
 harden(fetchSwingsetParams);
 
 /**
- * @param {import('./rpc.js').MinimalNetworkConfig & {
+ * @param {MinimalNetworkConfig & {
  *   execFileSync: typeof import('child_process').execFileSync,
  *   delay: (ms: number) => Promise<void>,
  *   period?: number,
@@ -154,7 +193,7 @@ export const pollBlocks = opts => async lookup => {
 
 /**
  * @param {string} txhash
- * @param {import('./rpc.js').MinimalNetworkConfig & {
+ * @param {MinimalNetworkConfig & {
  *   execFileSync: typeof import('child_process').execFileSync,
  *   delay: (ms: number) => Promise<void>,
  *   period?: number,

package/src/lib/format.js

@@ -1,23 +1,21 @@
-// @ts-check
-
 import { Fail, q } from '@endo/errors';
 import { makeBoardRemote } from '@agoric/vats/tools/board-utils.js';
 
-/** @import {BoardRemote} from '@agoric/vats/tools/board-utils.js' */
-/** @import {VBankAssetDetail} from '@agoric/vats/tools/board-utils.js'; */
+/**
+ * @import {Amount, Brand} from '@agoric/ertp'
+ * @import {AgoricNamesRemotes, BoardRemote, VBankAssetDetail} from '@agoric/vats/tools/board-utils.js';
+ */
 
+// TODO Move to packages/internal.
 /**
- * Like @endo/nat but coerces
+ * Parses the input and returns either a finite number or NaN.
  *
- * @param {string} str
- * @returns {bigint}
+ * @param {string} input
+ * @returns {number}
  */
-export const Natural = str => {
-  const b = BigInt(str);
-  if (b < 0) {
-    throw RangeError(`${b} is negative`);
-  }
-  return b;
+export const parseFiniteNumber = input => {
+  const result = /[0-9]/.test(input || '') ? Number(input) : NaN;
+  return Number.isFinite(result) ? result : NaN;
 };
 
 /**
@@ -102,14 +100,15 @@ export const purseBalanceTuples = (purses, assets) => {
  */
 export const fmtRecordOfLines = record => {
   const { stringify } = JSON;
+  /** @type {Array<[string, string[]]>} */
   const groups = Object.entries(record).map(([key, items]) => [
     key,
     items.map(item => `    ${stringify(item)}`),
   ]);
-  const lineEntries = groups.map(
-    // @ts-expect-error ???
-    ([key, lines]) => `  ${stringify(key)}: [\n${lines.join(',\n')}\n  ]`,
-  );
+  const lineEntries = groups.map(([key, lines]) => {
+    const linesStr = lines.length === 0 ? `[]` : `[\n${lines.join(',\n')}\n  ]`;
+    return `  ${stringify(key)}: ${linesStr}`;
+  });
   return `{\n${lineEntries.join(',\n')}\n}`;
 };
 
@@ -117,7 +116,7 @@ export const fmtRecordOfLines = record => {
  * Summarize the offerStatuses of the state as user-facing informative tuples
  *
  * @param {import('@agoric/smart-wallet/src/utils.js').CoalescedWalletState} state
- * @param {import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes} agoricNames
+ * @param {AgoricNamesRemotes} agoricNames
  */
 export const offerStatusTuples = (state, agoricNames) => {
   const { offerStatuses } = state;
@@ -174,7 +173,7 @@ export const offerStatusTuples = (state, agoricNames) => {
 /**
  * @param {import('@agoric/smart-wallet/src/smartWallet.js').CurrentWalletRecord} current
  * @param {ReturnType<import('@agoric/smart-wallet/src/utils.js').makeWalletStateCoalescer>['state']} coalesced
- * @param {import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes} agoricNames
+ * @param {AgoricNamesRemotes} agoricNames
  */
 export const summarize = (current, coalesced, agoricNames) => {
   return {

package/src/lib/index.js

@@ -0,0 +1,7 @@
+/** @file Utility library for use in other packages */
+
+export * from './bundles.js';
+export * from './casting.js';
+export * from './chain.js';
+export * from './format.js';
+export * from './wallet.js';

package/src/lib/packageManager.js

@@ -0,0 +1,22 @@
+// @ts-check
+
+/**
+ * @import { execFileSync } from 'child_process';
+ */
+
+/**
+ * Omits the root
+ *
+ * @param {{ execFileSync: execFileSync }} io
+ * @returns {Array<{ location: string, name: string }>}
+ */
+export const listWorkspaces = ({ execFileSync }) => {
+  const out = execFileSync('npm', ['query', '.workspace'], {
+    stdio: ['ignore', 'pipe', 'inherit'],
+    shell: true,
+    encoding: 'utf-8',
+  });
+  /** @type {Array<{ location: string, name: string, description: string }>} */
+  const result = JSON.parse(out);
+  return result.filter(({ location }) => location !== '.');
+};

package/src/lib/wallet.js

@@ -1,14 +1,17 @@
 // @ts-check
 /* eslint-env node */
 
-import { Fail } from '@endo/errors';
 import { iterateReverse } from '@agoric/casting';
+import { boardSlottingMarshaller } from '@agoric/client-utils';
 import { makeWalletStateCoalescer } from '@agoric/smart-wallet/src/utils.js';
-import { execSwingsetTransaction, pollBlocks, pollTx } from './chain.js';
-import { boardSlottingMarshaller, makeRpcUtils } from './rpc.js';
+import { Fail } from '@endo/errors';
+import { execSwingsetTransaction, pollTx } from './chain.js';
 
-/** @import {CurrentWalletRecord} from '@agoric/smart-wallet/src/smartWallet.js' */
-/** @import {AgoricNamesRemotes} from '@agoric/vats/tools/board-utils.js' */
+/**
+ * @import {CurrentWalletRecord} from '@agoric/smart-wallet/src/smartWallet.js';
+ * @import {AgoricNamesRemotes} from '@agoric/vats/tools/board-utils.js';
+ * @import {MinimalNetworkConfig, VstorageKit} from '@agoric/client-utils';
+ */
 
 const marshaller = boardSlottingMarshaller();
 
@@ -22,15 +25,15 @@ const emptyCurrentRecord = {
 
 /**
  * @param {string} addr
- * @param {Pick<import('./rpc.js').RpcUtils, 'readLatestHead'>} io
+ * @param {Pick<VstorageKit, 'readPublished'>} io
  * @returns {Promise<import('@agoric/smart-wallet/src/smartWallet.js').CurrentWalletRecord>}
  */
-export const getCurrent = async (addr, { readLatestHead }) => {
+export const getCurrent = async (addr, { readPublished }) => {
   // Partial because older writes may not have had all properties
   // NB: assumes changes are only additions
   let current =
     /** @type {Partial<import('@agoric/smart-wallet/src/smartWallet.js').CurrentWalletRecord> | undefined} */ (
-      await readLatestHead(`published.wallet.${addr}.current`)
+      await readPublished(`wallet.${addr}.current`)
     );
   if (current === undefined) {
     throw Error(`undefined current node for ${addr}`);
@@ -57,12 +60,11 @@ export const getCurrent = async (addr, { readLatestHead }) => {
 
 /**
  * @param {string} addr
- * @param {Pick<import('./rpc.js').RpcUtils, 'readLatestHead'>} io
+ * @param {Pick<VstorageKit, 'readPublished'>} io
  * @returns {Promise<import('@agoric/smart-wallet/src/smartWallet.js').UpdateRecord>}
  */
-export const getLastUpdate = (addr, { readLatestHead }) => {
-  // @ts-expect-error cast
-  return readLatestHead(`published.wallet.${addr}`);
+export const getLastUpdate = (addr, { readPublished }) => {
+  return readPublished(`wallet.${addr}`);
 };
 
 /**
@@ -142,12 +144,12 @@ export const coalesceWalletState = async (follower, invitationBrand) => {
  *
  * @throws { Error & { code: number } } if transaction fails
  * @param {import('@agoric/smart-wallet/src/smartWallet.js').BridgeAction} bridgeAction
- * @param {import('./rpc.js').MinimalNetworkConfig & {
+ * @param {MinimalNetworkConfig & {
  *   from: string,
  *   fees?: string,
  *   verbose?: boolean,
  *   keyring?: {home?: string, backend: string},
- *   stdout: Pick<import('stream').Writable, 'write'>,
+ *   stdout?: Pick<import('stream').Writable, 'write'>,
  *   execFileSync: typeof import('child_process').execFileSync,
  *   delay: (ms: number) => Promise<void>,
  *   dryRun?: boolean,
@@ -211,76 +213,3 @@ export const findContinuingIds = (current, agoricNames) => {
   }
   return found;
 };
-
-export const makeWalletUtils = async (
-  { fetch, execFileSync, delay },
-  networkConfig,
-) => {
-  const { agoricNames, fromBoard, readLatestHead, vstorage } =
-    await makeRpcUtils({ fetch }, networkConfig);
-  /**
-   * @param {string} from
-   * @param {number|string} [minHeight]
-   */
-  const storedWalletState = async (from, minHeight = undefined) => {
-    const m = boardSlottingMarshaller(fromBoard.convertSlotToVal);
-
-    const history = await vstorage.readFully(
-      `published.wallet.${from}`,
-      minHeight,
-    );
-
-    /** @type {{ Invitation: Brand<'set'> }} */
-    // @ts-expect-error XXX how to narrow AssetKind to set?
-    const { Invitation } = agoricNames.brand;
-    const coalescer = makeWalletStateCoalescer(Invitation);
-    // update with oldest first
-    for (const txt of history.reverse()) {
-      const { body, slots } = JSON.parse(txt);
-      const record = m.fromCapData({ body, slots });
-      coalescer.update(record);
-    }
-    const coalesced = coalescer.state;
-    harden(coalesced);
-    return coalesced;
-  };
-
-  /**
-   * Get OfferStatus by id, polling until available.
-   *
-   * @param {string} from
-   * @param {string|number} id
-   * @param {number|string} minHeight
-   * @param {boolean} [untilNumWantsSatisfied]
-   */
-  const pollOffer = async (
-    from,
-    id,
-    minHeight,
-    untilNumWantsSatisfied = false,
-  ) => {
-    const lookup = async () => {
-      const { offerStatuses } = await storedWalletState(from, minHeight);
-      const offerStatus = [...offerStatuses.values()].find(s => s.id === id);
-      if (!offerStatus) throw Error('retry');
-      harden(offerStatus);
-      if (untilNumWantsSatisfied && !('numWantsSatisfied' in offerStatus)) {
-        throw Error('retry (no numWantsSatisfied yet)');
-      }
-      return offerStatus;
-    };
-    const retryMessage = 'offer not in wallet at block';
-    const opts = { ...networkConfig, execFileSync, delay, retryMessage };
-    return pollBlocks(opts)(lookup);
-  };
-
-  return {
-    networkConfig,
-    agoricNames,
-    fromBoard,
-    vstorage,
-    readLatestHead,
-    storedWalletState,
-    pollOffer,
-  };
-};

package/src/main.js

@@ -66,7 +66,9 @@ const main = async (progname, rawArgs, powers) => {
       'verbosity that can be increased',
       (_value, _previous) => (cmdOpts.verbose += 1),
     );
-  const baseCmd = (...args) => addCmdOpts(program.command(...args));
+  /** @type {typeof program.command} */
+  const baseCmd = (nameAndParams, ...rest) =>
+    addCmdOpts(program.command(nameAndParams, ...rest));
 
   addCmdOpts(
     program

package/src/scripts.js

@@ -56,7 +56,7 @@ export const makeLookup =
 
 /**
  * @param {string[]} scripts
- * @param {{ allowUnsafePlugins: boolean, progname: string, rawArgs: string[], endowments?: Record<string, any> }} opts
+ * @param {{ allowUnsafePlugins?: boolean, progname: string, rawArgs: string[], endowments?: Record<string, any> }} opts
  * @param {{ fs: import('fs/promises'), console: Console }} powers
  */
 export const makeScriptLoader =

package/src/sdk-package-names.js

@@ -9,6 +9,7 @@ export default [
   "@agoric/builders",
   "@agoric/cache",
   "@agoric/casting",
+  "@agoric/client-utils",
   "@agoric/cosmic-proto",
   "@agoric/cosmic-swingset",
   "@agoric/cosmos",
@@ -17,6 +18,7 @@ export default [
   "@agoric/deployment",
   "@agoric/ertp",
   "@agoric/eslint-config",
+  "@agoric/fast-usdc",
   "@agoric/governance",
   "@agoric/import-manager",
   "@agoric/inter-protocol",
@@ -49,6 +51,5 @@ export default [
   "@agoric/xsnap-lockdown",
   "@agoric/zoe",
   "@agoric/zone",
-  "agoric",
-  "fast-usdc"
+  "agoric"
 ];

package/src/start.js

@@ -276,13 +276,13 @@ export default async function startMain(progname, rawArgs, powers, opts) {
       await rmVerbose(serverDir);
     }
 
+    /** @type {(args: string[], spawnOpts?: Parameters<typeof pspawn>[2], dockerArgs?: string[]) => ReturnType<pspawn>} */
     let chainSpawn;
     if (!popts.dockerTag) {
-      chainSpawn = (args, spawnOpts = undefined) => {
-        return pspawn(cosmosChain, [...args, `--home=${serverDir}`], spawnOpts);
-      };
+      chainSpawn = (args, spawnOpts) =>
+        pspawn(cosmosChain, [...args, `--home=${serverDir}`], spawnOpts);
     } else {
-      chainSpawn = (args, spawnOpts = undefined, dockerArgs = []) =>
+      chainSpawn = (args, spawnOpts, dockerArgs = []) =>
         pspawn(
           'docker',
           [
@@ -482,12 +482,12 @@ export default async function startMain(progname, rawArgs, powers, opts) {
       await rmVerbose(serverDir);
     }
 
+    /** @type {(args: string[], spawnOpts?: Parameters<typeof pspawn>[2], dockerArgs?: string[]) => ReturnType<pspawn>} */
     let soloSpawn;
     if (!popts.dockerTag) {
-      soloSpawn = (args, spawnOpts = undefined) =>
-        pspawn(agSolo, args, spawnOpts);
+      soloSpawn = (args, spawnOpts) => pspawn(agSolo, args, spawnOpts);
     } else {
-      soloSpawn = (args, spawnOpts = undefined, dockerArgs = []) =>
+      soloSpawn = (args, spawnOpts, dockerArgs = []) =>
         pspawn(
           'docker',
           [

package/tools/getting-started.js

@@ -62,6 +62,13 @@ const getLatestBlockHeight = url =>
     req.end();
   });
 
+/**
+ * Test the "getting started" workflow. Note that this function may be imported
+ * by external repositories.
+ *
+ * @param {import('ava').ExecutionContext} t
+ * @param {{ init?: string[], install?: string[] }} [options]
+ */
 export const gettingStartedWorkflowTest = async (t, options = {}) => {
   const { init: initOptions = [], install: installOptions = [] } = options;
   const pspawn = makePspawn({ spawn });