@agoric/orchestration 0.1.1-dev-6d71e87.0 → 0.1.1-dev-b9091ce.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/orchestration",
-  "version": "0.1.1-dev-6d71e87.0+6d71e87",
+  "version": "0.1.1-dev-b9091ce.0+b9091ce",
   "description": "Chain abstraction for Agoric's orchestration clients",
   "type": "module",
   "main": "index.js",
@@ -33,19 +33,19 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/async-flow": "0.1.1-dev-6d71e87.0+6d71e87",
-    "@agoric/cosmic-proto": "0.4.1-dev-6d71e87.0+6d71e87",
-    "@agoric/ertp": "0.16.3-dev-6d71e87.0+6d71e87",
-    "@agoric/internal": "0.3.3-dev-6d71e87.0+6d71e87",
-    "@agoric/network": "0.1.1-dev-6d71e87.0+6d71e87",
-    "@agoric/notifier": "0.6.3-dev-6d71e87.0+6d71e87",
-    "@agoric/store": "0.9.3-dev-6d71e87.0+6d71e87",
-    "@agoric/time": "0.3.3-dev-6d71e87.0+6d71e87",
-    "@agoric/vat-data": "0.5.3-dev-6d71e87.0+6d71e87",
-    "@agoric/vats": "0.15.2-dev-6d71e87.0+6d71e87",
-    "@agoric/vow": "0.1.1-dev-6d71e87.0+6d71e87",
-    "@agoric/zoe": "0.26.3-dev-6d71e87.0+6d71e87",
-    "@agoric/zone": "0.2.3-dev-6d71e87.0+6d71e87",
+    "@agoric/async-flow": "0.1.1-dev-b9091ce.0+b9091ce",
+    "@agoric/cosmic-proto": "0.4.1-dev-b9091ce.0+b9091ce",
+    "@agoric/ertp": "0.16.3-dev-b9091ce.0+b9091ce",
+    "@agoric/internal": "0.3.3-dev-b9091ce.0+b9091ce",
+    "@agoric/network": "0.1.1-dev-b9091ce.0+b9091ce",
+    "@agoric/notifier": "0.6.3-dev-b9091ce.0+b9091ce",
+    "@agoric/store": "0.9.3-dev-b9091ce.0+b9091ce",
+    "@agoric/time": "0.3.3-dev-b9091ce.0+b9091ce",
+    "@agoric/vat-data": "0.5.3-dev-b9091ce.0+b9091ce",
+    "@agoric/vats": "0.15.2-dev-b9091ce.0+b9091ce",
+    "@agoric/vow": "0.1.1-dev-b9091ce.0+b9091ce",
+    "@agoric/zoe": "0.26.3-dev-b9091ce.0+b9091ce",
+    "@agoric/zone": "0.2.3-dev-b9091ce.0+b9091ce",
     "@cosmjs/encoding": "^0.32.4",
     "@endo/base64": "^1.0.9",
     "@endo/errors": "^1.2.10",
@@ -56,7 +56,7 @@
     "bs58": "^6.0.0"
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-dev-6d71e87.0+6d71e87",
+    "@agoric/swingset-liveslots": "0.10.3-dev-b9091ce.0+b9091ce",
     "@chain-registry/client": "^1.47.4",
     "@cosmjs/amino": "^0.33.0",
     "@cosmjs/proto-signing": "^0.33.0",
@@ -99,5 +99,5 @@
   "typeCoverage": {
     "atLeast": 97.7
   },
-  "gitHead": "6d71e877bc133484d89e4e44ec534d5283a30eb3"
+  "gitHead": "b9091ce4718c00fc3981445b2d76afb1c0134540"
 }

package/src/exos/ibc-packet.d.ts

