feat: atomicProvider service

Agoric · Sep 24, 2024 · 061f3cb · 061f3cb
1 parent 2ccf887
commit 061f3cb
Show file tree

Hide file tree

Showing 13 changed files with 80 additions and 84 deletions.
diff --git a/packages/orchestration/src/examples/send-anywhere.contract.js b/packages/orchestration/src/examples/send-anywhere.contract.js
@@ -1,4 +1,3 @@
-import { makeSharedStateRecord } from '@agoric/async-flow';
 import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
 import { M } from '@endo/patterns';
 import { withOrchestration } from '../utils/start-helper.js';
@@ -33,19 +32,13 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { chainHub, orchestrateAll, zoeTools },
+  { atomicProvider, chainHub, orchestrateAll, zoeTools },
 ) => {
-  const contractState = makeSharedStateRecord(
-    /** @type {{ account: OrchestrationAccount<any> | undefined }} */ {
-      localAccount: undefined,
-    },
-  );
-
   const creatorFacet = prepareChainHubAdmin(zone, chainHub);
 
   // orchestrate uses the names on orchestrationFns to do a "prepare" of the associated behavior
   const orchFns = orchestrateAll(flows, {
-    contractState,
+    atomicProvider,
     zoeTools,
   });
 

diff --git a/packages/orchestration/src/examples/send-anywhere.flows.js b/packages/orchestration/src/examples/send-anywhere.flows.js
@@ -5,7 +5,8 @@ import { M, mustMatch } from '@endo/patterns';
 /**
  * @import {GuestInterface} from '@agoric/async-flow';
  * @import {ZoeTools} from '../utils/zoe-tools.js';
- * @import {Orchestrator, LocalAccountMethods, OrchestrationAccountI, OrchestrationFlow} from '../types.js';
+ * @import {AtomicProvider} from '@agoric/store/src/stores/store-utils.js';
+ * @import {Orchestrator, OrchestrationFlow, OrchestrationAccount} from '../types.js';
  */
 
 const { entries } = Object;
@@ -17,14 +18,14 @@ const { entries } = Object;
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {object} ctx
- * @param {{ localAccount?: OrchestrationAccountI & LocalAccountMethods }} ctx.contractState
+ * @param {AtomicProvider<string, any>} ctx.atomicProvider
  * @param {GuestInterface<ZoeTools>} ctx.zoeTools
  * @param {ZCFSeat} seat
  * @param {{ chainName: string; destAddr: string }} offerArgs
  */
 export const sendIt = async (
   orch,
-  { contractState, zoeTools: { localTransfer, withdrawToSeat } },
+  { atomicProvider, zoeTools: { localTransfer, withdrawToSeat } },
   seat,
   offerArgs,
 ) => {
@@ -41,19 +42,22 @@ export const sendIt = async (
   );
   const chain = await orch.getChain(chainName);
 
-  if (!contractState.localAccount) {
-    const agoricChain = await orch.getChain('agoric');
-    contractState.localAccount = await agoricChain.makeAccount();
-  }
+  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, contractState.localAccount, give);
+  await localTransfer(seat, localAccount, give);
 
   try {
-    await contractState.localAccount.transfer(
+    await localAccount.transfer(
       { denom, value: amt.value },
       {
         value: destAddr,
@@ -62,7 +66,7 @@ export const sendIt = async (
       },
     );
   } catch (e) {
-    await withdrawToSeat(contractState.localAccount, seat, give);
+    await withdrawToSeat(localAccount, seat, give);
     const errorMsg = `IBC Transfer failed ${q(e)}`;
     seat.exit(errorMsg);
     throw makeError(errorMsg);

diff --git a/packages/orchestration/src/examples/staking-combinations.contract.js b/packages/orchestration/src/examples/staking-combinations.contract.js
@@ -5,7 +5,6 @@
  *   The primary offer result is a power for invitation makers that can perform
  *   actions with an ICA account.
  */
-import { makeSharedStateRecord } from '@agoric/async-flow';
 import { AmountShape } from '@agoric/ertp';
 import { M } from '@endo/patterns';
 import { prepareCombineInvitationMakers } from '../exos/combine-invitation-makers.js';
@@ -44,18 +43,8 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { orchestrateAll, zoeTools, chainHub },
+  { atomicProvider, orchestrateAll, zoeTools, chainHub },
 ) => {
-  const contractState = makeSharedStateRecord(
-    /**
-     * @type {{
-     *   account: (OrchestrationAccount<any> & LocalAccountMethods) | undefined;
-     * }}
-     */ {
-      localAccount: undefined,
-    },
-  );
-
   const StakingCombinationsInvitationMakersI = M.interface(
     'StakingCombinationsInvitationMakersI',
     {
@@ -129,7 +118,7 @@ const contract = async (
   );
 
   const orchFns = orchestrateAll(flows, {
-    contractState,
+    atomicProvider,
     makeCombineInvitationMakers,
     makeExtraInvitationMaker,
     flows,

diff --git a/packages/orchestration/src/examples/staking-combinations.flows.js b/packages/orchestration/src/examples/staking-combinations.flows.js
@@ -2,6 +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 {MakeCombineInvitationMakers} from '../exos/combine-invitation-makers.js';
  * @import {CosmosOrchestrationAccount} from '../exos/cosmos-orchestration-account.js';
  * @import {ZoeTools} from '../utils/zoe-tools.js';
@@ -48,7 +49,7 @@ harden(makeAccount);
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {object} ctx
- * @param {{ localAccount?: OrchestrationAccountI & LocalAccountMethods }} ctx.contractState
+ * @param {AtomicProvider<string, any>} ctx.atomicProvider
  * @param {GuestInterface<ZoeTools>} ctx.zoeTools
  * @param {GuestInterface<CosmosOrchestrationAccount>} account
  * @param {ZCFSeat} seat
@@ -57,26 +58,31 @@ harden(makeAccount);
  */
 export const depositAndDelegate = async (
   orch,
-  { contractState, zoeTools },
+  { atomicProvider, zoeTools },
   account,
   seat,
   validator,
 ) => {
   await null;
   trace('depositAndDelegate', account, seat, validator);
   mustMatch(validator, ChainAddressShape);
-  if (!contractState.localAccount) {
-    const agoricChain = await orch.getChain('agoric');
-    contractState.localAccount = await agoricChain.makeAccount();
-  }
+
+  const localAccount = await atomicProvider.provideAsync(
+    'localAccount',
+    async () => {
+      const agoricChain = await orch.getChain('agoric');
+      return agoricChain.makeAccount();
+    },
+  );
+
   const { give } = seat.getProposal();
-  await zoeTools.localTransfer(seat, contractState.localAccount, give);
+  await zoeTools.localTransfer(seat, localAccount, give);
 
   const address = account.getAddress();
   try {
-    await contractState.localAccount.transfer(give.Stake, address);
+    await localAccount.transfer(give.Stake, address);
   } catch (cause) {
-    await zoeTools.withdrawToSeat(contractState.localAccount, seat, give);
+    await zoeTools.withdrawToSeat(localAccount, seat, give);
     const errMsg = makeError(`ibc transfer failed ${q(cause)}`);
     seat.exit(errMsg);
     throw errMsg;

diff --git a/packages/orchestration/src/utils/start-helper.js b/packages/orchestration/src/utils/start-helper.js
@@ -2,6 +2,7 @@ import { prepareAsyncFlowTools } from '@agoric/async-flow';
 import { prepareVowTools } from '@agoric/vow';
 import { prepareRecorderKitMakers } from '@agoric/zoe/src/contractSupport/recorder.js';
 import { makeDurableZone } from '@agoric/zone/durable.js';
+import { makeAtomicProvider } from '@agoric/store/src/stores/store-utils.js';
 import { makeChainHub } from '../exos/chain-hub.js';
 import { prepareCosmosOrchestrationAccount } from '../exos/cosmos-orchestration-account.js';
 import { prepareLocalChainFacade } from '../exos/local-chain-facade.js';
@@ -170,9 +171,14 @@ export const provideOrchestration = (
     zones.contract.subZone('orchestration'),
   );
 
+  const atomicProvider = makeAtomicProvider(
+    zones.contract.mapStore('atomicProvider'),
+  );
+
   return {
     ...defaultOrchestrateKit,
     makeOrchestrateKit,
+    atomicProvider,
     chainHub,
     vowTools,
     asyncFlowTools,

diff --git a/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md b/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md
@@ -37,13 +37,16 @@ Generated by [AVA](https://avajs.dev).
         'ChainHub Admin_singleton': 'Alleged: ChainHub Admin',
         'Send PF_kindHandle': 'Alleged: kind',
         'Send PF_singleton': 'Alleged: Send PF',
+        atomicProvider: {},
         orchestration: {
           sendIt: {
             asyncFlow_kindHandle: 'Alleged: kind',
             endowments: {
               0: {
-                contractState_kindHandle: 'Alleged: kind',
-                contractState_singleton: 'Alleged: contractState',
+                atomicProvider: {
+                  provideAsync_kindHandle: 'Alleged: kind',
+                  provideAsync_singleton: 'Alleged: provideAsync',
+                },
                 zoeTools: {
                   localTransfer_kindHandle: 'Alleged: kind',
                   localTransfer_singleton: 'Alleged: localTransfer',

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/unbond.contract.test.ts.md b/packages/orchestration/test/examples/snapshots/unbond.contract.test.ts.md
@@ -116,6 +116,7 @@ Generated by [AVA](https://avajs.dev).
         denom: {},
       },
       contract: {
+        atomicProvider: {},
         orchestration: {
           unbondAndTransfer: {
             asyncFlow_kindHandle: 'Alleged: kind',

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/fixtures/zoe-tools.contract.js b/packages/orchestration/test/fixtures/zoe-tools.contract.js
@@ -3,7 +3,6 @@
  *   around `zoeTools.localTransfer` and `zoeTools.withdrawToSeat`
  */
 
-import { makeSharedStateRecord } from '@agoric/async-flow';
 import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
 import { E } from '@endo/far';
 import { M } from '@endo/patterns';
@@ -47,18 +46,12 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { chainHub, orchestrateAll, zoeTools },
+  { atomicProvider, chainHub, orchestrateAll, zoeTools },
 ) => {
-  const contractState = makeSharedStateRecord(
-    /** @type {{ account: OrchestrationAccount<any> | undefined }} */ {
-      localAccount: undefined,
-    },
-  );
-
   const creatorFacet = prepareChainHubAdmin(zone, chainHub);
 
   const orchFns = orchestrateAll(flows, {
-    contractState,
+    atomicProvider,
     zoeTools,
   });
 

diff --git a/packages/orchestration/test/fixtures/zoe-tools.flows.js b/packages/orchestration/test/fixtures/zoe-tools.flows.js
@@ -11,6 +11,7 @@ const { values } = Object;
 
 /**
  * @import {GuestInterface} from '@agoric/async-flow';
+ * @import {AtomicProvider} from '@agoric/store/src/stores/store-utils.js';
  * @import {Orchestrator, LocalAccountMethods, OrchestrationAccountI, OrchestrationFlow, ChainAddress} from '@agoric/orchestration';
  * @import {ZoeTools} from '../../src/utils/zoe-tools.js';
  */
@@ -23,14 +24,14 @@ const { values } = Object;
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {object} ctx
- * @param {{ localAccount?: OrchestrationAccountI & LocalAccountMethods }} ctx.contractState
+ * @param {AtomicProvider<string, any>} ctx.atomicProvider
  * @param {GuestInterface<ZoeTools>} ctx.zoeTools
  * @param {ZCFSeat} seat
  * @param {{ destAddr: ChainAddress }} offerArgs
  */
 export const depositSend = async (
   orch,
-  { contractState, zoeTools: { localTransfer, withdrawToSeat } },
+  { atomicProvider, zoeTools: { localTransfer, withdrawToSeat } },
   seat,
   offerArgs,
 ) => {
@@ -40,18 +41,20 @@ export const depositSend = async (
 
   const { give } = seat.getProposal();
 
-  await null;
-  if (!contractState.localAccount) {
-    const agoricChain = await orch.getChain('agoric');
-    contractState.localAccount = await agoricChain.makeAccount();
-  }
+  const localAccount = await atomicProvider.provideAsync(
+    'localAccount',
+    async () => {
+      const agoricChain = await orch.getChain('agoric');
+      return agoricChain.makeAccount();
+    },
+  );
 
-  await localTransfer(seat, contractState.localAccount, give);
+  await localTransfer(seat, localAccount, give);
 
   try {
-    await contractState.localAccount.sendAll(destAddr, values(give));
+    await localAccount.sendAll(destAddr, values(give));
   } catch (error) {
-    await withdrawToSeat(contractState.localAccount, seat, give);
+    await withdrawToSeat(localAccount, seat, give);
     const errMsg = makeError(`SendAll failed ${q(error)}`);
     seat.exit(errMsg);
     throw errMsg;
@@ -67,25 +70,27 @@ harden(depositSend);
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {object} ctx
- * @param {{ localAccount?: OrchestrationAccountI & LocalAccountMethods }} ctx.contractState
+ * @param {AtomicProvider<string, any>} ctx.atomicProvider
  * @param {GuestInterface<ZoeTools>} ctx.zoeTools
  * @param {ZCFSeat} seat
  */
 export const deposit = async (
   orch,
-  { contractState, zoeTools: { localTransfer } },
+  { atomicProvider, zoeTools: { localTransfer } },
   seat,
 ) => {
   const { give } = seat.getProposal();
 
-  await null;
-  if (!contractState.localAccount) {
-    const agoricChain = await orch.getChain('agoric');
-    contractState.localAccount = await agoricChain.makeAccount();
-  }
+  const localAccount = await atomicProvider.provideAsync(
+    'localAccount',
+    async () => {
+      const agoricChain = await orch.getChain('agoric');
+      return agoricChain.makeAccount();
+    },
+  );
 
   try {
-    await localTransfer(seat, contractState.localAccount, give);
+    await localTransfer(seat, localAccount, give);
   } catch (e) {
     seat.exit(e);
     throw e;
@@ -100,25 +105,27 @@ harden(deposit);
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {object} ctx
- * @param {{ localAccount?: OrchestrationAccountI & LocalAccountMethods }} ctx.contractState
+ * @param {AtomicProvider<string, any>} ctx.atomicProvider
  * @param {GuestInterface<ZoeTools>} ctx.zoeTools
  * @param {ZCFSeat} seat
  */
 export const withdraw = async (
   orch,
-  { contractState, zoeTools: { withdrawToSeat } },
+  { atomicProvider, zoeTools: { withdrawToSeat } },
   seat,
 ) => {
   const { want } = seat.getProposal();
 
-  await null;
-  if (!contractState.localAccount) {
-    const agoricChain = await orch.getChain('agoric');
-    contractState.localAccount = await agoricChain.makeAccount();
-  }
+  const localAccount = await atomicProvider.provideAsync(
+    'localAccount',
+    async () => {
+      const agoricChain = await orch.getChain('agoric');
+      return agoricChain.makeAccount();
+    },
+  );
 
   try {
-    await withdrawToSeat(contractState.localAccount, seat, want);
+    await withdrawToSeat(localAccount, seat, want);
   } catch (e) {
     seat.exit(e);
     throw e;