From dd61e16283693c71bd0e8dc392c5986dc42d5689 Mon Sep 17 00:00:00 2001
From: Turadg Aleahmad <turadg@agoric.com>
Date: Tue, 17 Sep 2024 13:35:49 -0700
Subject: [PATCH] feat(examples): logging progress

---
 .../src/examples/send-anywhere.contract.js    |  11 ++++-
 .../src/examples/send-anywhere.flows.js       |  10 +++--
 .../snapshots/send-anywhere.test.ts.md        |  42 +++++++++++-------
 .../snapshots/send-anywhere.test.ts.snap      | Bin 1288 -> 1309 bytes
 4 files changed, 44 insertions(+), 19 deletions(-)

diff --git a/packages/orchestration/src/examples/send-anywhere.contract.js b/packages/orchestration/src/examples/send-anywhere.contract.js
index ebe77f1af7d..b05bab026a9 100644
--- a/packages/orchestration/src/examples/send-anywhere.contract.js
+++ b/packages/orchestration/src/examples/send-anywhere.contract.js
@@ -1,12 +1,15 @@
 import { makeSharedStateRecord } from '@agoric/async-flow';
+
 import { AmountShape } from '@agoric/ertp';
 import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
 import { M } from '@endo/patterns';
+import { E } from '@endo/far';
 import { withOrchestration } from '../utils/start-helper.js';
 import * as flows from './send-anywhere.flows.js';
 import { prepareChainHubAdmin } from '../exos/chain-hub-admin.js';
 
 /**
+ * @import {Vow} from '@agoric/vow';
  * @import {Zone} from '@agoric/zone';
  * @import {OrchestrationPowers, OrchestrationTools} from '../utils/start-helper.js';
  */
