@agoric/client-utils 0.1.1-dev-fbae24c.0 → 0.1.1-dev-8f9f075.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/client-utils",
-  "version": "0.1.1-dev-fbae24c.0+fbae24c",
+  "version": "0.1.1-dev-8f9f075.0+8f9f075",
   "description": "Utilities for building Agoric clients",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -27,11 +27,11 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/casting": "0.4.3-dev-fbae24c.0+fbae24c",
-    "@agoric/ertp": "0.16.3-dev-fbae24c.0+fbae24c",
-    "@agoric/internal": "0.3.3-dev-fbae24c.0+fbae24c",
-    "@agoric/smart-wallet": "0.5.4-dev-fbae24c.0+fbae24c",
-    "@agoric/vats": "0.15.2-dev-fbae24c.0+fbae24c",
+    "@agoric/casting": "0.4.3-dev-8f9f075.0+8f9f075",
+    "@agoric/ertp": "0.16.3-dev-8f9f075.0+8f9f075",
+    "@agoric/internal": "0.3.3-dev-8f9f075.0+8f9f075",
+    "@agoric/smart-wallet": "0.5.4-dev-8f9f075.0+8f9f075",
+    "@agoric/vats": "0.15.2-dev-8f9f075.0+8f9f075",
     "@cosmjs/stargate": "^0.32.3",
     "@cosmjs/tendermint-rpc": "^0.32.3",
     "@endo/common": "^1.2.8",
@@ -58,5 +58,5 @@
     ],
     "timeout": "20m"
   },
-  "gitHead": "fbae24ccaff7b911a2ef72e1c47434e6dfd73d9f"
+  "gitHead": "8f9f07501c1e5f25103d0a015f2f2817275391f2"
 }

package/src/main.js

@@ -1,6 +1,7 @@
 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';

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

@@ -2,6 +2,7 @@ import {
   boardSlottingMarshaller,
   makeBoardRemote,
 } from '@agoric/vats/tools/board-utils.js';
+import { assertAllDefined } from '@agoric/internal';
 import { makeVStorage } from './vstorage.js';
 
 export { boardSlottingMarshaller };
@@ -73,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 => {
@@ -96,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);
 
@@ -131,7 +131,6 @@ export const makeVstorageKit = async ({ fetch }, config) => {
       readLatestHead(`published.${subpath}`);
 
     return {
-      agoricNames,
       fromBoard,
       marshaller,
       readLatestHead,
@@ -143,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/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 './network-config.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;