@agoric/vats 0.15.2-dev-6d71e87.0 → 0.15.2-dev-b9091ce.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/package.json +16 -16
  2. package/src/types.d.ts +20 -23
  3. package/src/types.d.ts.map +1 -1
  4. package/src/types.ts +29 -24
  5. package/tools/fake-bridge.d.ts.map +1 -1
  6. package/tools/fake-bridge.js +13 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agoric/vats",
3
- "version": "0.15.2-dev-6d71e87.0+6d71e87",
3
+ "version": "0.15.2-dev-b9091ce.0+b9091ce",
4
4
  "description": "Agoric's Vat library",
5
5
  "type": "module",
6
6
  "main": "./index.js",
@@ -22,19 +22,19 @@
22
22
  "author": "Agoric",
23
23
  "license": "Apache-2.0",
24
24
  "dependencies": {
25
- "@agoric/cosmic-proto": "0.4.1-dev-6d71e87.0+6d71e87",
26
- "@agoric/ertp": "0.16.3-dev-6d71e87.0+6d71e87",
27
- "@agoric/governance": "0.10.4-dev-6d71e87.0+6d71e87",
28
- "@agoric/internal": "0.3.3-dev-6d71e87.0+6d71e87",
29
- "@agoric/network": "0.1.1-dev-6d71e87.0+6d71e87",
30
- "@agoric/notifier": "0.6.3-dev-6d71e87.0+6d71e87",
31
- "@agoric/store": "0.9.3-dev-6d71e87.0+6d71e87",
32
- "@agoric/swingset-vat": "0.32.3-dev-6d71e87.0+6d71e87",
33
- "@agoric/time": "0.3.3-dev-6d71e87.0+6d71e87",
34
- "@agoric/vat-data": "0.5.3-dev-6d71e87.0+6d71e87",
35
- "@agoric/vow": "0.1.1-dev-6d71e87.0+6d71e87",
36
- "@agoric/zoe": "0.26.3-dev-6d71e87.0+6d71e87",
37
- "@agoric/zone": "0.2.3-dev-6d71e87.0+6d71e87",
25
+ "@agoric/cosmic-proto": "0.4.1-dev-b9091ce.0+b9091ce",
26
+ "@agoric/ertp": "0.16.3-dev-b9091ce.0+b9091ce",
27
+ "@agoric/governance": "0.10.4-dev-b9091ce.0+b9091ce",
28
+ "@agoric/internal": "0.3.3-dev-b9091ce.0+b9091ce",
29
+ "@agoric/network": "0.1.1-dev-b9091ce.0+b9091ce",
30
+ "@agoric/notifier": "0.6.3-dev-b9091ce.0+b9091ce",
31
+ "@agoric/store": "0.9.3-dev-b9091ce.0+b9091ce",
32
+ "@agoric/swingset-vat": "0.32.3-dev-b9091ce.0+b9091ce",
33
+ "@agoric/time": "0.3.3-dev-b9091ce.0+b9091ce",
34
+ "@agoric/vat-data": "0.5.3-dev-b9091ce.0+b9091ce",
35
+ "@agoric/vow": "0.1.1-dev-b9091ce.0+b9091ce",
36
+ "@agoric/zoe": "0.26.3-dev-b9091ce.0+b9091ce",
37
+ "@agoric/zone": "0.2.3-dev-b9091ce.0+b9091ce",
38
38
  "@endo/errors": "^1.2.10",
39
39
  "@endo/far": "^1.1.11",
40
40
  "@endo/import-bundle": "^1.4.0",
@@ -47,7 +47,7 @@
47
47
  "jessie.js": "^0.3.4"
48
48
  },
49
49
  "devDependencies": {
50
- "@agoric/swingset-liveslots": "0.10.3-dev-6d71e87.0+6d71e87",
50
+ "@agoric/swingset-liveslots": "0.10.3-dev-b9091ce.0+b9091ce",
51
51
  "@endo/bundle-source": "^4.0.0",
52
52
  "@endo/init": "^1.1.9",
53
53
  "ava": "^5.3.0",
@@ -79,5 +79,5 @@
79
79
  "typeCoverage": {
80
80
  "atLeast": 90.49
81
81
  },
82
- "gitHead": "6d71e877bc133484d89e4e44ec534d5283a30eb3"
82
+ "gitHead": "b9091ce4718c00fc3981445b2d76afb1c0134540"
83
83
  }
