feat(orch)!: opt-in publishing of account info

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

@@ -181,11 +181,7 @@ test.serial('writes account addresses to vstorage', async t => {
     showValue: JSON.parse,
     pattern: /published\.fastUsdc\.(feeConfig|feedPolicy|poolMetrics)/,
     replacement: '',
-    note: `Under "published", the "fastUsdc" node is delegated to FastUSDC contract.
-    Note: published.fastUsdc.[settleAcctAddr], published.fastUsdc.[poolAcctAddr],
-    and published.fastUsdc.[intermediateAcctAddr] are published by @agoric/orchestration
-    via 'withOrchestration' and (local|cosmos)-orch-account-kit.js.
-    `,
+    note: 'Under "published", the "fastUsdc" node is delegated to FastUSDC contract.',
   };
 
   await documentStorageSchema(t, storage, doc);

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

@@ -131,10 +131,6 @@ Generated by [AVA](https://avajs.dev).
 ## writes account addresses to vstorage
 
 > Under "published", the "fastUsdc" node is delegated to FastUSDC contract.
->     Note: published.fastUsdc.[settleAcctAddr], published.fastUsdc.[poolAcctAddr],
->     and published.fastUsdc.[intermediateAcctAddr] are published by @agoric/orchestration
->     via 'withOrchestration' and (local|cosmos)-orch-account-kit.js.
->     
 > The example below illustrates the schema of the data published there.
 > 
 > See also board marshalling conventions (_to appear_).
@@ -147,27 +143,6 @@ Generated by [AVA](https://avajs.dev).
           settlementAccount: 'agoric1qyqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqc09z0g',
         },
       ],
-      [
-        'published.fastUsdc.agoric1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqp7zqht',
-        {
-          body: '#""',
-          slots: [],
-        },
-      ],
-      [
-        'published.fastUsdc.agoric1qyqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqc09z0g',
-        {
-          body: '#""',
-          slots: [],
-        },
-      ],
-      [
-        'published.fastUsdc.noble1test',
-        {
-          body: '#{"localAddress":"/ibc-port/icacontroller-1/ordered/{\\"version\\":\\"ics27-1\\",\\"controllerConnectionId\\":\\"connection-72\\",\\"hostConnectionId\\":\\"connection-40\\",\\"address\\":\\"noble1test\\",\\"encoding\\":\\"proto3\\",\\"txType\\":\\"sdk_multi_msg\\"}/ibc-channel/channel-1","remoteAddress":"/ibc-hop/connection-72/ibc-port/icahost/ordered/{\\"version\\":\\"ics27-1\\",\\"controllerConnectionId\\":\\"connection-72\\",\\"hostConnectionId\\":\\"connection-40\\",\\"address\\":\\"noble1test\\",\\"encoding\\":\\"proto3\\",\\"txType\\":\\"sdk_multi_msg\\"}/ibc-channel/channel-1"}',
-          slots: [],
-        },
-      ],
     ]
 
 ## makes usdc advance

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

@@ -90,6 +90,7 @@ const publishAddresses = (contractNode, addresses) => {
  *   feeConfig: FeeConfig;
  *   marshaller: Marshaller;
  *   poolMetricsNode: Remote<StorageNode>;
+ *   storageNode: Remote<StorageNode>;
  * }} privateArgs
  * @param {Zone} zone
  * @param {OrchestrationTools} tools

packages/orchestration/src/examples/auto-stake-it.contract.js

@@ -81,7 +81,7 @@ const contract = async (
   return { publicFacet, creatorFacet };
 };
 
-export const start = withOrchestration(contract);
+export const start = withOrchestration(contract, { publishAccountInfo: true });
 harden(start);
 
 /** @typedef {typeof start} AutoStakeItSF */

packages/orchestration/src/examples/basic-flows.contract.js

@@ -70,7 +70,7 @@ const contract = async (
   return { publicFacet };
 };
 
-export const start = withOrchestration(contract);
+export const start = withOrchestration(contract, { publishAccountInfo: true });
 harden(start);
 
 /** @typedef {typeof start} BasicFlowsSF */

packages/orchestration/src/examples/send-anywhere.contract.js

