agoric 0.22.0-u18.4 → 0.22.0-u18.6

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 });

package/src/lib/rpc.js

@@ -1,285 +0,0 @@
-// @ts-check
-/* eslint-env node */
-
-import { NonNullish } from '@agoric/internal';
-import {
-  boardSlottingMarshaller,
-  makeBoardRemote,
-} from '@agoric/vats/tools/board-utils.js';
-
-export { boardSlottingMarshaller };
-
-export const networkConfigUrl = agoricNetSubdomain =>
-  `https://${agoricNetSubdomain}.agoric.net/network-config`;
-export const rpcUrl = agoricNetSubdomain =>
-  `https://${agoricNetSubdomain}.rpc.agoric.net:443`;
-
-/**
- * @typedef {{ rpcAddrs: string[], chainName: string }} MinimalNetworkConfig
- */
-
-/**
- *  @param {string} str
- * @returns {Promise<MinimalNetworkConfig>}
- */
-const fromAgoricNet = str => {
-  const [netName, chainName] = str.split(',');
-  if (chainName) {
-    return Promise.resolve({ chainName, rpcAddrs: [rpcUrl(netName)] });
-  }
-  return fetch(networkConfigUrl(netName)).then(res => res.json());
-};
-
-/**
- * @param {typeof process.env} env
- * @returns {Promise<MinimalNetworkConfig>}
- */
-export const getNetworkConfig = async env => {
-  if (!('AGORIC_NET' in env) || env.AGORIC_NET === 'local') {
-    return { rpcAddrs: ['http://0.0.0.0:26657'], chainName: 'agoriclocal' };
-  }
-
-  return fromAgoricNet(NonNullish(env.AGORIC_NET)).catch(err => {
-    throw Error(
-      `cannot get network config (${env.AGORIC_NET || 'local'}): ${
-        err.message
-      }`,
-    );
-  });
-};
-
-/** @type {MinimalNetworkConfig} */
-const networkConfig = await getNetworkConfig(process.env);
-export { networkConfig };
-// console.warn('networkConfig', networkConfig);
-
-/**
- * @param {object} powers
- * @param {typeof window.fetch} powers.fetch
- * @param {MinimalNetworkConfig} config
- */
-export const makeVStorage = (powers, config = networkConfig) => {
-  /** @param {string} path */
-  const getJSON = path => {
-    const url = config.rpcAddrs[0] + path;
-    // console.warn('fetching', url);
-    return powers.fetch(url, { keepalive: true }).then(res => res.json());
-  };
-  // height=0 is the same as omitting height and implies the highest block
-  const url = (path = 'published', { kind = 'children', height = 0 } = {}) =>
-    `/abci_query?path=%22/custom/vstorage/${kind}/${path}%22&height=${height}`;
-
-  const readStorage = (path = 'published', { kind = 'children', height = 0 }) =>
-    getJSON(url(path, { kind, height }))
-      .catch(err => {
-        throw Error(`cannot read ${kind} of ${path}: ${err.message}`);
-      })
-      .then(data => {
-        const {
-          result: { response },
-        } = data;
-        if (response?.code !== 0) {
-          /** @type {any} */
-          const err = Error(
-            `error code ${response?.code} reading ${kind} of ${path}: ${response.log}`,
-          );
-          err.code = response?.code;
-          err.codespace = response?.codespace;
-          throw err;
-        }
-        return data;
-      });
-
-  return {
-    url,
-    decode({ result: { response } }) {
-      const { code } = response;
-      if (code !== 0) {
-        throw response;
-      }
-      const { value } = response;
-      return Buffer.from(value, 'base64').toString();
-    },
-    /**
-     *
-     * @param {string} path
-     * @returns {Promise<string>} latest vstorage value at path
-     */
-    async readLatest(path = 'published') {
-      const raw = await readStorage(path, { kind: 'data' });
-      return this.decode(raw);
-    },
-    async keys(path = 'published') {
-      const raw = await readStorage(path, { kind: 'children' });
-      return JSON.parse(this.decode(raw)).children;
-    },
-    /**
-     * @param {string} path
-     * @param {number} [height] default is highest
-     * @returns {Promise<{blockHeight: number, values: string[]}>}
-     */
-    async readAt(path, height = undefined) {
-      const raw = await readStorage(path, { kind: 'data', height });
-      const txt = this.decode(raw);
-      /** @type {{ value: string }} */
-      const { value } = JSON.parse(txt);
-      return JSON.parse(value);
-    },
-    /**
-     * Read values going back as far as available
-     *
-     * @param {string} path
-     * @param {number | string} [minHeight]
-     * @returns {Promise<string[]>}
-     */
-    async readFully(path, minHeight = undefined) {
-      const parts = [];
-      // undefined the first iteration, to query at the highest
-      let blockHeight;
-      await null;
-      do {
-        // console.debug('READING', { blockHeight });
-        let values;
-        try {
-          ({ blockHeight, values } = await this.readAt(
-            path,
-            blockHeight && Number(blockHeight) - 1,
-          ));
-          // console.debug('readAt returned', { blockHeight });
-        } catch (err) {
-          if (
-            // CosmosSDK ErrInvalidRequest with particular message text;
-            // misrepresentation of pruned data
-            // TODO replace after incorporating a fix to
-            // https://github.com/cosmos/cosmos-sdk/issues/19992
-            err.codespace === 'sdk' &&
-            err.code === 18 &&
-            err.message.match(/pruned/)
-          ) {
-            // console.error(err);
-            break;
-          }
-          throw err;
-        }
-        parts.push(values);
-        // console.debug('PUSHED', values);
-        // console.debug('NEW', { blockHeight, minHeight });
-        if (minHeight && Number(blockHeight) <= Number(minHeight)) break;
-      } while (blockHeight > 0);
-      return parts.flat();
-    },
-  };
-};
-/** @typedef {ReturnType<typeof makeVStorage>} VStorage */
-
-export const makeFromBoard = () => {
-  const cache = new Map();
-  const convertSlotToVal = (boardId, iface) => {
-    if (cache.has(boardId)) {
-      return cache.get(boardId);
-    }
-    const val = makeBoardRemote({ boardId, iface });
-    cache.set(boardId, val);
-    return val;
-  };
-  return harden({ convertSlotToVal });
-};
-/** @typedef {ReturnType<typeof makeFromBoard>} IdMap */
-
-export const storageHelper = {
-  /** @param { string } txt */
-  parseCapData: txt => {
-    assert(typeof txt === 'string', typeof txt);
-    /** @type {{ value: string }} */
-    const { value } = JSON.parse(txt);
-    const specimen = JSON.parse(value);
-    const { blockHeight, values } = specimen;
-    assert(values, `empty values in specimen ${value}`);
-    const capDatas = storageHelper.parseMany(values);
-    return { blockHeight, capDatas };
-  },
-  /**
-   * @param {string} txt
-   * @param {IdMap} ctx
-   */
-  unserializeTxt: (txt, ctx) => {
-    const { capDatas } = storageHelper.parseCapData(txt);
-    return capDatas.map(capData =>
-      boardSlottingMarshaller(ctx.convertSlotToVal).fromCapData(capData),
-    );
-  },
-  /** @param {string[]} capDataStrings array of stringified capData */
-  parseMany: capDataStrings => {
-    assert(capDataStrings && capDataStrings.length);
-    /** @type {{ body: string, slots: string[] }[]} */
-    const capDatas = capDataStrings.map(s => JSON.parse(s));
-    for (const capData of capDatas) {
-      assert(typeof capData === 'object' && capData !== null);
-      assert('body' in capData && 'slots' in capData);
-      assert(typeof capData.body === 'string');
-      assert(Array.isArray(capData.slots));
-    }
-    return capDatas;
-  },
-};
-harden(storageHelper);
-
-/**
- * @param {IdMap} ctx
- * @param {VStorage} vstorage
- * @returns {Promise<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes>}
- */
-export const makeAgoricNames = async (ctx, vstorage) => {
-  const reverse = {};
-  const entries = await Promise.all(
-    ['brand', 'instance', 'vbankAsset'].map(async kind => {
-      const content = await vstorage.readLatest(
-        `published.agoricNames.${kind}`,
-      );
-      /** @type {Array<[string, import('@agoric/vats/tools/board-utils.js').BoardRemote]>} */
-      const parts = storageHelper.unserializeTxt(content, ctx).at(-1);
-      for (const [name, remote] of parts) {
-        if ('getBoardId' in remote) {
-          reverse[remote.getBoardId()] = name;
-        }
-      }
-      return [kind, Object.fromEntries(parts)];
-    }),
-  );
-  return { ...Object.fromEntries(entries), reverse };
-};
-
-/**
- * @param {{ fetch: typeof window.fetch }} io
- * @param {MinimalNetworkConfig} config
- */
-export const makeRpcUtils = async ({ fetch }, config = networkConfig) => {
-  await null;
-  try {
-    const vstorage = makeVStorage({ fetch }, config);
-    const fromBoard = makeFromBoard();
-    const agoricNames = await makeAgoricNames(fromBoard, vstorage);
-
-    const unserializer = boardSlottingMarshaller(fromBoard.convertSlotToVal);
-
-    /** @type {(txt: string) => unknown} */
-    const unserializeHead = txt =>
-      storageHelper.unserializeTxt(txt, fromBoard).at(-1);
-
-    /** @type {(path: string) => Promise<unknown>} */
-    const readLatestHead = path =>
-      vstorage.readLatest(path).then(unserializeHead);
-
-    return {
-      agoricNames,
-      fromBoard,
-      readLatestHead,
-      unserializeHead,
-      unserializer,
-      vstorage,
-    };
-  } catch (err) {
-    throw Error(`RPC failure (${config.rpcAddrs}): ${err.message}`);
-  }
-};
-/** @typedef {Awaited<ReturnType<typeof makeRpcUtils>>} RpcUtils */