@agoric/client-utils 0.1.1-other-dev-3eb1a1d.0 → 0.2.0-u18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/client-utils",
-  "version": "0.1.1-other-dev-3eb1a1d.0+3eb1a1d",
+  "version": "0.2.0-u18.0",
   "description": "Utilities for building Agoric clients",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -24,14 +24,14 @@
   "devDependencies": {
     "ava": "^5.3.0",
     "c8": "^10.1.2",
-    "ts-blank-space": "^0.4.1"
+    "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/casting": "0.4.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/ertp": "0.16.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/internal": "0.3.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/smart-wallet": "0.5.4-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/vats": "0.15.2-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/casting": "^0.4.3-u18.5",
+    "@agoric/ertp": "^0.16.3-u18.1",
+    "@agoric/internal": "^0.4.0-u18.1",
+    "@agoric/smart-wallet": "^0.5.4-u18.5",
+    "@agoric/vats": "^0.16.0-u18.5",
     "@cosmjs/stargate": "^0.32.3",
     "@cosmjs/tendermint-rpc": "^0.32.3",
     "@endo/common": "^1.2.8",
@@ -58,5 +58,5 @@
     ],
     "timeout": "20m"
   },
-  "gitHead": "3eb1a1d2d75b2b4a94807cd3bf759bc9fc531f05"
+  "gitHead": "f8c45b8a2e29a51522a81a6692af25b2d7f6b50f"
 }

package/src/cli.js

@@ -0,0 +1,20 @@
+import { LOCAL_CONFIG_KEY, fetchNetworkConfig } from './network-config.js';
+
+/**
+ * @import {MinimalNetworkConfig} from './network-config.js';
+ */
+
+/**
+ * Fetch the network config for the AGORIC_NET environment variable.
+ *
+ * If none is set or it's 'local', return a local chain config.
+ *
+ * @param {{ env: typeof process.env, fetch: typeof fetch }} io
+ * @returns {Promise<MinimalNetworkConfig>}
+ */
+
+export const fetchEnvNetworkConfig = async ({ env, fetch }) => {
+  const net = env.AGORIC_NET || LOCAL_CONFIG_KEY;
+
+  return fetchNetworkConfig(net, { fetch });
+};

package/src/main.js

@@ -1,5 +1,9 @@
+export * from './cli.js';
+export * from './network-config.js';
 export * from './rpc.js';
+export * from './smart-wallet-kit.js';
 export * from './sync-tools.js';
+export * from './vstorage.js';
 export * from './vstorage-kit.js';
 export * from './wallet-utils.js';
 

package/src/network-config.js

@@ -0,0 +1,42 @@
+/**
+ * @typedef {{ rpcAddrs: string[], chainName: string }} MinimalNetworkConfig
+ */
+
+export const toNetworkConfigUrl = agoricNetSubdomain =>
+  `https://${agoricNetSubdomain}.agoric.net/network-config`;
+
+export const toRpcUrl = agoricNetSubdomain =>
+  `https://${agoricNetSubdomain}.rpc.agoric.net:443`;
+
+/** @satisfies {MinimalNetworkConfig} */
+export const LOCAL_CONFIG = {
+  rpcAddrs: ['http://0.0.0.0:26657'],
+  chainName: 'agoriclocal',
+};
+
+export const LOCAL_CONFIG_KEY = 'local';
+
+/**
+ * Fetches the network config for the given network specifier.
+ *
+ * @param {string} spec
+ * @param {{ fetch: typeof fetch }} io
+ * @returns {Promise<MinimalNetworkConfig>}
+ */
+export const fetchNetworkConfig = async (spec, { fetch }) => {
+  const [netName, chainName] = spec.split(',');
+
+  if (netName === LOCAL_CONFIG_KEY) {
+    return LOCAL_CONFIG;
+  }
+
+  if (chainName) {
+    return { chainName, rpcAddrs: [toRpcUrl(netName)] };
+  }
+
+  return fetch(toNetworkConfigUrl(netName))
+    .then(res => res.json())
+    .catch(err => {
+      throw Error(`cannot get network config (${spec}): ${err.message}`);
+    });
+};

package/src/rpc.js

@@ -3,7 +3,7 @@ import { StargateClient } from '@cosmjs/stargate';
 import { Tendermint34Client } from '@cosmjs/tendermint-rpc';
 
 /**
- * @typedef {{ rpcAddrs: string[], chainName: string }} MinimalNetworkConfig
+ * @import {MinimalNetworkConfig} from './network-config.js';
  */
 
 // TODO distribute load

package/src/smart-wallet-kit.js