@@ -9,7 +9,7 @@ import * as flows from './send-anywhere.flows.js';
 import * as sharedFlows from './shared.flows.js';
 
 /**
- * @import {Vow} from '@agoric/vow';
+ * @import {Remote, Vow} from '@agoric/vow';
  * @import {Zone} from '@agoric/zone';
  * @import {OrchestrationPowers, OrchestrationTools} from '../utils/start-helper.js';
  * @import {CosmosChainInfo, Denom, DenomDetail} from '@agoric/orchestration';
@@ -28,9 +28,10 @@ harden(SingleNatAmountRecord);
  *
  * @param {ZCF} zcf
  * @param {OrchestrationPowers & {
- *   marshaller: Marshaller;
- *   chainInfo?: Record<string, CosmosChainInfo>;
  *   assetInfo?: [Denom, DenomDetail & { brandKey?: string }][];
+ *   chainInfo?: Record<string, CosmosChainInfo>;
+ *   marshaller: Marshaller;
+ *   storageNode: Remote<StorageNode>;
  * }} privateArgs
  * @param {Zone} zone
  * @param {OrchestrationTools} tools
@@ -97,5 +98,5 @@ export const contract = async (
 };
 harden(contract);
 
-export const start = withOrchestration(contract);
+export const start = withOrchestration(contract, { publishAccountInfo: true });
 harden(start);

packages/orchestration/src/examples/staking-combinations.contract.js

@@ -159,5 +159,5 @@ const contract = async (
   return harden({ publicFacet, creatorFacet });
 };
 
-export const start = withOrchestration(contract);
+export const start = withOrchestration(contract, { publishAccountInfo: true });
 harden(start);

packages/orchestration/src/examples/swap.contract.js

@@ -89,5 +89,5 @@ const contract = async (
   return harden({ publicFacet });
 };
 
-export const start = withOrchestration(contract);
+export const start = withOrchestration(contract, { publishAccountInfo: true });
 harden(start);

packages/orchestration/src/examples/unbond.contract.js

@@ -54,5 +54,5 @@ const contract = async (
   return harden({ publicFacet });
 };
 
-export const start = withOrchestration(contract);
+export const start = withOrchestration(contract, { publishAccountInfo: true });
 harden(start);

packages/orchestration/src/exos/cosmos-orchestration-account.js

@@ -87,20 +87,20 @@ const trace = makeTracer('CosmosOrchAccount');
 const { Vow$ } = NetworkShape; // TODO #9611
 
 /**
- * @typedef {object} ComosOrchestrationAccountNotification
+ * @typedef {object} CosmosOrchestrationAccountNotification
  * @property {ChainAddress} chainAddress
  */
 
 /**
  * @private
  * @typedef {{
- *   topicKit: RecorderKit<ComosOrchestrationAccountNotification>;
  *   account: IcaAccount;
  *   chainAddress: ChainAddress;
+ *   icqConnection: ICQConnection | undefined;
  *   localAddress: LocalIbcAddress;
  *   remoteAddress: RemoteIbcAddress;
- *   icqConnection: ICQConnection | undefined;
  *   timer: Remote<TimerService>;
+ *   topicKit: RecorderKit<CosmosOrchestrationAccountNotification> | undefined;
  * }} State
  *   Internal to the IcaAccountHolder exo
  */
