fix(orchestration): chainHub accepts zone (#10129)

refs: #9541 ## Description Extracted the chain hub changes from #9785 Changed `makeChainHub` to accept a zone instead of it implicitly creating a heap zone. A durable zone is required for `retriable`. ### Security Considerations None ### Scaling Considerations This store the map in durable storage instead of keeping it in the heap, which uses more persistent storage. ### Documentation Considerations Not sure if any docs need to be updated besides the JS doc for `makeChainHub` ### Testing Considerations Updated tests and examples ### Upgrade Considerations This moves into durable storage some info that was heap only before, effectively commiting ourselves to the shape of the data in these maps.
Agoric · Sep 24, 2024 · cfec54b · cfec54b
1 parent f991204
commit cfec54b
Show file tree

Hide file tree

Showing 15 changed files with 228 additions and 24 deletions.
diff --git a/packages/orchestration/src/examples/stake-bld.contract.js b/packages/orchestration/src/examples/stake-bld.contract.js
@@ -43,7 +43,11 @@ export const start = async (zcf, privateArgs, baggage) => {
   );
   const vowTools = prepareVowTools(zone.subZone('vows'));
 
-  const chainHub = makeChainHub(privateArgs.agoricNames, vowTools);
+  const chainHub = makeChainHub(
+    zone.subZone('chainHub'),
+    privateArgs.agoricNames,
+    vowTools,
+  );
   const zoeTools = makeZoeTools(zcf, vowTools);
 
   const { localchain, timerService } = privateArgs;

diff --git a/packages/orchestration/src/examples/stake-ica.contract.js b/packages/orchestration/src/examples/stake-ica.contract.js
@@ -84,7 +84,11 @@ export const start = async (zcf, privateArgs, baggage) => {
 
   const vowTools = prepareVowTools(zone.subZone('vows'));
 
-  const chainHub = makeChainHub(agoricNames, vowTools);
+  const chainHub = makeChainHub(
+    zone.subZone('chainHub'),
+    agoricNames,
+    vowTools,
+  );
 
   const makeCosmosOrchestrationAccount = prepareCosmosOrchestrationAccount(
     zone,

diff --git a/packages/orchestration/src/exos/chain-hub.js b/packages/orchestration/src/exos/chain-hub.js
@@ -4,12 +4,12 @@ import { M } from '@endo/patterns';
 import { BrandShape } from '@agoric/ertp/src/typeGuards.js';
 
 import { VowShape } from '@agoric/vow';
-import { makeHeapZone } from '@agoric/zone';
 import { CosmosChainInfoShape, IBCConnectionInfoShape } from '../typeGuards.js';
 
 /**
  * @import {NameHub} from '@agoric/vats';
  * @import {Vow, VowTools} from '@agoric/vow';
+ * @import {Zone} from '@agoric/zone';
  * @import {CosmosAssetInfo, CosmosChainInfo, IBCConnectionInfo} from '../cosmos-api.js';
  * @import {ChainInfo, KnownChains} from '../chain-info.js';
  * @import {Denom} from '../orchestration-api.js';
@@ -171,18 +171,18 @@ const ChainHubI = M.interface('ChainHub', {
 });
 
 /**
- * Make a new ChainHub in the zone (or in the heap if no zone is provided).
+ * Make a new ChainHub in the zone.
  *
  * The resulting object is an Exo singleton. It has no precious state. It's only
  * state is a cache of queries to agoricNames and whatever info was provided in
  * registration calls. When you need a newer version you can simply make a hub
  * hub and repeat the registrations.
  *
+ * @param {Zone} zone
  * @param {Remote<NameHub>} agoricNames
  * @param {VowTools} vowTools
  */
-export const makeChainHub = (agoricNames, vowTools) => {
-  const zone = makeHeapZone();
+export const makeChainHub = (zone, agoricNames, vowTools) => {
   /** @type {MapStore<string, CosmosChainInfo>} */
   const chainInfos = zone.mapStore('chainInfos', {
     keyShape: M.string(),

diff --git a/packages/orchestration/src/proposals/start-stakeAtom.js b/packages/orchestration/src/proposals/start-stakeAtom.js
@@ -46,8 +46,13 @@ export const startStakeAtom = async ({
   const storageNode = await makeStorageNodeChild(chainStorage, VSTORAGE_PATH);
   const marshaller = await E(board).getPublishingMarshaller();
 
-  const vt = prepareVowTools(makeHeapZone());
-  const chainHub = makeChainHub(await agoricNames, vt);
+  const zone = makeHeapZone();
+  const vt = prepareVowTools(zone.subZone('vows'));
+  const chainHub = makeChainHub(
+    zone.subZone('chainHub'),
+    await agoricNames,
+    vt,
+  );
 
   const [_, cosmoshub, connectionInfo] = await vt.when(
     chainHub.getChainsAndConnection('agoric', 'cosmoshub'),

diff --git a/packages/orchestration/src/proposals/start-stakeOsmo.js b/packages/orchestration/src/proposals/start-stakeOsmo.js
@@ -51,8 +51,13 @@ export const startStakeOsmo = async ({
   const storageNode = await makeStorageNodeChild(chainStorage, VSTORAGE_PATH);
   const marshaller = await E(board).getPublishingMarshaller();
 
-  const vt = prepareVowTools(makeHeapZone());
-  const chainHub = makeChainHub(await agoricNames, vt);
+  const zone = makeHeapZone();
+  const vt = prepareVowTools(zone.subZone('vows'));
+  const chainHub = makeChainHub(
+    zone.subZone('chainHub'),
+    await agoricNames,
+    vt,
+  );
 
   const [_, osmosis, connectionInfo] = await vt.when(
     chainHub.getChainsAndConnection('agoric', 'osmosis'),

diff --git a/packages/orchestration/src/utils/start-helper.js b/packages/orchestration/src/utils/start-helper.js
@@ -62,6 +62,8 @@ export const provideOrchestration = (
       asyncFlow: zone.subZone('asyncFlow'),
       /** system names for orchestration implementation */
       orchestration: zone.subZone('orchestration'),
+      /** system names for chainHub */
+      chainHub: zone.subZone('chainHub'),
       /** system names for vows */
       vows: zone.subZone('vows'),
       /** contract-provided names, and subzones */
@@ -73,7 +75,7 @@ export const provideOrchestration = (
 
   const vowTools = prepareVowTools(zones.vows);
 
-  const chainHub = makeChainHub(agoricNames, vowTools);
+  const chainHub = makeChainHub(zones.chainHub, agoricNames, vowTools);
 
   const zoeTools = makeZoeTools(zcf, vowTools);
 

diff --git a/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md b/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md
@@ -24,6 +24,14 @@ Generated by [AVA](https://avajs.dev).
         flowForOutcomeVow: {},
         unwrapMap: 'Alleged: weakMapStore',
       },
+      chainHub: {
+        ChainHub_kindHandle: 'Alleged: kind',
+        ChainHub_singleton: 'Alleged: ChainHub',
+        brandDenom: {},
+        chainInfos: {},
+        connectionInfos: {},
+        denom: {},
+      },
       contract: {
         'ChainHub Admin_kindHandle': 'Alleged: kind',
         'ChainHub Admin_singleton': 'Alleged: ChainHub Admin',

diff --git a/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.snap b/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.snap
diff --git a/packages/orchestration/test/examples/snapshots/staking-combinations.test.ts.md b/packages/orchestration/test/examples/snapshots/staking-combinations.test.ts.md
@@ -24,6 +24,79 @@ Generated by [AVA](https://avajs.dev).
         flowForOutcomeVow: {},
         unwrapMap: 'Alleged: weakMapStore',
       },
+      chainHub: {
+        ChainHub_kindHandle: 'Alleged: kind',
+        ChainHub_singleton: 'Alleged: ChainHub',
+        brandDenom: {
+          'Alleged: BLD brand': 'ubld',
+        },
+        chainInfos: {
+          agoric: {
+            chainId: 'agoric-3',
+            icqEnabled: false,
+            stakingTokens: [
+              {
+                denom: 'ubld',
+              },
+            ],
+          },
+          cosmoshub: {
+            chainId: 'cosmoshub-4',
+            icqEnabled: false,
+            stakingTokens: [
+              {
+                denom: 'uatom',
+              },
+            ],
+          },
+        },
+        connectionInfos: {
+          'agoric-3_cosmoshub-4': {
+            client_id: '07-tendermint-6',
+            counterparty: {
+              client_id: '07-tendermint-927',
+              connection_id: 'connection-649',
+            },
+            id: 'connection-8',
+            state: 3,
+            transferChannel: {
+              channelId: 'channel-5',
+              counterPartyChannelId: 'channel-405',
+              counterPartyPortId: 'transfer',
+              ordering: 0,
+              portId: 'transfer',
+              state: 3,
+              version: 'ics20-1',
+            },
+          },
+          'cosmoshub-4_osmosis-1': {
+            client_id: '07-tendermint-259',
+            counterparty: {
+              client_id: '07-tendermint-1',
+              connection_id: 'connection-1',
+            },
+            id: 'connection-257',
+            state: 3,
+            transferChannel: {
+              channelId: 'channel-141',
+              counterPartyChannelId: 'channel-0',
+              counterPartyPortId: 'transfer',
+              ordering: 0,
+              portId: 'transfer',
+              state: 3,
+              version: 'ics20-1',
+            },
+          },
+        },
+        denom: {
+          ubld: {
+            baseDenom: 'ubld',
+            baseName: 'agoric',
+            brand: Object @Alleged: BLD brand {},
+            chainName: 'agoric',
+          },
+        },
+      },
       contract: {
         'ChainHub Admin_kindHandle': 'Alleged: kind',
         'ChainHub Admin_singleton': 'Alleged: ChainHub Admin',

diff --git a/packages/orchestration/test/examples/snapshots/staking-combinations.test.ts.snap b/packages/orchestration/test/examples/snapshots/staking-combinations.test.ts.snap
diff --git a/packages/orchestration/test/examples/snapshots/unbond.contract.test.ts.md b/packages/orchestration/test/examples/snapshots/unbond.contract.test.ts.md
@@ -24,6 +24,97 @@ Generated by [AVA](https://avajs.dev).
         flowForOutcomeVow: {},
         unwrapMap: 'Alleged: weakMapStore',
       },
+      chainHub: {
+        ChainHub_kindHandle: 'Alleged: kind',
+        ChainHub_singleton: 'Alleged: ChainHub',
+        brandDenom: {},
+        chainInfos: {
+          agoric: {
+            chainId: 'agoric-3',
+            icqEnabled: false,
+            stakingTokens: [
+              {
+                denom: 'ubld',
+              },
+            ],
+          },
+          osmosis: {
+            chainId: 'osmosis-1',
+            icqEnabled: true,
+            stakingTokens: [
+              {
+                denom: 'uosmo',
+              },
+            ],
+          },
+          stride: {
+            chainId: 'stride-1',
+            icqEnabled: false,
+            stakingTokens: [
+              {
+                denom: 'ustrd',
+              },
+            ],
+          },
+        },
+        connectionInfos: {
+          'agoric-3_osmosis-1': {
+            client_id: '07-tendermint-1',
+            counterparty: {
+              client_id: '07-tendermint-2109',
+              connection_id: 'connection-1649',
+            },
+            id: 'connection-1',
+            state: 3,
+            transferChannel: {
+              channelId: 'channel-1',
+              counterPartyChannelId: 'channel-320',
+              counterPartyPortId: 'transfer',
+              ordering: 0,
+              portId: 'transfer',
+              state: 3,
+              version: 'ics20-1',
+            },
+          },
+          'agoric-3_stride-1': {
+            client_id: '07-tendermint-74',
+            counterparty: {
+              client_id: '07-tendermint-129',
+              connection_id: 'connection-118',
+            },
+            id: 'connection-68',
+            state: 3,
+            transferChannel: {
+              channelId: 'channel-59',
+              counterPartyChannelId: 'channel-148',
+              counterPartyPortId: 'transfer',
+              ordering: 0,
+              portId: 'transfer',
+              state: 3,
+              version: 'ics20-1',
+            },
+          },
+          'osmosis-1_stride-1': {
+            client_id: '07-tendermint-2119',
+            counterparty: {
+              client_id: '07-tendermint-1',
+              connection_id: 'connection-2',
+            },
+            id: 'connection-1657',
+            state: 3,
+            transferChannel: {
+              channelId: 'channel-326',
+              counterPartyChannelId: 'channel-5',
+              counterPartyPortId: 'transfer',
+              ordering: 0,
+              portId: 'transfer',
+              state: 3,
+              version: 'ics20-1',
+            },
+          },
+        },
+        denom: {},
+      },
       contract: {
         orchestration: {
           unbondAndTransfer: {

diff --git a/packages/orchestration/test/examples/snapshots/unbond.contract.test.ts.snap b/packages/orchestration/test/examples/snapshots/unbond.contract.test.ts.snap
diff --git a/packages/orchestration/test/exos/chain-hub.test.ts b/packages/orchestration/test/exos/chain-hub.test.ts
@@ -42,9 +42,9 @@ const connection = {
 // fresh state for each test
 const setup = () => {
   const zone = provideDurableZone('root');
-  const vt = prepareSwingsetVowTools(zone);
+  const vt = prepareSwingsetVowTools(zone.subZone('vows'));
   const { nameHub, nameAdmin } = makeNameHubKit();
-  const chainHub = makeChainHub(nameHub, vt);
+  const chainHub = makeChainHub(zone.subZone('chainHub'), nameHub, vt);
 
   return { chainHub, nameAdmin, vt };
 };