@agoric/fast-usdc 0.1.1-dev-059601c.0 → 0.1.1-dev-4feddb0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-dev-059601c.0+059601c",
+  "version": "0.1.1-dev-4feddb0.0+4feddb0",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -22,9 +22,9 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-dev-059601c.0+059601c",
-    "@agoric/vats": "0.15.2-dev-059601c.0+059601c",
-    "@agoric/zone": "0.2.3-dev-059601c.0+059601c",
+    "@agoric/swingset-liveslots": "0.10.3-dev-4feddb0.0+4feddb0",
+    "@agoric/vats": "0.15.2-dev-4feddb0.0+4feddb0",
+    "@agoric/zone": "0.2.3-dev-4feddb0.0+4feddb0",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
@@ -32,15 +32,15 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-059601c.0+059601c",
-    "@agoric/ertp": "0.16.3-dev-059601c.0+059601c",
-    "@agoric/internal": "0.3.3-dev-059601c.0+059601c",
-    "@agoric/notifier": "0.6.3-dev-059601c.0+059601c",
-    "@agoric/orchestration": "0.1.1-dev-059601c.0+059601c",
-    "@agoric/store": "0.9.3-dev-059601c.0+059601c",
-    "@agoric/vat-data": "0.5.3-dev-059601c.0+059601c",
-    "@agoric/vow": "0.1.1-dev-059601c.0+059601c",
-    "@agoric/zoe": "0.26.3-dev-059601c.0+059601c",
+    "@agoric/client-utils": "0.1.1-dev-4feddb0.0+4feddb0",
+    "@agoric/ertp": "0.16.3-dev-4feddb0.0+4feddb0",
+    "@agoric/internal": "0.3.3-dev-4feddb0.0+4feddb0",
+    "@agoric/notifier": "0.6.3-dev-4feddb0.0+4feddb0",
+    "@agoric/orchestration": "0.1.1-dev-4feddb0.0+4feddb0",
+    "@agoric/store": "0.9.3-dev-4feddb0.0+4feddb0",
+    "@agoric/vat-data": "0.5.3-dev-4feddb0.0+4feddb0",
+    "@agoric/vow": "0.1.1-dev-4feddb0.0+4feddb0",
+    "@agoric/zoe": "0.26.3-dev-4feddb0.0+4feddb0",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
@@ -80,5 +80,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "059601c7e5961085634c8553c4998dc9043e1792"
+  "gitHead": "4feddb0e0fbdf2343622c7424c6e6d3de013c85d"
 }

package/src/exos/advancer.js

@@ -3,7 +3,6 @@ import { assertAllDefined, makeTracer } from '@agoric/internal';
 import { AnyNatAmountShape, ChainAddressShape } from '@agoric/orchestration';
 import { pickFacet } from '@agoric/vat-data';
 import { VowShape } from '@agoric/vow';
-import { q } from '@endo/errors';
 import { E } from '@endo/far';
 import { M } from '@endo/patterns';
 import {
@@ -153,6 +152,7 @@ export const prepareAdvancerKit = (
               recipientAddress,
               EudParamShape,
             );
+            log(`decoded EUD: ${EUD}`);
             // throws if the bech32 prefix is not found
             const destination = chainHub.makeChainAddress(EUD);
 
@@ -161,9 +161,8 @@ export const prepareAdvancerKit = (
             const advanceAmount = feeTools.calculateAdvance(fullAmount);
 
             const { zcfSeat: tmpSeat } = zcf.makeEmptySeatKit();
-            const amountKWR = harden({ USDC: advanceAmount });
             // throws if the pool has insufficient funds
-            borrowerFacet.borrow(tmpSeat, amountKWR);
+            borrowerFacet.borrow(tmpSeat, advanceAmount);
 
             // this cannot throw since `.isSeen()` is called in the same turn
             statusManager.advance(evidence);
@@ -172,7 +171,7 @@ export const prepareAdvancerKit = (
               tmpSeat,
               // @ts-expect-error LocalAccountMethods vs OrchestrationAccount
               poolAccount,
-              amountKWR,
+              harden({ USDC: advanceAmount }),
             );
             void watch(depositV, this.facets.depositHandler, {
               fullAmount,
@@ -182,8 +181,8 @@ export const prepareAdvancerKit = (
               tmpSeat,
               txHash: evidence.txHash,
             });
-          } catch (e) {
-            log('Advancer error:', q(e).toString());
+          } catch (error) {
+            log('Advancer error:', error);
             statusManager.observe(evidence);
           }
         },
@@ -212,18 +211,28 @@ export const prepareAdvancerKit = (
           });
         },
         /**
+         * We do not expect this to be a common failure. it should only occur
+         * if USDC is not registered in vbank or the tmpSeat has less than
+         * `advanceAmount`.
+         *
+         * If we do hit this path, we return funds to the Liquidity Pool and
+         * notify of Advancing failure.
+         *
          * @param {Error} error
          * @param {AdvancerVowCtx & { tmpSeat: ZCFSeat }} ctx
          */
