feat: integrate advancer in StartFn

Author: 0xpatrickdev

packages/fast-usdc/src/exos/advancer.js

@@ -13,7 +13,7 @@ import { addressTools } from '../utils/address.js';
  * @import {HostInterface} from '@agoric/async-flow';
  * @import {NatAmount} from '@agoric/ertp';
  * @import {ChainAddress, ChainHub, Denom, DenomAmount, OrchestrationAccount} from '@agoric/orchestration';
- * @import {VowTools} from '@agoric/vow';
+ * @import {Vow, VowTools} from '@agoric/vow';
  * @import {Zone} from '@agoric/zone';
  * @import {CctpTxEvidence, LogFn} from '../types.js';
  * @import {StatusManager} from './status-manager.js';
@@ -85,7 +85,7 @@ export const prepareAdvancerKit = (
      * @param {{
      *   assetManagerFacet: AssetManagerFacet;
      *   localDenom: Denom;
-     *   poolAccount: ERef<HostInterface<OrchestrationAccount<{chainId: 'agoric';}>>>
+     *   poolAccount: Vow<HostInterface<OrchestrationAccount<{chainId: 'agoric';}>>> | HostInterface<OrchestrationAccount<{chainId: 'agoric';}>>;
      *   usdcBrand: Brand<'nat'>;
      * }} config
      */
@@ -107,8 +107,9 @@ export const prepareAdvancerKit = (
         async handleTransactionEvent(evidence) {
           await null;
           try {
-            // TODO poolAccount might be a vow we need to unwrap
-            const { assetManagerFacet, poolAccount, usdcBrand } = this.state;
+            const { assetManagerFacet, usdcBrand } = this.state;
+            // is there a better way than this?
+            const poolAccount = await when(this.state.poolAccount);
             const { recipientAddress } = evidence.aux;
             const { EUD } =
               addressTools.getQueryParams(recipientAddress).params;
@@ -173,6 +174,7 @@ export const prepareAdvancerKit = (
          */
         onFulfilled(amount, destination) {
           const { localDenom, poolAccount } = this.state;
+          // @ts-expect-error poolAccountV already settled
           const transferV = E(poolAccount).transfer(
             destination,
             /** @type {DenomAmount} */ ({

packages/fast-usdc/src/fast-usdc.contract.js

@@ -11,11 +11,15 @@ import { prepareLiquidityPoolKit } from './exos/liquidity-pool.js';
 import { prepareSettler } from './exos/settler.js';
 import { prepareStatusManager } from './exos/status-manager.js';
 import { prepareTransactionFeedKit } from './exos/transaction-feed.js';
+import * as flows from './fast-usdc.flows.js';
 
 const trace = makeTracer('FastUsdc');
 
 /**
+ * @import {HostInterface} from '@agoric/async-flow';
+ * @import {OrchestrationAccount} from '@agoric/orchestration';
  * @import {OrchestrationPowers, OrchestrationTools} from '@agoric/orchestration/src/utils/start-helper.js';
+ * @import {Vow} from '@agoric/vow';
  * @import {Zone} from '@agoric/zone';
  * @import {CctpTxEvidence} from './types.js';
  */
@@ -24,13 +28,15 @@ const trace = makeTracer('FastUsdc');
  * @typedef {{
  *   poolFee: Amount<'nat'>;
  *   contractFee: Amount<'nat'>;
+ *   usdcDenom: string;
  * }} FastUsdcTerms
  */
 const NatAmountShape = { brand: BrandShape, value: M.nat() };
 export const meta = {
   customTermsShape: {
     contractFee: NatAmountShape,
     poolFee: NatAmountShape,
+    usdcDenom: M.string(),
   },
 };
 harden(meta);
@@ -55,7 +61,7 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
 
   const statusManager = prepareStatusManager(zone);
   const makeSettler = prepareSettler(zone, { statusManager });
-  const { chainHub, vowTools } = tools;
+  const { chainHub, orchestrateAll, vowTools } = tools;
   const makeAdvancer = prepareAdvancer(zone, {
     chainHub,
     log: trace,
@@ -64,17 +70,6 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
   });
   const makeFeedKit = prepareTransactionFeedKit(zone);
   assertAllDefined({ makeFeedKit, makeAdvancer, makeSettler, statusManager });
-  const feedKit = makeFeedKit();
-  const advancer = makeAdvancer(
-    // @ts-expect-error FIXME
-    {},
-  );
-  // Connect evidence stream to advancer
-  void observeIteration(subscribeEach(feedKit.public.getEvidenceStream()), {
-    updateState(evidence) {
-      void advancer.handleTransactionEvent(evidence);
-    },
-  });
   const makeLiquidityPoolKit = prepareLiquidityPoolKit(zone, {
     zcf,
     USDC: {
@@ -91,6 +86,7 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
       // return poolKit.feeSink.receive(amount, payment);
     },
   });
+  const { makeLocalAccount } = orchestrateAll(flows, {});
 
   const publicFacet = zone.exo('Fast USDC Public', undefined, {
     // XXX to be removed before production
@@ -106,6 +102,7 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     makeTestPushInvitation(evidence) {
       // TODO(bootstrap integration): force this to throw and confirm that it
       // shows up in the the smart-wallet UpdateRecord `error` property
+      // eslint-disable-next-line no-use-before-define
       feedKit.admin.submitEvidence(evidence);
       return zcf.makeInvitation(async cSeat => {
         trace('Offer made on noop invitation');
@@ -153,6 +150,36 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     makeLiquidityPoolKit(shareMint, privateArgs.storageNode),
   );
 
+  const poolAccount =
+    // cast to HostInterface
+    /** @type { Vow<HostInterface<OrchestrationAccount<{chainId: 'agoric';}>>>} */ (
+      /** @type {unknown}*/ (
+        zone.makeOnce('Pool Local Orch Account', () => makeLocalAccount())
+      )
+    );
+
+  const advancer = zone.makeOnce('Advancer', () => {
+    // TODO, ensure ChainHub is populated
+    const localDenom = terms.usdcDenom;
+    // from ChainHub is better?
+    // chainHub.getDenom(terms.brands.USDC) ||
+    // Fail`No brand or AssetDetail for USDC `;
+    return makeAdvancer({
+      localDenom,
+      poolAccount,
+      usdcBrand: terms.brands.USDC,
+      assetManagerFacet: poolKit.assetManager,
+    });
+  });
+
+  const feedKit = zone.makeOnce('Feed Kit', () => makeFeedKit());
+  // Connect evidence stream to advancer
+  void observeIteration(subscribeEach(feedKit.public.getEvidenceStream()), {
+    updateState(evidence) {
+      void advancer.handleTransactionEvent(evidence);
+    },
+  });
+
   return harden({ creatorFacet, publicFacet });
 };
 harden(contract);

packages/fast-usdc/src/fast-usdc.flows.js

@@ -0,0 +1,15 @@
+/**
+ * @import {HostInterface} from '@agoric/async-flow';
+ * @import {Orchestrator, OrchestrationFlow, OrchestrationAccount} from '@agoric/orchestration';
+ */
+
+/**
+ * @satisfies {OrchestrationFlow}w
+ * @param {Orchestrator} orch
+ * @returns {Promise<OrchestrationAccount<{ chainId: 'agoric'; }>>}
+ */
+export const makeLocalAccount = async orch => {
+  const agoricChain = await orch.getChain('agoric');
+  return agoricChain.makeAccount();
+};
+harden(makeLocalAccount);

packages/fast-usdc/test/fast-usdc.contract.test.ts

@@ -11,6 +11,8 @@ import { setUpZoeForTest } from '@agoric/zoe/tools/setup-zoe.js';
 import { E } from '@endo/far';
 import path from 'path';
 import fetchedChainInfo from '@agoric/orchestration/src/fetched-chain-info.js';
+import { denomHash } from '@agoric/orchestration';
+import type { NatAmount } from '@agoric/ertp';
 import { MockCctpTxEvidences } from './fixtures.js';
 import { commonSetup } from './supports.js';
 
@@ -20,6 +22,15 @@ const contractName = 'fast-usdc';
 const contractFile = `${dirname}/../src/fast-usdc.contract.js`;
 type StartFn = typeof import('../src/fast-usdc.contract.js').start;
 
+const makeDefaultTerms = (usdc: { make: (v: NatValue) => NatAmount }) => ({
+  poolFee: usdc.make(1n),
+  contractFee: usdc.make(1n),
+  usdcDenom: denomHash({
+    denom: 'uusdc',
+    channelId: 'channel-62',
+  }),
+});
+
 test('start', async t => {
   const {
     bootstrap,
@@ -39,10 +50,7 @@ test('start', async t => {
   const { creatorFacet, publicFacet } = await E(zoe).startInstance(
     installation,
     { USDC: usdc.issuer },
-    {
-      poolFee: usdc.make(1n),
-      contractFee: usdc.make(1n),
-    },
+    makeDefaultTerms(usdc),
     commonPrivateArgs,
   );
   t.truthy(creatorFacet);
@@ -88,10 +96,7 @@ test('LP deposits, earns fees, withdraws', async t => {
   const { creatorFacet, publicFacet, instance } = await E(zoe).startInstance(
     installation,
     { USDC: usdc.issuer },
-    {
-      poolFee: usdc.make(1n),
-      contractFee: usdc.make(1n),
-    },
+    makeDefaultTerms(usdc),
     commonPrivateArgs,
   );
   t.truthy(creatorFacet);
@@ -203,10 +208,7 @@ test('baggage', async t => {
   await E(zoe).startInstance(
     installation,
     { USDC: usdc.issuer },
-    {
-      poolFee: usdc.make(1n),
-      contractFee: usdc.make(1n),
-    },
+    makeDefaultTerms(usdc),
     commonPrivateArgs,
   );
 

packages/fast-usdc/test/snapshots/fast-usdc.contract.test.ts.md

@@ -22,24 +22,42 @@ Generated by [AVA](https://avajs.dev).
         },
         LogStore_kindHandle: 'Alleged: kind',
         StateUnwrapper_kindHandle: 'Alleged: kind',
-        asyncFuncEagerWakers: [],
+        asyncFuncEagerWakers: [
+          Object @Alleged: asyncFlow flow {},
+        ],
         asyncFuncFailures: {},
-        flowForOutcomeVow: {},
+        flowForOutcomeVow: {
+          'Alleged: VowInternalsKit vowV0': 'Alleged: asyncFlow flow',
+        },
         unwrapMap: 'Alleged: weakMapStore',
       },
       chainHub: {
         ChainHub_kindHandle: 'Alleged: kind',
         ChainHub_singleton: 'Alleged: ChainHub',
-        bech32PrefixToChainName: {},
+        bech32PrefixToChainName: {
+          agoric: 'agoric',
+        },
         brandDenom: {},
-        chainInfos: {},
+        chainInfos: {
+          agoric: {
+            bech32Prefix: 'agoric',
+            chainId: 'agoric-3',
+            icqEnabled: false,
+            stakingTokens: [
+              {
+                denom: 'ubld',
+              },
+            ],
+          },
+        },
         connectionInfos: {},
         denom: {},
         lookupChainInfo_kindHandle: 'Alleged: kind',
         lookupChainsAndConnection_kindHandle: 'Alleged: kind',
         lookupConnectionInfo_kindHandle: 'Alleged: kind',
       },
       contract: {
+        Advancer: 'Alleged: Fast USDC Advancer advancer',
         'Fast USDC Advancer_kindHandle': 'Alleged: kind',
         'Fast USDC Creator_kindHandle': 'Alleged: kind',
         'Fast USDC Creator_singleton': 'Alleged: Fast USDC Creator',
@@ -49,6 +67,10 @@ Generated by [AVA](https://avajs.dev).
         'Fast USDC Settler_kindHandle': 'Alleged: kind',
         'Fast USDC Status Manager_kindHandle': 'Alleged: kind',
         'Fast USDC Status Manager_singleton': 'Alleged: Fast USDC Status Manager',
+        'Feed Kit': {
+          admin: Object @Alleged: Fast USDC Feed admin {},
+          public: Object @Alleged: Fast USDC Feed public {},
+        },
         Kinds: {
           'Transaction Feed_kindHandle': 'Alleged: kind',
         },
@@ -61,11 +83,16 @@ Generated by [AVA](https://avajs.dev).
         },
         'Liquidity Pool_kindHandle': 'Alleged: kind',
         PendingTxs: {},
+        'Pool Local Orch Account': 'Vow',
         SeenTxs: [],
         mint: {
           PoolShare: 'Alleged: zcfMint',
         },
-        orchestration: {},
+        orchestration: {
+          makeLocalAccount: {
+            asyncFlow_kindHandle: 'Alleged: kind',
+          },
+        },
         vstorage: {
           'Durable Publish Kit_kindHandle': 'Alleged: kind',
           Recorder_kindHandle: 'Alleged: kind',
@@ -77,7 +104,16 @@ Generated by [AVA](https://avajs.dev).
         LocalChainFacade_kindHandle: 'Alleged: kind',
         Orchestrator_kindHandle: 'Alleged: kind',
         RemoteChainFacade_kindHandle: 'Alleged: kind',
-        chainName: {},
+        chainName: {
+          agoric: {
+            pending: true,
+            vow: Object @Vow {
+              payload: {
+                vowV0: Object @Alleged: VowInternalsKit vowV0 {},
+              },
+            },
+          },
+        },
         ibcTools: {
           IBCTransferSenderKit_kindHandle: 'Alleged: kind',
           ibcResultWatcher_kindHandle: 'Alleged: kind',