@metamask-previews/keyring-api 11.0.0-b85bfaa → 11.0.0-cd6bf38

package/dist/api/transaction.cjs

@@ -0,0 +1,283 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionsPageStruct = exports.TransactionStruct = exports.TransactionEventStruct = exports.TransactionType = exports.TransactionStatus = exports.FeeType = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const asset_1 = require("./asset.cjs");
+const superstruct_2 = require("../superstruct.cjs");
+const utils_2 = require("../utils/index.cjs");
+/**
+ * This struct represents a participant in a transaction.
+ *
+ * @example
+ * ```ts
+ * {
+ *   address: '0x1234...',
+ *   asset: {
+ *     fungible: true,
+ *     type: 'eip155:1/slip44:60',
+ *     unit: 'ETH',
+ *     amount: '0.01',
+ *   },
+ * },
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   address: '0x1234...',
+ *   asset: {
+ *     fungible: false,
+ *     id: 'eip155:1/erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d/771769',
+ *   },
+ * },
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   address: '0x1234...',
+ *   asset: null,
+ * },
+ * ```
+ */
+const ParticipantStruct = (0, superstruct_2.object)({
+    /**
+     * Participant address.
+     */
+    address: (0, superstruct_1.string)(),
+    /**
+     * Asset being transferred.
+     */
+    asset: (0, superstruct_1.nullable)(asset_1.AssetStruct),
+});
+/**
+ * Fee types.
+ */
+var FeeType;
+(function (FeeType) {
+    /**
+     * Base fee. It is the minimum fee required to include a transaction in the
+     * blockchain.
+     *
+     * For non-confirmed transactions, it must be the maximum base fee. For
+     * confirmed transactions, it must be the actual base fee paid.
+     */
+    FeeType["Base"] = "base";
+    /**
+     * Priority fee. It is an optional fee used to prioritize the transaction.
+     *
+     * For non-confirmed transactions, it must be the maximum priority fee. For
+     * confirmed transactions, it must be the actual priority fee paid.
+     */
+    FeeType["Priority"] = "priority";
+})(FeeType || (exports.FeeType = FeeType = {}));
+/**
+ * This struct represents a transaction fee.
+ */
+const FeeStruct = (0, superstruct_2.object)({
+    /**
+     * Fee type {@see FeeType}.
+     */
+    type: (0, superstruct_1.enums)([`${FeeType.Base}`, `${FeeType.Priority}`]),
+    /**
+     * Asset used to pay for the fee.
+     */
+    asset: asset_1.AssetStruct,
+});
+/**
+ * Transaction statuses.
+ */
+var TransactionStatus;
+(function (TransactionStatus) {
+    /**
+     * The transaction has been submitted but is not yet in the
+     * blockchain. For example, it can be in the mempool.
+     */
+    TransactionStatus["Submitted"] = "submitted";
+    /**
+     * The transaction is in the blockchain but has not been
+     * confirmed yet.
+     */
+    TransactionStatus["Unconfirmed"] = "unconfirmed";
+    /**
+     * The transaction has been confirmed.
+     */
+    TransactionStatus["Confirmed"] = "confirmed";
+    /**
+     * The transaction has failed. For example, it has been reverted.
+     */
+    TransactionStatus["Failed"] = "failed";
+})(TransactionStatus || (exports.TransactionStatus = TransactionStatus = {}));
+/**
+ * Transaction types.
+ */
+var TransactionType;
+(function (TransactionType) {
+    /**
+     * The transaction was originated by the account. If the transaction
+     * has a change output that goes back to the same account, it must be tagged
+     * as a send transaction.
+     */
+    TransactionType["Send"] = "send";
+    /**
+     * The transaction was received by the account, but originated by
+     * another account.
+     */
+    TransactionType["Receive"] = "receive";
+})(TransactionType || (exports.TransactionType = TransactionType = {}));
+/**
+ * This struct represents a transaction event.
+ */
+exports.TransactionEventStruct = (0, superstruct_2.object)({
+    /**
+     * New status of the transaction.
+     */
+    status: (0, superstruct_1.enums)([
+        `${TransactionStatus.Submitted}`,
+        `${TransactionStatus.Unconfirmed}`,
+        `${TransactionStatus.Confirmed}`,
+        `${TransactionStatus.Failed}`,
+    ]),
+    /**
+     * UNIX timestamp of when the event occurred.
+     */
+    timestamp: (0, superstruct_1.nullable)((0, superstruct_1.number)()),
+});
+/**
+ * This struct represents a blockchain transaction.
+ *
+ * @example
+ * ```ts
+ * const tx = {
+ *   id: 'f5d8ee39a430901c91a5917b9f2dc19d6d1a0e9cea205b009ca73dd04470b9a6',
+ *   chain: 'bip122:000000000019d6689c085ae165831e93',
+ *   account: 'b9beb861-9761-4b97-89ce-d992be5f34da',
+ *   status: 'confirmed',
+ *   timestamp: 1716367781,
+ *   type: 'send',
+ *   from: [
+ *     {
+ *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',
+ *       asset: {
+ *         fungible: true,
+ *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+ *         unit: 'BTC',
+ *         amount: '0.1',
+ *       },
+ *     },
+ *   ],
+ *   to: [
+ *     {
+ *       address: 'bc1qrp0yzgkf8rawkuvdlhnjfj2fnjwm0m8727kgah',
+ *       asset: {
+ *         fungible: true,
+ *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+ *         unit: 'BTC',
+ *         amount: '0.1',
+ *       },
+ *     },
+ *     {
+ *       address: 'bc1qwl8399fz829uqvqly9tcatgrgtwp3udnhxfq4k',
+ *       asset: {
+ *         fungible: true,
+ *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+ *         unit: 'BTC',
+ *         amount: '0.1',
+ *       },
+ *     },
+ *   ],
+ *   fees: [
+ *     {
+ *       type: 'priority',
+ *       asset: {
+ *         fungible: true,
+ *         type: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+ *         unit: 'BTC',
+ *         amount: '0.1',
+ *       },
+ *     },
+ *   ],
+ * };
+ * ```
+ */
+exports.TransactionStruct = (0, superstruct_2.object)({
+    /**
+     * Chain-specific transaction ID.
+     */
+    id: (0, superstruct_1.string)(),
+    /**
+     * Chain ID (CAIP-2).
+     */
+    chain: utils_1.CaipChainIdStruct,
+    /**
+     * Account ID (UUIDv4).
+     */
+    account: utils_2.UuidStruct,
+    /**
+     * Transaction status {@see TransactionStatus}.
+     */
+    status: (0, superstruct_1.enums)([
+        `${TransactionStatus.Submitted}`,
+        `${TransactionStatus.Unconfirmed}`,
+        `${TransactionStatus.Confirmed}`,
+        `${TransactionStatus.Failed}`,
+    ]),
+    /**
+     * UNIX timestamp of when the transaction was added to the blockchain. The
+     * timestamp can be null if the transaction has not been included in the
+     * blockchain yet.
+     */
+    timestamp: (0, superstruct_1.nullable)((0, superstruct_1.number)()),
+    /**
+     * Transaction type {@see TransactionType}. This will be used by MetaMask to enrich the transaction
+     * details on the UI.
+     */
+    type: (0, superstruct_1.enums)([`${TransactionType.Send}`, `${TransactionType.Receive}`]),
+    /**
+     * Transaction sender addresses and amounts.
+     */
+    from: (0, superstruct_1.array)(ParticipantStruct),
+    /**
+     * Transaction receiver addresses and amounts.
+     */
+    to: (0, superstruct_1.array)(ParticipantStruct),
+    /**
+     * Total transaction fee.
+     */
+    fees: (0, superstruct_1.array)(FeeStruct),
+    /**
+     * List of events related to the transaction {@see TransactionEventStruct}.
+     *
+     * The events are tracked in a best-effort basis and may not be available for
+     * all transactions.
+     */
+    events: (0, superstruct_1.array)(exports.TransactionEventStruct),
+});
+/**
+ * This struct represents a page of transactions.
+ *
+ * @example
+ * ```ts
+ * {
+ *   data: [
+ *     {
+ *       // Transaction object
+ *     }
+ *   ],
+ *   next: 'c3y1Q6QtqtstbxKX+oqVdEW6',
+ * }
+ * ```
+ */
+exports.TransactionsPageStruct = (0, superstruct_2.object)({
+    /**
+     * List of transactions.
+     */
+    data: (0, superstruct_1.array)(exports.TransactionStruct),
+    /**
+     * Next cursor to iterate over the results. If null, there are no more
+     * results.
+     */
+    next: (0, superstruct_1.nullable)((0, superstruct_1.string)()),
+});
+//# sourceMappingURL=transaction.cjs.map