@@ -33,7 +36,7 @@ const contract = async (
   zcf,
   privateArgs,
   zone,
-  { chainHub, orchestrateAll, zoeTools },
+  { chainHub, orchestrateAll, vowTools, zoeTools },
 ) => {
   const contractState = makeSharedStateRecord(
     /** @type {{ account: OrchestrationAccount<any> | undefined }} */ {
@@ -43,10 +46,16 @@ const contract = async (
 
   const creatorFacet = prepareChainHubAdmin(zone, chainHub);
 
+  // UNTIL https://github.com/Agoric/agoric-sdk/issues/9066
+  const logNode = E(privateArgs.storageNode).makeChildNode('log');
+  /** @type {(msg: string) => Vow<void>} */
+  const log = msg => vowTools.watch(E(logNode).setValue(msg));
+
   // orchestrate uses the names on orchestrationFns to do a "prepare" of the associated behavior
   const orchFns = orchestrateAll(flows, {
     zcf,
     contractState,
+    log,
     localTransfer: zoeTools.localTransfer,
   });
 
diff --git a/packages/orchestration/src/examples/send-anywhere.flows.js b/packages/orchestration/src/examples/send-anywhere.flows.js
index 6c7128df268..191109d025b 100644
--- a/packages/orchestration/src/examples/send-anywhere.flows.js
+++ b/packages/orchestration/src/examples/send-anywhere.flows.js
@@ -3,6 +3,7 @@ import { M, mustMatch } from '@endo/patterns';
 
 /**
  * @import {GuestOf} from '@agoric/async-flow';
+ * @import {Vow} from '@agoric/vow';
  * @import {ZoeTools} from '../utils/zoe-tools.js';
  * @import {Orchestrator, LocalAccountMethods, OrchestrationAccountI, OrchestrationFlow} from '../types.js';
  */
@@ -18,12 +19,13 @@ const { entries } = Object;
  * @param {object} ctx
  * @param {{ localAccount?: OrchestrationAccountI & LocalAccountMethods }} ctx.contractState
  * @param {GuestOf<ZoeTools['localTransfer']>} ctx.localTransfer
+ * @param {GuestOf<(msg: string) => Vow<void>>} ctx.log
  * @param {ZCFSeat} seat
  * @param {{ chainName: string; destAddr: string }} offerArgs
  */
 export const sendIt = async (
   orch,
-  { contractState, localTransfer },
+  { contractState, localTransfer, log },
   seat,
   offerArgs,
 ) => {
@@ -32,8 +34,10 @@ export const sendIt = async (
   // NOTE the proposal shape ensures that the `give` is a single asset
   const { give } = seat.getProposal();
   const [[_kw, amt]] = entries(give);
+  void log(`sending {${amt.value}} from ${chainName} to ${destAddr}`);
   const agoric = await orch.getChain('agoric');
   const assets = await agoric.getVBankAssetInfo();
+  void log(`got info for denoms: ${assets.map(a => a.denom).join(', ')}`);
   const { denom } = NonNullish(
     assets.find(a => a.brand === amt.brand),
     `${amt.brand} not registered in vbank`,
@@ -41,8 +45,7 @@ export const sendIt = async (
   const chain = await orch.getChain(chainName);
 
   if (!contractState.localAccount) {
-    const agoricChain = await orch.getChain('agoric');
-    contractState.localAccount = await agoricChain.makeAccount();
+    contractState.localAccount = await agoric.makeAccount();
   }
 
   const info = await chain.getChainInfo();
@@ -65,5 +68,6 @@ export const sendIt = async (
     },
   );
   seat.exit();
+  void log(`transfer complete, seat exited`);
 };
 harden(sendIt);
diff --git a/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md b/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md
index 9cc05e0959f..874ee76b50c 100644
--- a/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md
+++ b/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.md
@@ -1,6 +1,6 @@
-# Snapshot report for `test/examples/sendAnywhere.test.ts`
+# Snapshot report for `test/examples/send-anywhere.test.ts`
 
-The actual snapshot is saved in `sendAnywhere.test.ts.snap`.
+The actual snapshot is saved in `send-anywhere.test.ts.snap`.
 
 Generated by [AVA](https://avajs.dev).
 
@@ -27,8 +27,10 @@ Generated by [AVA](https://avajs.dev).
       chainHub: {
         ChainHub_kindHandle: 'Alleged: kind',
         ChainHub_singleton: 'Alleged: ChainHub',
+        brandDenom: {},
         chainInfos: {},
         connectionInfos: {},
+        denom: {},
         lookupChainInfo_kindHandle: 'Alleged: kind',
         lookupChainsAndConnection_kindHandle: 'Alleged: kind',
         lookupConnectionInfo_kindHandle: 'Alleged: kind',
@@ -38,7 +40,21 @@ Generated by [AVA](https://avajs.dev).
         'ChainHub Admin_singleton': 'Alleged: ChainHub Admin',
         'Send PF_kindHandle': 'Alleged: kind',
         'Send PF_singleton': 'Alleged: Send PF',
-        findBrandInVBank_kindHandle: 'Alleged: kind',
+        orchestration: {
+          sendIt: {
+            asyncFlow_kindHandle: 'Alleged: kind',
+            endowments: {
+              0: {
+                contractState_kindHandle: 'Alleged: kind',
+                contractState_singleton: 'Alleged: contractState',
+                localTransfer_kindHandle: 'Alleged: kind',
+                localTransfer_singleton: 'Alleged: localTransfer',
+                log_kindHandle: 'Alleged: kind',
+                log_singleton: 'Alleged: log',
+              },
+            },
+          },
+        },
       },
       orchestration: {
         'Cosmos Orchestration Account Holder_kindHandle': 'Alleged: kind',
@@ -46,18 +62,14 @@ Generated by [AVA](https://avajs.dev).
         LocalChainFacade_kindHandle: 'Alleged: kind',
         Orchestrator_kindHandle: 'Alleged: kind',
         RemoteChainFacade_kindHandle: 'Alleged: kind',
-        sendIt: {
-          asyncFlow_kindHandle: 'Alleged: kind',
-          endowments: {
-            1: {
-              contractState_kindHandle: 'Alleged: kind',
-              contractState_singleton: 'Alleged: contractState',
-              findBrandInVBank_kindHandle: 'Alleged: kind',
-              findBrandInVBank_singleton: 'Alleged: findBrandInVBank',
-              localTransfer_kindHandle: 'Alleged: kind',
-              localTransfer_singleton: 'Alleged: localTransfer',
-            },
-          },
+        chainName: {},
+        ibcTools: {
+          IBCTransferSenderKit_kindHandle: 'Alleged: kind',
+          ibcResultWatcher_kindHandle: 'Alleged: kind',
+          ibcResultWatcher_singleton: 'Alleged: ibcResultWatcher',
+        },
+        packetTools: {
+          PacketToolsKit_kindHandle: 'Alleged: kind',
         },
       },
       vows: {
diff --git a/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.snap b/packages/orchestration/test/examples/snapshots/send-anywhere.test.ts.snap
index db5e4fcd09358ecf830457f606c586941142ccf2..e29cb8eb0e236ac0f9b1c6e76002f7fa3332e0c7 100644
GIT binary patch
literal 1309
zcmV+&1>*WaRzV<BZeeh9Xm4~Nb~6eC08_W?`VDHP-3Ds~_YK=2yAVopHh9ov)L2O8
zMBWhe*B^@r00000000A}SWRdgRUH4l{hZlkb~a7YG#{;th)NM#kzVwariLW8O-%ZM
z2a&fkFPky5@2xX$x>mgOD0om5@h0u1h$j#BCgQ<^V8MfjLZMJl@Zdo&f}mh_HnThP
zCRujkUUr$^|Nndc@Asd*z1?tywd>!y!=xi!)@;yblQx;-bK3TIg!FISv27~p>$Qh@
zl+pbVjp%CtHUNAA;68xg0OSa;K!BGC@EQRoNoj(V)*EjzOA^xmS*z7R3=j>(#3ad0
zkvvFof}FY#c(mcN`bN-j9e=0(sw3arb-2Akx$Uw@%vf|?)@1fe^)9AxOl~qucsBD!
zP^=QNO@Ij2sehAO%dY5z(AP0Yvv#P%SAs@}{F6Wgmmalbh`g8^AcpX)9p+1qN=NVz
zz7c~9H$=w|pMDj4ntxZYZg|HZ<bX#x;A9?PdEoOr@Hh{gDF8bK;BEo9UjY6n0Fy-}
z)VXA+HBwnC0vko({UY#v5qMk#{w)HhO2D}i5R`y#OA1X%r70E4K&1?<mVuA<zJDkK
zc}-CpQ`Ph*HQ-qdcuxa<)Br;V)^y+l9k{Cl-{}fPO{FM5(t%(0#Gk1EoeFTT0{m40
zUKmqUr&QJ48)JZ_iXBf?<Cs!Ovx|1i;fqmCWG%!Kin{Ocrpu(@k-$t}J1ME~Or3YS
zRyu-bwP0a6;GyDG-tlO=JyK6380OOqDL3Z&1Sw&)H7|<hmJ}Y#YR2rAq>^RvqDsi^
zu|Zc&^*TG?)+@Bhyz6wAdA;8ICMGq}ms+Nd8+fcI@-Qy4?TXH_@YVxqi59z-%9b94
zR$ij*=*e{7v<{=YmuNc-L0ECR8la{9DU&ro$NGw?^i1^imf|Dq@0e4ShDW)5fpO6a
zv6=B077o5uzAbveI2XfAOK{#R&4IvHOrU7@I1{$cxkBs)?WKq}tFKSR^!-I{FZGSc
z%JjrOQ^Jc8NDPpoTA@*Jd%c`_Rw(L2W<^p`t%EJb?fS-Y*7GMKz0|?AzS_P>nB=#|
z55MLPxYwUw5`Ihg_4T-9ebKT+z-4_!xT9Uy3C`0Og+<*%D37o=%!hnobeE|`?aV`J
zW?+iQ?9IX^YYEA+9bYBnvsfbZuvIV977L+!F-UV7))gV#UW@)3L&n<F+GTPdG(bv<
zWhcWr+ho#nx~thyZo-8FC{l$spS%qd(rUA9c%tR_>^ha!PWH-~yCyoTTr!VS*FQp~
zOo!)Qm5%F=mZWiG5brrJ?wE3u7$8KQ3~sk9uXvRE+atNE_12u?qUX_@Bp>}UO|y?h
zD^Nk%l#*z1C|VwhYC}<dC|XJFZ>J65tfB00<3mX%RFcAq0bJfA`Pcw{R>_W~&a78~
zr>lzC<j^yxQyV1-)6c4d^p||b?Nu3~dG$J4J--wsx;t!{ca$;aG^|bL2d+G7ccchX
ztvcJ+S7i?@;n|JBh#AczjpRS90-siapVS-}sVL{vg_&kp*{g*79?MUKaa(j+j7vW(
zgGm#ZH5C)8ha~zrb3jDShHouR6KI*hmnQJ137n|`K@Iq#rf`}mPIVBUh+Z_qWjOQg
zl+;e;^mt!6A^3l%QPPH__7EEqf(lF370s+C8(p2$dE>G3n#`pQ=DxEKxnJM^8>CLR
TCG+aOq@Mf_P3!k0D-i$y6kdoU

literal 1288
zcmV+j1^4<vRzV<BZeeh9Xm4~Nb~6eC03J<3jC9jifeW^JF<1J4eulH_DZw3SR<wE5
z-dE5)Iv<M&00000000A}SW9dhMHv3Z_S(Bn)@wIOLmn*_LKIa9icl|bN>idF^bwLi
z!~s>~-HEegJ!5vqHAP%{MB)GfA#SMU&@%^mLx=+hBr0*>fK;hcC6GYkzzGQnB;s|}
z-knV>Z^$K<zwiI%pZ_&~a%a2Y341rVeV0jBdaT)?%_eO!H{i4#><Ag$zUw$t(l@HD
zJWA;O5S<w705$-80^k9F-vHzYut<Pc2=F=qrbw|yikBO2F<TNc_*ku0K}--G#KIKG
zO_Mx`RwF0RcYNCLSbd|@@Z4ah{+cUq?7G}prQGpYL^GE>k2RU|a=nKs8dICh7QVy$
zF$^n&Y!e`Y4I13y_KGLEA@o%Y((N7U^3_fwME*%2f=i#;GDKd=4G~lL_6`fAPo*n(
z2;Ypsg`1)qgx`J{`!@fsV7>58{+t6I<$x1;faQVD^T6Xg@InFDDFF8hz=HztX91Yf
zlu+lAq1H)xT>~~W;C&7FP6Hlmz`q)BvIv|l0-Yl8O;M34sxrkw2`HC<wG!~r-tX^A
zKwekOCR8)yDIIuL2j0_xA9TPpfOP}-zyR(Uz_*4XQB@^Mj|||KJ^HCK&@BV^%fMe{
z;Kd2WbXqmdy*UBcD(!fx8Yh%Wnp<*OE?<gjB5NT&p_m6QZ+c7$9uZ~-)=8$KGkwnO
zdFcwC)q};A4i62l@~%(Y?Xh|yp|FrvNL^!oAdn)ft$9H-x1{h{RyXFhB$X`7Eh>cE
znHYA}bicDZ+<uidnSY(`GQZz@U&mOr0c(Z2UdLyB%ELHi+Y{Xt;a~1ZTeR4<RJM#x
z=;cM)j=q^0xYlKK_abeFAqXqZPy@8QKV`B8=-9w8m7dzbZaF@}{*GO$-0&%P&ND7r
zAvQZ1!@|M0#<xX37-wUcWed*xr8y*Q#R!_y*G%|2?+LNnX)i~*S?~IE%syD+&ho&C
ztV&PrD<y6*hKLEGsTCRpx8KW|XN6)uVpb%XY8`Ab?$kF{vYuay>{16;2WI<}Fv)LE
z9{$W7@UB0<EP|E@>X+lp`jTyn4wv;+;f?oPCp1rA5H|G=kvziQun_8n(Osc7butgB
z*`X^U^KBM4SxZQk?f42IpT!bkgspmswpa+=k3qWIu&)T=^;`7U7&6hO_AZnApb1h`
zJUbEA*(Q^|+gr_!@)9l{AdxDxh2(3PV5`lx;ft0Vu<KOXJJ~B|{+j5namjp6z2FFy
zG83MARk~g<UXmuwVZ7)4_{Ef$!~`MgWbk@rdBvwZ*dFVudVkH)mVBSyBKhc(Wmy9(
zT7e46rj$grk!Wcos*gmCk!U%!znwOLGp4e?O^y_)sUn3{6S%Y|^05j0q>3F&omsB{
z&r}rJ)W|buQX3@+)6Xiy^cMrhoi!PvdG$G3JGUGqx;Jc@f0QxiHtbCnbUb;~?nnuw
zT6Jz<uW}D8;kk|Bh#BujI>~=n0Y0q&KdLz}Q&G;T3p35IvR4TCBbJ{s<BsUI7?(j<
z22&O=XDKdJ4oUQL)=-F?>Dg;HEPz?S7Z&il1)QoXT2@M{piY4356o~0&ipDRty8%?
yJ}^!Y|L+t^`jE69;X{JRJlbI1JByKH_5FWL)akZlem#)Xm;V86r0Pq(5C8yUduA5^