chore(fast-usdc): limited operation before connecting to noble (#10641)

closes: #10657 refs: #10328 ## Description - advancer, settler can operate without a noble account address - creatorFacet method to synchronize on fulfillment of `nobleAccountV` vow - restore fast-usdc a3p-integration test to working order ### Security / Documentation Considerations While the noble account vow has not fulfilled, diagnostics for advancing to non-agoric chains are likely to be obscure. Configuration flexibility leads to possibility of configuration errors. ### Scaling Considerations n/a ### Testing Considerations existing tests, but with `set -e` so that when `fastUsdc` is not in `agoricNames.instance`, we actually notice. ### Upgrade Considerations `nobleAccountV` persists across incarnations, so we won't try to make another one on restart / upgrade. TODO: - [x] what to do if `nobleAccountV` rejects?
Agoric · Dec 10, 2024 · 340ef0d · 340ef0d
2 parents 86e3b2d + c9ba09e
commit 340ef0d
Show file tree

Hide file tree

Showing 12 changed files with 96 additions and 52 deletions.
diff --git a/a3p-integration/proposals/f:fast-usdc/package.json b/a3p-integration/proposals/f:fast-usdc/package.json
@@ -2,7 +2,7 @@
   "agoricProposal": {
     "source": "subdir",
     "sdk-generate": [
-      "fast-usdc/init-fast-usdc.js submission --net A3P_INTEGRATION"
+      "fast-usdc/init-fast-usdc.js submission --net A3P_INTEGRATION --noNoble"
     ],
     "type": "/agoric.swingset.CoreEvalProposal"
   },

diff --git a/a3p-integration/proposals/f:fast-usdc/test.sh b/a3p-integration/proposals/f:fast-usdc/test.sh
@@ -1,4 +1,6 @@
 #!/bin/bash
+set -euo pipefail
+
 yarn ava
 
 # TODO get CLI test passing and part of CI

diff --git a/packages/builders/scripts/fast-usdc/init-fast-usdc.js b/packages/builders/scripts/fast-usdc/init-fast-usdc.js
@@ -38,6 +38,7 @@ const options = {
   },
   chainInfo: { type: 'string' },
   assetInfo: { type: 'string' },
+  noNoble: { type: 'boolean', default: false },
 };
 const oraclesUsage = 'use --oracle name:address ...';
 
@@ -57,8 +58,9 @@ const assetInfoUsage =
  *   oracle?: string[];
  *   usdcDenom: string;
  *   feedPolicy?: string;
- *   chainInfo: string;
- *   assetInfo: string;
+ *   chainInfo?: string;
+ *   assetInfo?: string;
+ *   noNoble: boolean;
  * }} FastUSDCOpts
  */
 
@@ -107,6 +109,7 @@ export default async (homeP, endowments) => {
       feedPolicy,
       chainInfo,
       assetInfo,
+      noNoble,
       ...fees
     },
   } = parseArgs({ args: scriptArgs, options });