package/dist/api/transaction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.cjs","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":";;;AACA,uDAA+E;AAC/E,2CAAoD;AAEpD,uCAAsC;AAEtC,oDAAwC;AAExC,8CAAsC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,iBAAiB,GAAG,IAAA,oBAAM,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,oBAAM,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,eAaX;AAbD,WAAY,eAAe;IACzB;;;;OAIG;IACH,gCAAa,CAAA;IAEb;;;OAGG;IACH,sCAAmB,CAAA;AACrB,CAAC,EAbW,eAAe,+BAAf,eAAe,QAa1B;AAED;;GAEG;AACU,QAAA,sBAAsB,GAAG,IAAA,oBAAM,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,oBAAM,EAAC;IACtC;;OAEG;IACH,EAAE,EAAE,IAAA,oBAAM,GAAE;IAEZ;;OAEG;IACH,KAAK,EAAE,yBAAiB;IAExB;;OAEG;IACH,OAAO,EAAE,kBAAU;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,CAAC,GAAG,eAAe,CAAC,IAAI,EAAE,EAAE,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC;IAEtE;;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;;;;;;;;;;;;;;GAcG;AACU,QAAA,sBAAsB,GAAG,IAAA,oBAAM,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 { Infer } from '@metamask/superstruct';\nimport { array, enums, nullable, number, string } from '@metamask/superstruct';\nimport { CaipChainIdStruct } from '@metamask/utils';\n\nimport { AssetStruct } from './asset';\nimport type { InferEquals } from '../superstruct';\nimport { object } from '../superstruct';\nimport type { Paginated } from '../utils';\nimport { UuidStruct } from '../utils';\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/**\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([`${TransactionType.Send}`, `${TransactionType.Receive}`]),\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 */\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"]}