feat: use orchFns.autoStake as target for receiveUpcall

packages/orchestration/src/examples/auto-stake-it.contract.js

@@ -2,18 +2,57 @@ import {
   EmptyProposalShape,
   InvitationShape,
 } from '@agoric/zoe/src/typeGuards.js';
-import { M } from '@endo/patterns';
+import { makeTracer } from '@agoric/internal';
+import { M, mustMatch } from '@endo/patterns';
 import { prepareChainHubAdmin } from '../exos/chain-hub-admin.js';
 import { preparePortfolioHolder } from '../exos/portfolio-holder-kit.js';
 import { withOrchestration } from '../utils/start-helper.js';
-import { prepareStakingTap } from './auto-stake-it-tap-kit.js';
 import * as flows from './auto-stake-it.flows.js';
+import { ChainAddressShape } from '../typeGuards.js';
+
+const trace = makeTracer('AutoStakeIt');
 
 /**
+ * @import {GuestInterface} from '@agoric/async-flow';
  * @import {Zone} from '@agoric/zone';
+ * @import {IBCChannelID, VTransferIBCEvent} from '@agoric/vats';
+ * @import {TargetApp} from '@agoric/vats/src/bridge-target.js';
+ * @import {ChainAddress, CosmosValidatorAddress, Denom} from '@agoric/orchestration';
+ * @import {TypedPattern} from '@agoric/internal';
+ * @import {CosmosOrchestrationAccount} from '../exos/cosmos-orchestration-account.js';
+ * @import {LocalOrchestrationAccount} from '../exos/local-orchestration-account.js';
  * @import {OrchestrationPowers, OrchestrationTools} from '../utils/start-helper.js';
  */
 
