chore: bring back address hooks

Refs: #8863

Author: anilhelvaci

multichain-testing/test/xcs-swap-anything/swap-anything.test.ts

@@ -428,11 +428,7 @@ test.serial(
   },
 );
 
-/**
- * UNTIL https://github.com/Agoric/BytePitchPartnerEng/issues/51, we are skipping this
- * until the ticket above is done
- */
-test.skip('address hook - BLD for OSMO, receiver on Agoric', async t => {
+test.serial('address hook - BLD for OSMO, receiver on Agoric', async t => {
   const { wallets, vstorageClient, retryUntilCondition, useChain } = t.context;
   const { getRestEndpoint, chain: cosmosChain } = useChain('cosmoshub');
 
@@ -507,7 +503,7 @@ test.skip('address hook - BLD for OSMO, receiver on Agoric', async t => {
       const currentBalanceAmount = BigInt(balances[0]?.amount || 0);
       return currentBalanceAmount > balancesBeforeAmount;
     },
-    'Deposit reflected in localOrchAccount balance',
+    'Osmosis swap output reflected on Agoric receiver balance',
   );
   t.log(agoricReceiverBalances);
 

packages/orchestration/src/examples/swap-anything.contract.js

@@ -2,20 +2,21 @@ import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
 import { makeTracer } from '@agoric/internal';
 import { E } from '@endo/far';
 import { M } from '@endo/patterns';
+import { decodeAddressHook } from '@agoric/cosmic-proto/address-hooks.js';
 import { prepareChainHubAdmin } from '../exos/chain-hub-admin.js';
 import { withOrchestration } from '../utils/start-helper.js';
 import * as sharedFlows from './shared.flows.js';
-import { swapIt } from './swap-anything.flows.js';
+import { swapAnythingViaHook, swapIt } from './swap-anything.flows.js';
 import { AnyNatAmountShape } from '../typeGuards.js';
 import { registerChainsAndAssets } from '../utils/chain-hub-helper.js';
 
 const trace = makeTracer('SwapAnything.Contract');
-
+const interfaceTODO = undefined;
 /**
  * @import {Remote, Vow} from '@agoric/vow';
  * @import {Zone} from '@agoric/zone';
  * @import {OrchestrationPowers, OrchestrationTools} from '../utils/start-helper.js';
- * @import {CosmosChainInfo, Denom, DenomDetail} from '@agoric/orchestration';
+ * @import {CosmosChainInfo, Denom, DenomDetail, OrchestrationAccount} from '@agoric/orchestration';
  */
 
 export const SingleNatAmountRecord = M.and(
@@ -48,6 +49,11 @@ export const contract = async (
 ) => {
   const creatorFacet = prepareChainHubAdmin(zone, chainHub);
 
+  /**
+   * @type {OrchestrationAccount<{ chainId: 'agoric' }>} ;
+   */
+  let sharedLocalAccount;
+
   // UNTIL https://github.com/Agoric/agoric-sdk/issues/9066
   const logNode = E(privateArgs.storageNode).makeChildNode('log');
   /** @type {(msg: string) => Vow<void>} */
@@ -74,7 +80,74 @@ export const contract = async (
     swapIt,
   );
 
-  void vowTools.when(sharedLocalAccountP, async sharedLocalAccount => {
+  const swapAnythingAddressHook = orchestrate(
+    'swapAnythingViaHook',
+    {
+      chainHub,
+      sharedLocalAccountP,
+      log,
+    },
+    swapAnythingViaHook,
+  );
+
+  const tap = zone.makeOnce('tapPosition', _key => {
+    console.log('making tap');
+    return zone.exo('tap', interfaceTODO, {
+      /**
+       * @param {import('@agoric/vats').VTransferIBCEvent} event
+       */
+      async receiveUpcall(event) {
+        await null;
+        trace('receiveUpcall', event);
+
+        if (event.event !== 'writeAcknowledgement') return;
+        trace('Moving on...');
+
+        const {
+          amount,
+          extra: { receiver: origReceiver },
+        } = await vowTools.when(
+          E(sharedLocalAccount).parseInboundTransfer(event.packet),
+        );
+
+        const { baseAddress, query } = decodeAddressHook(origReceiver);
+
+        /**
+         * @type {{
+         *   destAddr: string;
+         *   receiverAddr: string;
+         *   outDenom: string;
+         * }}
+         */
+        // @ts-expect-error
+        const { destAddr, receiverAddr, outDenom } = query;
+
+        trace({
+          baseAddress,
+          destAddr,
+          receiverAddr,
+          outDenom,
+        });
+
+        if (!receiverAddr || !destAddr || !outDenom) return;
+        // Invoke the flow to perform swap and end up at the final destination.
+        return swapAnythingAddressHook(amount, {
+          destAddr,
+          receiverAddr,
+          outDenom, // swapOutDenom
+          onFailedDelivery: 'do_nothing',
+          slippage: {
+            slippagePercentage: '20',
+            windowSeconds: 10,
+          },
+        });
+      },
+    });
+  });
+
+  void vowTools.when(sharedLocalAccountP, async lca => {
+    sharedLocalAccount = lca;
+    await sharedLocalAccount.monitorTransfers(tap);
     const encoded = await E(privateArgs.marshaller).toCapData({
       sharedLocalAccount: sharedLocalAccount.getAddress(),
     });

packages/orchestration/src/examples/swap-anything.flows.js

@@ -22,7 +22,7 @@ const { entries } = Object;
  * @import {Vow} from '@agoric/vow';
  * @import {LocalOrchestrationAccountKit} from '../exos/local-orchestration-account.js';
  * @import {ZoeTools} from '../utils/zoe-tools.js';
- * @import {Orchestrator, OrchestrationFlow, ChainHub, CosmosChainInfo} from '../types.js';
+ * @import {Orchestrator, OrchestrationFlow, ChainHub, CosmosChainInfo, DenomAmount} from '../types.js';
  */
 
 const denomForBrand = async (orch, brand) => {
@@ -166,21 +166,18 @@ export const swapIt = async (
 harden(swapIt);
 
 /**
- * UNTIL https://github.com/Agoric/BytePitchPartnerEng/issues/51 is done, we
- * can't demonstrate this
- *
  * @satisfies {OrchestrationFlow}
  * @param {Orchestrator} _orch
  * @param {object} ctx
  * @param {GuestInterface<ChainHub>} ctx.chainHub
  * @param {Promise<GuestInterface<LocalOrchestrationAccountKit['holder']>>} ctx.sharedLocalAccountP
- * @param {{ denom: string; amount: string }} transferInfo
+ * @param {DenomAmount} transferInfo
  * @param {SwapInfo} memoArgs
  */
 export const swapAnythingViaHook = async (
   _orch,
   { chainHub, sharedLocalAccountP },
-  { denom, amount },
+  { denom, value },
   memoArgs,
 ) => {
   mustMatch(
@@ -198,7 +195,7 @@ export const swapAnythingViaHook = async (
   );
 
   const { receiverAddr, destAddr } = memoArgs;
-  trace(`sending {${amount}} from osmosis to ${receiverAddr}`);
+  trace(`sending {${value}} from osmosis to ${receiverAddr}`);
 
   /**
    * @type {any} XXX methods returning vows
@@ -222,7 +219,7 @@ export const swapAnythingViaHook = async (
       encoding: 'bech32',
       chainId: /** @type {CosmosChainInfo} */ (osmosisChainInfo).chainId,
     },
-    { denom, value: BigInt(amount) },
+    { denom, value },
     { memo },
   );