@metamask/keyring-api 17.3.0 → 17.5.0

package/dist/api/transaction.cjs

@@ -131,6 +131,21 @@ var TransactionType;
      * A swap transaction must be originated by the account.
      */
     TransactionType["Swap"] = "swap";
+    /**
+     * Represents an outgoing bridge transaction, transferring assets from
+     * the account to another blockchain.
+     */
+    TransactionType["BridgeSend"] = "bridge:send";
+    /**
+     * Represents an incoming bridge transaction, transferring assets from
+     * another blockchain to the account.
+     */
+    TransactionType["BridgeReceive"] = "bridge:receive";
+    /**
+     * The transaction type is unknown. It's not possible to determine the
+     * transaction type based on the information available.
+     */
+    TransactionType["Unknown"] = "unknown";
 })(TransactionType || (exports.TransactionType = TransactionType = {}));
 /**
  * This struct represents a transaction event.
@@ -243,6 +258,9 @@ exports.TransactionStruct = (0, keyring_utils_1.object)({
         `${TransactionType.Send}`,
         `${TransactionType.Receive}`,
         `${TransactionType.Swap}`,
+        `${TransactionType.BridgeSend}`,
+        `${TransactionType.BridgeReceive}`,
+        `${TransactionType.Unknown}`,
     ]),
     /**
      * Transaction sender addresses and amounts.

package/dist/api/transaction.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.cjs","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":";;;AACA,2DAA6D;AAE7D,uDAA+E;AAE/E,uCAAsC;AACtC,qCAA2C;AAG3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,iBAAiB,GAAG,IAAA,sBAAM,EAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,KAAK,EAAE,IAAA,sBAAQ,EAAC,mBAAW,CAAC;CAC7B,CAAC,CAAC;AAEH;;GAEG;AACH,IAAY,OAiBX;AAjBD,WAAY,OAAO;IACjB;;;;;;OAMG;IACH,wBAAa,CAAA;IAEb;;;;;OAKG;IACH,gCAAqB,CAAA;AACvB,CAAC,EAjBW,OAAO,uBAAP,OAAO,QAiBlB;AAED;;GAEG;AACH,MAAM,SAAS,GAAG,IAAA,sBAAM,EAAC;IACvB;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvD;;OAEG;IACH,KAAK,EAAE,mBAAW;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,IAAY,iBAsBX;AAtBD,WAAY,iBAAiB;IAC3B;;;OAGG;IACH,4CAAuB,CAAA;IAEvB;;;OAGG;IACH,gDAA2B,CAAA;IAE3B;;OAEG;IACH,4CAAuB,CAAA;IAEvB;;OAEG;IACH,sCAAiB,CAAA;AACnB,CAAC,EAtBW,iBAAiB,iCAAjB,iBAAiB,QAsB5B;AAED;;GAEG;AACH,IAAY,eAqBX;AArBD,WAAY,eAAe;IACzB;;;;OAIG;IACH,gCAAa,CAAA;IAEb;;;OAGG;IACH,sCAAmB,CAAA;IAEnB;;;;;OAKG;IACH,gCAAa,CAAA;AACf,CAAC,EArBW,eAAe,+BAAf,eAAe,QAqB1B;AAED;;GAEG;AACU,QAAA,sBAAsB,GAAG,IAAA,sBAAM,EAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC9B,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACU,QAAA,iBAAiB,GAAG,IAAA,sBAAM,EAAC;IACtC;;OAEG;IACH,EAAE,EAAE,IAAA,oBAAM,GAAE;IAEZ;;OAEG;IACH,KAAK,EAAE,wBAAiB;IAExB;;OAEG;IACH,OAAO,EAAE,0BAAU;IAEnB;;OAEG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;;;OAIG;IACH,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAE7B;;;OAGG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC;QACV,GAAG,eAAe,CAAC,IAAI,EAAE;QACzB,GAAG,eAAe,CAAC,OAAO,EAAE;QAC5B,GAAG,eAAe,CAAC,IAAI,EAAE;KAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,iBAAiB,CAAC;IAE9B;;OAEG;IACH,EAAE,EAAE,IAAA,mBAAK,EAAC,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,SAAS,CAAC;IAEtB;;;;;OAKG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC,8BAAsB,CAAC;CACtC,CAAC,CAAC;AASH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,sBAAsB,GAAG,IAAA,sBAAM,EAAC;IAC3C;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,yBAAiB,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CACzB,CAAC,CAAC","sourcesContent":["import type { InferEquals } from '@metamask/keyring-utils';\nimport { object, UuidStruct } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, enums, nullable, number, string } from '@metamask/superstruct';\n\nimport { AssetStruct } from './asset';\nimport { CaipChainIdStruct } from './caip';\nimport type { Paginated } from './pagination';\n\n/**\n * This struct represents a participant in a transaction.\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: true,\n *     type: 'eip155:1/slip44:60',\n *     unit: 'ETH',\n *     amount: '0.01',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: false,\n *     id: 'eip155:1/erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d/771769',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: null,\n * },\n * ```\n */\nconst ParticipantStruct = object({\n  /**\n   * Participant address.\n   */\n  address: string(),\n\n  /**\n   * Asset being transferred.\n   */\n  asset: nullable(AssetStruct),\n});\n\n/**\n * Fee types.\n */\nexport enum FeeType {\n  /**\n   * Base fee. It is the minimum fee required to include a transaction in the\n   * blockchain.\n   *\n   * For non-confirmed transactions, it must be the maximum base fee. For\n   * confirmed transactions, it must be the actual base fee paid.\n   */\n  Base = 'base',\n\n  /**\n   * Priority fee. It is an optional fee used to prioritize the transaction.\n   *\n   * For non-confirmed transactions, it must be the maximum priority fee. For\n   * confirmed transactions, it must be the actual priority fee paid.\n   */\n  Priority = 'priority',\n}\n\n/**\n * This struct represents a transaction fee.\n */\nconst FeeStruct = object({\n  /**\n   * Fee type {@see FeeType}.\n   */\n  type: enums([`${FeeType.Base}`, `${FeeType.Priority}`]),\n\n  /**\n   * Asset used to pay for the fee.\n   */\n  asset: AssetStruct,\n});\n\n/**\n * Transaction statuses.\n */\nexport enum TransactionStatus {\n  /**\n   * The transaction has been submitted but is not yet in the\n   * blockchain. For example, it can be in the mempool.\n   */\n  Submitted = 'submitted',\n\n  /**\n   * The transaction is in the blockchain but has not been\n   * confirmed yet.\n   */\n  Unconfirmed = 'unconfirmed',\n\n  /**\n   * The transaction has been confirmed.\n   */\n  Confirmed = 'confirmed',\n\n  /**\n   * The transaction has failed. For example, it has been reverted.\n   */\n  Failed = 'failed',\n}\n\n/**\n * Transaction types.\n */\nexport enum TransactionType {\n  /**\n   * The transaction was originated by the account. If the transaction\n   * has a change output that goes back to the same account, it must be tagged\n   * as a send transaction.\n   */\n  Send = 'send',\n\n  /**\n   * The transaction was received by the account, but originated by\n   * another account.\n   */\n  Receive = 'receive',\n\n  /**\n   * The transaction is a swap. It decreases the balance of one asset and\n   * increases the balance of another asset in a single transaction.\n   *\n   * A swap transaction must be originated by the account.\n   */\n  Swap = 'swap',\n}\n\n/**\n * This struct represents a transaction event.\n */\nexport const TransactionEventStruct = object({\n  /**\n   * New status of the transaction.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the event occurred.\n   */\n  timestamp: nullable(number()),\n});\n\n/**\n * This struct represents a blockchain transaction.\n *\n * @example\n * ```ts\n * const tx = {\n *   id: 'f5d8ee39a430901c91a5917b9f2dc19d6d1a0e9cea205b009ca73dd04470b9a6',\n *   chain: 'bip122:000000000019d6689c085ae165831e93',\n *   account: 'b9beb861-9761-4b97-89ce-d992be5f34da',\n *   status: 'confirmed',\n *   timestamp: 1716367781,\n *   type: 'send',\n *   from: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   to: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *     {\n *       address: 'bc1qwl8399fz829uqvqly9tcatgrgtwp3udnhxfq4k',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   fees: [\n *     {\n *       type: 'priority',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n * };\n * ```\n */\nexport const TransactionStruct = object({\n  /**\n   * Chain-specific transaction ID.\n   */\n  id: string(),\n\n  /**\n   * Chain ID (CAIP-2).\n   */\n  chain: CaipChainIdStruct,\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Transaction status {@see TransactionStatus}.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the transaction was added to the blockchain. The\n   * timestamp can be null if the transaction has not been included in the\n   * blockchain yet.\n   */\n  timestamp: nullable(number()),\n\n  /**\n   * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction\n   * details on the UI.\n   */\n  type: enums([\n    `${TransactionType.Send}`,\n    `${TransactionType.Receive}`,\n    `${TransactionType.Swap}`,\n  ]),\n\n  /**\n   * Transaction sender addresses and amounts.\n   */\n  from: array(ParticipantStruct),\n\n  /**\n   * Transaction receiver addresses and amounts.\n   */\n  to: array(ParticipantStruct),\n\n  /**\n   * Total transaction fee.\n   */\n  fees: array(FeeStruct),\n\n  /**\n   * List of events related to the transaction {@see TransactionEventStruct}.\n   *\n   * The events are tracked in a best-effort basis and may not be available for\n   * all transactions.\n   */\n  events: array(TransactionEventStruct),\n});\n\n/**\n * Transaction object.\n *\n * See {@link TransactionStruct}.\n */\nexport type Transaction = Infer<typeof TransactionStruct>;\n\n/**\n * This struct represents a page of transactions.\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: 'c3y1Q6QtqtstbxKX+oqVdEW6',\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: null, // No more results\n * }**\n * ```\n */\nexport const TransactionsPageStruct = object({\n  /**\n   * List of transactions.\n   */\n  data: array(TransactionStruct),\n\n  /**\n   * Next cursor to iterate over the results. If null, there are no more\n   * results.\n   */\n  next: nullable(string()),\n});\n\n/**\n * Transactions page object.\n *\n * See {@link TransactionsPageStruct}.\n */\nexport type TransactionsPage = InferEquals<\n  typeof TransactionsPageStruct,\n  Paginated<Transaction>\n>;\n"]}
+{"version":3,"file":"transaction.cjs","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":";;;AACA,2DAA6D;AAE7D,uDAA+E;AAE/E,uCAAsC;AACtC,qCAA2C;AAG3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,iBAAiB,GAAG,IAAA,sBAAM,EAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,KAAK,EAAE,IAAA,sBAAQ,EAAC,mBAAW,CAAC;CAC7B,CAAC,CAAC;AAEH;;GAEG;AACH,IAAY,OAiBX;AAjBD,WAAY,OAAO;IACjB;;;;;;OAMG;IACH,wBAAa,CAAA;IAEb;;;;;OAKG;IACH,gCAAqB,CAAA;AACvB,CAAC,EAjBW,OAAO,uBAAP,OAAO,QAiBlB;AAED;;GAEG;AACH,MAAM,SAAS,GAAG,IAAA,sBAAM,EAAC;IACvB;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvD;;OAEG;IACH,KAAK,EAAE,mBAAW;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,IAAY,iBAsBX;AAtBD,WAAY,iBAAiB;IAC3B;;;OAGG;IACH,4CAAuB,CAAA;IAEvB;;;OAGG;IACH,gDAA2B,CAAA;IAE3B;;OAEG;IACH,4CAAuB,CAAA;IAEvB;;OAEG;IACH,sCAAiB,CAAA;AACnB,CAAC,EAtBW,iBAAiB,iCAAjB,iBAAiB,QAsB5B;AAED;;GAEG;AACH,IAAY,eAuCX;AAvCD,WAAY,eAAe;IACzB;;;;OAIG;IACH,gCAAa,CAAA;IAEb;;;OAGG;IACH,sCAAmB,CAAA;IAEnB;;;;;OAKG;IACH,gCAAa,CAAA;IAEb;;;OAGG;IACH,6CAA0B,CAAA;IAE1B;;;OAGG;IACH,mDAAgC,CAAA;IAEhC;;;OAGG;IACH,sCAAmB,CAAA;AACrB,CAAC,EAvCW,eAAe,+BAAf,eAAe,QAuC1B;AAED;;GAEG;AACU,QAAA,sBAAsB,GAAG,IAAA,sBAAM,EAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC9B,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACU,QAAA,iBAAiB,GAAG,IAAA,sBAAM,EAAC;IACtC;;OAEG;IACH,EAAE,EAAE,IAAA,oBAAM,GAAE;IAEZ;;OAEG;IACH,KAAK,EAAE,wBAAiB;IAExB;;OAEG;IACH,OAAO,EAAE,0BAAU;IAEnB;;OAEG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;;;OAIG;IACH,SAAS,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAE7B;;;OAGG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC;QACV,GAAG,eAAe,CAAC,IAAI,EAAE;QACzB,GAAG,eAAe,CAAC,OAAO,EAAE;QAC5B,GAAG,eAAe,CAAC,IAAI,EAAE;QACzB,GAAG,eAAe,CAAC,UAAU,EAAE;QAC/B,GAAG,eAAe,CAAC,aAAa,EAAE;QAClC,GAAG,eAAe,CAAC,OAAO,EAAE;KAC7B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,iBAAiB,CAAC;IAE9B;;OAEG;IACH,EAAE,EAAE,IAAA,mBAAK,EAAC,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,SAAS,CAAC;IAEtB;;;;;OAKG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC,8BAAsB,CAAC;CACtC,CAAC,CAAC;AASH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,sBAAsB,GAAG,IAAA,sBAAM,EAAC;IAC3C;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,yBAAiB,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CACzB,CAAC,CAAC","sourcesContent":["import type { InferEquals } from '@metamask/keyring-utils';\nimport { object, UuidStruct } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, enums, nullable, number, string } from '@metamask/superstruct';\n\nimport { AssetStruct } from './asset';\nimport { CaipChainIdStruct } from './caip';\nimport type { Paginated } from './pagination';\n\n/**\n * This struct represents a participant in a transaction.\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: true,\n *     type: 'eip155:1/slip44:60',\n *     unit: 'ETH',\n *     amount: '0.01',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: false,\n *     id: 'eip155:1/erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d/771769',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: null,\n * },\n * ```\n */\nconst ParticipantStruct = object({\n  /**\n   * Participant address.\n   */\n  address: string(),\n\n  /**\n   * Asset being transferred.\n   */\n  asset: nullable(AssetStruct),\n});\n\n/**\n * Fee types.\n */\nexport enum FeeType {\n  /**\n   * Base fee. It is the minimum fee required to include a transaction in the\n   * blockchain.\n   *\n   * For non-confirmed transactions, it must be the maximum base fee. For\n   * confirmed transactions, it must be the actual base fee paid.\n   */\n  Base = 'base',\n\n  /**\n   * Priority fee. It is an optional fee used to prioritize the transaction.\n   *\n   * For non-confirmed transactions, it must be the maximum priority fee. For\n   * confirmed transactions, it must be the actual priority fee paid.\n   */\n  Priority = 'priority',\n}\n\n/**\n * This struct represents a transaction fee.\n */\nconst FeeStruct = object({\n  /**\n   * Fee type {@see FeeType}.\n   */\n  type: enums([`${FeeType.Base}`, `${FeeType.Priority}`]),\n\n  /**\n   * Asset used to pay for the fee.\n   */\n  asset: AssetStruct,\n});\n\n/**\n * Transaction statuses.\n */\nexport enum TransactionStatus {\n  /**\n   * The transaction has been submitted but is not yet in the\n   * blockchain. For example, it can be in the mempool.\n   */\n  Submitted = 'submitted',\n\n  /**\n   * The transaction is in the blockchain but has not been\n   * confirmed yet.\n   */\n  Unconfirmed = 'unconfirmed',\n\n  /**\n   * The transaction has been confirmed.\n   */\n  Confirmed = 'confirmed',\n\n  /**\n   * The transaction has failed. For example, it has been reverted.\n   */\n  Failed = 'failed',\n}\n\n/**\n * Transaction types.\n */\nexport enum TransactionType {\n  /**\n   * The transaction was originated by the account. If the transaction\n   * has a change output that goes back to the same account, it must be tagged\n   * as a send transaction.\n   */\n  Send = 'send',\n\n  /**\n   * The transaction was received by the account, but originated by\n   * another account.\n   */\n  Receive = 'receive',\n\n  /**\n   * The transaction is a swap. It decreases the balance of one asset and\n   * increases the balance of another asset in a single transaction.\n   *\n   * A swap transaction must be originated by the account.\n   */\n  Swap = 'swap',\n\n  /**\n   * Represents an outgoing bridge transaction, transferring assets from\n   * the account to another blockchain.\n   */\n  BridgeSend = 'bridge:send',\n\n  /**\n   * Represents an incoming bridge transaction, transferring assets from\n   * another blockchain to the account.\n   */\n  BridgeReceive = 'bridge:receive',\n\n  /**\n   * The transaction type is unknown. It's not possible to determine the\n   * transaction type based on the information available.\n   */\n  Unknown = 'unknown',\n}\n\n/**\n * This struct represents a transaction event.\n */\nexport const TransactionEventStruct = object({\n  /**\n   * New status of the transaction.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the event occurred.\n   */\n  timestamp: nullable(number()),\n});\n\n/**\n * This struct represents a blockchain transaction.\n *\n * @example\n * ```ts\n * const tx = {\n *   id: 'f5d8ee39a430901c91a5917b9f2dc19d6d1a0e9cea205b009ca73dd04470b9a6',\n *   chain: 'bip122:000000000019d6689c085ae165831e93',\n *   account: 'b9beb861-9761-4b97-89ce-d992be5f34da',\n *   status: 'confirmed',\n *   timestamp: 1716367781,\n *   type: 'send',\n *   from: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   to: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *     {\n *       address: 'bc1qwl8399fz829uqvqly9tcatgrgtwp3udnhxfq4k',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   fees: [\n *     {\n *       type: 'priority',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n * };\n * ```\n */\nexport const TransactionStruct = object({\n  /**\n   * Chain-specific transaction ID.\n   */\n  id: string(),\n\n  /**\n   * Chain ID (CAIP-2).\n   */\n  chain: CaipChainIdStruct,\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Transaction status {@see TransactionStatus}.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the transaction was added to the blockchain. The\n   * timestamp can be null if the transaction has not been included in the\n   * blockchain yet.\n   */\n  timestamp: nullable(number()),\n\n  /**\n   * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction\n   * details on the UI.\n   */\n  type: enums([\n    `${TransactionType.Send}`,\n    `${TransactionType.Receive}`,\n    `${TransactionType.Swap}`,\n    `${TransactionType.BridgeSend}`,\n    `${TransactionType.BridgeReceive}`,\n    `${TransactionType.Unknown}`,\n  ]),\n\n  /**\n   * Transaction sender addresses and amounts.\n   */\n  from: array(ParticipantStruct),\n\n  /**\n   * Transaction receiver addresses and amounts.\n   */\n  to: array(ParticipantStruct),\n\n  /**\n   * Total transaction fee.\n   */\n  fees: array(FeeStruct),\n\n  /**\n   * List of events related to the transaction {@see TransactionEventStruct}.\n   *\n   * The events are tracked in a best-effort basis and may not be available for\n   * all transactions.\n   */\n  events: array(TransactionEventStruct),\n});\n\n/**\n * Transaction object.\n *\n * See {@link TransactionStruct}.\n */\nexport type Transaction = Infer<typeof TransactionStruct>;\n\n/**\n * This struct represents a page of transactions.\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: 'c3y1Q6QtqtstbxKX+oqVdEW6',\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: null, // No more results\n * }**\n * ```\n */\nexport const TransactionsPageStruct = object({\n  /**\n   * List of transactions.\n   */\n  data: array(TransactionStruct),\n\n  /**\n   * Next cursor to iterate over the results. If null, there are no more\n   * results.\n   */\n  next: nullable(string()),\n});\n\n/**\n * Transactions page object.\n *\n * See {@link TransactionsPageStruct}.\n */\nexport type TransactionsPage = InferEquals<\n  typeof TransactionsPageStruct,\n  Paginated<Transaction>\n>;\n"]}