+/**
+ * @typedef {{
+ *   stakingAccount: GuestInterface<CosmosOrchestrationAccount>;
+ *   localAccount: GuestInterface<LocalOrchestrationAccount>;
+ *   config: {
+ *     validator: CosmosValidatorAddress;
+ *     localChainAddress: ChainAddress;
+ *     remoteChainAddress: ChainAddress;
+ *     sourceChannel: IBCChannelID;
+ *     remoteDenom: Denom;
+ *     localDenom: Denom;
+ *   };
+ * }} StakingTapState
+ */
+
+/** @type {TypedPattern<StakingTapState>} */
+const StakingTapStateShape = harden({
+  stakingAccount: M.remotable('CosmosOrchestrationAccount'),
+  localAccount: M.remotable('LocalOrchestrationAccount'),
+  config: {
+    validator: ChainAddressShape,
+    localChainAddress: ChainAddressShape,
+    remoteChainAddress: ChainAddressShape,
+    sourceChannel: M.string(),
+    remoteDenom: M.string(),
+    localDenom: M.string(),
+  },
+});
+
 /**
  * AutoStakeIt allows users to to create an auto-forwarding address that
  * transfers and stakes tokens on a remote chain when received.
@@ -33,16 +72,42 @@ const contract = async (
   zone,
   { chainHub, orchestrateAll, vowTools },
 ) => {
-  const makeStakingTap = prepareStakingTap(
-    zone.subZone('stakingTap'),
-    vowTools,
-  );
   const makePortfolioHolder = preparePortfolioHolder(
     zone.subZone('portfolio'),
     vowTools,
   );
 
-  const { makeAccounts } = orchestrateAll(flows, {
+  /**
+   * Provides a {@link TargetApp} that reacts to an incoming IBC transfer.
+   */
+  const makeStakingTap = zone.exoClass(
+    'StakingTap',
+    M.interface('AutoStakeItTap', {
+      receiveUpcall: M.call(M.record()).returns(M.undefined()),
+    }),
+    /** @param {StakingTapState} initialState */
+    initialState => {
+      mustMatch(initialState, StakingTapStateShape); // TODO use opts.stateShape
+      return harden(initialState);
+    },
+    {
+      /**
+       * Transfers from localAccount to stakingAccount, then delegates from the
+       * stakingAccount to `validator` if the expected token (remoteDenom) is
+       * received.
+       *
+       * @param {VTransferIBCEvent} event
+       */
+      receiveUpcall(event) {
+        trace('receiveUpcall', event);
+        const { localAccount, stakingAccount, config } = this.state;
+        // eslint-disable-next-line no-use-before-define -- defined by orchestrateAll, necessarily after this
+        orchFns.autoStake(localAccount, stakingAccount, config, event);
+      },
+    },
+  );
+
+  const orchFns = orchestrateAll(flows, {
     makeStakingTap,
     makePortfolioHolder,
     chainHub,
@@ -56,7 +121,7 @@ const contract = async (
     {
       makeAccountsInvitation() {
         return zcf.makeInvitation(
-          makeAccounts,
+          orchFns.makeAccounts,
           'Make Accounts',
           undefined,
           EmptyProposalShape,

packages/orchestration/src/examples/auto-stake-it.flows.js

@@ -1,20 +1,29 @@
+import { makeTracer } from '@agoric/internal';
+import { atob } from '@endo/base64';
 import { Fail } from '@endo/errors';
 import { denomHash } from '../utils/denomHash.js';
 
+const trace = makeTracer('AutoStakeItFlows');
+
 /**
  * @import {ResolvedPublicTopic} from '@agoric/zoe/src/contractSupport/topics.js';
  * @import {GuestInterface} from '@agoric/async-flow';
- * @import {CosmosValidatorAddress, Orchestrator, CosmosInterchainService, Denom, OrchestrationAccount, StakingAccountActions, OrchestrationFlow} from '@agoric/orchestration';
- * @import {MakeStakingTap} from './auto-stake-it-tap-kit.js';
+ * @import {VTransferIBCEvent} from '@agoric/vats';
+ * @import {CosmosValidatorAddress, Orchestrator, OrchestrationAccount, StakingAccountActions, OrchestrationFlow} from '@agoric/orchestration';
+ * @import {FungibleTokenPacketData} from '@agoric/cosmic-proto/ibc/applications/transfer/v2/packet.js';
+ * @import {Guarded} from '@endo/exo';
  * @import {MakePortfolioHolder} from '../exos/portfolio-holder-kit.js';
  * @import {ChainHub} from '../exos/chain-hub.js';
+ * @import {StakingTapState} from './auto-stake-it.contract.js';
  */
 
 /**
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} orch
  * @param {{
- *   makeStakingTap: MakeStakingTap;
+ *   makeStakingTap: (
+ *     initialState: StakingTapState,
+ *   ) => Guarded<{ receiveUpcall: (event: VTransferIBCEvent) => void }>;
  *   makePortfolioHolder: MakePortfolioHolder;
  *   chainHub: GuestInterface<ChainHub>;
  * }} ctx
@@ -64,14 +73,18 @@ export const makeAccounts = async (
 
   // Every time the `localAccount` receives `remoteDenom` over IBC, delegate it.
   const tap = makeStakingTap({
+    // @ts-expect-error LocalOrchestrationAccount vs. OrchestrationAccount<any>
     localAccount,
+    // @ts-expect-error CosmosOrchestrationAccount vs. OrchestrationAccount<any>
     stakingAccount,
-    validator,
-    localChainAddress,
-    remoteChainAddress,
-    sourceChannel: transferChannel.counterPartyChannelId,
-    remoteDenom,
-    localDenom,
+    config: {
+      validator,
+      localChainAddress,
+      remoteChainAddress,
+      sourceChannel: transferChannel.counterPartyChannelId,
+      remoteDenom,
+      localDenom,
+    },
   });
   // XXX consider storing appRegistration, so we can .revoke() or .updateTargetApp()
   // @ts-expect-error tap.receiveUpcall: 'Vow<void> | undefined' not assignable to 'Promise<any>'
@@ -100,3 +113,55 @@ export const makeAccounts = async (
   return portfolioHolder.asContinuingOffer();
 };
 harden(makeAccounts);
+
+/**
+ * @satisfies {OrchestrationFlow}
+ * @param {Orchestrator} orch
+ * @param {object} ctx
+ * @param {StakingTapState['localAccount']} localAccount
+ * @param {StakingTapState['stakingAccount']} stakingAccount
+ * @param {StakingTapState['config']} config
+ * @param {VTransferIBCEvent} event
+ */
+export const autoStake = async (
+  orch,
+  ctx,
+  localAccount,
+  stakingAccount,
+  config,
+  event,
+) => {
+  // ignore packets from unknown channels
+  if (event.packet.source_channel !== config.sourceChannel) {
+    return;
+  }
+  const tx = /** @type {FungibleTokenPacketData} */ (
+    JSON.parse(atob(event.packet.data))
+  );
+  trace('receiveUpcall packet data', tx);
+  const { remoteDenom, localChainAddress } = config;
+  // ignore outgoing transfers
+  if (tx.receiver !== localChainAddress.value) {
+    return;
+  }
+  // only interested in transfers of `remoteDenom`
+  if (tx.denom !== remoteDenom) {
+    return;
+  }
+
+  const { localDenom, remoteChainAddress, validator } = config;
+
+  await localAccount.transfer(
+    {
+      denom: localDenom,
+      value: BigInt(tx.amount),
+    },
+    remoteChainAddress,
+  );
+
+  await stakingAccount.delegate(validator, {
+    denom: remoteDenom,
+    value: BigInt(tx.amount),
+  });
+};
+harden(autoStake);

packages/orchestration/src/exos/local-orchestration-account.js

@@ -664,3 +664,4 @@ export const prepareLocalOrchestrationAccountKit = (
 
 /** @typedef {ReturnType<typeof prepareLocalOrchestrationAccountKit>} MakeLocalOrchestrationAccountKit */
 /** @typedef {ReturnType<MakeLocalOrchestrationAccountKit>} LocalOrchestrationAccountKit */
+/** @typedef {LocalOrchestrationAccountKit['holder']} LocalOrchestrationAccount */