package/src/types.d.ts CHANGED
@@ -138,7 +138,7 @@ export type ConnectingInfo = {
138
138
  asyncVersions?: boolean;
139
139
  };
140
140
  /** see [ibc_module.go](../../../golang/cosmos/x/vibc/types/ibc_module.go) */
141
- export type IBCBridgeEvent = 'channelOpenInit' | 'channelOpenTry' | 'channelOpenAck' | 'channelOpenConfirm' | 'receivePacket' | 'acknowledgementPacket' | 'timeoutPacket' | 'channelCloseInit' | 'channelCloseConfirm' | 'sendPacket';
141
+ export type IBCBridgeEvent = 'writeAcknowledgement' | 'channelOpenInit' | 'channelOpenTry' | 'channelOpenAck' | 'channelOpenConfirm' | 'channelCloseInit' | 'channelCloseConfirm' | 'receivePacket' | 'acknowledgementPacket' | 'timeoutPacket' | 'sendPacket';
142
142
  type IBCPacketEvents = {
143
143
  channelOpenInit: ConnectingInfo;
144
144
  channelOpenTry: ConnectingInfo;
@@ -152,6 +152,11 @@ type IBCPacketEvents = {
152
152
  packet: IBCPacket;
153
153
  relayer: string;
154
154
  };
155
+ writeAcknowledgement: {
156
+ acknowledgement: Bytes;
157
+ packet: IBCPacket;
158
+ relayer: string;
159
+ };
155
160
  timeoutPacket: {
156
161
  packet: IBCPacket;
157
162
  };
@@ -168,11 +173,18 @@ type IBCPacketEvents = {
168
173
  packet: IBCPacket;
169
174
  };
170
175
  };