package/dist/api/transaction.d.cts

@@ -65,7 +65,22 @@ export declare enum TransactionType {
      *
      * A swap transaction must be originated by the account.
      */
-    Swap = "swap"
+    Swap = "swap",
+    /**
+     * Represents an outgoing bridge transaction, transferring assets from
+     * the account to another blockchain.
+     */
+    BridgeSend = "bridge:send",
+    /**
+     * Represents an incoming bridge transaction, transferring assets from
+     * another blockchain to the account.
+     */
+    BridgeReceive = "bridge:receive",
+    /**
+     * The transaction type is unknown. It's not possible to determine the
+     * transaction type based on the information available.
+     */
+    Unknown = "unknown"
 }
 /**
  * This struct represents a transaction event.
@@ -146,7 +161,7 @@ export declare const TransactionEventStruct: import("@metamask/superstruct").Str
  * ```
  */
 export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
-    type: "send" | "receive" | "swap";
+    type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
     id: string;
     from: {
         address: string;
@@ -224,10 +239,13 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
      * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction
      * details on the UI.
      */
-    type: import("@metamask/superstruct").Struct<"send" | "receive" | "swap", {
+    type: import("@metamask/superstruct").Struct<"unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive", {
+        unknown: "unknown";
         send: "send";
         receive: "receive";
         swap: "swap";
+        "bridge:send": "bridge:send";
+        "bridge:receive": "bridge:receive";
     }>;
     /**
      * Transaction sender addresses and amounts.
@@ -424,7 +442,7 @@ export type Transaction = Infer<typeof TransactionStruct>;
  */
 export declare const TransactionsPageStruct: import("@metamask/superstruct").Struct<{
     data: {
-        type: "send" | "receive" | "swap";
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
         id: string;
         from: {
             address: string;
@@ -477,7 +495,7 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
      * List of transactions.
      */
     data: import("@metamask/superstruct").Struct<{
-        type: "send" | "receive" | "swap";
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
         id: string;
         from: {
             address: string;
@@ -524,7 +542,7 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
             };
         }[];
     }[], import("@metamask/superstruct").Struct<{
-        type: "send" | "receive" | "swap";
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
         id: string;
         from: {
             address: string;
@@ -602,10 +620,13 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
          * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction
          * details on the UI.
          */
-        type: import("@metamask/superstruct").Struct<"send" | "receive" | "swap", {
+        type: import("@metamask/superstruct").Struct<"unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive", {
+            unknown: "unknown";
             send: "send";
             receive: "receive";
             swap: "swap";
+            "bridge:send": "bridge:send";
+            "bridge:receive": "bridge:receive";
         }>;
         /**
          * Transaction sender addresses and amounts.

package/dist/api/transaction.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.cts","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,gCAAgC;AAE3D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAKnD,OAAO,KAAK,EAAE,SAAS,EAAE,yBAAqB;AAiD9C;;GAEG;AACH,oBAAY,OAAO;IACjB;;;;;;OAMG;IACH,IAAI,SAAS;IAEb;;;;;OAKG;IACH,QAAQ,aAAa;CACtB;AAiBD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;;OAGG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB;;;;OAIG;IACH,IAAI,SAAS;IAEb;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;;;OAKG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;IACjC;;OAEG;;;;;;;IAQH;;OAEG;;EAEH,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAC5B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;IAQH;;;;OAIG;;IAGH;;;OAGG;;;;;;IAOH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QA/NH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA2NH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApOH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAgOH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApMH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAgMH;;;;;OAKG;;;;;;;;QAxIH;;WAEG;;;;;;;QAQH;;WAEG;;;EA8HH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAvGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;QAOH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YA/NH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA2NH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApOH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAgOH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApMH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAgMH;;;;;WAKG;;;;;;;;YAxIH;;eAEG;;;;;;;YAQH;;eAEG;;;;IAwKH;;;OAGG;;EAEH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,OAAO,sBAAsB,EAC7B,SAAS,CAAC,WAAW,CAAC,CACvB,CAAC"}
+{"version":3,"file":"transaction.d.cts","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,gCAAgC;AAE3D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAKnD,OAAO,KAAK,EAAE,SAAS,EAAE,yBAAqB;AAiD9C;;GAEG;AACH,oBAAY,OAAO;IACjB;;;;;;OAMG;IACH,IAAI,SAAS;IAEb;;;;;OAKG;IACH,QAAQ,aAAa;CACtB;AAiBD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;;OAGG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB;;;;OAIG;IACH,IAAI,SAAS;IAEb;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;;OAGG;IACH,UAAU,gBAAgB;IAE1B;;;OAGG;IACH,aAAa,mBAAmB;IAEhC;;;OAGG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;IACjC;;OAEG;;;;;;;IAQH;;OAEG;;EAEH,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAC5B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;IAQH;;;;OAIG;;IAGH;;;OAGG;;;;;;;;;IAUH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApPH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAgPH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAzPH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAqPH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAzNH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAqNH;;;;;OAKG;;;;;;;;QA3IH;;WAEG;;;;;;;QAQH;;WAEG;;;EAiIH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA1GH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;;;;QAUH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApPH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAgPH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAzPH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAqPH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAzNH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAqNH;;;;;WAKG;;;;;;;;YA3IH;;eAEG;;;;;;;YAQH;;eAEG;;;;IA2KH;;;OAGG;;EAEH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,OAAO,sBAAsB,EAC7B,SAAS,CAAC,WAAW,CAAC,CACvB,CAAC"}

package/dist/api/transaction.d.mts

@@ -65,7 +65,22 @@ export declare enum TransactionType {
      *
      * A swap transaction must be originated by the account.
      */
-    Swap = "swap"
+    Swap = "swap",
+    /**
+     * Represents an outgoing bridge transaction, transferring assets from
+     * the account to another blockchain.
+     */
+    BridgeSend = "bridge:send",
+    /**
+     * Represents an incoming bridge transaction, transferring assets from
+     * another blockchain to the account.
+     */
+    BridgeReceive = "bridge:receive",
+    /**
+     * The transaction type is unknown. It's not possible to determine the
+     * transaction type based on the information available.
+     */
+    Unknown = "unknown"
 }
 /**
  * This struct represents a transaction event.
@@ -146,7 +161,7 @@ export declare const TransactionEventStruct: import("@metamask/superstruct").Str
  * ```
  */
 export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
-    type: "send" | "receive" | "swap";
+    type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
     id: string;
     from: {
         address: string;
@@ -224,10 +239,13 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
      * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction
      * details on the UI.
      */
-    type: import("@metamask/superstruct").Struct<"send" | "receive" | "swap", {
+    type: import("@metamask/superstruct").Struct<"unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive", {
+        unknown: "unknown";
         send: "send";
         receive: "receive";
         swap: "swap";
+        "bridge:send": "bridge:send";
+        "bridge:receive": "bridge:receive";
     }>;
     /**
      * Transaction sender addresses and amounts.
@@ -424,7 +442,7 @@ export type Transaction = Infer<typeof TransactionStruct>;
  */
 export declare const TransactionsPageStruct: import("@metamask/superstruct").Struct<{
     data: {
-        type: "send" | "receive" | "swap";
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
         id: string;
         from: {
             address: string;
@@ -477,7 +495,7 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
      * List of transactions.
      */
     data: import("@metamask/superstruct").Struct<{
-        type: "send" | "receive" | "swap";
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
         id: string;
         from: {
             address: string;
@@ -524,7 +542,7 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
             };
         }[];
     }[], import("@metamask/superstruct").Struct<{
-        type: "send" | "receive" | "swap";
+        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
         id: string;
         from: {
             address: string;
@@ -602,10 +620,13 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
          * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction
          * details on the UI.
          */
-        type: import("@metamask/superstruct").Struct<"send" | "receive" | "swap", {
+        type: import("@metamask/superstruct").Struct<"unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive", {
+            unknown: "unknown";
             send: "send";
             receive: "receive";
             swap: "swap";
+            "bridge:send": "bridge:send";
+            "bridge:receive": "bridge:receive";
         }>;
         /**
          * Transaction sender addresses and amounts.

package/dist/api/transaction.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.mts","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,gCAAgC;AAE3D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAKnD,OAAO,KAAK,EAAE,SAAS,EAAE,yBAAqB;AAiD9C;;GAEG;AACH,oBAAY,OAAO;IACjB;;;;;;OAMG;IACH,IAAI,SAAS;IAEb;;;;;OAKG;IACH,QAAQ,aAAa;CACtB;AAiBD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;;OAGG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB;;;;OAIG;IACH,IAAI,SAAS;IAEb;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;;;OAKG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;IACjC;;OAEG;;;;;;;IAQH;;OAEG;;EAEH,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAC5B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;IAQH;;;;OAIG;;IAGH;;;OAGG;;;;;;IAOH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QA/NH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA2NH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApOH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAgOH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApMH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAgMH;;;;;OAKG;;;;;;;;QAxIH;;WAEG;;;;;;;QAQH;;WAEG;;;EA8HH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAvGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;QAOH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YA/NH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA2NH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApOH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAgOH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApMH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAgMH;;;;;WAKG;;;;;;;;YAxIH;;eAEG;;;;;;;YAQH;;eAEG;;;;IAwKH;;;OAGG;;EAEH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,OAAO,sBAAsB,EAC7B,SAAS,CAAC,WAAW,CAAC,CACvB,CAAC"}
+{"version":3,"file":"transaction.d.mts","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,gCAAgC;AAE3D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAKnD,OAAO,KAAK,EAAE,SAAS,EAAE,yBAAqB;AAiD9C;;GAEG;AACH,oBAAY,OAAO;IACjB;;;;;;OAMG;IACH,IAAI,SAAS;IAEb;;;;;OAKG;IACH,QAAQ,aAAa;CACtB;AAiBD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;;OAGG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB;;;;OAIG;IACH,IAAI,SAAS;IAEb;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;;OAGG;IACH,UAAU,gBAAgB;IAE1B;;;OAGG;IACH,aAAa,mBAAmB;IAEhC;;;OAGG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;IACjC;;OAEG;;;;;;;IAQH;;OAEG;;EAEH,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAC5B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;IAQH;;;;OAIG;;IAGH;;;OAGG;;;;;;;;;IAUH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApPH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAgPH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAzPH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAqPH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAzNH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAqNH;;;;;OAKG;;;;;;;;QA3IH;;WAEG;;;;;;;QAQH;;WAEG;;;EAiIH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA1GH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;;;;QAUH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApPH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAgPH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAzPH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAqPH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAzNH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAqNH;;;;;WAKG;;;;;;;;YA3IH;;eAEG;;;;;;;YAQH;;eAEG;;;;IA2KH;;;OAGG;;EAEH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,OAAO,sBAAsB,EAC7B,SAAS,CAAC,WAAW,CAAC,CACvB,CAAC"}

package/dist/api/transaction.mjs

@@ -128,6 +128,21 @@ export var TransactionType;
      * A swap transaction must be originated by the account.
      */
     TransactionType["Swap"] = "swap";
+    /**
+     * Represents an outgoing bridge transaction, transferring assets from
+     * the account to another blockchain.
+     */
+    TransactionType["BridgeSend"] = "bridge:send";
+    /**
+     * Represents an incoming bridge transaction, transferring assets from
+     * another blockchain to the account.
+     */
+    TransactionType["BridgeReceive"] = "bridge:receive";
+    /**
+     * The transaction type is unknown. It's not possible to determine the
+     * transaction type based on the information available.
+     */
+    TransactionType["Unknown"] = "unknown";
 })(TransactionType || (TransactionType = {}));
 /**
  * This struct represents a transaction event.
@@ -240,6 +255,9 @@ export const TransactionStruct = object({
         `${TransactionType.Send}`,
         `${TransactionType.Receive}`,
         `${TransactionType.Swap}`,
+        `${TransactionType.BridgeSend}`,
+        `${TransactionType.BridgeReceive}`,
+        `${TransactionType.Unknown}`,
     ]),
     /**
      * Transaction sender addresses and amounts.

package/dist/api/transaction.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.mjs","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,gCAAgC;AAE7D,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B;AAE/E,OAAO,EAAE,WAAW,EAAE,oBAAgB;AACtC,OAAO,EAAE,iBAAiB,EAAE,mBAAe;AAG3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,iBAAiB,GAAG,MAAM,CAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE;IAEjB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC;CAC7B,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,OAiBX;AAjBD,WAAY,OAAO;IACjB;;;;;;OAMG;IACH,wBAAa,CAAA;IAEb;;;;;OAKG;IACH,gCAAqB,CAAA;AACvB,CAAC,EAjBW,OAAO,KAAP,OAAO,QAiBlB;AAED;;GAEG;AACH,MAAM,SAAS,GAAG,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvD;;OAEG;IACH,KAAK,EAAE,WAAW;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,iBAsBX;AAtBD,WAAY,iBAAiB;IAC3B;;;OAGG;IACH,4CAAuB,CAAA;IAEvB;;;OAGG;IACH,gDAA2B,CAAA;IAE3B;;OAEG;IACH,4CAAuB,CAAA;IAEvB;;OAEG;IACH,sCAAiB,CAAA;AACnB,CAAC,EAtBW,iBAAiB,KAAjB,iBAAiB,QAsB5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAqBX;AArBD,WAAY,eAAe;IACzB;;;;OAIG;IACH,gCAAa,CAAA;IAEb;;;OAGG;IACH,sCAAmB,CAAA;IAEnB;;;;;OAKG;IACH,gCAAa,CAAA;AACf,CAAC,EArBW,eAAe,KAAf,eAAe,QAqB1B;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CAC9B,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,EAAE;IAEZ;;OAEG;IACH,KAAK,EAAE,iBAAiB;IAExB;;OAEG;IACH,OAAO,EAAE,UAAU;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;;;OAIG;IACH,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAE7B;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC;QACV,GAAG,eAAe,CAAC,IAAI,EAAE;QACzB,GAAG,eAAe,CAAC,OAAO,EAAE;QAC5B,GAAG,eAAe,CAAC,IAAI,EAAE;KAC1B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAE9B;;OAEG;IACH,EAAE,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC;IAEtB;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC;CACtC,CAAC,CAAC;AASH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;IAC3C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACzB,CAAC,CAAC","sourcesContent":["import type { InferEquals } from '@metamask/keyring-utils';\nimport { object, UuidStruct } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, enums, nullable, number, string } from '@metamask/superstruct';\n\nimport { AssetStruct } from './asset';\nimport { CaipChainIdStruct } from './caip';\nimport type { Paginated } from './pagination';\n\n/**\n * This struct represents a participant in a transaction.\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: true,\n *     type: 'eip155:1/slip44:60',\n *     unit: 'ETH',\n *     amount: '0.01',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: false,\n *     id: 'eip155:1/erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d/771769',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: null,\n * },\n * ```\n */\nconst ParticipantStruct = object({\n  /**\n   * Participant address.\n   */\n  address: string(),\n\n  /**\n   * Asset being transferred.\n   */\n  asset: nullable(AssetStruct),\n});\n\n/**\n * Fee types.\n */\nexport enum FeeType {\n  /**\n   * Base fee. It is the minimum fee required to include a transaction in the\n   * blockchain.\n   *\n   * For non-confirmed transactions, it must be the maximum base fee. For\n   * confirmed transactions, it must be the actual base fee paid.\n   */\n  Base = 'base',\n\n  /**\n   * Priority fee. It is an optional fee used to prioritize the transaction.\n   *\n   * For non-confirmed transactions, it must be the maximum priority fee. For\n   * confirmed transactions, it must be the actual priority fee paid.\n   */\n  Priority = 'priority',\n}\n\n/**\n * This struct represents a transaction fee.\n */\nconst FeeStruct = object({\n  /**\n   * Fee type {@see FeeType}.\n   */\n  type: enums([`${FeeType.Base}`, `${FeeType.Priority}`]),\n\n  /**\n   * Asset used to pay for the fee.\n   */\n  asset: AssetStruct,\n});\n\n/**\n * Transaction statuses.\n */\nexport enum TransactionStatus {\n  /**\n   * The transaction has been submitted but is not yet in the\n   * blockchain. For example, it can be in the mempool.\n   */\n  Submitted = 'submitted',\n\n  /**\n   * The transaction is in the blockchain but has not been\n   * confirmed yet.\n   */\n  Unconfirmed = 'unconfirmed',\n\n  /**\n   * The transaction has been confirmed.\n   */\n  Confirmed = 'confirmed',\n\n  /**\n   * The transaction has failed. For example, it has been reverted.\n   */\n  Failed = 'failed',\n}\n\n/**\n * Transaction types.\n */\nexport enum TransactionType {\n  /**\n   * The transaction was originated by the account. If the transaction\n   * has a change output that goes back to the same account, it must be tagged\n   * as a send transaction.\n   */\n  Send = 'send',\n\n  /**\n   * The transaction was received by the account, but originated by\n   * another account.\n   */\n  Receive = 'receive',\n\n  /**\n   * The transaction is a swap. It decreases the balance of one asset and\n   * increases the balance of another asset in a single transaction.\n   *\n   * A swap transaction must be originated by the account.\n   */\n  Swap = 'swap',\n}\n\n/**\n * This struct represents a transaction event.\n */\nexport const TransactionEventStruct = object({\n  /**\n   * New status of the transaction.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the event occurred.\n   */\n  timestamp: nullable(number()),\n});\n\n/**\n * This struct represents a blockchain transaction.\n *\n * @example\n * ```ts\n * const tx = {\n *   id: 'f5d8ee39a430901c91a5917b9f2dc19d6d1a0e9cea205b009ca73dd04470b9a6',\n *   chain: 'bip122:000000000019d6689c085ae165831e93',\n *   account: 'b9beb861-9761-4b97-89ce-d992be5f34da',\n *   status: 'confirmed',\n *   timestamp: 1716367781,\n *   type: 'send',\n *   from: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   to: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *     {\n *       address: 'bc1qwl8399fz829uqvqly9tcatgrgtwp3udnhxfq4k',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   fees: [\n *     {\n *       type: 'priority',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n * };\n * ```\n */\nexport const TransactionStruct = object({\n  /**\n   * Chain-specific transaction ID.\n   */\n  id: string(),\n\n  /**\n   * Chain ID (CAIP-2).\n   */\n  chain: CaipChainIdStruct,\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Transaction status {@see TransactionStatus}.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the transaction was added to the blockchain. The\n   * timestamp can be null if the transaction has not been included in the\n   * blockchain yet.\n   */\n  timestamp: nullable(number()),\n\n  /**\n   * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction\n   * details on the UI.\n   */\n  type: enums([\n    `${TransactionType.Send}`,\n    `${TransactionType.Receive}`,\n    `${TransactionType.Swap}`,\n  ]),\n\n  /**\n   * Transaction sender addresses and amounts.\n   */\n  from: array(ParticipantStruct),\n\n  /**\n   * Transaction receiver addresses and amounts.\n   */\n  to: array(ParticipantStruct),\n\n  /**\n   * Total transaction fee.\n   */\n  fees: array(FeeStruct),\n\n  /**\n   * List of events related to the transaction {@see TransactionEventStruct}.\n   *\n   * The events are tracked in a best-effort basis and may not be available for\n   * all transactions.\n   */\n  events: array(TransactionEventStruct),\n});\n\n/**\n * Transaction object.\n *\n * See {@link TransactionStruct}.\n */\nexport type Transaction = Infer<typeof TransactionStruct>;\n\n/**\n * This struct represents a page of transactions.\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: 'c3y1Q6QtqtstbxKX+oqVdEW6',\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: null, // No more results\n * }**\n * ```\n */\nexport const TransactionsPageStruct = object({\n  /**\n   * List of transactions.\n   */\n  data: array(TransactionStruct),\n\n  /**\n   * Next cursor to iterate over the results. If null, there are no more\n   * results.\n   */\n  next: nullable(string()),\n});\n\n/**\n * Transactions page object.\n *\n * See {@link TransactionsPageStruct}.\n */\nexport type TransactionsPage = InferEquals<\n  typeof TransactionsPageStruct,\n  Paginated<Transaction>\n>;\n"]}
+{"version":3,"file":"transaction.mjs","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,gCAAgC;AAE7D,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B;AAE/E,OAAO,EAAE,WAAW,EAAE,oBAAgB;AACtC,OAAO,EAAE,iBAAiB,EAAE,mBAAe;AAG3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,iBAAiB,GAAG,MAAM,CAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE;IAEjB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC;CAC7B,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,OAiBX;AAjBD,WAAY,OAAO;IACjB;;;;;;OAMG;IACH,wBAAa,CAAA;IAEb;;;;;OAKG;IACH,gCAAqB,CAAA;AACvB,CAAC,EAjBW,OAAO,KAAP,OAAO,QAiBlB;AAED;;GAEG;AACH,MAAM,SAAS,GAAG,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvD;;OAEG;IACH,KAAK,EAAE,WAAW;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,iBAsBX;AAtBD,WAAY,iBAAiB;IAC3B;;;OAGG;IACH,4CAAuB,CAAA;IAEvB;;;OAGG;IACH,gDAA2B,CAAA;IAE3B;;OAEG;IACH,4CAAuB,CAAA;IAEvB;;OAEG;IACH,sCAAiB,CAAA;AACnB,CAAC,EAtBW,iBAAiB,KAAjB,iBAAiB,QAsB5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAuCX;AAvCD,WAAY,eAAe;IACzB;;;;OAIG;IACH,gCAAa,CAAA;IAEb;;;OAGG;IACH,sCAAmB,CAAA;IAEnB;;;;;OAKG;IACH,gCAAa,CAAA;IAEb;;;OAGG;IACH,6CAA0B,CAAA;IAE1B;;;OAGG;IACH,mDAAgC,CAAA;IAEhC;;;OAGG;IACH,sCAAmB,CAAA;AACrB,CAAC,EAvCW,eAAe,KAAf,eAAe,QAuC1B;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CAC9B,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,EAAE;IAEZ;;OAEG;IACH,KAAK,EAAE,iBAAiB;IAExB;;OAEG;IACH,OAAO,EAAE,UAAU;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;QACZ,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,WAAW,EAAE;QAClC,GAAG,iBAAiB,CAAC,SAAS,EAAE;QAChC,GAAG,iBAAiB,CAAC,MAAM,EAAE;KAC9B,CAAC;IAEF;;;;OAIG;IACH,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAE7B;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC;QACV,GAAG,eAAe,CAAC,IAAI,EAAE;QACzB,GAAG,eAAe,CAAC,OAAO,EAAE;QAC5B,GAAG,eAAe,CAAC,IAAI,EAAE;QACzB,GAAG,eAAe,CAAC,UAAU,EAAE;QAC/B,GAAG,eAAe,CAAC,aAAa,EAAE;QAClC,GAAG,eAAe,CAAC,OAAO,EAAE;KAC7B,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAE9B;;OAEG;IACH,EAAE,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC;IAEtB;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC;CACtC,CAAC,CAAC;AASH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;IAC3C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACzB,CAAC,CAAC","sourcesContent":["import type { InferEquals } from '@metamask/keyring-utils';\nimport { object, UuidStruct } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, enums, nullable, number, string } from '@metamask/superstruct';\n\nimport { AssetStruct } from './asset';\nimport { CaipChainIdStruct } from './caip';\nimport type { Paginated } from './pagination';\n\n/**\n * This struct represents a participant in a transaction.\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: true,\n *     type: 'eip155:1/slip44:60',\n *     unit: 'ETH',\n *     amount: '0.01',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: {\n *     fungible: false,\n *     id: 'eip155:1/erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d/771769',\n *   },\n * },\n * ```\n *\n * @example\n * ```ts\n * {\n *   address: '0x1234...',\n *   asset: null,\n * },\n * ```\n */\nconst ParticipantStruct = object({\n  /**\n   * Participant address.\n   */\n  address: string(),\n\n  /**\n   * Asset being transferred.\n   */\n  asset: nullable(AssetStruct),\n});\n\n/**\n * Fee types.\n */\nexport enum FeeType {\n  /**\n   * Base fee. It is the minimum fee required to include a transaction in the\n   * blockchain.\n   *\n   * For non-confirmed transactions, it must be the maximum base fee. For\n   * confirmed transactions, it must be the actual base fee paid.\n   */\n  Base = 'base',\n\n  /**\n   * Priority fee. It is an optional fee used to prioritize the transaction.\n   *\n   * For non-confirmed transactions, it must be the maximum priority fee. For\n   * confirmed transactions, it must be the actual priority fee paid.\n   */\n  Priority = 'priority',\n}\n\n/**\n * This struct represents a transaction fee.\n */\nconst FeeStruct = object({\n  /**\n   * Fee type {@see FeeType}.\n   */\n  type: enums([`${FeeType.Base}`, `${FeeType.Priority}`]),\n\n  /**\n   * Asset used to pay for the fee.\n   */\n  asset: AssetStruct,\n});\n\n/**\n * Transaction statuses.\n */\nexport enum TransactionStatus {\n  /**\n   * The transaction has been submitted but is not yet in the\n   * blockchain. For example, it can be in the mempool.\n   */\n  Submitted = 'submitted',\n\n  /**\n   * The transaction is in the blockchain but has not been\n   * confirmed yet.\n   */\n  Unconfirmed = 'unconfirmed',\n\n  /**\n   * The transaction has been confirmed.\n   */\n  Confirmed = 'confirmed',\n\n  /**\n   * The transaction has failed. For example, it has been reverted.\n   */\n  Failed = 'failed',\n}\n\n/**\n * Transaction types.\n */\nexport enum TransactionType {\n  /**\n   * The transaction was originated by the account. If the transaction\n   * has a change output that goes back to the same account, it must be tagged\n   * as a send transaction.\n   */\n  Send = 'send',\n\n  /**\n   * The transaction was received by the account, but originated by\n   * another account.\n   */\n  Receive = 'receive',\n\n  /**\n   * The transaction is a swap. It decreases the balance of one asset and\n   * increases the balance of another asset in a single transaction.\n   *\n   * A swap transaction must be originated by the account.\n   */\n  Swap = 'swap',\n\n  /**\n   * Represents an outgoing bridge transaction, transferring assets from\n   * the account to another blockchain.\n   */\n  BridgeSend = 'bridge:send',\n\n  /**\n   * Represents an incoming bridge transaction, transferring assets from\n   * another blockchain to the account.\n   */\n  BridgeReceive = 'bridge:receive',\n\n  /**\n   * The transaction type is unknown. It's not possible to determine the\n   * transaction type based on the information available.\n   */\n  Unknown = 'unknown',\n}\n\n/**\n * This struct represents a transaction event.\n */\nexport const TransactionEventStruct = object({\n  /**\n   * New status of the transaction.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the event occurred.\n   */\n  timestamp: nullable(number()),\n});\n\n/**\n * This struct represents a blockchain transaction.\n *\n * @example\n * ```ts\n * const tx = {\n *   id: 'f5d8ee39a430901c91a5917b9f2dc19d6d1a0e9cea205b009ca73dd04470b9a6',\n *   chain: 'bip122:000000000019d6689c085ae165831e93',\n *   account: 'b9beb861-9761-4b97-89ce-d992be5f34da',\n *   status: 'confirmed',\n *   timestamp: 1716367781,\n *   type: 'send',\n *   from: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   to: [\n *     {\n *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *     {\n *       address: 'bc1qwl8399fz829uqvqly9tcatgrgtwp3udnhxfq4k',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n *   fees: [\n *     {\n *       type: 'priority',\n *       asset: {\n *         fungible: true,\n *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',\n *         unit: 'BTC',\n *         amount: '0.1',\n *       },\n *     },\n *   ],\n * };\n * ```\n */\nexport const TransactionStruct = object({\n  /**\n   * Chain-specific transaction ID.\n   */\n  id: string(),\n\n  /**\n   * Chain ID (CAIP-2).\n   */\n  chain: CaipChainIdStruct,\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Transaction status {@see TransactionStatus}.\n   */\n  status: enums([\n    `${TransactionStatus.Submitted}`,\n    `${TransactionStatus.Unconfirmed}`,\n    `${TransactionStatus.Confirmed}`,\n    `${TransactionStatus.Failed}`,\n  ]),\n\n  /**\n   * UNIX timestamp of when the transaction was added to the blockchain. The\n   * timestamp can be null if the transaction has not been included in the\n   * blockchain yet.\n   */\n  timestamp: nullable(number()),\n\n  /**\n   * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction\n   * details on the UI.\n   */\n  type: enums([\n    `${TransactionType.Send}`,\n    `${TransactionType.Receive}`,\n    `${TransactionType.Swap}`,\n    `${TransactionType.BridgeSend}`,\n    `${TransactionType.BridgeReceive}`,\n    `${TransactionType.Unknown}`,\n  ]),\n\n  /**\n   * Transaction sender addresses and amounts.\n   */\n  from: array(ParticipantStruct),\n\n  /**\n   * Transaction receiver addresses and amounts.\n   */\n  to: array(ParticipantStruct),\n\n  /**\n   * Total transaction fee.\n   */\n  fees: array(FeeStruct),\n\n  /**\n   * List of events related to the transaction {@see TransactionEventStruct}.\n   *\n   * The events are tracked in a best-effort basis and may not be available for\n   * all transactions.\n   */\n  events: array(TransactionEventStruct),\n});\n\n/**\n * Transaction object.\n *\n * See {@link TransactionStruct}.\n */\nexport type Transaction = Infer<typeof TransactionStruct>;\n\n/**\n * This struct represents a page of transactions.\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: 'c3y1Q6QtqtstbxKX+oqVdEW6',\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   data: [\n *     {\n *       // Transaction object\n *     }\n *   ],\n *   next: null, // No more results\n * }**\n * ```\n */\nexport const TransactionsPageStruct = object({\n  /**\n   * List of transactions.\n   */\n  data: array(TransactionStruct),\n\n  /**\n   * Next cursor to iterate over the results. If null, there are no more\n   * results.\n   */\n  next: nullable(string()),\n});\n\n/**\n * Transactions page object.\n *\n * See {@link TransactionsPageStruct}.\n */\nexport type TransactionsPage = InferEquals<\n  typeof TransactionsPageStruct,\n  Paginated<Transaction>\n>;\n"]}

package/dist/events.cjs

@@ -1,4 +1,6 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-redundant-type-constituents */
+// FIXME: This rule seems to be triggering a false positive on the `KeyringEvents`.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountAssetListUpdatedEventStruct = exports.AccountTransactionsUpdatedEventStruct = exports.AccountBalancesUpdatedEventStruct = exports.RequestRejectedEventStruct = exports.RequestApprovedEventStruct = exports.AccountDeletedEventStruct = exports.AccountUpdatedEventStruct = exports.AccountCreatedEventStruct = exports.KeyringEvent = void 0;
 const keyring_utils_1 = require("@metamask/keyring-utils");
@@ -100,6 +102,13 @@ exports.RequestRejectedEventStruct = (0, keyring_utils_1.object)({
 });
 // Assets related events:
 // -----------------------------------------------------------------------------------------------
+/**
+ * Event emitted when the balances of an account are updated.
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
 exports.AccountBalancesUpdatedEventStruct = (0, keyring_utils_1.object)({
     method: (0, superstruct_1.literal)(`${KeyringEvent.AccountBalancesUpdated}`),
     params: (0, keyring_utils_1.object)({
@@ -125,6 +134,14 @@ exports.AccountBalancesUpdatedEventStruct = (0, keyring_utils_1.object)({
         api_1.FungibleAssetAmountStruct)),
     }),
 });
+/**
+ * Event emitted when the transactions of an account are updated (added or
+ * changed).
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
 exports.AccountTransactionsUpdatedEventStruct = (0, keyring_utils_1.object)({
     method: (0, superstruct_1.literal)(`${KeyringEvent.AccountTransactionsUpdated}`),
     params: (0, keyring_utils_1.object)({
@@ -142,6 +159,13 @@ exports.AccountTransactionsUpdatedEventStruct = (0, keyring_utils_1.object)({
         (0, superstruct_1.array)(api_1.TransactionStruct)),
     }),
 });
+/**
+ * Event emitted when the assets of an account are updated.
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
 exports.AccountAssetListUpdatedEventStruct = (0, keyring_utils_1.object)({
     method: (0, superstruct_1.literal)(`${KeyringEvent.AccountAssetListUpdated}`),
     params: (0, keyring_utils_1.object)({

package/dist/events.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"events.cjs","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";;;AAAA,2DAKiC;AAEjC,uDAAgF;AAChF,2CAIyB;AAEzB,yCAKe;AAEf;;GAEG;AACH,IAAY,YAcX;AAdD,WAAY,YAAY;IACtB,iBAAiB;IACjB,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IAExC,iBAAiB;IACjB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAE1C,wBAAwB;IACxB,wEAAwD,CAAA;IACxD,0EAA0D,CAAA;IAC1D,gFAAgE,CAAA;AAClE,CAAC,EAdW,YAAY,4BAAZ,YAAY,QAcvB;AAEY,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;QAE7B;;;;;;WAMG;QACH,qBAAqB,EAAE,IAAA,6BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QAE9C;;;;WAIG;QACH,mBAAmB,EAAE,IAAA,6BAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;QAE7C;;;;;;;WAOG;QACH,4BAA4B,EAAE,IAAA,6BAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;QAEtD;;WAEG;QACH,GAAG,2BAAqB,CAAC,MAAM;KAChC,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;QAEd;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEH,yBAAyB;AACzB,kGAAkG;AAErF,QAAA,iCAAiC,GAAG,IAAA,sBAAM,EAAC;IACtD,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,sBAAsB,EAAE,CAAC;IACzD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,QAAQ,EAAE,IAAA,oBAAM;QACd;;WAEG;QACH,+BAAe;QAEf;;WAEG;QACH,IAAA,oBAAM;QACJ;;WAEG;QACH,2BAAmB;QAEnB;;WAEG;QACH,+BAAyB,CAC1B,CACF;KACF,CAAC;CACH,CAAC,CAAC;AAeU,QAAA,qCAAqC,GAAG,IAAA,sBAAM,EAAC;IAC1D,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,0BAA0B,EAAE,CAAC;IAC7D,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,YAAY,EAAE,IAAA,oBAAM;QAClB;;WAEG;QACH,+BAAe;QAEf;;WAEG;QACH,IAAA,mBAAK,EAAC,uBAAiB,CAAC,CACzB;KACF,CAAC;CACH,CAAC,CAAC;AAgBU,QAAA,kCAAkC,GAAG,IAAA,sBAAM,EAAC;IACvD,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,uBAAuB,EAAE,CAAC;IAC1D,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,MAAM,EAAE,IAAA,oBAAM;QACZ;;WAEG;QACH,+BAAe;QAEf;;WAEG;QACH,IAAA,sBAAM,EAAC;YACL;;eAEG;YACH,KAAK,EAAE,IAAA,mBAAK,EAAC,+BAAuB,CAAC;YAErC;;eAEG;YACH,OAAO,EAAE,IAAA,mBAAK,EAAC,+BAAuB,CAAC;SACxC,CAAC,CACH;KACF,CAAC;CACH,CAAC,CAAC","sourcesContent":["import {\n  exactOptional,\n  object,\n  UuidStruct,\n  AccountIdStruct,\n} from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, boolean, literal, record, string } from '@metamask/superstruct';\nimport {\n  CaipAssetTypeStruct,\n  CaipAssetTypeOrIdStruct,\n  JsonStruct,\n} from '@metamask/utils';\n\nimport {\n  FungibleAssetAmountStruct,\n  KeyringAccountStruct,\n  TransactionStruct,\n  MetaMaskOptionsStruct,\n} from './api';\n\n/**\n * Supported keyring events.\n */\nexport enum KeyringEvent {\n  // Account events\n  AccountCreated = 'notify:accountCreated',\n  AccountUpdated = 'notify:accountUpdated',\n  AccountDeleted = 'notify:accountDeleted',\n\n  // Request events\n  RequestApproved = 'notify:requestApproved',\n  RequestRejected = 'notify:requestRejected',\n\n  // Assets related events\n  AccountBalancesUpdated = 'notify:accountBalancesUpdated',\n  AccountAssetListUpdated = 'notify:accountAssetListUpdated',\n  AccountTransactionsUpdated = 'notify:accountTransactionsUpdated',\n}\n\nexport const AccountCreatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountCreated}`),\n  params: object({\n    /**\n     * New account object.\n     */\n    account: KeyringAccountStruct,\n\n    /**\n     * Account name suggestion provided to the MetaMask client.\n     *\n     * The keyring can suggest a name for the account, but it's up to the\n     * client to decide whether to use it. The keyring won't be informed if the\n     * client decides to use a different name.\n     */\n    accountNameSuggestion: exactOptional(string()),\n\n    /**\n     * Instructs MetaMask to display the add account confirmation dialog in the UI.\n     *\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayConfirmation: exactOptional(boolean()),\n\n    /**\n     * Instructs MetaMask to display the name confirmation dialog in the UI.\n     * Otherwise, the account will be added with the suggested name, if it's not\n     * already in use; if it is, a suffix will be appended to the name to make it\n     * unique.\n     *\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayAccountNameSuggestion: exactOptional(boolean()),\n\n    /**\n     * Metamask internal options.\n     */\n    ...MetaMaskOptionsStruct.schema,\n  }),\n});\n\nexport const AccountUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountUpdated}`),\n  params: object({\n    /**\n     * Updated account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\n\nexport const AccountDeletedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountDeleted}`),\n  params: object({\n    /**\n     * Deleted account ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\nexport const RequestApprovedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestApproved}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n});\n\nexport const RequestRejectedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestRejected}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\n// Assets related events:\n// -----------------------------------------------------------------------------------------------\n\nexport const AccountBalancesUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountBalancesUpdated}`),\n  params: object({\n    /**\n     * Balances updates of accounts owned by the Snap.\n     */\n    balances: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * Mapping of each owned assets and their respective balances for that account.\n       */\n      record(\n        /**\n         * Asset type (CAIP-19).\n         */\n        CaipAssetTypeStruct,\n\n        /**\n         * Balance information for a given asset.\n         */\n        FungibleAssetAmountStruct,\n      ),\n    ),\n  }),\n});\n\n/**\n * Event emitted when the balances of an account are updated.\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport type AccountBalancesUpdatedEvent = Infer<\n  typeof AccountBalancesUpdatedEventStruct\n>;\nexport type AccountBalancesUpdatedEventPayload =\n  AccountBalancesUpdatedEvent['params'];\n\nexport const AccountTransactionsUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountTransactionsUpdated}`),\n  params: object({\n    /**\n     * Transactions updates of accounts owned by the Snap.\n     */\n    transactions: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * List of updated transactions for that account.\n       */\n      array(TransactionStruct),\n    ),\n  }),\n});\n\n/**\n * Event emitted when the transactions of an account are updated (added or\n * changed).\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport type AccountTransactionsUpdatedEvent = Infer<\n  typeof AccountTransactionsUpdatedEventStruct\n>;\nexport type AccountTransactionsUpdatedEventPayload =\n  AccountTransactionsUpdatedEvent['params'];\n\nexport const AccountAssetListUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountAssetListUpdated}`),\n  params: object({\n    /**\n     * Asset list update of accounts owned by the Snap.\n     */\n    assets: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * Asset list changes for that account.\n       */\n      object({\n        /**\n         * New assets detected.\n         */\n        added: array(CaipAssetTypeOrIdStruct),\n\n        /**\n         * Assets no longer available on that account.\n         */\n        removed: array(CaipAssetTypeOrIdStruct),\n      }),\n    ),\n  }),\n});\n\n/**\n * Event emitted when the assets of an account are updated.\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport type AccountAssetListUpdatedEvent = Infer<\n  typeof AccountAssetListUpdatedEventStruct\n>;\nexport type AccountAssetListUpdatedEventPayload =\n  AccountAssetListUpdatedEvent['params'];\n"]}
+{"version":3,"file":"events.cjs","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,mFAAmF;;;AAEnF,2DAKiC;AAEjC,uDAAgF;AAChF,2CAIyB;AAEzB,yCAKe;AAEf;;GAEG;AACH,IAAY,YAcX;AAdD,WAAY,YAAY;IACtB,iBAAiB;IACjB,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IAExC,iBAAiB;IACjB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAE1C,wBAAwB;IACxB,wEAAwD,CAAA;IACxD,0EAA0D,CAAA;IAC1D,gFAAgE,CAAA;AAClE,CAAC,EAdW,YAAY,4BAAZ,YAAY,QAcvB;AAEY,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;QAE7B;;;;;;WAMG;QACH,qBAAqB,EAAE,IAAA,6BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QAE9C;;;;WAIG;QACH,mBAAmB,EAAE,IAAA,6BAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;QAE7C;;;;;;;WAOG;QACH,4BAA4B,EAAE,IAAA,6BAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;QAEtD;;WAEG;QACH,GAAG,2BAAqB,CAAC,MAAM;KAChC,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,0BAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;QAEd;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC;AAIH,yBAAyB;AACzB,kGAAkG;AAElG;;;;;;GAMG;AACU,QAAA,iCAAiC,GAAG,IAAA,sBAAM,EAAC;IACtD,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,sBAAsB,EAAE,CAAC;IACzD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,QAAQ,EAAE,IAAA,oBAAM;QACd;;WAEG;QACH,+BAAe;QAEf;;WAEG;QACH,IAAA,oBAAM;QACJ;;WAEG;QACH,2BAAmB;QAEnB;;WAEG;QACH,+BAAyB,CAC1B,CACF;KACF,CAAC;CACH,CAAC,CAAC;AAOH;;;;;;;GAOG;AACU,QAAA,qCAAqC,GAAG,IAAA,sBAAM,EAAC;IAC1D,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,0BAA0B,EAAE,CAAC;IAC7D,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,YAAY,EAAE,IAAA,oBAAM;QAClB;;WAEG;QACH,+BAAe;QAEf;;WAEG;QACH,IAAA,mBAAK,EAAC,uBAAiB,CAAC,CACzB;KACF,CAAC;CACH,CAAC,CAAC;AAOH;;;;;;GAMG;AACU,QAAA,kCAAkC,GAAG,IAAA,sBAAM,EAAC;IACvD,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,uBAAuB,EAAE,CAAC;IAC1D,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,MAAM,EAAE,IAAA,oBAAM;QACZ;;WAEG;QACH,+BAAe;QAEf;;WAEG;QACH,IAAA,sBAAM,EAAC;YACL;;eAEG;YACH,KAAK,EAAE,IAAA,mBAAK,EAAC,+BAAuB,CAAC;YAErC;;eAEG;YACH,OAAO,EAAE,IAAA,mBAAK,EAAC,+BAAuB,CAAC;SACxC,CAAC,CACH;KACF,CAAC;CACH,CAAC,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/no-redundant-type-constituents */\n// FIXME: This rule seems to be triggering a false positive on the `KeyringEvents`.\n\nimport {\n  exactOptional,\n  object,\n  UuidStruct,\n  AccountIdStruct,\n} from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, boolean, literal, record, string } from '@metamask/superstruct';\nimport {\n  CaipAssetTypeStruct,\n  CaipAssetTypeOrIdStruct,\n  JsonStruct,\n} from '@metamask/utils';\n\nimport {\n  FungibleAssetAmountStruct,\n  KeyringAccountStruct,\n  TransactionStruct,\n  MetaMaskOptionsStruct,\n} from './api';\n\n/**\n * Supported keyring events.\n */\nexport enum KeyringEvent {\n  // Account events\n  AccountCreated = 'notify:accountCreated',\n  AccountUpdated = 'notify:accountUpdated',\n  AccountDeleted = 'notify:accountDeleted',\n\n  // Request events\n  RequestApproved = 'notify:requestApproved',\n  RequestRejected = 'notify:requestRejected',\n\n  // Assets related events\n  AccountBalancesUpdated = 'notify:accountBalancesUpdated',\n  AccountAssetListUpdated = 'notify:accountAssetListUpdated',\n  AccountTransactionsUpdated = 'notify:accountTransactionsUpdated',\n}\n\nexport const AccountCreatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountCreated}`),\n  params: object({\n    /**\n     * New account object.\n     */\n    account: KeyringAccountStruct,\n\n    /**\n     * Account name suggestion provided to the MetaMask client.\n     *\n     * The keyring can suggest a name for the account, but it's up to the\n     * client to decide whether to use it. The keyring won't be informed if the\n     * client decides to use a different name.\n     */\n    accountNameSuggestion: exactOptional(string()),\n\n    /**\n     * Instructs MetaMask to display the add account confirmation dialog in the UI.\n     *\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayConfirmation: exactOptional(boolean()),\n\n    /**\n     * Instructs MetaMask to display the name confirmation dialog in the UI.\n     * Otherwise, the account will be added with the suggested name, if it's not\n     * already in use; if it is, a suffix will be appended to the name to make it\n     * unique.\n     *\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayAccountNameSuggestion: exactOptional(boolean()),\n\n    /**\n     * Metamask internal options.\n     */\n    ...MetaMaskOptionsStruct.schema,\n  }),\n});\nexport type AccountCreatedEvent = Infer<typeof AccountCreatedEventStruct>;\nexport type AccountCreatedEventPayload = AccountCreatedEvent['params'];\n\nexport const AccountUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountUpdated}`),\n  params: object({\n    /**\n     * Updated account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\nexport type AccountUpdatedEvent = Infer<typeof AccountUpdatedEventStruct>;\nexport type AccountUpdatedEventPayload = AccountUpdatedEvent['params'];\n\nexport const AccountDeletedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountDeleted}`),\n  params: object({\n    /**\n     * Deleted account ID.\n     */\n    id: UuidStruct,\n  }),\n});\nexport type AccountDeletedEvent = Infer<typeof AccountDeletedEventStruct>;\nexport type AccountDeletedEventPayload = AccountDeletedEvent['params'];\n\nexport const RequestApprovedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestApproved}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n});\nexport type RequestApprovedEvent = Infer<typeof RequestApprovedEventStruct>;\nexport type RequestApprovedEventPayload = RequestApprovedEvent['params'];\n\nexport const RequestRejectedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestRejected}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n  }),\n});\nexport type RequestRejectedEvent = Infer<typeof RequestRejectedEventStruct>;\nexport type RequestRejectedEventPayload = RequestRejectedEvent['params'];\n\n// Assets related events:\n// -----------------------------------------------------------------------------------------------\n\n/**\n * Event emitted when the balances of an account are updated.\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport const AccountBalancesUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountBalancesUpdated}`),\n  params: object({\n    /**\n     * Balances updates of accounts owned by the Snap.\n     */\n    balances: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * Mapping of each owned assets and their respective balances for that account.\n       */\n      record(\n        /**\n         * Asset type (CAIP-19).\n         */\n        CaipAssetTypeStruct,\n\n        /**\n         * Balance information for a given asset.\n         */\n        FungibleAssetAmountStruct,\n      ),\n    ),\n  }),\n});\nexport type AccountBalancesUpdatedEvent = Infer<\n  typeof AccountBalancesUpdatedEventStruct\n>;\nexport type AccountBalancesUpdatedEventPayload =\n  AccountBalancesUpdatedEvent['params'];\n\n/**\n * Event emitted when the transactions of an account are updated (added or\n * changed).\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport const AccountTransactionsUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountTransactionsUpdated}`),\n  params: object({\n    /**\n     * Transactions updates of accounts owned by the Snap.\n     */\n    transactions: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * List of updated transactions for that account.\n       */\n      array(TransactionStruct),\n    ),\n  }),\n});\nexport type AccountTransactionsUpdatedEvent = Infer<\n  typeof AccountTransactionsUpdatedEventStruct\n>;\nexport type AccountTransactionsUpdatedEventPayload =\n  AccountTransactionsUpdatedEvent['params'];\n\n/**\n * Event emitted when the assets of an account are updated.\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport const AccountAssetListUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountAssetListUpdated}`),\n  params: object({\n    /**\n     * Asset list update of accounts owned by the Snap.\n     */\n    assets: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * Asset list changes for that account.\n       */\n      object({\n        /**\n         * New assets detected.\n         */\n        added: array(CaipAssetTypeOrIdStruct),\n\n        /**\n         * Assets no longer available on that account.\n         */\n        removed: array(CaipAssetTypeOrIdStruct),\n      }),\n    ),\n  }),\n});\nexport type AccountAssetListUpdatedEvent = Infer<\n  typeof AccountAssetListUpdatedEventStruct\n>;\nexport type AccountAssetListUpdatedEventPayload =\n  AccountAssetListUpdatedEvent['params'];\n\n/**\n * Keyring events.\n */\n// For some reason, eslint sometimes infer one of those members as `any`...\ntype KeyringEvents =\n  | AccountCreatedEvent\n  | AccountUpdatedEvent\n  | AccountDeletedEvent\n  | AccountAssetListUpdatedEvent\n  | AccountBalancesUpdatedEvent\n  | AccountTransactionsUpdatedEvent\n  | RequestApprovedEvent\n  | RequestRejectedEvent;\n\n/**\n * Extract the payload for a given `KeyringEvent` event.\n */\nexport type KeyringEventPayload<Event extends KeyringEvent> = Extract<\n  KeyringEvents,\n  // We need to use a literal string here, since that is what `KeyringEvents`\n  // is using (probably because of `superstruct`.\n  { method: `${Event}` }\n>['params'];\n"]}

package/dist/events.d.cts

@@ -101,6 +101,8 @@ export declare const AccountCreatedEventStruct: import("@metamask/superstruct").
         displayAccountNameSuggestion: import("@metamask/superstruct").Struct<boolean | import("@metamask/keyring-utils").ExactOptionalTag, null>;
     }>;
 }>;
+export type AccountCreatedEvent = Infer<typeof AccountCreatedEventStruct>;
+export type AccountCreatedEventPayload = AccountCreatedEvent['params'];
 export declare const AccountUpdatedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:accountUpdated";
     params: {
@@ -150,6 +152,8 @@ export declare const AccountUpdatedEventStruct: import("@metamask/superstruct").
         }>;
     }>;
 }>;
+export type AccountUpdatedEvent = Infer<typeof AccountUpdatedEventStruct>;
+export type AccountUpdatedEventPayload = AccountUpdatedEvent['params'];
 export declare const AccountDeletedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:accountDeleted";
     params: {
@@ -166,6 +170,8 @@ export declare const AccountDeletedEventStruct: import("@metamask/superstruct").
         id: import("@metamask/superstruct").Struct<string, null>;
     }>;
 }>;
+export type AccountDeletedEvent = Infer<typeof AccountDeletedEventStruct>;
+export type AccountDeletedEventPayload = AccountDeletedEvent['params'];
 export declare const RequestApprovedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:requestApproved";
     params: {
@@ -188,6 +194,8 @@ export declare const RequestApprovedEventStruct: import("@metamask/superstruct")
         result: import("@metamask/superstruct").Struct<import("@metamask/utils").Json, unknown>;
     }>;
 }>;
+export type RequestApprovedEvent = Infer<typeof RequestApprovedEventStruct>;
+export type RequestApprovedEventPayload = RequestApprovedEvent['params'];
 export declare const RequestRejectedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:requestRejected";
     params: {
@@ -204,6 +212,15 @@ export declare const RequestRejectedEventStruct: import("@metamask/superstruct")
         id: import("@metamask/superstruct").Struct<string, null>;
     }>;
 }>;
+export type RequestRejectedEvent = Infer<typeof RequestRejectedEventStruct>;
+export type RequestRejectedEventPayload = RequestRejectedEvent['params'];
+/**
+ * Event emitted when the balances of an account are updated.
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
 export declare const AccountBalancesUpdatedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:accountBalancesUpdated";
     params: {
@@ -229,20 +246,21 @@ export declare const AccountBalancesUpdatedEventStruct: import("@metamask/supers
         }>>, null>;
     }>;
 }>;
+export type AccountBalancesUpdatedEvent = Infer<typeof AccountBalancesUpdatedEventStruct>;
+export type AccountBalancesUpdatedEventPayload = AccountBalancesUpdatedEvent['params'];
 /**
- * Event emitted when the balances of an account are updated.
+ * Event emitted when the transactions of an account are updated (added or
+ * changed).
  *
  * Only changes are reported.
  *
  * The Snap can choose to emit this event for multiple accounts at once.
  */
-export type AccountBalancesUpdatedEvent = Infer<typeof AccountBalancesUpdatedEventStruct>;
-export type AccountBalancesUpdatedEventPayload = AccountBalancesUpdatedEvent['params'];
 export declare const AccountTransactionsUpdatedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:accountTransactionsUpdated";
     params: {
         transactions: Record<string, {
-            type: "send" | "receive" | "swap";
+            type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
             id: string;
             from: {
                 address: string;
@@ -294,7 +312,7 @@ export declare const AccountTransactionsUpdatedEventStruct: import("@metamask/su
     method: import("@metamask/superstruct").Struct<"notify:accountTransactionsUpdated", "notify:accountTransactionsUpdated">;
     params: import("@metamask/superstruct").Struct<{
         transactions: Record<string, {
-            type: "send" | "receive" | "swap";
+            type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
             id: string;
             from: {
                 address: string;
@@ -346,7 +364,7 @@ export declare const AccountTransactionsUpdatedEventStruct: import("@metamask/su
          * Transactions updates of accounts owned by the Snap.
          */
         transactions: import("@metamask/superstruct").Struct<Record<string, {
-            type: "send" | "receive" | "swap";
+            type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive";
             id: string;
             from: {
                 address: string;
@@ -395,16 +413,15 @@ export declare const AccountTransactionsUpdatedEventStruct: import("@metamask/su
         }[]>, null>;
     }>;
 }>;
+export type AccountTransactionsUpdatedEvent = Infer<typeof AccountTransactionsUpdatedEventStruct>;
+export type AccountTransactionsUpdatedEventPayload = AccountTransactionsUpdatedEvent['params'];
 /**
- * Event emitted when the transactions of an account are updated (added or
- * changed).
+ * Event emitted when the assets of an account are updated.
  *
  * Only changes are reported.
  *
  * The Snap can choose to emit this event for multiple accounts at once.
  */
-export type AccountTransactionsUpdatedEvent = Infer<typeof AccountTransactionsUpdatedEventStruct>;
-export type AccountTransactionsUpdatedEventPayload = AccountTransactionsUpdatedEvent['params'];
 export declare const AccountAssetListUpdatedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:accountAssetListUpdated";
     params: {
@@ -430,13 +447,17 @@ export declare const AccountAssetListUpdatedEventStruct: import("@metamask/super
         }>, null>;
     }>;
 }>;
-/**
- * Event emitted when the assets of an account are updated.
- *
- * Only changes are reported.
- *
- * The Snap can choose to emit this event for multiple accounts at once.
- */
 export type AccountAssetListUpdatedEvent = Infer<typeof AccountAssetListUpdatedEventStruct>;
 export type AccountAssetListUpdatedEventPayload = AccountAssetListUpdatedEvent['params'];
+/**
+ * Keyring events.
+ */
+type KeyringEvents = AccountCreatedEvent | AccountUpdatedEvent | AccountDeletedEvent | AccountAssetListUpdatedEvent | AccountBalancesUpdatedEvent | AccountTransactionsUpdatedEvent | RequestApprovedEvent | RequestRejectedEvent;
+/**
+ * Extract the payload for a given `KeyringEvent` event.
+ */
+export type KeyringEventPayload<Event extends KeyringEvent> = Extract<KeyringEvents, {
+    method: `${Event}`;
+}>['params'];
+export {};
 //# sourceMappingURL=events.d.cts.map

package/dist/events.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.cts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAenD;;GAEG;AACH,oBAAY,YAAY;IAEtB,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IAGxC,eAAe,2BAA2B;IAC1C,eAAe,2BAA2B;IAG1C,sBAAsB,kCAAkC;IACxD,uBAAuB,mCAAmC;IAC1D,0BAA0B,sCAAsC;CACjE;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;;QAGH;;;;WAIG;;QAGH;;;;;;;WAOG;;;EAQL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;QAGlC;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;QAGnC;;WAEG;;QAGH;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;QAGnC;;WAEG;;;EAGL,CAAC;AAKH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;QAG1C;;WAEG;;;;;;EAuBL,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AACF,MAAM,MAAM,kCAAkC,GAC5C,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AAExC,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAG9C;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAaL,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,+BAA+B,GAAG,KAAK,CACjD,OAAO,qCAAqC,CAC7C,CAAC;AACF,MAAM,MAAM,sCAAsC,GAChD,+BAA+B,CAAC,QAAQ,CAAC,CAAC;AAE5C,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;QAG3C;;WAEG;;;;;;EAuBL,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AACF,MAAM,MAAM,mCAAmC,GAC7C,4BAA4B,CAAC,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"events.d.cts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAenD;;GAEG;AACH,oBAAY,YAAY;IAEtB,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IAGxC,eAAe,2BAA2B;IAC1C,eAAe,2BAA2B;IAG1C,sBAAsB,kCAAkC;IACxD,uBAAuB,mCAAmC;IAC1D,0BAA0B,sCAAsC;CACjE;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;;QAGH;;;;WAIG;;QAGH;;;;;;;WAOG;;;EAQL,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC1E,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAEvE,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC1E,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAEvE,eAAO,MAAM,yBAAyB;;;;;;;;;;QAGlC;;WAEG;;;EAGL,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC1E,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAEvE,eAAO,MAAM,0BAA0B;;;;;;;;;;;;QAGnC;;WAEG;;QAGH;;WAEG;;;EAGL,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC5E,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAEzE,eAAO,MAAM,0BAA0B;;;;;;;;;;QAGnC;;WAEG;;;EAGL,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC5E,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAKzE;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;QAG1C;;WAEG;;;;;;EAuBL,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AACF,MAAM,MAAM,kCAAkC,GAC5C,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AAExC;;;;;;;GAOG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAG9C;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAaL,CAAC;AACH,MAAM,MAAM,+BAA+B,GAAG,KAAK,CACjD,OAAO,qCAAqC,CAC7C,CAAC;AACF,MAAM,MAAM,sCAAsC,GAChD,+BAA+B,CAAC,QAAQ,CAAC,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;QAG3C;;WAEG;;;;;;EAuBL,CAAC;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AACF,MAAM,MAAM,mCAAmC,GAC7C,4BAA4B,CAAC,QAAQ,CAAC,CAAC;AAEzC;;GAEG;AAEH,KAAK,aAAa,GACd,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,4BAA4B,GAC5B,2BAA2B,GAC3B,+BAA+B,GAC/B,oBAAoB,GACpB,oBAAoB,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,SAAS,YAAY,IAAI,OAAO,CACnE,aAAa,EAGb;IAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAAA;CAAE,CACvB,CAAC,QAAQ,CAAC,CAAC"}