@@ -0,0 +1,113 @@
+import { makeWalletStateCoalescer } from '@agoric/smart-wallet/src/utils.js';
+import { pollBlocks } from './chain.js';
+import { makeStargateClient } from './rpc.js';
+import { makeAgoricNames, makeVstorageKit } from './vstorage-kit.js';
+
+/**
+ * @import {Amount, Brand} from '@agoric/ertp/src/types.js'
+ * @import {CurrentWalletRecord, UpdateRecord} from '@agoric/smart-wallet/src/smartWallet.js';
+ * @import {MinimalNetworkConfig} from './network-config.js';
+ */
+
+/**
+ * Augment VstorageKit with addtional convenience methods for working with
+ * Agoric smart wallets.
+ *
+ * @param {object} root0
+ * @param {typeof globalThis.fetch} root0.fetch
+ * @param {(ms: number) => Promise<void>} root0.delay
+ * @param {MinimalNetworkConfig} networkConfig
+ */
+export const makeSmartWalletKit = async ({ fetch, delay }, networkConfig) => {
+  const vsk = makeVstorageKit({ fetch }, networkConfig);
+
+  const client = await makeStargateClient(networkConfig, { fetch });
+
+  const agoricNames = await makeAgoricNames(vsk.fromBoard, vsk.vstorage);
+
+  /**
+   * @param {string} from
+   * @param {number|string} [minHeight]
+   */
+  const storedWalletState = async (from, minHeight = undefined) => {
+    const history = await vsk.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 = vsk.marshaller.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 poll = pollBlocks({
+      client,
+      delay,
+      retryMessage: 'offer not in wallet at block',
+    });
+
+    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;
+    };
+    return poll(lookup);
+  };
+
+  /**
+   * @param {string} addr
+   * @returns {Promise<UpdateRecord>}
+   */
+  const getLastUpdate = addr => {
+    return vsk.readPublished(`wallet.${addr}`);
+  };
+
+  /**
+   * @param {string} addr
+   * @returns {Promise<CurrentWalletRecord>}
+   */
+  const getCurrentWalletRecord = addr => {
+    return vsk.readPublished(`wallet.${addr}.current`);
+  };
+
+  return {
+    // pass along all of VstorageKit
+    ...vsk,
+    agoricNames,
+    networkConfig,
+    getLastUpdate,
+    getCurrentWalletRecord,
+    storedWalletState,
+    pollOffer,
+  };
+};
+/** @typedef {Awaited<ReturnType<typeof makeSmartWalletKit>>} SmartWalletKit */

package/src/vstorage-kit.js

@@ -1,135 +1,18 @@
-/* global Buffer */
 import {
   boardSlottingMarshaller,
   makeBoardRemote,
 } from '@agoric/vats/tools/board-utils.js';
+import { assertAllDefined } from '@agoric/internal';
+import { makeVStorage } from './vstorage.js';
 
 export { boardSlottingMarshaller };
 
 /**
- * @import {MinimalNetworkConfig} from './rpc.js';
+ * @import {MinimalNetworkConfig} from './network-config.js';
  * @import {TypedPublished} from './types.js';
+ * @import {VStorage} from './vstorage.js';
  */
 
