chore: add .asContinuingOffer to LOA holder

Agoric · Jul 10, 2024 · bc12cbd · bc12cbd
1 parent 0b6d5f3
commit bc12cbd
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 24 deletions.
diff --git a/packages/orchestration/src/examples/stakeBld.contract.js b/packages/orchestration/src/examples/stakeBld.contract.js
@@ -87,17 +87,13 @@ export const start = async (zcf, privateArgs, baggage) => {
           async seat => {
             const { give } = seat.getProposal();
             trace('makeStakeBldInvitation', give);
-            const { holder, invitationMakers } = await makeLocalAccountKit();
+            const { holder } = await makeLocalAccountKit();
             const { In } = await deeplyFulfilled(
               withdrawFromSeat(zcf, seat, give),
             );
             await E(holder).deposit(In);
             seat.exit();
-            return harden({
-              publicSubscribers: holder.getPublicTopics(),
-              invitationMakers,
-              account: holder,
-            });
+            return holder.asContinuingOffer();
           },
           'wantStake',
           undefined,
@@ -118,12 +114,8 @@ export const start = async (zcf, privateArgs, baggage) => {
         trace('makeCreateAccountInvitation');
         return zcf.makeInvitation(async seat => {
           seat.exit();
-          const { holder, invitationMakers } = await makeLocalAccountKit();
-          return harden({
-            publicSubscribers: holder.getPublicTopics(),
-            invitationMakers,
-            account: holder,
-          });
+          const { holder } = await makeLocalAccountKit();
+          return holder.asContinuingOffer();
         }, 'wantLocalChainAccount');
       },
     },

diff --git a/packages/orchestration/src/exos/cosmos-orchestration-account.js b/packages/orchestration/src/exos/cosmos-orchestration-account.js
@@ -69,11 +69,6 @@ const { Vow$ } = NetworkShape; // TODO #9611
 /** @see {OrchestrationAccountI} */
 export const IcaAccountHolderI = M.interface('IcaAccountHolder', {
   ...orchestrationAccountMethods,
-  asContinuingOffer: M.call().returns({
-    publicSubscribers: M.any(),
-    invitationMakers: M.any(),
-    holder: M.any(),
-  }),
   getPublicTopics: M.call().returns(TopicsRecordShape),
   delegate: M.call(ChainAddressShape, AmountArgShape).returns(VowShape),
   redelegate: M.call(

diff --git a/packages/orchestration/src/exos/local-orchestration-account.js b/packages/orchestration/src/exos/local-orchestration-account.js
@@ -287,6 +287,14 @@ export const prepareLocalOrchestrationAccountKit = (
         },
       },
       holder: {
+        asContinuingOffer() {
+          const { holder, invitationMakers } = this.facets;
+          return harden({
+            publicSubscribers: holder.getPublicTopics(),
+            invitationMakers,
+            holder,
+          });
+        },
         /**
          * TODO: balance lookups for non-vbank assets
          *

diff --git a/packages/orchestration/src/orchestration-api.ts b/packages/orchestration/src/orchestration-api.ts
@@ -4,14 +4,12 @@
  * - must not have chain-specific types without runtime narrowing by chain id
  * - should remain relatively stable.
  */
-import type {
-  Amount,
-  Brand,
-  NatAmount,
-  Payment,
-} from '@agoric/ertp/src/types.js';
+import type { Amount, Brand, NatAmount } from '@agoric/ertp/src/types.js';
 import type { LocalChainAccount } from '@agoric/vats/src/localchain.js';
 import type { Timestamp } from '@agoric/time';
+import type { ContinuingOfferResult } from '@agoric/smart-wallet/src/types.js';
+import type { TopicsRecord } from '@agoric/zoe/src/contractSupport/topics.js';
+import type { CurrentWalletRecord } from '@agoric/smart-wallet/src/smartWallet.js';
 import type {
   ChainInfo,
   CosmosChainAccountMethods,
@@ -172,6 +170,20 @@ export interface OrchestrationAccountI {
    * @returns void
    */
   transferSteps: (amount: AmountArg, msg: TransferMsg) => Promise<void>;
+
+  /**
+   * Returns `invitationMakers` and `publicSubscribers` to the account
+   * holder's smart wallet so they can continue interacting with the account
+   * and read account state in vstorage if published.
+   */
+  asContinuingOffer: () => Promise<ContinuingOfferResult>;
+  /**
+   * Public topics are a map to different vstorage paths and subscribers that
+   * can be shared with on or offchain clients.
+   * When returned as part of a continuing invitation, it will appear
+   * in the {@link CurrentWalletRecord} in vstorage.
+   */
+  getPublicTopics: () => Promise<TopicsRecord>;
 }
 
 /**

diff --git a/packages/orchestration/src/utils/orchestrationAccount.js b/packages/orchestration/src/utils/orchestrationAccount.js
@@ -1,6 +1,7 @@
 import { M } from '@endo/patterns';
 import { Shape as NetworkShape } from '@agoric/network';
 import { VowShape } from '@agoric/vow';
+import { TopicsRecordShape } from '@agoric/zoe/src/contractSupport/topics.js';
 import { AmountArgShape, ChainAddressShape, CoinShape } from '../typeGuards.js';
 
 /** @import {OrchestrationAccountI} from '../orchestration-api.js'; */
@@ -17,4 +18,9 @@ export const orchestrationAccountMethods = {
     .optional(M.record())
     .returns(VowShape),
   transferSteps: M.call(AmountArgShape, M.any()).returns(VowShape),
+  asContinuingOffer: M.call().returns({
+    publicSubscribers: TopicsRecordShape,
+    invitationMakers: M.any(),
+    holder: M.remotable(),
+  }),
 };
diff --git a/packages/orchestration/test/examples/stake-bld.contract.test.ts b/packages/orchestration/test/examples/stake-bld.contract.test.ts
@@ -142,6 +142,12 @@ test('makeAccountInvitationMaker', async t => {
 
   const userSeat = await E(zoe).offer(inv);
   const offerResult = await E(userSeat).getOfferResult();
-  t.true('account' in offerResult, 'received account');
+  t.true('holder' in offerResult, 'received account holder');
   t.truthy('invitationMakers' in offerResult, 'received continuing invitation');
+  t.like(offerResult.publicSubscribers, {
+    account: {
+      description: 'Account holder status',
+      storagePath: 'mockChainStorageRoot',
+    },
+  });
 });