@@ -185,6 +188,7 @@ export default async (homeP, endowments) => {
     feedPolicy: parseFeedPolicy(),
     chainInfo: parseChainInfo(),
     assetInfo: parseAssetInfo(),
+    noNoble,
   });
 
   await writeCoreEval('start-fast-usdc', utils =>

diff --git a/packages/fast-usdc/src/exos/advancer.js b/packages/fast-usdc/src/exos/advancer.js
@@ -56,6 +56,7 @@ const AdvancerVowCtxShape = M.splitRecord(
 const AdvancerKitI = harden({
   advancer: M.interface('AdvancerI', {
     handleTransactionEvent: M.callWhen(CctpTxEvidenceShape).returns(),
+    setIntermediateRecipient: M.call(ChainAddressShape).returns(),
   }),
   depositHandler: M.interface('DepositHandlerI', {
     onFulfilled: M.call(M.undefined(), AdvancerVowCtxShape).returns(VowShape),
@@ -95,7 +96,7 @@ export const prepareAdvancerKit = (
     usdc,
     vowTools: { watch, when },
     zcf,
-  } = /** @type {AdvancerKitPowers} */ ({}),
+  },
 ) => {
   assertAllDefined({
     chainHub,
@@ -116,10 +117,15 @@ export const prepareAdvancerKit = (
      *   notifyFacet: import('./settler.js').SettlerKit['notify'];
      *   borrowerFacet: LiquidityPoolKit['borrower'];
      *   poolAccount: HostInterface<OrchestrationAccount<{chainId: 'agoric'}>>;
-     *   intermediateRecipient: ChainAddress;
+     *   intermediateRecipient?: ChainAddress;
      * }} config
      */
-    config => harden(config),
+    config =>
+      harden({
+        ...config,
+        // make sure the state record has this property, perhaps with an undefined value
+        intermediateRecipient: config.intermediateRecipient,
+      }),
     {
       advancer: {
         /**
@@ -181,6 +187,10 @@ export const prepareAdvancerKit = (
             statusManager.observe(evidence);
           }
         },
+        /** @param {ChainAddress} intermediateRecipient */
+        setIntermediateRecipient(intermediateRecipient) {
+          this.state.intermediateRecipient = intermediateRecipient;
+        },
       },
       depositHandler: {
         /**
@@ -192,15 +202,8 @@ export const prepareAdvancerKit = (
           const { destination, advanceAmount, ...detail } = ctx;
           const transferV = E(poolAccount).transfer(
             destination,
-            {
-              denom: usdc.denom,
-              value: advanceAmount.value,
-            },
-            {
-              forwardOpts: {
-                intermediateRecipient,
-              },
-            },
+            { denom: usdc.denom, value: advanceAmount.value },
+            { forwardOpts: { intermediateRecipient } },
           );
           return watch(transferV, this.facets.transferHandler, {
             destination,
@@ -259,7 +262,7 @@ export const prepareAdvancerKit = (
         notifyFacet: M.remotable(),
         borrowerFacet: M.remotable(),
         poolAccount: M.remotable(),
-        intermediateRecipient: ChainAddressShape,
+        intermediateRecipient: M.opt(ChainAddressShape),
       }),
     },
   );

diff --git a/packages/fast-usdc/src/exos/settler.js b/packages/fast-usdc/src/exos/settler.js
@@ -62,6 +62,7 @@ export const prepareSettler = (
     {
       creator: M.interface('SettlerCreatorI', {
         monitorMintingDeposits: M.callWhen().returns(M.any()),
+        setIntermediateRecipient: M.call(ChainAddressShape).returns(),
       }),
       tap: M.interface('SettlerTapI', {
         receiveUpcall: M.call(M.record()).returns(M.promise()),
@@ -94,13 +95,15 @@ export const prepareSettler = (
      *   remoteDenom: Denom;
      *   repayer: LiquidityPoolKit['repayer'];
      *   settlementAccount: HostInterface<OrchestrationAccount<{ chainId: 'agoric' }>>
-     *   intermediateRecipient: ChainAddress;
+     *   intermediateRecipient?: ChainAddress;
      * }} config
      */
     config => {
       log('config', config);
       return {
         ...config,
+        // make sure the state record has this property, perhaps with an undefined value
+        intermediateRecipient: config.intermediateRecipient,
         /** @type {HostInterface<TargetRegistration>|undefined} */
         registration: undefined,
         /** @type {SetStore<ReturnType<typeof makeMintedEarlyKey>>} */
@@ -117,6 +120,10 @@ export const prepareSettler = (
           assert.typeof(registration, 'object');
           this.state.registration = registration;
         },
+        /** @param {ChainAddress} intermediateRecipient */
+        setIntermediateRecipient(intermediateRecipient) {
+          this.state.intermediateRecipient = intermediateRecipient;
+        },
       },
       tap: {
         /** @param {VTransferIBCEvent} event */
@@ -265,11 +272,7 @@ export const prepareSettler = (
           const txfrV = E(settlementAccount).transfer(
             dest,
             AmountMath.make(USDC, fullValue),
-            {
-              forwardOpts: {
-                intermediateRecipient,
-              },
-            },
+            { forwardOpts: { intermediateRecipient } },
           );
           void vowTools.watch(txfrV, this.facets.transferHandler, {
             txHash,
@@ -312,7 +315,7 @@ export const prepareSettler = (
         sourceChannel: M.string(),
         remoteDenom: M.string(),
         mintedEarly: M.remotable('mintedEarly'),
-        intermediateRecipient: ChainAddressShape,
+        intermediateRecipient: M.opt(ChainAddressShape),
       }),
     },
   );

diff --git a/packages/fast-usdc/src/fast-usdc.contract.js b/packages/fast-usdc/src/fast-usdc.contract.js
@@ -1,5 +1,5 @@
 import { AssetKind } from '@agoric/ertp';
-import { assertAllDefined, makeTracer } from '@agoric/internal';
+import { makeTracer } from '@agoric/internal';
 import { observeIteration, subscribeEach } from '@agoric/notifier';
 import {
   CosmosChainInfoShape,
@@ -126,7 +126,6 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
   });
 
   const makeFeedKit = prepareTransactionFeedKit(zone, zcf);
-  assertAllDefined({ makeFeedKit, makeAdvancer, makeSettler, statusManager });
 
   const makeLiquidityPoolKit = prepareLiquidityPoolKit(
     zone,
@@ -147,6 +146,20 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     async makeOperatorInvitation(operatorId) {
       return feedKit.creator.makeOperatorInvitation(operatorId);
     },
+    async connectToNoble() {
+      return vowTools.when(nobleAccountV, nobleAccount => {
+        trace('nobleAccount', nobleAccount);
+        return vowTools.when(
+          E(nobleAccount).getAddress(),
+          intermediateRecipient => {
+            trace('intermediateRecipient', intermediateRecipient);
+            advancer.setIntermediateRecipient(intermediateRecipient);
+            settlerKit.creator.setIntermediateRecipient(intermediateRecipient);
+            return intermediateRecipient;
+          },
+        );
+      });
+    },
   });
 
   const publicFacet = zone.exo('Fast USDC Public', undefined, {
@@ -214,26 +227,22 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
       privateArgs.assetInfo,
     );
   }
+
   const nobleAccountV = zone.makeOnce('NobleAccount', () => makeNobleAccount());
+
   const feedKit = zone.makeOnce('Feed Kit', () => makeFeedKit());
 
   const poolAccountV = zone.makeOnce('PoolAccount', () => makeLocalAccount());
   const settleAccountV = zone.makeOnce('SettleAccount', () =>
     makeLocalAccount(),
   );
   // when() is OK here since this clearly resolves promptly.
-  /** @type {[HostInterface<OrchestrationAccount<{chainId: 'noble-1';}>>, HostInterface<OrchestrationAccount<{chainId: 'agoric-3';}>>, HostInterface<OrchestrationAccount<{chainId: 'agoric-3';}>>]} */
-  const [nobleAccount, poolAccount, settlementAccount] = await vowTools.when(
-    vowTools.all([nobleAccountV, poolAccountV, settleAccountV]),
+  /** @type {[HostInterface<OrchestrationAccount<{chainId: 'agoric-3';}>>, HostInterface<OrchestrationAccount<{chainId: 'agoric-3';}>>]} */
+  const [poolAccount, settlementAccount] = await vowTools.when(
+    vowTools.all([poolAccountV, settleAccountV]),
   );
   trace('settlementAccount', settlementAccount);
   trace('poolAccount', poolAccount);
-  trace('nobleAccount', nobleAccount);
-
-  const intermediateRecipient = await vowTools.when(
-    E(nobleAccount).getAddress(),
-  );
-  trace('intermediateRecipient', intermediateRecipient);
 
   const [_agoric, _noble, agToNoble] = await vowTools.when(
     chainHub.getChainsAndConnection('agoric', 'noble'),
@@ -243,15 +252,13 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     sourceChannel: agToNoble.transferChannel.counterPartyChannelId,
     remoteDenom: 'uusdc',
     settlementAccount,
-    intermediateRecipient,
   });
 
   const advancer = zone.makeOnce('Advancer', () =>
     makeAdvancer({
       borrowerFacet: poolKit.borrower,
       notifyFacet: settlerKit.notify,
       poolAccount,
-      intermediateRecipient,
     }),
   );
   // Connect evidence stream to advancer

diff --git a/packages/fast-usdc/src/fast-usdc.start.js b/packages/fast-usdc/src/fast-usdc.start.js
@@ -147,12 +147,11 @@ export const startFastUSDC = async (
     USDC: await E(USDCissuer).getBrand(),
   });
 
-  const { terms, oracles, feeConfig, feedPolicy, chainInfo, assetInfo } =
-    fromExternalConfig(
-      config?.options, // just in case config is missing somehow
-      brands,
-      FastUSDCConfigShape,
-    );
+  const { terms, oracles, feeConfig, feedPolicy, ...net } = fromExternalConfig(
+    config.options,
+    brands,
+    FastUSDCConfigShape,
+  );
   trace('using terms', terms);
   trace('using fee config', feeConfig);
 
@@ -186,8 +185,8 @@ export const startFastUSDC = async (
       storageNode,
       timerService,
       marshaller,
-      chainInfo,
-      assetInfo,
+      chainInfo: net.chainInfo,
+      assetInfo: net.assetInfo,
     }),
   );
 
@@ -224,6 +223,11 @@ export const startFastUSDC = async (
 
   produceInstance.reset();
   produceInstance.resolve(instance);
+
+  if (!net.noNoble) {
+    const addr = await E(kit.creatorFacet).connectToNoble();
+    trace('noble intermediate recipient', addr);
+  }
   trace('startFastUSDC done', instance);
 };
 harden(startFastUSDC);

diff --git a/packages/fast-usdc/src/types.ts b/packages/fast-usdc/src/types.ts
@@ -6,7 +6,7 @@ import type {
 } from '@agoric/orchestration';
 import type { IBCChannelID } from '@agoric/vats';
 import type { Amount } from '@agoric/ertp';
-import type { Passable } from '@endo/pass-style';
+import type { CopyRecord, Passable } from '@endo/pass-style';
 import type { PendingTxStatus } from './constants.js';
 import type { FastUsdcTerms } from './fast-usdc.contract.js';
 
@@ -78,14 +78,15 @@ export interface FeedPolicy {
   eventFilter?: string;
 }
 
-export type FastUSDCConfig = Passable & {
+export type FastUSDCConfig = {
   terms: FastUsdcTerms;
   oracles: Record<string, string>;
   feeConfig: FeeConfig;
   feedPolicy: FeedPolicy & Passable;
+  noNoble: boolean; // support a3p-integration, which has no noble chain
   chainInfo: Record<string, CosmosChainInfo & Passable>;
   assetInfo: [Denom, DenomDetail & { brandKey?: string }][];
-};
+} & CopyRecord;
 
 export type * from './constants.js';
 export type { LiquidityPoolKit } from './exos/liquidity-pool.js';
diff --git a/packages/fast-usdc/src/utils/deploy-config.js b/packages/fast-usdc/src/utils/deploy-config.js
@@ -35,6 +35,11 @@ export const defaultAssetInfo = [
     },
   ],
 ];
+harden(defaultAssetInfo);
+
+const agoricAssetInfo = defaultAssetInfo.filter(
+  ([_d, i]) => i.chainName === 'agoric',
+);
 
 /**
  * @type {Record<string, Pick<FastUSDCConfig, 'oracles' | 'feedPolicy' | 'chainInfo' | 'assetInfo' >>}
@@ -43,14 +48,19 @@ export const defaultAssetInfo = [
  * meanwhile, use price oracle addresses (from updatePriceFeeds.js).
  */
 export const configurations = {
+  /**
+   * NOTE: The a3p-integration runtime does _not_ include
+   * a noble chain; this limits functionality to advancing
+   * to the Agoric chain.
+   */
   A3P_INTEGRATION: {
     oracles: {
       gov1: 'agoric1ee9hr0jyrxhy999y755mp862ljgycmwyp4pl7q',
       gov2: 'agoric1wrfh296eu2z34p6pah7q04jjuyj3mxu9v98277',
       gov3: 'agoric1ydzxwh6f893jvpaslmaz6l8j2ulup9a7x8qvvq',
     },
     feedPolicy: {
-      nobleAgoricChannelId: 'TODO',
+      nobleAgoricChannelId: 'channel-does-not-exist',
       nobleDomainId: 4,
       chainPolicies: {
         Arbitrum: {
@@ -63,9 +73,13 @@ export const configurations = {
       },
     },
     chainInfo: /** @type {Record<string, CosmosChainInfo & Passable>} */ (
-      withChainCapabilities(fetchedChainInfo)
+      withChainCapabilities({
+        agoric: fetchedChainInfo.agoric,
+        // registering USDC-on-agoric requires registering the noble chain
+        noble: fetchedChainInfo.noble,
+      })
     ),
-    assetInfo: defaultAssetInfo,
+    assetInfo: agoricAssetInfo,
   },
   MAINNET: {
     oracles: {
@@ -139,3 +153,4 @@ export const configurations = {
     assetInfo: defaultAssetInfo, // TODO: use emerynet values
   },
 };
+harden(configurations);
diff --git a/packages/fast-usdc/test/fast-usdc.contract.test.ts b/packages/fast-usdc/test/fast-usdc.contract.test.ts
@@ -85,6 +85,7 @@ const startContract = async (
       E(startKit.creatorFacet).makeOperatorInvitation(`operator-${opIx}`),
     ),
   );
+  await E(startKit.creatorFacet).connectToNoble();
 
   return {
     ...startKit,