-/**
- * @param {object} powers
- * @param {typeof window.fetch} powers.fetch
- * @param {MinimalNetworkConfig} config
- */
-export const makeVStorage = (powers, config) => {
-  /** @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 */
-
 /** @deprecated */
 export const makeFromBoard = () => {
   const cache = new Map();
@@ -191,6 +74,7 @@ harden(storageHelper);
  * @returns {Promise<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes>}
  */
 export const makeAgoricNames = async (ctx, vstorage) => {
+  assertAllDefined({ ctx, vstorage });
   const reverse = {};
   const entries = await Promise.all(
     ['brand', 'instance', 'vbankAsset'].map(async kind => {
@@ -214,12 +98,10 @@ export const makeAgoricNames = async (ctx, vstorage) => {
  * @param {{ fetch: typeof window.fetch }} io
  * @param {MinimalNetworkConfig} config
  */
-export const makeVstorageKit = async ({ fetch }, config) => {
-  await null;
+export const makeVstorageKit = ({ fetch }, config) => {
   try {
     const vstorage = makeVStorage({ fetch }, config);
     const fromBoard = makeFromBoard();
-    const agoricNames = await makeAgoricNames(fromBoard, vstorage);
 
     const marshaller = boardSlottingMarshaller(fromBoard.convertSlotToVal);
 
@@ -249,7 +131,6 @@ export const makeVstorageKit = async ({ fetch }, config) => {
       readLatestHead(`published.${subpath}`);
 
     return {
-      agoricNames,
       fromBoard,
       marshaller,
       readLatestHead,
@@ -261,4 +142,4 @@ export const makeVstorageKit = async ({ fetch }, config) => {
     throw Error(`RPC failure (${config.rpcAddrs}): ${err.message}`);
   }
 };
-/** @typedef {Awaited<ReturnType<typeof makeVstorageKit>>} VstorageKit */
+/** @typedef {ReturnType<typeof makeVstorageKit>} VstorageKit */

package/src/vstorage.js

@@ -0,0 +1,125 @@
+/* global Buffer */
+
+/**
+ * @import {MinimalNetworkConfig} from './network-config.js';
+ */
+
+/**
+ * @param {object} powers
+ * @param {typeof window.fetch} powers.fetch
+ * @param {MinimalNetworkConfig} config
+ */
+export const makeVStorage = ({ fetch }, config) => {
+  /** @param {string} path */
+  const getJSON = path => {
+    const url = config.rpcAddrs[0] + path;
+    // console.warn('fetching', url);
+    return 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;
+      });
+
+  const vstorage = {
+    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 vstorage.decode(raw);
+    },
+    async keys(path = 'published') {
+      const raw = await readStorage(path, { kind: 'children' });
+      return JSON.parse(vstorage.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 = vstorage.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 vstorage.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();
+    },
+  };
+  return vstorage;
+};
+/** @typedef {ReturnType<typeof makeVStorage>} VStorage */

package/src/wallet-utils.js

@@ -1,113 +1,8 @@
-import { makeWalletStateCoalescer } from '@agoric/smart-wallet/src/utils.js';
-import { pollBlocks } from './chain.js';
-import { makeStargateClient } from './rpc.js';
-import { boardSlottingMarshaller, makeVstorageKit } from './vstorage-kit.js';
+/** @file backwards compat */
 
-/**
- * @import {Amount, Brand} from '@agoric/ertp/src/types.js'
- * @import {CurrentWalletRecord, UpdateRecord} from '@agoric/smart-wallet/src/smartWallet.js';
- * @import {MinimalNetworkConfig} from './rpc.js';
- */
+import { makeSmartWalletKit } from './smart-wallet-kit.js';
 
-// XXX this is really a SmartWalletKit
-/**
- * Augment VstorageKit with addtional convenience methods for working with
- * Agoric smart wallets.
- *
- * @param {object} root0
- * @param {typeof globalThis.fetch} root0.fetch
- * @param {(ms: number) => Promise<void>} root0.delay
- * @param {MinimalNetworkConfig} networkConfig
- */
-export const makeWalletUtils = async ({ fetch, delay }, networkConfig) => {
-  const vsk = await makeVstorageKit({ fetch }, networkConfig);
+/** @typedef {import('./smart-wallet-kit.js').SmartWalletKit} WalletUtils  */
 
-  const m = boardSlottingMarshaller(vsk.fromBoard.convertSlotToVal);
-
-  const client = await makeStargateClient(networkConfig, { fetch });
-
-  /**
-   * @param {string} from
-   * @param {number|string} [minHeight]
-   */
-  const storedWalletState = async (from, minHeight = undefined) => {
-    const history = await vsk.vstorage.readFully(
-      `published.wallet.${from}`,
-      minHeight,
-    );
-
-    /** @type {{ Invitation: Brand<'set'> }} */
-    // @ts-expect-error XXX how to narrow AssetKind to set?
-    const { Invitation } = vsk.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 poll = pollBlocks({
-      client,
-      delay,
-      retryMessage: 'offer not in wallet at block',
-    });
-
-    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;
-    };
-    return poll(lookup);
-  };
-
-  /**
-   * @param {string} addr
-   * @returns {Promise<UpdateRecord>}
-   */
-  const getLastUpdate = addr => {
-    return vsk.readPublished(`wallet.${addr}`);
-  };
-
-  /**
-   * @param {string} addr
-   * @returns {Promise<CurrentWalletRecord>}
-   */
-  const getCurrentWalletRecord = addr => {
-    return vsk.readPublished(`wallet.${addr}.current`);
-  };
-
-  return {
-    // pass along all of VstorageKit
-    ...vsk,
-    networkConfig,
-    getLastUpdate,
-    getCurrentWalletRecord,
-    storedWalletState,
-    pollOffer,
-  };
-};
-/** @typedef {Awaited<ReturnType<typeof makeWalletUtils>>} WalletUtils */
+/** @deprecated use `makeSmartWalletKit` */
+export const makeWalletUtils = makeSmartWalletKit;