chore: sharedLocalAccount pattern

Agoric · Sep 27, 2024 · f5198ed · f5198ed
1 parent 2783cba
commit f5198ed
Show file tree

Hide file tree

Showing 13 changed files with 100 additions and 85 deletions.
diff --git a/packages/orchestration/src/examples/send-anywhere.contract.js b/packages/orchestration/src/examples/send-anywhere.contract.js
@@ -2,6 +2,7 @@ import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
 import { M } from '@endo/patterns';
 import { withOrchestration } from '../utils/start-helper.js';
 import * as flows from './send-anywhere.flows.js';
+import * as sharedFlows from './shared.flows.js';
 import { prepareChainHubAdmin } from '../exos/chain-hub-admin.js';
 import { AnyNatAmountShape } from '../typeGuards.js';
 
@@ -32,13 +33,18 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { atomicProvider, chainHub, orchestrateAll, zoeTools },
+  { atomicProvider, chainHub, orchestrate, orchestrateAll, vowTools, zoeTools },
 ) => {
   const creatorFacet = prepareChainHubAdmin(zone, chainHub);
 
+  const sharedLocalAccount = await atomicProvider.provideAsync(
+    'localAccount',
+    key => vowTools.when(orchestrate(key, {}, sharedFlows.makeLocalAccount)()),
+  );
+
   // orchestrate uses the names on orchestrationFns to do a "prepare" of the associated behavior
   const orchFns = orchestrateAll(flows, {
-    atomicProvider,
+    sharedLocalAccount,
     zoeTools,
   });
 

diff --git a/packages/orchestration/src/examples/send-anywhere.flows.js b/packages/orchestration/src/examples/send-anywhere.flows.js
@@ -4,9 +4,9 @@ import { M, mustMatch } from '@endo/patterns';
 
 /**
  * @import {GuestInterface} from '@agoric/async-flow';
+ * @import {LocalOrchestrationAccountKit} from '../exos/local-orchestration-account.js';
  * @import {ZoeTools} from '../utils/zoe-tools.js';
- * @import {AtomicProvider} from '@agoric/store/src/stores/store-utils.js';
- * @import {Orchestrator, OrchestrationFlow, OrchestrationAccount} from '../types.js';
+ * @import {Orchestrator, OrchestrationFlow, LocalAccountMethods} from '../types.js';
  */
 
 const { entries } = Object;
@@ -18,14 +18,14 @@ const { entries } = Object;
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {object} ctx
- * @param {AtomicProvider<string, any>} ctx.atomicProvider
+ * @param {GuestInterface<LocalOrchestrationAccountKit['holder']>} ctx.sharedLocalAccount
  * @param {GuestInterface<ZoeTools>} ctx.zoeTools
  * @param {ZCFSeat} seat
  * @param {{ chainName: string; destAddr: string }} offerArgs
  */
 export const sendIt = async (
   orch,
-  { atomicProvider, zoeTools: { localTransfer, withdrawToSeat } },
+  { sharedLocalAccount, zoeTools: { localTransfer, withdrawToSeat } },
   seat,
   offerArgs,
 ) => {
@@ -42,23 +42,14 @@ export const sendIt = async (
   );
   const chain = await orch.getChain(chainName);
 
-  const localAccount = await atomicProvider.provideAsync(
-    'localAccount',
-    async () => {
-      const agoricChain = await orch.getChain('agoric');
-      return agoricChain.makeAccount();
-    },
-  );
-
   const info = await chain.getChainInfo();
   const { chainId } = info;
   assert(typeof chainId === 'string', 'bad chainId');
 
-  await localTransfer(seat, localAccount, give);
+  await localTransfer(seat, sharedLocalAccount, give);
 
   try {
-    await localAccount.transfer(
-      { denom, value: amt.value },
+    await sharedLocalAccount.transfer(
       {
         value: destAddr,
         encoding: 'bech32',
@@ -67,7 +58,7 @@ export const sendIt = async (
       { denom, value: amt.value },
     );
   } catch (e) {
-    await withdrawToSeat(localAccount, seat, give);
+    await withdrawToSeat(sharedLocalAccount, seat, give);
     const errorMsg = `IBC Transfer failed ${q(e)}`;
     seat.exit(errorMsg);
     throw makeError(errorMsg);

diff --git a/packages/orchestration/src/examples/shared.flows.js b/packages/orchestration/src/examples/shared.flows.js
@@ -0,0 +1,17 @@
+/**
+ * @import {Orchestrator, OrchestrationFlow, LocalAccountMethods} from '../types.js';
+ */
+
+// in guest file (the orchestration functions)
+// the second argument is all the endowments provided
+
+/**
+ * @satisfies {OrchestrationFlow}
+ * @param {Orchestrator} orch
+ * @returns {Promise<LocalAccountMethods>}
+ */
+export const makeLocalAccount = async orch => {
+  const agoricChain = await orch.getChain('agoric');
+  return agoricChain.makeAccount();
+};
+harden(makeLocalAccount);
diff --git a/packages/orchestration/src/examples/staking-combinations.contract.js b/packages/orchestration/src/examples/staking-combinations.contract.js
@@ -12,6 +12,7 @@ import { CosmosOrchestrationInvitationMakersI } from '../exos/cosmos-orchestrati
 import { ChainAddressShape, DelegationShape } from '../typeGuards.js';
 import { withOrchestration } from '../utils/start-helper.js';
 import * as flows from './staking-combinations.flows.js';
+import * as sharedFlows from './shared.flows.js';
 import { prepareChainHubAdmin } from '../exos/chain-hub-admin.js';
 
 /**
@@ -43,7 +44,7 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { atomicProvider, orchestrateAll, zoeTools, chainHub },
+  { atomicProvider, orchestrate, orchestrateAll, zoeTools, chainHub, vowTools },
 ) => {
   const StakingCombinationsInvitationMakersI = M.interface(
     'StakingCombinationsInvitationMakersI',
@@ -117,8 +118,13 @@ const contract = async (
     StakingCombinationsInvitationMakersI,
   );
 
+  const sharedLocalAccount = await atomicProvider.provideAsync(
+    'localAccount',
+    key => vowTools.when(orchestrate(key, {}, sharedFlows.makeLocalAccount)()),
+  );
+
   const orchFns = orchestrateAll(flows, {
-    atomicProvider,
+    sharedLocalAccount,
     makeCombineInvitationMakers,
     makeExtraInvitationMaker,
     flows,

diff --git a/packages/orchestration/src/examples/staking-combinations.flows.js b/packages/orchestration/src/examples/staking-combinations.flows.js
@@ -2,7 +2,7 @@
  * @import {GuestInterface} from '@agoric/async-flow';
  * @import {Orchestrator, OrchestrationFlow, AmountArg, CosmosValidatorAddress, ChainAddress, LocalAccountMethods, OrchestrationAccountI} from '../types.js'
  * @import {ContinuingOfferResult, InvitationMakers} from '@agoric/smart-wallet/src/types.js';
- * @import {AtomicProvider} from '@agoric/store/src/stores/store-utils.js';
+ * @import {LocalOrchestrationAccountKit} from '../exos/local-orchestration-account.js';
  * @import {MakeCombineInvitationMakers} from '../exos/combine-invitation-makers.js';
  * @import {CosmosOrchestrationAccount} from '../exos/cosmos-orchestration-account.js';
  * @import {ZoeTools} from '../utils/zoe-tools.js';
@@ -49,7 +49,7 @@ harden(makeAccount);
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {object} ctx
- * @param {AtomicProvider<string, any>} ctx.atomicProvider
+ * @param {GuestInterface<LocalOrchestrationAccountKit['holder']>} ctx.sharedLocalAccount
  * @param {GuestInterface<ZoeTools>} ctx.zoeTools
  * @param {GuestInterface<CosmosOrchestrationAccount>} account
  * @param {ZCFSeat} seat
@@ -58,7 +58,7 @@ harden(makeAccount);
  */
 export const depositAndDelegate = async (
   orch,
-  { atomicProvider, zoeTools },
+  { sharedLocalAccount, zoeTools },
   account,
   seat,
   validator,
@@ -67,22 +67,14 @@ export const depositAndDelegate = async (
   trace('depositAndDelegate', account, seat, validator);
   mustMatch(validator, ChainAddressShape);
 
-  const localAccount = await atomicProvider.provideAsync(
-    'localAccount',
-    async () => {
-      const agoricChain = await orch.getChain('agoric');
-      return agoricChain.makeAccount();
-    },
-  );
-
   const { give } = seat.getProposal();
-  await zoeTools.localTransfer(seat, localAccount, give);
+  await zoeTools.localTransfer(seat, sharedLocalAccount, give);
 
   const address = account.getAddress();
   try {
-    await localAccount.transfer(give.Stake, address);
+    await sharedLocalAccount.transfer(address, give.Stake);
   } catch (cause) {
-    await zoeTools.withdrawToSeat(localAccount, seat, give);
+    await zoeTools.withdrawToSeat(sharedLocalAccount, seat, give);
     const errMsg = makeError(`ibc transfer failed ${q(cause)}`);
     seat.exit(errMsg);
     throw errMsg;

diff --git a/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md b/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md
@@ -28,7 +28,17 @@ Generated by [AVA](https://avajs.dev).
         ChainHub_kindHandle: 'Alleged: kind',
         ChainHub_singleton: 'Alleged: ChainHub',
         brandDenom: {},
-        chainInfos: {},
+        chainInfos: {
+          agoric: {
+            chainId: 'agoric-3',
+            icqEnabled: false,
+            stakingTokens: [
+              {
+                denom: 'ubld',
+              },
+            ],
+          },
+        },
         connectionInfos: {},
         denom: {},
       },
@@ -37,16 +47,17 @@ Generated by [AVA](https://avajs.dev).
         'ChainHub Admin_singleton': 'Alleged: ChainHub Admin',
         'Send PF_kindHandle': 'Alleged: kind',
         'Send PF_singleton': 'Alleged: Send PF',
-        atomicProvider: {},
+        atomicProvider: {
+          localAccount: 'Alleged: Local Orchestration Account Kit holder',
+        },
         orchestration: {
+          localAccount: {
+            asyncFlow_kindHandle: 'Alleged: kind',
+          },
           sendIt: {
             asyncFlow_kindHandle: 'Alleged: kind',
             endowments: {
               0: {
-                atomicProvider: {
-                  provideAsync_kindHandle: 'Alleged: kind',
-                  provideAsync_singleton: 'Alleged: provideAsync',
-                },
                 zoeTools: {
                   localTransfer_kindHandle: 'Alleged: kind',
                   localTransfer_singleton: 'Alleged: localTransfer',
@@ -64,7 +75,9 @@ Generated by [AVA](https://avajs.dev).
         LocalChainFacade_kindHandle: 'Alleged: kind',
         Orchestrator_kindHandle: 'Alleged: kind',
         RemoteChainFacade_kindHandle: 'Alleged: kind',
-        chainName: {},
+        chainName: {
+          agoric: 'Alleged: LocalChainFacade public',
+        },
         ibcTools: {
           IBCTransferSenderKit_kindHandle: 'Alleged: kind',
           ibcResultWatcher_kindHandle: 'Alleged: kind',

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
@@ -102,13 +102,14 @@ Generated by [AVA](https://avajs.dev).
         'ChainHub Admin_singleton': 'Alleged: ChainHub Admin',
         CombinedInvitationMakers_kindHandle: 'Alleged: kind',
         StakingCombinationsInvitationMakers_kindHandle: 'Alleged: kind',
+        atomicProvider: {
+          localAccount: 'Alleged: Local Orchestration Account Kit holder',
+        },
         orchestration: {
           depositAndDelegate: {
             asyncFlow_kindHandle: 'Alleged: kind',
             endowments: {
               0: {
-                contractState_kindHandle: 'Alleged: kind',
-                contractState_singleton: 'Alleged: contractState',
                 flows: {
                   depositAndDelegate_kindHandle: 'Alleged: kind',
                   depositAndDelegate_singleton: 'Alleged: depositAndDelegate',
@@ -130,12 +131,13 @@ Generated by [AVA](https://avajs.dev).
               },
             },
           },
+          localAccount: {
+            asyncFlow_kindHandle: 'Alleged: kind',
+          },
           makeAccount: {
             asyncFlow_kindHandle: 'Alleged: kind',
             endowments: {
               0: {
-                contractState_kindHandle: 'Alleged: kind',
-                contractState_singleton: 'Alleged: contractState',
                 flows: {
                   depositAndDelegate_kindHandle: 'Alleged: kind',
                   depositAndDelegate_singleton: 'Alleged: depositAndDelegate',
@@ -161,8 +163,6 @@ Generated by [AVA](https://avajs.dev).
             asyncFlow_kindHandle: 'Alleged: kind',
             endowments: {
               0: {
-                contractState_kindHandle: 'Alleged: kind',
-                contractState_singleton: 'Alleged: contractState',
                 flows: {
                   depositAndDelegate_kindHandle: 'Alleged: kind',
                   depositAndDelegate_singleton: 'Alleged: depositAndDelegate',

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/fixtures/zoe-tools.contract.js b/packages/orchestration/test/fixtures/zoe-tools.contract.js
@@ -9,6 +9,7 @@ import { M } from '@endo/patterns';
 import { withOrchestration } from '../../src/utils/start-helper.js';
 import { prepareChainHubAdmin } from '../../src/exos/chain-hub-admin.js';
 import * as flows from './zoe-tools.flows.js';
+import * as sharedFlows from '../../src/examples/shared.flows.js';
 import fetchedChainInfo from '../../src/fetched-chain-info.js';
 
 const { values } = Object;
@@ -46,12 +47,17 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { atomicProvider, chainHub, orchestrateAll, zoeTools },
+  { atomicProvider, chainHub, orchestrate, orchestrateAll, vowTools, zoeTools },
 ) => {
   const creatorFacet = prepareChainHubAdmin(zone, chainHub);
 
+  const sharedLocalAccount = await atomicProvider.provideAsync(
+    'localAccount',
+    key => vowTools.when(orchestrate(key, {}, sharedFlows.makeLocalAccount)()),
+  );
+
   const orchFns = orchestrateAll(flows, {
-    atomicProvider,
+    sharedLocalAccount,
     zoeTools,
   });
 
@@ -60,7 +66,8 @@ const contract = async (
   const assets = /** @type {AssetInfo[]} */ (
     await E(E(privateArgs.agoricNames).lookup('vbankAsset')).values()
   );
-  for (const chainName of ['agoric', 'cosmoshub']) {
+  // 'agoric' was registered by mocaLocalAccount above
+  for (const chainName of ['cosmoshub']) {
     chainHub.registerChain(chainName, fetchedChainInfo[chainName]);
   }
   for (const brand of values(zcf.getTerms().brands)) {