@@ -291,26 +291,29 @@ export const prepareCosmosOrchestrationAccountKit = (
      * @param {RemoteIbcAddress} info.remoteAddress
      * @param {object} io
      * @param {IcaAccount} io.account
-     * @param {Remote<StorageNode>} io.storageNode
-     * @param {ICQConnection | undefined} io.icqConnection
+     * @param {Remote<StorageNode>} [io.storageNode]
+     * @param {ICQConnection} [io.icqConnection]
      * @param {Remote<TimerService>} io.timer
      * @returns {State}
      */
     ({ chainAddress, localAddress, remoteAddress }, io) => {
       const { storageNode } = io;
       // must be the fully synchronous maker because the kit is held in durable state
-      const topicKit = makeRecorderKit(storageNode, PUBLIC_TOPICS.account[1]);
+      const topicKit = storageNode
+        ? makeRecorderKit(storageNode, PUBLIC_TOPICS.account[1])
+        : undefined;
       // TODO determine what goes in vstorage https://github.com/Agoric/agoric-sdk/issues/9066
       // XXX consider parsing local/remoteAddr to portId, channelId, counterpartyPortId, counterpartyChannelId, connectionId, counterpartyConnectionId
       // FIXME these values will not update if IcaAccount gets new values after reopening.
       // consider having IcaAccount responsible for the owning the writer. It might choose to share it with COA.
-      void E(topicKit.recorder).write(
-        /** @type {CosmosOrchestrationAccountStorageState} */ ({
-          localAddress,
-          remoteAddress,
-        }),
-      );
-
+      if (topicKit) {
+        void E(topicKit.recorder).write(
+          /** @type {CosmosOrchestrationAccountStorageState} */ ({
+            localAddress,
+            remoteAddress,
+          }),
+        );
+      }
       const { account, icqConnection, timer } = io;
       return {
         account,
@@ -333,6 +336,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           return account;
         },
         getUpdater() {
+          if (!this.state.topicKit) throw Fail`no topicKit`;
           return this.state.topicKit.recorder;
         },
         /**
@@ -731,6 +735,7 @@ export const prepareCosmosOrchestrationAccountKit = (
           return asVow(async () => {
             await null;
             const { topicKit } = this.state;
+            if (!topicKit) throw Fail`No topicKit; storageNode not provided`;
             return harden({
               account: {
                 description: PUBLIC_TOPICS.account[0],

packages/orchestration/src/exos/local-chain-facade.js

@@ -36,7 +36,7 @@ import { chainFacadeMethods, TypedJsonShape } from '../typeGuards.js';
  * @typedef {{
  *   makeLocalOrchestrationAccountKit: MakeLocalOrchestrationAccountKit;
  *   orchestration: Remote<CosmosInterchainService>;
- *   storageNode: Remote<StorageNode>;
+ *   storageNode: Remote<StorageNode> | undefined;
  *   agoricNames: Remote<NameHub>;
  *   timer: Remote<TimerService>;
  *   localchain: Remote<LocalChain>;
@@ -79,7 +79,7 @@ const prepareLocalChainFacadeKit = (
           .returns(VowShape),
       }),
       makeChildNodeWatcher: M.interface('makeChildNodeWatcher', {
-        onFulfilled: M.call(M.remotable())
+        onFulfilled: M.call(M.or(M.remotable(), M.undefined()))
           .optional({ account: M.remotable(), address: M.string() }) // empty context
           .returns(M.remotable()),
       }),
@@ -145,11 +145,13 @@ const prepareLocalChainFacadeKit = (
          * @param {[LocalChainAccount, ChainAddress['value']]} results
          */
         onFulfilled([account, address]) {
-          return watch(
-            E(storageNode).makeChildNode(address),
-            this.facets.makeChildNodeWatcher,
-            { account, address },
-          );
+          const optionalStorageNode = storageNode
+            ? E(storageNode).makeChildNode(address)
+            : undefined;
+          return watch(optionalStorageNode, this.facets.makeChildNodeWatcher, {
+            account,
+            address,
+          });
         },
       },
       makeChildNodeWatcher: {

packages/orchestration/src/exos/local-orchestration-account.js

@@ -57,7 +57,7 @@ const EVow$ = shape => M.or(Vow$(shape), M.promise(/* shape */));
 /**
  * @private
  * @typedef {{
- *   topicKit: RecorderKit<LocalChainAccountNotification>;
+ *   topicKit: RecorderKit<LocalChainAccountNotification> | undefined;
  *   packetTools: PacketTools;
  *   account: LocalChainAccount;
  *   address: ChainAddress;
@@ -181,17 +181,22 @@ export const prepareLocalOrchestrationAccountKit = (
      * @param {object} initState
      * @param {LocalChainAccount} initState.account
      * @param {ChainAddress} initState.address
-     * @param {Remote<StorageNode>} initState.storageNode
+     * @param {Remote<StorageNode>} [initState.storageNode]
      * @returns {State}
      */
     ({ account, address, storageNode }) => {
       // must be the fully synchronous maker because the kit is held in durable state
-      const topicKit = makeRecorderKit(storageNode, PUBLIC_TOPICS.account[1]);
+      const topicKit = storageNode
+        ? makeRecorderKit(storageNode, PUBLIC_TOPICS.account[1])
+        : undefined;
       // TODO determine what goes in vstorage https://github.com/Agoric/agoric-sdk/issues/9066
-      void E(topicKit.recorder).write('');
+      if (topicKit) {
+        void E(topicKit.recorder).write('');
+      }
+
       const packetTools = makePacketTools(account);
 
-      return { account, address, topicKit, packetTools };
+      return { account, address, packetTools, topicKit };
     },
     {
       helper: {
@@ -548,6 +553,7 @@ export const prepareLocalOrchestrationAccountKit = (
           return asVow(async () => {
             await null;
             const { topicKit } = this.state;
+            if (!topicKit) throw Fail`No topicKit; storageNode not provided`;
             return harden({
               account: {
                 description: PUBLIC_TOPICS.account[0],

packages/orchestration/src/exos/remote-chain-facade.js

@@ -33,7 +33,7 @@ const trace = makeTracer('RemoteChainFacade');
  *     typeof prepareCosmosOrchestrationAccount
  *   >;
  *   orchestration: Remote<CosmosInterchainService>;
- *   storageNode: Remote<StorageNode>;
+ *   storageNode: Remote<StorageNode> | undefined;
  *   timer: Remote<TimerService>;
  *   vowTools: VowTools;
  * }} RemoteChainFacadePowers
@@ -94,7 +94,7 @@ const prepareRemoteChainFacadeKit = (
         ).returns(VowShape),
       }),
       makeChildNodeWatcher: M.interface('makeChildNodeWatcher', {
-        onFulfilled: M.call(M.remotable(), {
+        onFulfilled: M.call(M.or(M.remotable(), M.undefined()), {
           account: M.remotable(),
           chainAddress: ChainAddressShape,
           localAddress: M.string(),
@@ -210,16 +210,20 @@ const prepareRemoteChainFacadeKit = (
          * @param {IcaAccount} account
          */
         onFulfilled([chainAddress, localAddress, remoteAddress], account) {
-          return watch(
-            E(storageNode).makeChildNode(chainAddress.value),
-            this.facets.makeChildNodeWatcher,
-            { account, chainAddress, localAddress, remoteAddress },
-          );
+          const optionalStorageNode = storageNode
+            ? E(storageNode).makeChildNode(chainAddress.value)
+            : undefined;
+          return watch(optionalStorageNode, this.facets.makeChildNodeWatcher, {
+            account,
+            chainAddress,
+            localAddress,
+            remoteAddress,
+          });
         },
       },
       makeChildNodeWatcher: {
         /**
-         * @param {Remote<StorageNode>} childNode
+         * @param {Remote<StorageNode> | undefined} childNode
          * @param {{
          *   account: IcaAccount;
          *   chainAddress: ChainAddress;

packages/orchestration/src/facade.js

@@ -2,15 +2,14 @@
 import { assertAllDefined, deepMapObject } from '@agoric/internal';
 
 /**
- * @import {AsyncFlowTools, GuestInterface, HostArgs, HostOf} from '@agoric/async-flow';
+ * @import {AsyncFlowTools, GuestInterface, HostArgs} from '@agoric/async-flow';
  * @import {Zone} from '@agoric/zone';
  * @import {Vow, VowTools} from '@agoric/vow';
  * @import {TimerService} from '@agoric/time';
- * @import {RecorderKit, MakeRecorderKit} from '@agoric/zoe/src/contractSupport/recorder.js'.
  * @import {HostOrchestrator} from './exos/orchestrator.js';
  * @import {Remote} from '@agoric/internal';
  * @import {CosmosInterchainService} from './exos/exo-interfaces.js';
- * @import {Chain, ChainInfo, CosmosChainInfo, IBCConnectionInfo, OrchestrationAccount, OrchestrationFlow, Orchestrator} from './types.js';
+ * @import {OrchestrationFlow, Orchestrator} from './types.js';
  */
 
 /**
@@ -31,9 +30,7 @@ import { assertAllDefined, deepMapObject } from '@agoric/internal';
  *   zone: Zone;
  *   timerService: Remote<TimerService>;
  *   zcf: ZCF;
- *   storageNode: Remote<StorageNode>;
  *   orchestrationService: Remote<CosmosInterchainService>;
- *   makeRecorderKit: MakeRecorderKit;
  *   makeOrchestrator: () => HostOrchestrator;
  *   vowTools: VowTools;
  *   asyncFlowTools: AsyncFlowTools;
@@ -43,9 +40,7 @@ export const makeOrchestrationFacade = ({
   zone,
   timerService,
   zcf,
-  storageNode,
   orchestrationService,
-  makeRecorderKit,
   makeOrchestrator,
   vowTools,
   asyncFlowTools,
@@ -54,9 +49,7 @@ export const makeOrchestrationFacade = ({
     zone,
     timerService,
     zcf,
-    storageNode,
     orchestrationService,
-    makeRecorderKit,
     makeOrchestrator,
     vowTools,
     asyncFlowTools,

packages/orchestration/src/fixtures/query-flows.contract.js

@@ -64,7 +64,7 @@ const contract = async (zcf, _privateArgs, zone, { orchestrateAll }) => {
   return { publicFacet };
 };
 
-export const start = withOrchestration(contract);
+export const start = withOrchestration(contract, { publishAccountInfo: true });
 harden(start);
 
 /** @typedef {typeof start} QueryFlowsSF */