171
- export type IBCEvent<E extends IBCBridgeEvent> = {
172
- type: 'IBC_EVENT';
176
+ /**
177
+ * ActionTypes as specified by `vibc` and `vtransfer`. This list is expected to
178
+ * grow as more IBC Applications modules are implemented.
179
+ */
180
+ type IBCEventType = 'IBC_EVENT' | 'VTRANSFER_IBC_EVENT';
181
+ export type IBCEvent<E extends IBCBridgeEvent, T extends IBCEventType = 'IBC_EVENT'> = {
182
+ type: T;
173
183
  blockHeight: number;
174
184
  blockTime: number;
175
185
  event: E;
186
+ /** e.g. the chain address of the LocalChainAccount */
187
+ target?: string;
176
188
  } & {
177
189
  [K in keyof IBCPacketEvents[E]]: IBCPacketEvents[E][K];
178
190
  };
@@ -234,26 +246,11 @@ type SendPacketDownCall = {
234
246
  * This event is emitted when a FungibleTokenPacket is sent or received
235
247
  * by a target (e.g. a {@link LocalChainAccount}) that has a registered
236
248
  * {@link TargetApp}. It is passed through the `receiveUpcall` handler.
249
+ *
250
+ * For ICS-20 transfer (including `MsgTransfer`), the `packet.data` field is a
251
+ * {@link FungibleTokenPacketData} object, and you can use
252
+ * `JSON.parse(atob(packet.data))` to extract it.
237
253
  */
238
- export type VTransferIBCEvent = {
239
- type: 'VTRANSFER_IBC_EVENT';
240
- blockHeight: number;
241
- blockTime: number;
242
- /**
243
- * Indicates the type of IBC packet event:
244
- * - 'acknowledgementPacket': passive tap that communicates the result of an acknowledged packet
245
- * - 'writeAcknowledgement': active tap where the receiver can return a write acknowledgement
246
- */
247
- event: 'acknowledgementPacket' | 'writeAcknowledgement';
248
- acknowledgement: Bytes;
249
- /**
250
- * Use `JSON.parse(atob(packet.data))` to get a
251
- * {@link FungibleTokenPacketData} object.
252
- */
253
- packet: IBCPacket;
254
- relayer: string;
255
- /** e.g. the chain address of the LocalChainAccount */
256
- target: string;
257
- };
254
+ export type VTransferIBCEvent = IBCEvent<'acknowledgementPacket', 'VTRANSFER_IBC_EVENT'> | IBCEvent<'writeAcknowledgement', 'VTRANSFER_IBC_EVENT'> | IBCEvent<'timeoutPacket', 'VTRANSFER_IBC_EVENT'>;
258
255
  export {};
259
256
  //# sourceMappingURL=types.d.ts.map
package/src/types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qDAAqD,CAAC;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAIrD,MAAM,MAAM,KAAK,GAAG,UAAU,CAC5B,UAAU,CAAC,cAAc,gBAAgB,EAAE,eAAe,CAAC,CAC5D,CAAC,OAAO,CAAC,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,GAAG,GAAG,IAAI;IACjC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAC9B;;;OAGG;IACH,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5C,2DAA2D;IAC3D,OAAO,EAAE,CAAC,eAAe,CAAC,EAAE,OAAO,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;IAC1D,qDAAqD;IACrD,IAAI,EAAE,MAAM,MAAM,EAAE,CAAC;IACrB,sDAAsD;IACtD,MAAM,EAAE,MAAM,KAAK,EAAE,CAAC;CACvB,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,SAAS,GAAG;IACtB,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IACxE;;;;OAIG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC;;;OAGG;IACH,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,SAAS,KAAK,CAAC,CAAC;IAClE,yDAAyD;IACzD,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;IAChE;;;;OAIG;IACH,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;IACnE;;;OAGG;IACH,WAAW,EAAE,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACvD,0EAA0E;IAC1E,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9B,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB;;;;OAIG;IACH,QAAQ,EAAE,CAAC,EAAE,EAAE,SAAS,GAAG,oBAAoB,KAAK,IAAI,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,oFAAoF;IACpF,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC;CAC3C,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,UAAU,GAAG;IACvB,kBAAkB;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,mBAAmB;IACnB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG;IAC3C,YAAY,IAAI,MAAM,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG;IAC5C,YAAY,CACV,IAAI,EAAE,MAAM,EACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,kBAAkB,CAAC;KAC/B,CAAC,CAAC;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACxD,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,aAAa,GAAG;IAC1B,gCAAgC;IAChC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,QAAQ,IAAI;IAC3D;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;IACtB,uCAAuC;IACvC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,qCAAqC;IACrC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;IACtD,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;CACtD,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,QAAQ,IAAI,OAAO,CAC3D,0BAA0B,CAAC,CAAC,CAAC,CAC9B,CAAC;AAEF,uCAAuC;AACvC,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,CAAC,CAAC,SAAS,QAAQ,EAC3B,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC,KAC5B,mBAAmB,CAAC,CAAC,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,YAAY,GAAG,WAAW,MAAM,EAAE,CAAC;AAC/C,MAAM,MAAM,eAAe,GAAG,cAAc,MAAM,EAAE,CAAC;AACrD,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,WAAW,CAAC;AAEzD,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;IAC/B,IAAI,EAAE,KAAK,CAAC;IACZ,cAAc,EAAE,YAAY,CAAC;IAC7B,WAAW,EAAE,SAAS,CAAC;IACvB,mBAAmB,EAAE,YAAY,CAAC;IAClC,gBAAgB,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACrC,cAAc,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;IACjD,iBAAiB,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CACxD,CAAC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,SAAS,CAAC;IACnB,UAAU,EAAE,YAAY,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,cAAc,EAAE,eAAe,EAAE,CAAC;IAClC,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,YAAY,CAAC;IACxB,YAAY,EAAE,eAAe,CAAC;IAC9B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,6EAA6E;AAC7E,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,uBAAuB,GACvB,eAAe,GACf,kBAAkB,GAClB,qBAAqB,GACrB,YAAY,CAAC;AAEjB,KAAK,eAAe,GAAG;IACrB,eAAe,EAAE,cAAc,CAAC;IAChC,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,kBAAkB,EAAE,cAAc,CAAC;IACnC,aAAa,EAAE;QACb,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,qBAAqB,EAAE;QACrB,eAAe,EAAE,KAAK,CAAC;QACvB,MAAM,EAAE,SAAS,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,aAAa,EAAE;QACb,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,gBAAgB,EAAE;QAAE,SAAS,EAAE,YAAY,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;IACjE,mBAAmB,EAAE;QAAE,SAAS,EAAE,YAAY,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;IACpE,UAAU,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,cAAc,IAAI;IAC/C,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,CAAC,CAAC;CACV,GAAG;KACD,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,iBAAiB,GACzB,YAAY,GACZ,iBAAiB,GACjB,iBAAiB,GACjB,sBAAsB,GACtB,uBAAuB,GACvB,UAAU,GACV,iBAAiB,GACjB,kBAAkB,CAAC;AAEvB,KAAK,eAAe,GAAG;IACrB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,eAAe,EAAE,sBAAsB,CAAC;IACxC,eAAe,EAAE;QACf,MAAM,EAAE,SAAS,CAAC;QAClB,GAAG,EAAE,KAAK,CAAC;KACZ,CAAC;IACF,oBAAoB,EAAE,uBAAuB,CAAC;IAC9C,qBAAqB,EAAE;QACrB,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,aAAa,GAAG,gBAAgB,CAAC,CAAC;KAC3D,CAAC;IACF,QAAQ,EAAE;QAAE,MAAM,EAAE;YAAE,WAAW,EAAE,SAAS,CAAA;SAAE,CAAA;KAAE,CAAC;IACjD,eAAe,EAAE;QACf,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,gBAAgB,EAAE,sBAAsB,CAAC;CAC1C,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,UAAU,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,iBAAiB,IAAI;IACnD,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,CAAC,CAAC;CACX,GAAG;KACD,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,iBAAiB,IAAI;KACpD,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,iBAAiB,IACvD,CAAC,SAAS,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AAEhE,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,iBAAiB,IACvD,eAAe,CAAC,CAAC,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAE7D,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,uBAAuB,GAAG,uBAAuB,GAAG;IACvD,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,kBAAkB,GAAG,aAAa,CAAC,CAAC;CAC7D,CAAC;AAEF,KAAK,sBAAsB,GAAG,uBAAuB,GAAG;IACtD,MAAM,EAAE,IAAI,CACV,SAAS,EACP,kBAAkB,GAClB,aAAa,GACb,qBAAqB,GACrB,gBAAgB,CACnB,CAAC;CACH,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,SAAS,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,qBAAqB,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,KAAK,EAAE,uBAAuB,GAAG,sBAAsB,CAAC;IACxD,eAAe,EAAE,KAAK,CAAC;IACvB;;;OAGG;IACH,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qDAAqD,CAAC;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAIrD,MAAM,MAAM,KAAK,GAAG,UAAU,CAC5B,UAAU,CAAC,cAAc,gBAAgB,EAAE,eAAe,CAAC,CAC5D,CAAC,OAAO,CAAC,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,GAAG,GAAG,IAAI;IACjC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAC9B;;;OAGG;IACH,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5C,2DAA2D;IAC3D,OAAO,EAAE,CAAC,eAAe,CAAC,EAAE,OAAO,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;IAC1D,qDAAqD;IACrD,IAAI,EAAE,MAAM,MAAM,EAAE,CAAC;IACrB,sDAAsD;IACtD,MAAM,EAAE,MAAM,KAAK,EAAE,CAAC;CACvB,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,SAAS,GAAG;IACtB,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IACxE;;;;OAIG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC;;;OAGG;IACH,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,SAAS,KAAK,CAAC,CAAC;IAClE,yDAAyD;IACzD,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;IAChE;;;;OAIG;IACH,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC;IACnE;;;OAGG;IACH,WAAW,EAAE,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACvD,0EAA0E;IAC1E,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9B,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB;;;;OAIG;IACH,QAAQ,EAAE,CAAC,EAAE,EAAE,SAAS,GAAG,oBAAoB,KAAK,IAAI,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,oFAAoF;IACpF,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC;CAC3C,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,UAAU,GAAG;IACvB,kBAAkB;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,mBAAmB;IACnB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG;IAC3C,YAAY,IAAI,MAAM,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG;IAC5C,YAAY,CACV,IAAI,EAAE,MAAM,EACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,kBAAkB,CAAC;KAC/B,CAAC,CAAC;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACxD,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,aAAa,GAAG;IAC1B,gCAAgC;IAChC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,QAAQ,IAAI;IAC3D;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;IACtB,uCAAuC;IACvC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,qCAAqC;IACrC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;IACtD,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;CACtD,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,QAAQ,IAAI,OAAO,CAC3D,0BAA0B,CAAC,CAAC,CAAC,CAC9B,CAAC;AAEF,uCAAuC;AACvC,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,CAAC,CAAC,SAAS,QAAQ,EAC3B,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC,KAC5B,mBAAmB,CAAC,CAAC,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,YAAY,GAAG,WAAW,MAAM,EAAE,CAAC;AAC/C,MAAM,MAAM,eAAe,GAAG,cAAc,MAAM,EAAE,CAAC;AACrD,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,WAAW,CAAC;AAEzD,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;IAC/B,IAAI,EAAE,KAAK,CAAC;IACZ,cAAc,EAAE,YAAY,CAAC;IAC7B,WAAW,EAAE,SAAS,CAAC;IACvB,mBAAmB,EAAE,YAAY,CAAC;IAClC,gBAAgB,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACrC,cAAc,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;IACjD,iBAAiB,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CACxD,CAAC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,SAAS,CAAC;IACnB,UAAU,EAAE,YAAY,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,cAAc,EAAE,eAAe,EAAE,CAAC;IAClC,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,YAAY,CAAC;IACxB,YAAY,EAAE,eAAe,CAAC;IAC9B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,6EAA6E;AAC7E,MAAM,MAAM,cAAc,GACtB,sBAAsB,GACtB,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,oBAAoB,GACpB,kBAAkB,GAClB,qBAAqB,GACrB,eAAe,GACf,uBAAuB,GACvB,eAAe,GACf,YAAY,CAAC;AAEjB,KAAK,eAAe,GAAG;IACrB,eAAe,EAAE,cAAc,CAAC;IAChC,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,kBAAkB,EAAE,cAAc,CAAC;IACnC,aAAa,EAAE;QACb,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,qBAAqB,EAAE;QACrB,eAAe,EAAE,KAAK,CAAC;QACvB,MAAM,EAAE,SAAS,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,oBAAoB,EAAE;QACpB,eAAe,EAAE,KAAK,CAAC;QACvB,MAAM,EAAE,SAAS,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,aAAa,EAAE;QACb,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,gBAAgB,EAAE;QAAE,SAAS,EAAE,YAAY,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;IACjE,mBAAmB,EAAE;QAAE,SAAS,EAAE,YAAY,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;IACpE,UAAU,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;CAC9D,CAAC;AAEF;;;GAGG;AACH,KAAK,YAAY,GAAG,WAAW,GAAG,qBAAqB,CAAC;AAExD,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,YAAY,GAAG,WAAW,IAClC;IACF,IAAI,EAAE,CAAC,CAAC;IACR,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,CAAC,CAAC;IACT,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG;KACD,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,iBAAiB,GACzB,YAAY,GACZ,iBAAiB,GACjB,iBAAiB,GACjB,sBAAsB,GACtB,uBAAuB,GACvB,UAAU,GACV,iBAAiB,GACjB,kBAAkB,CAAC;AAEvB,KAAK,eAAe,GAAG;IACrB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,eAAe,EAAE,sBAAsB,CAAC;IACxC,eAAe,EAAE;QACf,MAAM,EAAE,SAAS,CAAC;QAClB,GAAG,EAAE,KAAK,CAAC;KACZ,CAAC;IACF,oBAAoB,EAAE,uBAAuB,CAAC;IAC9C,qBAAqB,EAAE;QACrB,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,aAAa,GAAG,gBAAgB,CAAC,CAAC;KAC3D,CAAC;IACF,QAAQ,EAAE;QAAE,MAAM,EAAE;YAAE,WAAW,EAAE,SAAS,CAAA;SAAE,CAAA;KAAE,CAAC;IACjD,eAAe,EAAE;QACf,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,gBAAgB,EAAE,sBAAsB,CAAC;CAC1C,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,UAAU,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,iBAAiB,IAAI;IACnD,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,CAAC,CAAC;CACX,GAAG;KACD,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,iBAAiB,IAAI;KACpD,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,iBAAiB,IACvD,CAAC,SAAS,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AAEhE,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,iBAAiB,IACvD,eAAe,CAAC,CAAC,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAE7D,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,uBAAuB,GAAG,uBAAuB,GAAG;IACvD,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,kBAAkB,GAAG,aAAa,CAAC,CAAC;CAC7D,CAAC;AAEF,KAAK,sBAAsB,GAAG,uBAAuB,GAAG;IACtD,MAAM,EAAE,IAAI,CACV,SAAS,EACP,kBAAkB,GAClB,aAAa,GACb,qBAAqB,GACrB,gBAAgB,CACnB,CAAC;CACH,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,SAAS,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GACzB,QAAQ,CAAC,uBAAuB,EAAE,qBAAqB,CAAC,GACxD,QAAQ,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,GACvD,QAAQ,CAAC,eAAe,EAAE,qBAAqB,CAAC,CAAC"}
package/src/types.ts CHANGED
@@ -167,15 +167,16 @@ export type ConnectingInfo = {
167
167
 
168
168
  /** see [ibc_module.go](../../../golang/cosmos/x/vibc/types/ibc_module.go) */
169
169
  export type IBCBridgeEvent =
170
+ | 'writeAcknowledgement'
170
171
  | 'channelOpenInit'
171
172
  | 'channelOpenTry'
172
173
  | 'channelOpenAck'
173
174
  | 'channelOpenConfirm'
175
+ | 'channelCloseInit'
176
+ | 'channelCloseConfirm'
174
177
  | 'receivePacket'
175
178
  | 'acknowledgementPacket'
176
179
  | 'timeoutPacket'
177
- | 'channelCloseInit'
178
- | 'channelCloseConfirm'
179
180
  | 'sendPacket';
180
181
 
181
182
  type IBCPacketEvents = {
@@ -191,6 +192,11 @@ type IBCPacketEvents = {
191
192
  packet: IBCPacket;
192
193
  relayer: string; // chain address
193
194
  };
195
+ writeAcknowledgement: {
196
+ acknowledgement: Bytes;
197
+ packet: IBCPacket;
198
+ relayer: string; // chain address
199
+ };
194
200
  timeoutPacket: {
195
201
  packet: IBCPacket;
196
202
  };
@@ -199,11 +205,22 @@ type IBCPacketEvents = {
199
205
  sendPacket: { relativeTimeoutNs: bigint; packet: IBCPacket };
200
206
  };
201
207
 
202
- export type IBCEvent<E extends IBCBridgeEvent> = {
203
- type: 'IBC_EVENT';
208
+ /**
209
+ * ActionTypes as specified by `vibc` and `vtransfer`. This list is expected to
210
+ * grow as more IBC Applications modules are implemented.
211
+ */
212
+ type IBCEventType = 'IBC_EVENT' | 'VTRANSFER_IBC_EVENT';
213
+
214
+ export type IBCEvent<
215
+ E extends IBCBridgeEvent,
216
+ T extends IBCEventType = 'IBC_EVENT',
217
+ > = {
218
+ type: T;
204
219
  blockHeight: number;
205
220
  blockTime: number;
206
221
  event: E;
222
+ /** e.g. the chain address of the LocalChainAccount */
223
+ target?: string;
207
224
  } & {
208
225
  [K in keyof IBCPacketEvents[E]]: IBCPacketEvents[E][K];
209
226
  };
@@ -287,24 +304,12 @@ type SendPacketDownCall = {
287
304
  * This event is emitted when a FungibleTokenPacket is sent or received
288
305
  * by a target (e.g. a {@link LocalChainAccount}) that has a registered
289
306
  * {@link TargetApp}. It is passed through the `receiveUpcall` handler.
307
+ *
308
+ * For ICS-20 transfer (including `MsgTransfer`), the `packet.data` field is a
309
+ * {@link FungibleTokenPacketData} object, and you can use
310
+ * `JSON.parse(atob(packet.data))` to extract it.
290
311
  */
291
- export type VTransferIBCEvent = {
292
- type: 'VTRANSFER_IBC_EVENT';
293
- blockHeight: number;
294
- blockTime: number;
295
- /**
296
- * Indicates the type of IBC packet event:
297
- * - 'acknowledgementPacket': passive tap that communicates the result of an acknowledged packet
298
- * - 'writeAcknowledgement': active tap where the receiver can return a write acknowledgement
299
- */
300
- event: 'acknowledgementPacket' | 'writeAcknowledgement';
301
- acknowledgement: Bytes;
302
- /**
303
- * Use `JSON.parse(atob(packet.data))` to get a
304
- * {@link FungibleTokenPacketData} object.
305
- */
306
- packet: IBCPacket;
307
- relayer: string;
308
- /** e.g. the chain address of the LocalChainAccount */
309
- target: string;
310
- };
312
+ export type VTransferIBCEvent =
313
+ | IBCEvent<'acknowledgementPacket', 'VTRANSFER_IBC_EVENT'>
314
+ | IBCEvent<'writeAcknowledgement', 'VTRANSFER_IBC_EVENT'>
315
+ | IBCEvent<'timeoutPacket', 'VTRANSFER_IBC_EVENT'>;
package/tools/fake-bridge.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"fake-bridge.d.ts","sourceRoot":"","sources":["fake-bridge.js"],"names":[],"mappings":"AAkBA,6EAA6E;AAE7E,6BAA8B,QAAQ,CAAC;AAehC,yCAPI,OAAO,cAAc,EAAE,IAAI,6BAEnC;IAAwB,QAAQ;IACH,UAAU,kBAAtB,IAAI;CACrB,GAAU,oBAAoB,MAAM,CAAC,CA4FvC;AAOM,wCAJI,OAAO,cAAc,EAAE,IAAI,cAC3B,CAAC,GAAG,KAAA,KAAK,IAAI,GACX,oBAAoB,MAAM,CAAC,CAwCvC;AAED,yCAA0C,uBAAuB,CAAC;;;;;AAwB3D,0DALI,MAAM,YACN,MAAM,GACJ,OAAO,CAsCnB;AAED;;;IASE;AAWK,0DAHI,MAAM,GACJ,OAAO,CAsCnB;AAQM,+CALI,OAAO,cAAc,EAAE,IAAI,eAC3B,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,kBACrB,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GACvB,oBAAoB,aAAa,CAAC,CAoD9C;AAOM,6CAJI,OAAO,cAAc,EAAE,IAAI,eAC3B,CAAC,GAAG,KAAA,KAAK,IAAI,GACX,oBAAoB,WAAW,CAAC,CAuC5C;uBApXa;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;CAAE;yCAPX,iBAAiB"}
1
+ {"version":3,"file":"fake-bridge.d.ts","sourceRoot":"","sources":["fake-bridge.js"],"names":[],"mappings":"AAkBA,6EAA6E;AAE7E,6BAA8B,QAAQ,CAAC;AAehC,yCAPI,OAAO,cAAc,EAAE,IAAI,6BAEnC;IAAwB,QAAQ;IACH,UAAU,kBAAtB,IAAI;CACrB,GAAU,oBAAoB,MAAM,CAAC,CA4FvC;AAOM,wCAJI,OAAO,cAAc,EAAE,IAAI,cAC3B,CAAC,GAAG,KAAA,KAAK,IAAI,GACX,oBAAoB,MAAM,CAAC,CAwCvC;AAED,yCAA0C,uBAAuB,CAAC;;;;;AAwB3D,0DALI,MAAM,YACN,MAAM,GACJ,OAAO,CAgDnB;AAED;;;IASE;AAWK,0DAHI,MAAM,GACJ,OAAO,CAsCnB;AAQM,+CALI,OAAO,cAAc,EAAE,IAAI,eAC3B,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,kBACrB,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GACvB,oBAAoB,aAAa,CAAC,CAoD9C;AAOM,6CAJI,OAAO,cAAc,EAAE,IAAI,eAC3B,CAAC,GAAG,KAAA,KAAK,IAAI,GACX,oBAAoB,WAAW,CAAC,CAuC5C;uBA9Xa;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;CAAE;yCAPX,iBAAiB"}
package/tools/fake-bridge.js CHANGED
@@ -197,9 +197,19 @@ export const fakeLocalChainBridgeTxMsgHandler = (message, sequence) => {
197
197
  switch (message['@type']) {
198
198
  // TODO #9402 reference bank to ensure caller has tokens they are transferring
199
199
  case '/ibc.applications.transfer.v1.MsgTransfer': {
200
- if (message.token.amount === String(SIMULATED_ERRORS.TIMEOUT)) {
201
- throw Error('simulated unexpected MsgTransfer packet timeout');
202
- }
200
+ /**
201
+ * This call should always resolve with a sequence number unless the
202
+ * message is rejected by the local chain (malformed, unauthorized, etc).
203
+ * This sequence number is wrt to the channel (not the account) and
204
+ * indicates an outgoing IBC transfer has _started_ but doesn't mean it
205
+ * has been acknowledged by the remote chain.
206
+ *
207
+ * If you are testing `MsgTransfer` with a `LocalOrchestrationAccount`,
208
+ * you must inbound a `VTRANSFER_IBC_EVENT` to the `vtransfer` bridge with
209
+ * an acknowledgement, acknowledgement error, or timeout. See
210
+ * `buildVTransferEvent`, `transmitTransferTimeout`, `transmitTransferAck`
211
+ * and `transmitTransferAckError` for examples.
212
+ */
203
213
  // like `JsonSafe<MsgTransferResponse>`, but bigints are converted to numbers
204
214
  // FIXME should vlocalchain return a string instead of number for bigint?
205
215
  return {