@agoric/inter-protocol 0.13.3 → 0.13.4-dev-800c2bb.0

package/src/proposals/utils.js

@@ -1,19 +1,17 @@
+import { WalletName } from '@agoric/internal';
 import { getCopyMapEntries, makeCopyMap } from '@agoric/store';
 import { E } from '@endo/far';
 
-// must match packages/wallet/api/src/lib-wallet.js
-export const DEPOSIT_FACET = 'depositFacet';
-
-const { details: X } = assert;
+const { Fail } = assert;
 
 /**
- * @param {ERef<NameAdmin>} nameAdmin
+ * @param {ERef<import('@agoric/vats').NameAdmin>} nameAdmin
  * @param {string[][]} paths
  */
 export const reserveThenGetNamePaths = async (nameAdmin, paths) => {
   /**
    *
-   * @param {ERef<NameAdmin>} nextAdmin
+   * @param {ERef<import('@agoric/vats').NameAdmin>} nextAdmin
    * @param {string[]} path
    */
   const nextPath = async (nextAdmin, path) => {
@@ -36,14 +34,14 @@ export const reserveThenGetNamePaths = async (nameAdmin, paths) => {
 
   return Promise.all(
     paths.map(async path => {
-      assert(Array.isArray(path), X`path ${path} is not an array`);
+      Array.isArray(path) || Fail`path ${path} is not an array`;
       return nextPath(nameAdmin, path);
     }),
   );
 };
 
 /**
- * @param {ERef<NameAdmin>} nameAdmin
+ * @param {ERef<import('@agoric/vats').NameAdmin>} nameAdmin
  * @param {string[]} names
  */
 export const reserveThenGetNames = async (nameAdmin, names) =>
@@ -52,22 +50,36 @@ export const reserveThenGetNames = async (nameAdmin, names) =>
     names.map(name => [name]),
   );
 
+/**
+ * @param {string} debugName
+ * @param {ERef<import('@agoric/vats').NameAdmin>} namesByAddressAdmin
+ * @param {string} addr
+ * @param {Array<ERef<Payment>>} payments
+ */
 export const reserveThenDeposit = async (
   debugName,
   namesByAddressAdmin,
   addr,
   payments,
 ) => {
-  console.info('waiting for', debugName);
+  console.info('awaiting depositFacet for', debugName);
   const [depositFacet] = await reserveThenGetNamePaths(namesByAddressAdmin, [
-    [addr, DEPOSIT_FACET],
+    [addr, WalletName.depositFacet],
   ]);
   console.info('depositing to', debugName);
-  await Promise.all(payments.map(payment => E(depositFacet).receive(payment)));
-  console.info('confirmed deposit for', debugName);
+  await Promise.allSettled(
+    payments.map(async (paymentP, i) => {
+      const payment = await paymentP;
+      await E(depositFacet).receive(payment);
+      console.info(
+        `confirmed deposit ${i + 1}/${payments.length} for`,
+        debugName,
+      );
+    }),
+  );
 };
 
-/** @type {<T>(store: ERef<MapStore>, key: string, make: () => T) => Promise<T>} */
+/** @type {<T>(store: ERef<Map<string, T> | import('@agoric/internal/src/scratch.js').ScratchPad>, key: string, make: () => T) => Promise<T>} */
 const provideWhen = async (store, key, make) => {
   const found = await E(store).get(key);
   if (found) {
@@ -79,8 +91,7 @@ const provideWhen = async (store, key, make) => {
 };
 
 /**
- *
- * @param {{ scratch: ERef<MapStore<string, unknown>> }} homeP
+ * @param {{ scratch: ERef<import('@agoric/internal/src/scratch.js').ScratchPad> }} homeP
  * @param {object} opts
  * @param {(specifier: string) => Promise<{default: Bundle}>} opts.loadBundle
  * @param {string} [opts.installCacheKey]
@@ -108,9 +119,12 @@ export const makeInstallCache = async (
   };
 
   const wrapInstall = install => async (mPath, bPath, opts) => {
-    const { endoZipBase64Sha512: sha512 } = await loadBundle(bPath).then(
-      m => m.default,
+    const bundle = await loadBundle(bPath).then(m => m.default);
+    assert(
+      'endoZipBase64Sha512' in bundle,
+      'bundle must be EndoZipBase64Bundle',
     );
+    const { endoZipBase64Sha512: sha512 } = bundle;
     const detail = await provideWhen(working, sha512, () =>
       install(mPath, bPath, opts).then(installation => ({
         installation,

package/src/psm/README.md

@@ -0,0 +1,71 @@
+# Parity Stability Module
+
+The Parity Stability Module supports efficiently minting/burning a stable token
+at a specified fixed ratio to a reference stable token, which thereby acts as an
+anchor to provide additional stability. For flexible economic policies, the fee
+percentage for trading into and out of the stable token are specified
+separately.
+
+
+## Usage
+
+See the [Smart Wallet integration test](/packages/inter-protocol/test/smartWallet/test-psm-integration.js) for how it's used.
+
+End users can make swap offers in the CLI or GUI.
+
+### CLI
+
+See [psm.js command file](/packages/agoric-cli/src/commands/psm.js) and its [integration test script](/packages/agoric-cli/scripts/).
+
+```mermaid
+sequenceDiagram
+
+actor user
+
+participant cli as Dapp PSM
+participant disk
+participant B as Cosmos / Swingset <br/> bridge
+participant C as smart-wallet<br/>contract
+participant PSM as PSM<br/>contract
+
+user ->> cli: create a swap offer
+user -->> disk: write offer data
+user ->> cli: sign and send swap offer
+disk -->> cli: read offer data
+cli ->> B: spending transaction
+B ->> C: unpack ocap data
+C ->> PSM: route offer
+```
+
+
+### GUI
+
+The GUI is in https://github.com/Agoric/dapp-psm
+
+It introduces another layer of communication (between the dapp and Wallet UI):
+
+```mermaid
+sequenceDiagram
+
+actor user
+
+participant dapp as Dapp PSM
+participant ls as localStorage
+participant ui as Wallet UI
+participant Keplr
+participant B as Cosmos / Swingset <br/> bridge
+participant C as smart-wallet<br/>contract
+participant PSM as PSM<br/>contract
+
+user ->> dapp: configure offer and click
+dapp ->> ls: write offer record
+ls ->> ui: notify offer record
+ui ->> user: display offer for signing
+user ->> ui: click Approve
+ui ->> Keplr: request signing
+Keplr ->> user: pop-up transaction
+user ->> Keplr: click to sign
+Keplr ->> B: spending transaction
+B ->> C: unpack ocap data
+C ->> PSM: route offer
+```