feat: make vat-localchain resumable (#9488)

closes: #9484 closes: #9497 ## Description - Changes the type of every return in `localchain.js` to `PromiseVow` - Uses `watch` for `.query()` and `.deposit()` methods and returns a `Vow` - Updates call sites outside `vat-localchain` to expect and unwrap PromiseVows (using `V`) ### Upgrade Considerations These changes better prepare us for upgrades - consumers will know to expect a `PromiseVow`.
Agoric · Jun 14, 2024 · 5856dc0 · 5856dc0
2 parents a19a964 + 3027adf
commit 5856dc0
Show file tree

Hide file tree

Showing 16 changed files with 356 additions and 216 deletions.
diff --git a/packages/boot/test/bootstrapTests/ibcClientMock.js b/packages/boot/test/bootstrapTests/ibcClientMock.js
@@ -4,13 +4,14 @@ import { Far } from '@endo/far';
 import { V as E } from '@agoric/vow/vat.js';
 
 /**
- * @import {ListenHandler, PortAllocator} from '@agoric/network';
+ * @import {Connection, PortAllocator} from '@agoric/network';
+ * @import {FarRef, ERef} from '@agoric/vow';
  */
 
 /**
  * @param {ZCF} zcf
  * @param {{
- *   portAllocator: ERef<PortAllocator>;
+ *   portAllocator: FarRef<PortAllocator>;
  * }} privateArgs
  * @param {import('@agoric/vat-data').Baggage} _baggage
  */
@@ -20,7 +21,13 @@ export const start = async (zcf, privateArgs, _baggage) => {
   const myPort = await E(portAllocator).allocateCustomIBCPort();
 
   const { log } = console;
+  /**
+   * @type {FarRef<Connection>}
+   */
   let connP;
+  /**
+   * @type {ERef<string>}
+   */
   let ackP;
 
   const creatorFacet = Far('CF', {

diff --git a/packages/internal/src/types.d.ts b/packages/internal/src/types.d.ts
@@ -1,5 +1,5 @@
 /* eslint-disable max-classes-per-file */
-import type { RemotableBrand } from '@endo/eventual-send';
+import type { ERef, RemotableBrand } from '@endo/eventual-send';
 import type { Primitive } from '@endo/pass-style';
 import type { Callable } from './utils.js';
 
@@ -56,3 +56,11 @@ export type DataOnly<T> =
 export type Remote<Primary, Local = DataOnly<Primary>> =
   | Primary
   | RemotableBrand<Local, Primary>;
+
+// TODO: Add type tests for FarRef and Remote.
+/**
+ * Potentially remote promises or settled references.
+ */
+export type FarRef<Primary, Local = DataOnly<Primary>> = ERef<
+  Remote<Primary, Local>
+>;
diff --git a/packages/network/src/network.js b/packages/network/src/network.js
@@ -1475,7 +1475,7 @@ export const preparePortAllocator = (zone, { watch }) =>
      */
     ({ protocol }) => ({ protocol, lastICAPortNum: 0n, lastICQPortNum: 0n }),
     {
-      allocateCustomIBCPort(specifiedName = '') {
+      async allocateCustomIBCPort(specifiedName = '') {
         const { state } = this;
         let localAddr = `/ibc-port/`;
 
@@ -1488,7 +1488,7 @@ export const preparePortAllocator = (zone, { watch }) =>
         // Allocate an IBC port with a unique generated name.
         return watch(E(state.protocol).bindPort(localAddr));
       },
-      allocateICAControllerPort() {
+      async allocateICAControllerPort() {
         const { state } = this;
         state.lastICAPortNum += 1n;
         return watch(
@@ -1497,7 +1497,7 @@ export const preparePortAllocator = (zone, { watch }) =>
           ),
         );
       },
-      allocateICQControllerPort() {
+      async allocateICQControllerPort() {
         const { state } = this;
         state.lastICQPortNum += 1n;
         return watch(
@@ -1506,7 +1506,7 @@ export const preparePortAllocator = (zone, { watch }) =>
           ),
         );
       },
-      allocateCustomLocalPort(specifiedName = '') {
+      async allocateCustomLocalPort(specifiedName = '') {
         const { state } = this;
 
         let localAddr = `/local/`;

diff --git a/packages/orchestration/src/examples/stakeBld.contract.js b/packages/orchestration/src/examples/stakeBld.contract.js
@@ -6,6 +6,7 @@ import { prepareRecorderKitMakers } from '@agoric/zoe/src/contractSupport/record
 import { withdrawFromSeat } from '@agoric/zoe/src/contractSupport/zoeHelpers.js';
 import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
 import { makeDurableZone } from '@agoric/zone/durable.js';
+import { V } from '@agoric/vow/vat.js';
 import { E } from '@endo/far';
 import { deeplyFulfilled } from '@endo/marshal';
 import { M } from '@endo/patterns';
@@ -33,11 +34,6 @@ const trace = makeTracer('StakeBld');
  * @param {import('@agoric/vat-data').Baggage} baggage
  */
 export const start = async (zcf, privateArgs, baggage) => {
-  const BLD = zcf.getTerms().brands.In;
-
-  // XXX is this safe to call before prepare statements are completed?
-  const bldAmountShape = await E(BLD).getAmountShape();
-
   const zone = makeDurableZone(baggage);
 
   const { makeRecorderKit } = prepareRecorderKitMakers(
@@ -53,9 +49,15 @@ export const start = async (zcf, privateArgs, baggage) => {
     makeChainHub(privateArgs.agoricNames),
   );
 
+  // ----------------
+  // All `prepare*` calls should go above this line.
+
+  const BLD = zcf.getTerms().brands.In;
+  const bldAmountShape = await E(BLD).getAmountShape();
+
   async function makeLocalAccountKit() {
-    const account = await E(privateArgs.localchain).makeAccount();
-    const address = await E(account).getAddress();
+    const account = await V(privateArgs.localchain).makeAccount();
+    const address = await V(account).getAddress();
     // XXX 'address' is implied by 'account'; use an async maker that get the value itself
     return makeLocalChainAccountKit({
       account,
@@ -84,7 +86,7 @@ export const start = async (zcf, privateArgs, baggage) => {
             const { In } = await deeplyFulfilled(
               withdrawFromSeat(zcf, seat, give),
             );
-            await E(holder).deposit(In);
+            await V(holder).deposit(In);
             seat.exit();
             return harden({
               publicSubscribers: holder.getPublicTopics(),

diff --git a/packages/orchestration/src/exos/local-chain-account-kit.js b/packages/orchestration/src/exos/local-chain-account-kit.js
@@ -6,6 +6,7 @@ import { makeTracer } from '@agoric/internal';
 import { M } from '@agoric/vat-data';
 import { TopicsRecordShape } from '@agoric/zoe/src/contractSupport/index.js';
 import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
+import { V } from '@agoric/vow/vat.js';
 import { E } from '@endo/far';
 import {
   AmountArgShape,
@@ -159,9 +160,9 @@ export const prepareLocalChainAccountKit = (
           };
           const { account: lca } = this.state;
           trace('lca', lca);
-          const delegatorAddress = await E(lca).getAddress();
+          const delegatorAddress = await V(lca).getAddress();
           trace('delegatorAddress', delegatorAddress);
-          const [result] = await E(lca).executeTx([
+          const [result] = await V(lca).executeTx([
             typedJson('/cosmos.staking.v1beta1.MsgDelegate', {
               amount,
               validatorAddress,
@@ -184,9 +185,9 @@ export const prepareLocalChainAccountKit = (
           };
           const { account: lca } = this.state;
           trace('lca', lca);
-          const delegatorAddress = await E(lca).getAddress();
+          const delegatorAddress = await V(lca).getAddress();
           trace('delegatorAddress', delegatorAddress);
-          const [response] = await E(lca).executeTx([
+          const [response] = await V(lca).executeTx([
             typedJson('/cosmos.staking.v1beta1.MsgUndelegate', {
               amount,
               validatorAddress,
@@ -208,16 +209,16 @@ export const prepareLocalChainAccountKit = (
          */
         /** @type {LocalChainAccount['deposit']} */
         async deposit(payment, optAmountShape) {
-          return E(this.state.account).deposit(payment, optAmountShape);
+          return V(this.state.account).deposit(payment, optAmountShape);
         },
         /** @type {LocalChainAccount['withdraw']} */
         async withdraw(amount) {
-          return E(this.state.account).withdraw(amount);
+          return V(this.state.account).withdraw(amount);
         },
         /** @type {LocalChainAccount['executeTx']} */
         async executeTx(messages) {
           // @ts-expect-error subtype
-          return E(this.state.account).executeTx(messages);
+          return V(this.state.account).executeTx(messages);
         },
         /** @returns {ChainAddress['address']} */
         getAddress() {
@@ -252,7 +253,7 @@ export const prepareLocalChainAccountKit = (
               ? 0n
               : await timestampHelper.getTimeoutTimestampNS());
 
-          const [result] = await E(this.state.account).executeTx([
+          const [result] = await V(this.state.account).executeTx([
             typedJson('/ibc.applications.transfer.v1.MsgTransfer', {
               sourcePort: transferChannel.portId,
               sourceChannel: transferChannel.channelId,

diff --git a/packages/orchestration/src/facade.js b/packages/orchestration/src/facade.js
@@ -1,6 +1,6 @@
 /** @file Orchestration service */
 
-import { E } from '@endo/far';
+import { V as E } from '@agoric/vow/vat.js';
 import { prepareCosmosOrchestrationAccount } from './exos/cosmosOrchestrationAccount.js';
 
 /**

diff --git a/packages/orchestration/test/examples/stake-bld.contract.test.ts b/packages/orchestration/test/examples/stake-bld.contract.test.ts
@@ -2,6 +2,7 @@ import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
 import { AmountMath } from '@agoric/ertp';
 import { setUpZoeForTest } from '@agoric/zoe/tools/setup-zoe.js';
+import { V } from '@agoric/vow/vat.js';
 import { E } from '@endo/far';
 import path from 'path';
 import { commonSetup } from '../supports.js';
@@ -53,15 +54,15 @@ test('makeAccount, deposit, withdraw', async t => {
   t.regex(await E(account).getAddress(), /agoric1/);
 
   t.log('deposit 100 bld to account');
-  const depositResp = await E(account).deposit(
+  const depositResp = await V(account).deposit(
     await utils.pourPayment(bld.units(100)),
   );
   t.true(AmountMath.isEqual(depositResp, bld.units(100)), 'deposit');
 
   // TODO validate balance, .getBalance()
 
   t.log('withdraw bld from account');
-  const withdrawResp = await E(account).withdraw(bld.units(100));
+  const withdrawResp = await V(account).withdraw(bld.units(100));
   const withdrawAmt = await bld.issuer.getAmountOf(withdrawResp);
   t.true(AmountMath.isEqual(withdrawAmt, bld.units(100)), 'withdraw');
 

diff --git a/packages/orchestration/test/exos/local-chain-account-kit.test.ts b/packages/orchestration/test/exos/local-chain-account-kit.test.ts
@@ -2,7 +2,8 @@ import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
 
 import { AmountMath } from '@agoric/ertp';
 import { prepareRecorderKitMakers } from '@agoric/zoe/src/contractSupport/recorder.js';
-import { E, Far } from '@endo/far';
+import { V as E } from '@agoric/vow/vat.js';
+import { Far } from '@endo/far';
 import { commonSetup } from '../supports.js';
 import { prepareLocalChainAccountKit } from '../../src/exos/local-chain-account-kit.js';
 import { ChainAddress } from '../../src/orchestration-api.js';

diff --git a/packages/orchestration/test/supports.ts b/packages/orchestration/test/supports.ts
@@ -66,13 +66,15 @@ export const commonSetup = async t => {
     }),
   );
 
+  const vowTools = prepareVowTools(rootZone.subZone('vows'));
+
   const transferBridge = makeFakeTransferBridge(rootZone);
   const { makeBridgeTargetKit } = prepareBridgeTargetModule(
     rootZone.subZone('bridge'),
   );
   const { makeTransferMiddlewareKit } = prepareTransferTools(
     rootZone.subZone('transfer'),
-    prepareVowTools(rootZone.subZone('vows')),
+    vowTools,
   );
 
   const { finisher, interceptorFactory, transferMiddleware } =
@@ -90,6 +92,7 @@ export const commonSetup = async t => {
   );
   const localchain = prepareLocalChainTools(
     rootZone.subZone('localchain'),
+    vowTools,
   ).makeLocalChain({
     bankManager,
     system: localchainBridge,