@@ -8,7 +8,13 @@ export function prepareIBCTransferSender(zone: import("@agoric/base-zone").Zone,
     '@type': "/ibc.applications.transfer.v1.MsgTransfer";
 }) => import("@endo/exo").GuardedKit<{
     public: {
-        sendPacket(match: any, opts: any): Vow<{
+        /**
+         * @param {Vow<
+         *   IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>
+         * >} match
+         * @param {PacketOptions} opts
+         */
+        sendPacket(match: Vow<IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket">>, opts: PacketOptions): Vow<{
             eventPattern: import("@endo/patterns").Matcher;
             resultV: Vow<void>;
         }>;
@@ -24,9 +30,17 @@ export function prepareIBCTransferSender(zone: import("@agoric/base-zone").Zone,
          *     >
          *   >,
          * ]} response
-         * @param {Record<string, any>} ctx
+         * @param {{
+         *   opts: PacketOptions;
+         *   match: Vow<
+         *     IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>
+         *   >;
+         * }} ctx
          */
-        onFulfilled([{ sequence }]: [JsonSafe<ResponseTo<TypedJson<"/ibc.applications.transfer.v1.MsgTransfer">>>], ctx: Record<string, any>): {
+        onFulfilled([{ sequence }]: [JsonSafe<ResponseTo<TypedJson<"/ibc.applications.transfer.v1.MsgTransfer">>>], ctx: {
+            opts: PacketOptions;
+            match: Vow<IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket">>;
+        }): {
             eventPattern: import("@endo/patterns").Matcher;
             resultV: Vow<void>;
         };
@@ -35,12 +49,18 @@ export function prepareIBCTransferSender(zone: import("@agoric/base-zone").Zone,
         onFulfilled(ackData: any): void;
     };
 }>>) => import("@endo/exo").Guarded<{
-    sendPacket(match: any, opts: any): Vow<{
+    /**
+     * @param {Vow<
+     *   IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>
+     * >} match
+     * @param {PacketOptions} opts
+     */
+    sendPacket(match: Vow<IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket">>, opts: PacketOptions): Vow<{
         eventPattern: import("@endo/patterns").Matcher;
         resultV: Vow<void>;
     }>;
 }>;
-export function prepareIBCReplyKit(zone: import("@agoric/base-zone").Zone, vowTools: VowTools): (replyPacketPattern: Pattern, matchV: Vow<any>, opts: PacketOptions) => {
+export function prepareIBCReplyKit(zone: import("@agoric/base-zone").Zone, vowTools: VowTools): <E extends IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket"> = IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket">>(replyPacketPattern: Pattern, matchV: Vow<E>, opts: PacketOptions) => {
     eventPattern: import("@endo/patterns").Matcher;
     resultV: Vow<string>;
 };
@@ -50,12 +70,18 @@ export function prepareIBCTools(zone: import("@agoric/base-zone").Zone, vowTools
     }, transferMsg: import("@agoric/cosmic-proto/ibc/applications/transfer/v1/tx.js").MsgTransfer & {
         '@type': "/ibc.applications.transfer.v1.MsgTransfer";
     }) => import("@endo/exo").Guarded<{
-        sendPacket(match: any, opts: any): Vow<{
+        /**
+         * @param {Vow<
+         *   IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>
+         * >} match
+         * @param {PacketOptions} opts
+         */
+        sendPacket(match: Vow<IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket">>, opts: PacketOptions): Vow<{
             eventPattern: import("@endo/patterns").Matcher;
             resultV: Vow<void>;
         }>;
     }>;
-    makeIBCReplyKit: (replyPacketPattern: Pattern, matchV: Vow<any>, opts: PacketOptions) => {
+    makeIBCReplyKit: <E extends IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket"> = IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket">>(replyPacketPattern: Pattern, matchV: Vow<E>, opts: PacketOptions) => {
         eventPattern: import("@endo/patterns").Matcher;
         resultV: Vow<string>;
     };
@@ -63,10 +89,11 @@ export function prepareIBCTools(zone: import("@agoric/base-zone").Zone, vowTools
 export type MakeIBCReplyKit = ReturnType<typeof prepareIBCReplyKit>;
 import type { Pattern } from '@endo/patterns';
 import type { VowTools } from '@agoric/vow';
+import type { IBCEvent } from '@agoric/vats';
 import type { Vow } from '@agoric/vow';
+import type { PacketOptions } from './packet-tools.js';
 import type { LocalChainAccount } from '@agoric/vats/src/localchain.js';
 import type { TypedJson } from '@agoric/cosmic-proto';
 import type { ResponseTo } from '@agoric/cosmic-proto';
 import type { JsonSafe } from '@agoric/cosmic-proto';
-import type { PacketOptions } from './packet-tools.js';
 //# sourceMappingURL=ibc-packet.d.ts.map

package/src/exos/ibc-packet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ibc-packet.d.ts","sourceRoot":"","sources":["ibc-packet.js"],"names":[],"mappings":"AAMA,4CAA6C,MAAM,CAAC;AAqB7C,gDAHI,GAAG,GACD,OAAO,CAgCnB;AAOM,+CAHI,OAAO,mBAAmB,EAAE,IAAI,8BAChC,QAAQ,GAAG;IAAE,eAAe,EAAE,eAAe,CAAA;CAAE,IA+FhD,GAAG,MAFA,UAAU;eA3EH,iBAAiB,CAAC,WAAW,CAAC;;;;;;;;;;;QAoB1C;;;;;;;;;;;WAWG;oCARQ,CACV,SACA,WACA,UAAkB,2CAA2C,CAAC,CACvD,CACF,CACF,OACO,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;;;;;GA+CrB;;;;;GAChB;AAOM,yCAHI,OAAO,mBAAmB,EAAE,IAAI,YAChC,QAAQ,wBAyBN,OAAO,UACP,IAAI,GAAG,CAAC,QACR,aAAa;;;EAmBzB;AAQM,sCAHI,OAAO,mBAAmB,EAAE,IAAI,YAChC,QAAQ;;mBAvIC,iBAAiB,CAAC,WAAW,CAAC;;;;;;;;;0CA4GrC,OAAO,UACP,IAAI,GAAG,CAAC,QACR,aAAa;;;;EAkCzB;8BAba,UAAU,CAAC,OAAO,kBAAkB,CAAC;6BAxMpB,gBAAgB;8BAEf,aAAa;yBAAb,aAAa;uCACT,gCAAgC;+BAFlB,sBAAsB;gCAAtB,sBAAsB;8BAAtB,sBAAsB;mCAGxC,mBAAmB"}
+{"version":3,"file":"ibc-packet.d.ts","sourceRoot":"","sources":["ibc-packet.js"],"names":[],"mappings":"AAMA,4CAA6C,MAAM,CAAC;AAsB7C,gDAHI,GAAG,GACD,OAAO,CAgCnB;AAOM,+CAHI,OAAO,mBAAmB,EAAE,IAAI,8BAChC,QAAQ,GAAG;IAAE,eAAe,EAAE,eAAe,CAAA;CAAE,IA0GhD,GAAG,MAFA,UAAU;eAtFH,iBAAiB,CAAC,WAAW,CAAC;;;;;QAU1C;;;;;WAKG;0BAJQ,IACV,SAAa,uBAAuB,CAAC,GAAG,SAAS,eAAe,CAAC,CAC9D,QACO,aAAa;;;;;;QAYxB;;;;;;;;;;;;;;;;WAgBG;oCAbQ,CACV,SACA,WACA,UAAkB,2CAA2C,CAAC,CACvD,CACF,CACF,OACO;YACN,IAAI,EAAE,aAAa,CAAC;YACpB,KAAK,EAAE,IACX,SAAe,uBAAuB,CAAC,GAAG,SAAS,eAAe,CAAC,CAC9D,CAAC;SACH;;;;;;;;GA+CK;IA9ET;;;;;OAKG;sBAJQ,IACV,SAAa,uBAAuB,CAAC,GAAG,SAAS,eAAe,CAAC,CAC9D,QACO,aAAa;;;;GA2E/B;AAaM,yCAHI,OAAO,mBAAmB,EAAE,IAAI,YAChC,QAAQ,IAqC6D,CAAC,SAAjE,SAAS,uBAAuB,CAAC,GAAG,SAAS,eAAe,CAAE,sFACjE,OAAO,UACP,IAAI,CAAC,CAAC,QACN,aAAa;;;EAmBzB;AAQM,sCAHI,OAAO,mBAAmB,EAAE,IAAI,YAChC,QAAQ;;mBArKC,iBAAiB,CAAC,WAAW,CAAC;;;;QAU1C;;;;;WAKG;0BAJQ,IACV,SAAa,uBAAuB,CAAC,GAAG,SAAS,eAAe,CAAC,CAC9D,QACO,aAAa;;;;;sBA2HgD,CAAC,SAAjE,SAAS,uBAAuB,CAAC,GAAG,SAAS,eAAe,CAAE,sFACjE,OAAO,UACP,IAAI,CAAC,CAAC,QACN,aAAa;;;;EAkCzB;8BAba,UAAU,CAAC,OAAO,kBAAkB,CAAC;6BAvOpB,gBAAgB;8BAEf,aAAa;8BACP,cAAc;yBADpB,aAAa;mCAGb,mBAAmB;uCADf,gCAAgC;+BAHlB,sBAAsB;gCAAtB,sBAAsB;8BAAtB,sBAAsB"}

package/src/exos/ibc-packet.js

@@ -1,4 +1,4 @@
-import { assertAllDefined, makeTracer } from '@agoric/internal';
+import { makeTracer } from '@agoric/internal';
 import { base64ToBytes, Shape as NetworkShape } from '@agoric/network';
 import { M } from '@endo/patterns';
 import { E } from '@endo/far';
@@ -12,6 +12,7 @@ const trace = makeTracer('IBCP');
  * @import {Key, Pattern} from '@endo/patterns';
  * @import {JsonSafe, TypedJson, ResponseTo} from '@agoric/cosmic-proto';
  * @import {Vow, VowTools} from '@agoric/vow';
+ * @import {IBCEvent, IBCPacket} from '@agoric/vats';
  * @import {LocalChainAccount} from '@agoric/vats/src/localchain.js';
  * @import {PacketOptions} from './packet-tools.js';
  */
@@ -88,6 +89,12 @@ export const prepareIBCTransferSender = (zone, { watch, makeIBCReplyKit }) => {
     }),
     {
       public: {
+        /**
+         * @param {Vow<
+         *   IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>
+         * >} match
+         * @param {PacketOptions} opts
+         */
         sendPacket(match, opts) {
           const { txExecutor, transferMsg } = this.state;
           return watch(
@@ -108,10 +115,15 @@ export const prepareIBCTransferSender = (zone, { watch, makeIBCReplyKit }) => {
          *     >
          *   >,
          * ]} response
-         * @param {Record<string, any>} ctx
+         * @param {{
+         *   opts: PacketOptions;
+         *   match: Vow<
+         *     IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>
+         *   >;
+         * }} ctx
          */
         onFulfilled([{ sequence }], ctx) {
-          const { match } = ctx;
+          const { match, opts } = ctx;
           const { transferMsg } = this.state;
 
           // sequence + sourceChannel uniquely identifies a transfer.
@@ -128,7 +140,7 @@ export const prepareIBCTransferSender = (zone, { watch, makeIBCReplyKit }) => {
           const { resultV: ackDataV, ...rest } = makeIBCReplyKit(
             replyPacketPattern,
             match,
-            ctx,
+            { opName: 'transfer', ...opts },
           );
           const resultV = watch(ackDataV, this.facets.verifyTransferSuccess);
           return harden({ resultV, ...rest });
@@ -160,6 +172,12 @@ export const prepareIBCTransferSender = (zone, { watch, makeIBCReplyKit }) => {
 harden(prepareIBCTransferSender);
 
 /**
+ * `makeIBCReplyKit` creates a pattern for `acknowledgementPacket` and
+ * `timeoutPacket` {@link IBCEvent}s using the provided {@link IBCPacket}
+ * pattern.
+ *
+ * Returns a vow that settles when a match is found.
+ *
  * @param {import('@agoric/base-zone').Zone} zone
  * @param {VowTools} vowTools
  */
@@ -168,14 +186,26 @@ export const prepareIBCReplyKit = (zone, vowTools) => {
   const ibcWatcher = zone.exo(
     'ibcResultWatcher',
     M.interface('processIBCWatcher', {
-      onFulfilled: M.call(M.record(), M.record()).returns(Vow$(M.string())),
+      onFulfilled: M.call(
+        M.splitRecord({ event: M.string() }, { acknowledgement: M.string() }),
+        M.splitRecord({}, { opName: M.string(), timeout: M.record() }),
+      ).returns(Vow$(M.string())),
     }),
     {
-      onFulfilled({ event, acknowledgement }, { opName = 'unknown' }) {
-        assertAllDefined({ event, acknowledgement });
+      /**
+       * @param {IBCEvent<'acknowledgementPacket'>
+       *   | IBCEvent<'timeoutPacket'>} ibcEvent
+       * @param {PacketOptions} ctx
+       */
+      onFulfilled(ibcEvent, { opName = 'unknown' }) {
+        const { event } = ibcEvent;
         switch (event) {
-          case 'acknowledgementPacket':
+          case 'acknowledgementPacket': {
+            const { acknowledgement } = ibcEvent;
+            acknowledgement ||
+              Fail`acknowledgementPacket missing 'acknowledgement'`;
             return base64ToBytes(acknowledgement);
+          }
           case 'timeoutPacket':
             throw Fail`${bare(opName)} operation received timeout packet`;
           default:
@@ -186,8 +216,9 @@ export const prepareIBCReplyKit = (zone, vowTools) => {
   );
 
   /**
+   * @template {IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>} [E=IBCEvent<'acknowledgementPacket'>| IBCEvent<'timeoutPacket'>]
    * @param {Pattern} replyPacketPattern
-   * @param {Vow<any>} matchV
+   * @param {Vow<E>} matchV
    * @param {PacketOptions} opts
    */
   const makeIBCReplyKit = (replyPacketPattern, matchV, opts) => {

package/src/exos/packet-tools.d.ts

@@ -29,7 +29,7 @@ export type MatchEvent = (pattern: EVow<Pattern>) => Vow<{
     match: Vow<any>;
 }>;
 export type PacketSender = {
-    sendPacket: (opts: PacketOptions) => Vow<{
+    sendPacket: (match: Vow<IBCEvent<"acknowledgementPacket"> | IBCEvent<"timeoutPacket">>, opts: PacketOptions) => Vow<{
         eventPattern: Pattern;
         resultV: Vow<any>;
     }>;
@@ -48,4 +48,5 @@ import type { EVow } from '@agoric/vow';
 import type { VowResolver } from '@agoric/vow';
 import type { Vow } from '@agoric/vow';
 import type { Remote } from '@agoric/vow';
+import type { IBCEvent } from '@agoric/vats';
 //# sourceMappingURL=packet-tools.d.ts.map

package/src/exos/packet-tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packet-tools.d.ts","sourceRoot":"","sources":["packet-tools.js"],"names":[],"mappings":"AA+DO,yCAHI,OAAO,mBAAmB,EAAE,IAAI,YAChC,QAAQ;;;;;;;;IAiFX;;OAEG;8BADQ,IAAI,CAAC,SAAS,CAAC;;;;8BAnHvB,KAAK,OAAO,CAAC,GACX,IAAI;QAAE,QAAQ,EAAE,YAAY,GAAG,CAAC,CAAC;QAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAA;KAAE,CAAC;IAsIzD;;;;OAIG;qCAHQ,OAAO,YAAY,CAAC,SACpB,aAAa,GACX,IAAI,GAAG,CAAC;GAyM5B;mCAnVU,KAAK,OAAO,CAAC,KACX,IAAI;IAAE,QAAQ,EAAE,YAAY,GAAG,CAAC,CAAC;IAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAA;CAAE,CAAC;;gBAKnD,CACT,IAAI,EAAE,aAAa,KAChB,IAAI;QAAE,YAAY,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,IAAI,GAAG,CAAC,CAAA;KAAE,CAAC;;;;;;4BAU5C,IAAI,CAChB,OAAW,eAAe,EAAE,qBAAqB,EACjD,eAAmB,GAAG,kBAAkB,CACrC;0BAkUS,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;8BA/VZ,aAAa;6BAD9C,gBAAgB;+BAIM,mCAAmC;wCAAnC,mCAAmC;0BAHxB,aAAa;iCAAb,aAAa;yBAAb,aAAa;4BAAb,aAAa"}
+{"version":3,"file":"packet-tools.d.ts","sourceRoot":"","sources":["packet-tools.js"],"names":[],"mappings":"AAgEO,yCAHI,OAAO,mBAAmB,EAAE,IAAI,YAChC,QAAQ;;;;;;;;IAiFX;;OAEG;8BADQ,IAAI,CAAC,SAAS,CAAC;;;;8BApHvB,KAAK,OAAO,CAAC,GACX,IAAI;QAAE,QAAQ,EAAE,YAAY,GAAG,CAAC,CAAC;QAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAA;KAAE,CAAC;IAuIzD;;;;OAIG;qCAHQ,OAAO,YAAY,CAAC,SACpB,aAAa,GACX,IAAI,GAAG,CAAC;GAqN5B;mCAhWU,KAAK,OAAO,CAAC,KACX,IAAI;IAAE,QAAQ,EAAE,YAAY,GAAG,CAAC,CAAC;IAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAA;CAAE,CAAC;;gBAKnD,CACT,KAAK,EAAE,IAAI,SAAS,uBAAuB,CAAC,GAAG,SAAS,eAAe,CAAC,CAAC,EACzE,IAAI,EAAE,aAAa,KAChB,IAAI;QAAE,YAAY,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,IAAI,GAAG,CAAC,CAAA;KAAE,CAAC;;;;;;4BAU5C,IAAI,CAChB,OAAW,eAAe,EAAE,qBAAqB,EACjD,eAAmB,GAAG,kBAAkB,CACrC;0BA8US,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;8BA5WZ,aAAa;6BAD9C,gBAAgB;+BAIM,mCAAmC;wCAAnC,mCAAmC;0BAHxB,aAAa;iCAAb,aAAa;yBAAb,aAAa;4BAAb,aAAa;8BAE1B,cAAc"}

package/src/exos/packet-tools.js

@@ -20,7 +20,7 @@ const just = obj => {
  * @import {Pattern} from '@endo/patterns';
  * @import {EVow, Remote, Vow, VowResolver, VowTools} from '@agoric/vow';
  * @import {LocalChainAccount} from '@agoric/vats/src/localchain.js';
- * @import {VTransferIBCEvent} from '@agoric/vats';
+ * @import {IBCEvent, VTransferIBCEvent} from '@agoric/vats';
  * @import {TargetApp, TargetRegistration} from '@agoric/vats/src/bridge-target.js';
  */
 
@@ -33,6 +33,7 @@ const just = obj => {
 /**
  * @typedef {object} PacketSender
  * @property {(
+ *   match: Vow<IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>>,
  *   opts: PacketOptions,
  * ) => Vow<{ eventPattern: Pattern; resultV: Vow<any> }>} sendPacket
  */
@@ -241,6 +242,18 @@ export const preparePacketTools = (zone, vowTools) => {
         },
       },
       sendPacketWatcher: {
+        /**
+         * @param {[
+         *   {
+         *     resolver: VowResolver<any>;
+         *     match: Vow<
+         *       IBCEvent<'acknowledgementPacket'> | IBCEvent<'timeoutPacket'>
+         *     >;
+         *   },
+         *   Remote<PacketSender>,
+         * ]} result
+         * @param {{ opts: PacketOptions }} ctx
+         */
         onFulfilled([{ match }, sender], ctx) {
           return watch(E(sender).sendPacket(match, ctx.opts));
         },

package/tools/ibc-mocks.d.ts

@@ -5,7 +5,7 @@ import { Any } from '@agoric/cosmic-proto/google/protobuf/any.js';
 import type { PacketSDKType } from '@agoric/cosmic-proto/ibc/core/channel/v1/channel.js';
 import { RequestQuery, ResponseQuery } from '@agoric/cosmic-proto/tendermint/abci/types.js';
 import type { IBCChannelID, IBCEvent, VTransferIBCEvent } from '@agoric/vats';
-import type { AccountId, CosmosChainAddress } from '../src/orchestration-api.js';
+import type { CosmosChainAddress, Denom } from '../src/orchestration-api.js';
 interface EncoderCommon<T> {
     encode: (message: T) => {
         finish: () => Uint8Array;
@@ -62,18 +62,59 @@ export declare const parseOutgoingTxPacket: (b64: string) => TxBody;
  * @returns {string}
  */
 export declare function buildQueryPacketString(msgs: Any[], opts?: Partial<Omit<RequestQuery, 'path' | 'data'>>): string;
-type BuildVTransferEventParams = {
-    event?: VTransferIBCEvent['event'];
-    sender?: CosmosChainAddress['value'];
-    receiver?: AccountId | CosmosChainAddress['value'];
-    target?: CosmosChainAddress['value'];
+/**
+ * Fields that are common to every vtransfer IBC event.
+ */
+type BuildVTransferEventBaseParams = {
+    /**
+     * defaults to `cosmos1AccAddress` – set to `agoric1fakeLCAAddress` to
+     *  simulate an outgoing transfer.
+     */
+    sender?: CosmosChainAddress['value'] | string;
+    /**
+     * defaults to `agoric1fakeLCAAddress` – set differently to simulate
+     *  an outgoing transfer.
+     */
+    receiver?: CosmosChainAddress['value'] | string;
+    target?: CosmosChainAddress['value'] | string;
     amount?: bigint;
-    denom?: string;
+    denom?: Denom;
     destinationChannel?: IBCChannelID;
     sourceChannel?: IBCChannelID;
+    /** supports `bigint` or `string` so tests can pass encoded numbers */
     sequence?: PacketSDKType['sequence'] | JsonSafe<PacketSDKType['sequence']>;
     memo?: string;
 };
+/**
+ * Parameters allowed for the ACK-carrying events.
+ */
+type VTransferAckParams = BuildVTransferEventBaseParams & {
+    event?: 'acknowledgementPacket' | 'writeAcknowledgement';
+    /**
+     * if present, helper encodes `{ error: acknowledgementError }`
+     *  instead of the success result
+     */
+    acknowledgementError?: string;
+    /** override the default `"agoric123"` relayer address */
+    relayer?: string;
+};
+/**
+ * Parameters allowed for a timeout event (no ack/relayer).
+ */
+type VTransferTimeoutParams = BuildVTransferEventBaseParams & {
+    event: 'timeoutPacket';
+    acknowledgementError?: never;
+    relayer?: never;
+};
+type VTransferParams = VTransferAckParams | VTransferTimeoutParams;
+/** helper to turn param object into correct return */
+type ExtractEvent<P> = P extends {
+    event: infer Ev;
+} ? Ev extends undefined ? 'acknowledgementPacket' : Ev : 'acknowledgementPacket';
+type BuildVTransferEventResult<P extends VTransferParams> = VTransferByEvent<ExtractEvent<P>>;
+type VTransferByEvent<E extends VTransferIBCEvent['event']> = Extract<VTransferIBCEvent, {
+    event: E;
+}>;
 /**
  * `buildVTransferEvent` can be used with `transferBridge` to simulate incoming
  * and outgoing IBC fungible tokens transfers to a LocalChain account.
@@ -96,10 +137,8 @@ type BuildVTransferEventParams = {
  *
  * XXX integrate vlocalchain and vtransfer ScopedBridgeManagers
  * in test supports.
- *
- * @param {{BuildVTransferEventParams}} args
  */
-export declare const buildVTransferEvent: ({ event, sender, receiver, target, amount, denom, destinationChannel, sourceChannel, sequence, memo, }?: BuildVTransferEventParams) => VTransferIBCEvent;
+export declare function buildVTransferEvent<P extends VTransferParams>(params: P): BuildVTransferEventResult<P>;
 export declare function createMockAckMap(mockMap: Record<string, {
     msg: string;
     ack: string;

package/tools/ibc-mocks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ibc-mocks.d.ts","sourceRoot":"","sources":["ibc-mocks.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,OAAO,EAAE,KAAK,QAAQ,EAAsB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,8CAA8C,CAAC;AACtE,OAAO,EAAE,GAAG,EAAE,MAAM,6CAA6C,CAAC;AAElE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qDAAqD,CAAC;AAEzF,OAAO,EACL,YAAY,EACZ,aAAa,EACd,MAAM,+CAA+C,CAAC;AAKvD,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EAER,iBAAiB,EAClB,MAAM,cAAc,CAAC;AAGtB,OAAO,KAAK,EACV,SAAS,EACT,kBAAkB,EACnB,MAAM,6BAA6B,CAAC;AAGrC,UAAU,aAAa,CAAC,CAAC;IACvB,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK;QACtB,MAAM,EAAE,MAAM,UAAU,CAAC;KAC1B,CAAC;IACF,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;CACjB;AAKD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,EACzB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,MAAM,CAkBR;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,SAAgE,GAClE,MAAM,CAIR;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EACxC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,EACzB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EACjB,IAAI,GAAE,IAAI,CAAC,aAAa,EAAE,KAAK,CAQ9B,GACA,MAAM,CAeR;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAAE,GAC7C,MAAM,CAER;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,KAAK,MAAM,WAEhD,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,GAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,CAAM,GACtD,MAAM,CAER;AAED,KAAK,yBAAyB,GAAG;IAC/B,KAAK,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEnC,MAAM,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACnD,MAAM,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClC,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B,QAAQ,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,mBAAmB,GAAI,yGAWjC,yBAA8B,KAAG,iBA0BlC,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,MAOtD;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,GAAI,yBAG3C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAM,KAAG,OAAO,CACxD,QAAQ,CAAC,qBAAqB,CAAC,CAQ/B,CAAC"}
+{"version":3,"file":"ibc-mocks.d.ts","sourceRoot":"","sources":["ibc-mocks.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,OAAO,EAAE,KAAK,QAAQ,EAAsB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,8CAA8C,CAAC;AACtE,OAAO,EAAE,GAAG,EAAE,MAAM,6CAA6C,CAAC;AAElE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qDAAqD,CAAC;AAEzF,OAAO,EACL,YAAY,EACZ,aAAa,EACd,MAAM,+CAA+C,CAAC;AAKvD,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EAER,iBAAiB,EAClB,MAAM,cAAc,CAAC;AAGtB,OAAO,KAAK,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAG7E,UAAU,aAAa,CAAC,CAAC;IACvB,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK;QACtB,MAAM,EAAE,MAAM,UAAU,CAAC;KAC1B,CAAC;IACF,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;CACjB;AAKD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,EACzB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,MAAM,CAkBR;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,SAAgE,GAClE,MAAM,CAIR;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EACxC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,EACzB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EACjB,IAAI,GAAE,IAAI,CAAC,aAAa,EAAE,KAAK,CAQ9B,GACA,MAAM,CAeR;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAAE,GAC7C,MAAM,CAER;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,KAAK,MAAM,WAEhD,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,GAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,CAAM,GACtD,MAAM,CAER;AAED;;GAEG;AACH,KAAK,6BAA6B,GAAG;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAE9C;;;OAGG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAEhD,MAAM,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClC,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B,sEAAsE;IACtE,QAAQ,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,KAAK,kBAAkB,GAAG,6BAA6B,GAAG;IACxD,KAAK,CAAC,EAAE,uBAAuB,GAAG,sBAAsB,CAAC;IACzD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,KAAK,sBAAsB,GAAG,6BAA6B,GAAG;IAC5D,KAAK,EAAE,eAAe,CAAC;IACvB,oBAAoB,CAAC,EAAE,KAAK,CAAC;IAC7B,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC;AAEF,KAAK,eAAe,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;AAEnE,sDAAsD;AACtD,KAAK,YAAY,CAAC,CAAC,IAEjB,CAAC,SAAS;IAAE,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,GAEzB,EAAE,SAAS,SAAS,GAClB,uBAAuB,GACvB,EAAE,GAEJ,uBAAuB,CAAC;AAE9B,KAAK,yBAAyB,CAAC,CAAC,SAAS,eAAe,IAAI,gBAAgB,CAC1E,YAAY,CAAC,CAAC,CAAC,CAChB,CAAC;AAEF,KAAK,gBAAgB,CAAC,CAAC,SAAS,iBAAiB,CAAC,OAAO,CAAC,IAAI,OAAO,CACnE,iBAAiB,EACjB;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,eAAe,EAC3D,MAAM,EAAE,CAAC,GACR,yBAAyB,CAAC,CAAC,CAAC,CA4D9B;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,MAOtD;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,GAAI,yBAG3C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAM,KAAG,OAAO,CACxD,QAAQ,CAAC,qBAAqB,CAAC,CAQ/B,CAAC"}

package/tools/ibc-mocks.ts

@@ -21,10 +21,7 @@ import type {
 } from '@agoric/vats';
 import { LOCALCHAIN_DEFAULT_ADDRESS } from '@agoric/vats/tools/fake-bridge.js';
 import { atob, btoa, decodeBase64, encodeBase64 } from '@endo/base64';
-import type {
-  AccountId,
-  CosmosChainAddress,
-} from '../src/orchestration-api.js';
+import type { CosmosChainAddress, Denom } from '../src/orchestration-api.js';
 import { makeQueryPacket, makeTxPacket } from '../src/utils/packet.js';
 
 interface EncoderCommon<T> {
@@ -155,22 +152,78 @@ export function buildQueryPacketString(
   return btoa(makeQueryPacket(msgs.map(msg => toRequestQueryJson(msg, opts))));
 }
 
-type BuildVTransferEventParams = {
-  event?: VTransferIBCEvent['event'];
-  /* defaults to cosmos1AccAddress. set to `agoric1fakeLCAAddress` to simulate an outgoing transfer event */
-  sender?: CosmosChainAddress['value'];
-  /*  defaults to agoric1fakeLCAAddress. set to a different value to simulate an outgoing transfer event */
-  receiver?: AccountId | CosmosChainAddress['value'];
-  target?: CosmosChainAddress['value'];
+/**
+ * Fields that are common to every vtransfer IBC event.
+ */
+type BuildVTransferEventBaseParams = {
+  /**
+   * defaults to `cosmos1AccAddress` – set to `agoric1fakeLCAAddress` to
+   *  simulate an outgoing transfer.
+   */
+  sender?: CosmosChainAddress['value'] | string;
+
+  /**
+   * defaults to `agoric1fakeLCAAddress` – set differently to simulate
+   *  an outgoing transfer.
+   */
+  receiver?: CosmosChainAddress['value'] | string;
+
+  target?: CosmosChainAddress['value'] | string;
   amount?: bigint;
-  denom?: string;
+  denom?: Denom;
   destinationChannel?: IBCChannelID;
   sourceChannel?: IBCChannelID;
-  /* support bigint and string, to facilitate bootstrap testing */
+
+  /** supports `bigint` or `string` so tests can pass encoded numbers */
   sequence?: PacketSDKType['sequence'] | JsonSafe<PacketSDKType['sequence']>;
   memo?: string;
 };
 
+/**
+ * Parameters allowed for the ACK-carrying events.
+ */
+type VTransferAckParams = BuildVTransferEventBaseParams & {
+  event?: 'acknowledgementPacket' | 'writeAcknowledgement';
+  /**
+   * if present, helper encodes `{ error: acknowledgementError }`
+   *  instead of the success result
+   */
+  acknowledgementError?: string;
+  /** override the default `"agoric123"` relayer address */
+  relayer?: string;
+};
+
+/**
+ * Parameters allowed for a timeout event (no ack/relayer).
+ */
+type VTransferTimeoutParams = BuildVTransferEventBaseParams & {
+  event: 'timeoutPacket';
+  acknowledgementError?: never;
+  relayer?: never;
+};
+
+type VTransferParams = VTransferAckParams | VTransferTimeoutParams;
+
+/** helper to turn param object into correct return */
+type ExtractEvent<P> =
+  // event present?
+  P extends { event: infer Ev }
+    ? // undefined means “use default”
+      Ev extends undefined
+      ? 'acknowledgementPacket'
+      : Ev
+    : // no `event` entry, use default
+      'acknowledgementPacket';
+
+type BuildVTransferEventResult<P extends VTransferParams> = VTransferByEvent<
+  ExtractEvent<P>
+>;
+
+type VTransferByEvent<E extends VTransferIBCEvent['event']> = Extract<
+  VTransferIBCEvent,
+  { event: E }
+>;
+
 /**
  * `buildVTransferEvent` can be used with `transferBridge` to simulate incoming
  * and outgoing IBC fungible tokens transfers to a LocalChain account.
@@ -193,47 +246,70 @@ type BuildVTransferEventParams = {
  *
  * XXX integrate vlocalchain and vtransfer ScopedBridgeManagers
  * in test supports.
- *
- * @param {{BuildVTransferEventParams}} args
  */
-export const buildVTransferEvent = ({
-  event = 'acknowledgementPacket' as const,
-  sender = 'cosmos1AccAddress',
-  receiver = LOCALCHAIN_DEFAULT_ADDRESS,
-  target = LOCALCHAIN_DEFAULT_ADDRESS,
-  amount = 10n,
-  denom = 'uatom',
-  destinationChannel = 'channel-0' as IBCChannelID,
-  sourceChannel = 'channel-405' as IBCChannelID,
-  sequence = 0n,
-  memo = '',
-}: BuildVTransferEventParams = {}): VTransferIBCEvent => ({
-  type: VTRANSFER_IBC_EVENT,
-  blockHeight: 0,
-  blockTime: 0,
-  event,
-  acknowledgement: btoa(JSON.stringify({ result: 'AQ==' })),
-  relayer: 'agoric123',
-  target,
-  packet: {
-    data: btoa(
+export function buildVTransferEvent<P extends VTransferParams>(
+  params: P,
+): BuildVTransferEventResult<P> {
+  const {
+    event = 'acknowledgementPacket',
+    sender = 'cosmos1AccAddress',
+    receiver = LOCALCHAIN_DEFAULT_ADDRESS,
+    target = LOCALCHAIN_DEFAULT_ADDRESS,
+    amount = 10n,
+    denom = 'uatom',
+    destinationChannel = 'channel-0',
+    sourceChannel = 'channel-405',
+    sequence = 0n,
+    memo = '',
+    relayer = 'agoric123',
+    acknowledgementError,
+  } = params satisfies VTransferParams;
+
+  const base = {
+    type: VTRANSFER_IBC_EVENT,
+    blockHeight: 0,
+    blockTime: 0,
+    event,
+    target,
+    packet: {
+      data: btoa(
+        JSON.stringify(
+          FungibleTokenPacketData.fromPartial({
+            amount: String(amount),
+            denom,
+            sender,
+            receiver,
+            memo,
+          }),
+        ),
+      ),
+      destination_channel: destinationChannel as IBCChannelID,
+      source_channel: sourceChannel as IBCChannelID,
+      destination_port: 'transfer',
+      source_port: 'transfer',
+      // @ts-expect-error – supports `bigint` or `string` so tests can pass encoded numbers
+      sequence,
+    } satisfies IBCPacket,
+  };
+
+  /** `timeoutPacket` */
+  if (event === 'timeoutPacket') {
+    return base as BuildVTransferEventResult<P>;
+  }
+
+  /** `acknowledgementPacket`, `writeAcknowledgement`*/
+  return {
+    ...base,
+    relayer,
+    acknowledgement: btoa(
       JSON.stringify(
-        FungibleTokenPacketData.fromPartial({
-          amount: String(amount),
-          denom,
-          sender,
-          receiver,
-          memo,
-        }),
+        acknowledgementError
+          ? { error: acknowledgementError }
+          : { result: 'AQ==' },
       ),
     ),
-    destination_channel: destinationChannel,
-    source_channel: sourceChannel,
-    destination_port: 'transfer',
-    source_port: 'transfer',
-    sequence,
-  } as IBCPacket,
-});
+  } as BuildVTransferEventResult<P>;
+}
 
 export function createMockAckMap(
   mockMap: Record<string, { msg: string; ack: string }>,