-        onRejected(error, { tmpSeat }) {
-          // TODO return seat allocation from ctx to LP?
-          log('🚨 advance deposit failed', q(error).toString());
-          // TODO #10510 (comprehensive error testing) determine
-          // course of action here
+        onRejected(error, { tmpSeat, advanceAmount, ...restCtx }) {
           log(
-            'TODO live payment on seat to return to LP',
-            q(tmpSeat).toString(),
+            '⚠️ deposit to localOrchAccount failed, attempting to return payment to LP',
+            error,
           );
+          try {
+            const { borrowerFacet, notifyFacet } = this.state;
+            notifyFacet.notifyAdvancingResult(restCtx, false);
+            borrowerFacet.returnToPool(tmpSeat, advanceAmount);
+          } catch (e) {
+            log('🚨 deposit to localOrchAccount failure recovery failed', e);
+          }
         },
       },
       transferHandler: {
@@ -234,10 +243,11 @@ export const prepareAdvancerKit = (
         onFulfilled(result, ctx) {
           const { notifyFacet } = this.state;
           const { advanceAmount, destination, ...detail } = ctx;
-          log(
-            'Advance transfer fulfilled',
-            q({ advanceAmount, destination, result }).toString(),
-          );
+          log('Advance transfer fulfilled', {
+            advanceAmount,
+            destination,
+            result,
+          });
           // During development, due to a bug, this call threw.
           // The failure was silent (no diagnostics) due to:
           //  - #10576 Vows do not report unhandled rejections
@@ -252,7 +262,7 @@ export const prepareAdvancerKit = (
          */
         onRejected(error, ctx) {
           const { notifyFacet } = this.state;
-          log('Advance transfer rejected', q(error).toString());
+          log('Advance transfer rejected', error);
           notifyFacet.notifyAdvancingResult(ctx, false);
         },
       },

package/src/exos/liquidity-pool.js

@@ -28,7 +28,7 @@ import {
  * @import {PoolStats} from '../types.js';
  */
 
-const { add, isEqual, makeEmpty } = AmountMath;
+const { add, isEqual, isGTE, makeEmpty } = AmountMath;
 
 /** @param {Brand} brand */
 const makeDust = brand => AmountMath.make(brand, 1n);
@@ -84,10 +84,8 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
     'Liquidity Pool',
     {
       borrower: M.interface('borrower', {
-        borrow: M.call(
-          SeatShape,
-          harden({ USDC: makeNatAmountShape(USDC, 1n) }),
-        ).returns(),
+        borrow: M.call(SeatShape, makeNatAmountShape(USDC, 1n)).returns(),
+        returnToPool: M.call(SeatShape, makeNatAmountShape(USDC, 1n)).returns(),
       }),
       repayer: M.interface('repayer', {
         repay: M.call(
@@ -153,32 +151,48 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
       borrower: {
         /**
          * @param {ZCFSeat} toSeat
-         * @param {{ USDC: Amount<'nat'>}} amountKWR
+         * @param {Amount<'nat'>} amount
          */
-        borrow(toSeat, amountKWR) {
+        borrow(toSeat, amount) {
           const { encumberedBalance, poolSeat, poolStats } = this.state;
 
           // Validate amount is available in pool
           const post = borrowCalc(
-            amountKWR.USDC,
+            amount,
             poolSeat.getAmountAllocated('USDC', USDC),
             encumberedBalance,
             poolStats,
           );
 
           // COMMIT POINT
-          try {
-            zcf.atomicRearrange(harden([[poolSeat, toSeat, amountKWR]]));
-          } catch (cause) {
-            const reason = Error('🚨 cannot commit borrow', { cause });
-            console.error(reason.message, cause);
-            zcf.shutdownWithFailure(reason);
-          }
+          // UNTIL #10684: ability to terminate an incarnation w/o terminating the contract
+          zcf.atomicRearrange(harden([[poolSeat, toSeat, { USDC: amount }]]));
 
           Object.assign(this.state, post);
           this.facets.external.publishPoolMetrics();
         },
-        // TODO method to repay failed `LOA.deposit()`
+        /**
+         * If something fails during advance, return funds to the pool.
+         *
+         * @param {ZCFSeat} borrowSeat
+         * @param {Amount<'nat'>} amount
+         */
+        returnToPool(borrowSeat, amount) {
+          const { zcfSeat: repaySeat } = zcf.makeEmptySeatKit();
+          const returnAmounts = harden({
+            Principal: amount,
+            PoolFee: makeEmpty(USDC),
+            ContractFee: makeEmpty(USDC),
+          });
+          const borrowSeatAllocation = borrowSeat.getCurrentAllocation();
+          isGTE(borrowSeatAllocation.USDC, amount) ||
+            Fail`⚠️ borrowSeatAllocation ${q(borrowSeatAllocation)} less than amountKWR ${q(amount)}`;
+          // arrange payments in a format repay is expecting
+          zcf.atomicRearrange(
+            harden([[borrowSeat, repaySeat, { USDC: amount }, returnAmounts]]),
+          );
+          return this.facets.repayer.repay(repaySeat, returnAmounts);
+        },
       },
       repayer: {
         /**
@@ -208,23 +222,18 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
           const { ContractFee, ...rest } = amounts;
 
           // COMMIT POINT
-          try {
-            zcf.atomicRearrange(
-              harden([
-                [
-                  fromSeat,
-                  poolSeat,
-                  rest,
-                  { USDC: add(amounts.PoolFee, amounts.Principal) },
-                ],
-                [fromSeat, feeSeat, { ContractFee }, { USDC: ContractFee }],
-              ]),
-            );
-          } catch (cause) {
-            const reason = Error('🚨 cannot commit repay', { cause });
-            console.error(reason.message, cause);
-            zcf.shutdownWithFailure(reason);
-          }
+          // UNTIL #10684: ability to terminate an incarnation w/o terminating the contract
+          zcf.atomicRearrange(
+            harden([
+              [
+                fromSeat,
+                poolSeat,
+                rest,
+                { USDC: add(amounts.PoolFee, amounts.Principal) },
+              ],
+              [fromSeat, feeSeat, { ContractFee }, { USDC: ContractFee }],
+            ]),
+          );
 
           Object.assign(this.state, post);
           this.facets.external.publishPoolMetrics();
@@ -259,9 +268,8 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
           const post = depositCalc(shareWorth, proposal);
 
           // COMMIT POINT
-
+          const mint = shareMint.mintGains(post.payouts);
           try {
-            const mint = shareMint.mintGains(post.payouts);
             this.state.shareWorth = post.shareWorth;
             zcf.atomicRearrange(
               harden([
@@ -271,12 +279,12 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
                 [mint, lp, post.payouts],
               ]),
             );
+          } catch (cause) {
+            // UNTIL #10684: ability to terminate an incarnation w/o terminating the contract
+            throw new Error('🚨 cannot commit deposit', { cause });
+          } finally {
             lp.exit();
             mint.exit();
-          } catch (cause) {
-            const reason = Error('🚨 cannot commit deposit', { cause });
-            console.error(reason.message, cause);
-            zcf.shutdownWithFailure(reason);
           }
           external.publishPoolMetrics();
         },
@@ -296,7 +304,6 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
           const post = withdrawCalc(shareWorth, proposal);
 
           // COMMIT POINT
-
           try {
             this.state.shareWorth = post.shareWorth;
             zcf.atomicRearrange(
@@ -308,12 +315,12 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
               ]),
             );
             shareMint.burnLosses(proposal.give, burn);
+          } catch (cause) {
+            // UNTIL #10684: ability to terminate an incarnation w/o terminating the contract
+            throw new Error('🚨 cannot commit withdraw', { cause });
+          } finally {
             lp.exit();
             burn.exit();
-          } catch (cause) {
-            const reason = Error('🚨 cannot commit withdraw', { cause });
-            console.error(reason.message, cause);
-            zcf.shutdownWithFailure(reason);
           }
           external.publishPoolMetrics();
         },

package/src/exos/settler.js

@@ -237,13 +237,13 @@ export const prepareSettler = (
           const split = calculateSplit(received);
           log('disbursing', split);
 
-          // TODO: what if this throws?
-          // arguably, it cannot. Even if deposits
-          // and notifications get out of order,
-          // we don't ever withdraw more than has been deposited.
+          // If this throws, which arguably can't occur since we don't ever
+          // withdraw more than has been deposited (as denoted by
+          // `FungibleTokenPacketData`), funds will remain in the
+          // `settlementAccount`. A remediation can occur in a future upgrade.
           await vowTools.when(
             withdrawToSeat(
-              // @ts-expect-error Vow vs. Promise stuff. TODO: is this OK???
+              // @ts-expect-error LocalAccountMethods vs OrchestrationAccount
               settlementAccount,
               settlingSeat,
               harden({ In: received }),