@metamask-previews/keyring-api 21.3.0-feb98c5 → 21.5.0-fd40efd

package/dist/api/transaction.d.cts

@@ -90,6 +90,63 @@ export declare enum TransactionType {
      */
     Unknown = "unknown"
 }
+/**
+ * Security alert response values from the Security Alert API.
+ */
+export declare enum SecurityAlertResponse {
+    /**
+     * The transaction is considered safe with no detected security issues.
+     */
+    Benign = "Benign",
+    /**
+     * The transaction has potential security concerns that warrant user attention.
+     */
+    Warning = "Warning",
+    /**
+     * The transaction has been identified as malicious and should be avoided.
+     */
+    Malicious = "Malicious"
+}
+/**
+ * This struct represents additional transaction details.
+ *
+ * @example
+ * ```ts
+ * {
+ *   origin: 'https://dapp.example.com',
+ *   securityAlertResponse: 'Benign',
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   origin: 'metamask',
+ *   securityAlertResponse: 'Warning',
+ * }
+ * ```
+ */
+export declare const TransactionDetailsStruct: import("@metamask/superstruct").Struct<{
+    origin?: string;
+    securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+}, {
+    /**
+     * Origin of the original transaction request.
+     *
+     * This can be either 'metamask' for internally initiated transactions, or a URL
+     * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.
+     */
+    origin: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+    /**
+     * Response from the Security Alert API indicating the security assessment of the
+     * transaction.
+     */
+    securityAlertResponse: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | "Benign" | "Warning" | "Malicious", {
+        Benign: "Benign";
+        Warning: "Warning";
+        Malicious: "Malicious";
+    }>;
+}>;
 /**
  * This struct represents a transaction event.
  */
@@ -215,6 +272,10 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
             fungible: false;
         };
     }[];
+    details?: {
+        origin?: string;
+        securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+    };
 }, {
     /**
      * Chain-specific transaction ID.
@@ -416,7 +477,41 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
          */
         timestamp: import("@metamask/superstruct").Struct<number | null, null>;
     }>>;
+    /**
+     * Additional transaction details {@see TransactionDetailsStruct}.
+     *
+     * Contains contextual information about the transaction such as its origin and
+     * security assessment. This field is optional and may not be present for all
+     * transactions.
+     */
+    details: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+        origin?: string;
+        securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+    }, {
+        /**
+         * Origin of the original transaction request.
+         *
+         * This can be either 'metamask' for internally initiated transactions, or a URL
+         * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.
+         */
+        origin: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        /**
+         * Response from the Security Alert API indicating the security assessment of the
+         * transaction.
+         */
+        securityAlertResponse: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | "Benign" | "Warning" | "Malicious", {
+            Benign: "Benign";
+            Warning: "Warning";
+            Malicious: "Malicious";
+        }>;
+    }>;
 }>;
+/**
+ * Transaction details object.
+ *
+ * See {@link TransactionDetailsStruct}.
+ */
+export type TransactionDetails = Infer<typeof TransactionDetailsStruct>;
 /**
  * Transaction object.
  *
@@ -498,6 +593,10 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        };
     }[];
     next: string | null;
 }, {
@@ -551,6 +650,10 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        };
     }[], import("@metamask/superstruct").Struct<{
         type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw";
         id: string;
@@ -598,6 +701,10 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        };
     }, {
         /**
          * Chain-specific transaction ID.
@@ -799,6 +906,34 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
              */
             timestamp: import("@metamask/superstruct").Struct<number | null, null>;
         }>>;
+        /**
+         * Additional transaction details {@see TransactionDetailsStruct}.
+         *
+         * Contains contextual information about the transaction such as its origin and
+         * security assessment. This field is optional and may not be present for all
+         * transactions.
+         */
+        details: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        }, {
+            /**
+             * Origin of the original transaction request.
+             *
+             * This can be either 'metamask' for internally initiated transactions, or a URL
+             * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.
+             */
+            origin: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+            /**
+             * Response from the Security Alert API indicating the security assessment of the
+             * transaction.
+             */
+            securityAlertResponse: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | "Benign" | "Warning" | "Malicious", {
+                Benign: "Benign";
+                Warning: "Warning";
+                Malicious: "Malicious";
+            }>;
+        }>;
     }>>;
     /**
      * Next cursor to iterate over the results. If null, there are no more

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;IAEb;;;OAGG;IACH,UAAU,gBAAgB;IAE1B;;;OAGG;IACH,aAAa,mBAAmB;IAEhC;;OAEG;IACH,YAAY,kBAAkB;IAE9B;;OAEG;IACH,aAAa,mBAAmB;IAChC;;;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;;;;;;;;;;;IAYH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QA/PH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA2PH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApQH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAgQH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApOH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAgOH;;;;;OAKG;;;;;;;;QA7IH;;WAEG;;;;;;;QAQH;;WAEG;;;EAmIH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA5GH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;;;;;;QAYH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YA/PH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA2PH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApQH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAgQH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApOH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAgOH;;;;;WAKG;;;;;;;;YA7IH;;eAEG;;;;;;;YAQH;;eAEG;;;;IA6KH;;;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;;OAEG;IACH,YAAY,kBAAkB;IAE9B;;OAEG;IACH,aAAa,mBAAmB;IAEhC;;;OAGG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,SAAS,cAAc;CACxB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,wBAAwB;;;;IACnC;;;;;OAKG;;IAGH;;;OAGG;;;;;;EAQH,CAAC;AAEH;;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;;;;;;;;;;;IAYH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QA7TH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAyTH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAlUH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA8TH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAlSH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IA8RH;;;;;OAKG;;;;;;;;QA7IH;;WAEG;;;;;;;QAQH;;WAEG;;;IAoIH;;;;;;OAMG;;;;;QA/KH;;;;;WAKG;;QAGH;;;WAGG;;;;;;;EAsKH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA5HH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;;;;;;QAYH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YA7TH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAyTH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAlUH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA8TH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAlSH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QA8RH;;;;;WAKG;;;;;;;;YA7IH;;eAEG;;;;;;;YAQH;;eAEG;;;QAoIH;;;;;;WAMG;;;;;YA/KH;;;;;eAKG;;YAGH;;;eAGG;;;;;;;;IAuNH;;;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

@@ -90,6 +90,63 @@ export declare enum TransactionType {
      */
     Unknown = "unknown"
 }
+/**
+ * Security alert response values from the Security Alert API.
+ */
+export declare enum SecurityAlertResponse {
+    /**
+     * The transaction is considered safe with no detected security issues.
+     */
+    Benign = "Benign",
+    /**
+     * The transaction has potential security concerns that warrant user attention.
+     */
+    Warning = "Warning",
+    /**
+     * The transaction has been identified as malicious and should be avoided.
+     */
+    Malicious = "Malicious"
+}
+/**
+ * This struct represents additional transaction details.
+ *
+ * @example
+ * ```ts
+ * {
+ *   origin: 'https://dapp.example.com',
+ *   securityAlertResponse: 'Benign',
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   origin: 'metamask',
+ *   securityAlertResponse: 'Warning',
+ * }
+ * ```
+ */
+export declare const TransactionDetailsStruct: import("@metamask/superstruct").Struct<{
+    origin?: string;
+    securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+}, {
+    /**
+     * Origin of the original transaction request.
+     *
+     * This can be either 'metamask' for internally initiated transactions, or a URL
+     * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.
+     */
+    origin: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+    /**
+     * Response from the Security Alert API indicating the security assessment of the
+     * transaction.
+     */
+    securityAlertResponse: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | "Benign" | "Warning" | "Malicious", {
+        Benign: "Benign";
+        Warning: "Warning";
+        Malicious: "Malicious";
+    }>;
+}>;
 /**
  * This struct represents a transaction event.
  */
@@ -215,6 +272,10 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
             fungible: false;
         };
     }[];
+    details?: {
+        origin?: string;
+        securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+    };
 }, {
     /**
      * Chain-specific transaction ID.
@@ -416,7 +477,41 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
          */
         timestamp: import("@metamask/superstruct").Struct<number | null, null>;
     }>>;
+    /**
+     * Additional transaction details {@see TransactionDetailsStruct}.
+     *
+     * Contains contextual information about the transaction such as its origin and
+     * security assessment. This field is optional and may not be present for all
+     * transactions.
+     */
+    details: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+        origin?: string;
+        securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+    }, {
+        /**
+         * Origin of the original transaction request.
+         *
+         * This can be either 'metamask' for internally initiated transactions, or a URL
+         * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.
+         */
+        origin: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        /**
+         * Response from the Security Alert API indicating the security assessment of the
+         * transaction.
+         */
+        securityAlertResponse: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | "Benign" | "Warning" | "Malicious", {
+            Benign: "Benign";
+            Warning: "Warning";
+            Malicious: "Malicious";
+        }>;
+    }>;
 }>;
+/**
+ * Transaction details object.
+ *
+ * See {@link TransactionDetailsStruct}.
+ */
+export type TransactionDetails = Infer<typeof TransactionDetailsStruct>;
 /**
  * Transaction object.
  *
@@ -498,6 +593,10 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        };
     }[];
     next: string | null;
 }, {
@@ -551,6 +650,10 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        };
     }[], import("@metamask/superstruct").Struct<{
         type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw";
         id: string;
@@ -598,6 +701,10 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        details?: {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        };
     }, {
         /**
          * Chain-specific transaction ID.
@@ -799,6 +906,34 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
              */
             timestamp: import("@metamask/superstruct").Struct<number | null, null>;
         }>>;
+        /**
+         * Additional transaction details {@see TransactionDetailsStruct}.
+         *
+         * Contains contextual information about the transaction such as its origin and
+         * security assessment. This field is optional and may not be present for all
+         * transactions.
+         */
+        details: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            origin?: string;
+            securityAlertResponse?: "Benign" | "Warning" | "Malicious";
+        }, {
+            /**
+             * Origin of the original transaction request.
+             *
+             * This can be either 'metamask' for internally initiated transactions, or a URL
+             * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.
+             */
+            origin: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+            /**
+             * Response from the Security Alert API indicating the security assessment of the
+             * transaction.
+             */
+            securityAlertResponse: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | "Benign" | "Warning" | "Malicious", {
+                Benign: "Benign";
+                Warning: "Warning";
+                Malicious: "Malicious";
+            }>;
+        }>;
     }>>;
     /**
      * Next cursor to iterate over the results. If null, there are no more

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;IAEb;;;OAGG;IACH,UAAU,gBAAgB;IAE1B;;;OAGG;IACH,aAAa,mBAAmB;IAEhC;;OAEG;IACH,YAAY,kBAAkB;IAE9B;;OAEG;IACH,aAAa,mBAAmB;IAChC;;;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;;;;;;;;;;;IAYH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QA/PH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA2PH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApQH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAgQH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QApOH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAgOH;;;;;OAKG;;;;;;;;QA7IH;;WAEG;;;;;;;QAQH;;WAEG;;;EAmIH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA5GH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;;;;;;QAYH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YA/PH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA2PH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApQH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAgQH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YApOH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAgOH;;;;;WAKG;;;;;;;;YA7IH;;eAEG;;;;;;;YAQH;;eAEG;;;;IA6KH;;;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;;OAEG;IACH,YAAY,kBAAkB;IAE9B;;OAEG;IACH,aAAa,mBAAmB;IAEhC;;;OAGG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,SAAS,cAAc;CACxB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,wBAAwB;;;;IACnC;;;;;OAKG;;IAGH;;;OAGG;;;;;;EAQH,CAAC;AAEH;;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;;;;;;;;;;;IAYH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QA7TH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAyTH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAlUH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA8TH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAlSH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IA8RH;;;;;OAKG;;;;;;;;QA7IH;;WAEG;;;;;;;QAQH;;WAEG;;;IAoIH;;;;;;OAMG;;;;;QA/KH;;;;;WAKG;;QAGH;;;WAGG;;;;;;;EAsKH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA5HH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;;;;;;QAYH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YA7TH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAyTH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAlUH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA8TH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAlSH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QA8RH;;;;;WAKG;;;;;;;;YA7IH;;eAEG;;;;;;;YAQH;;eAEG;;;QAoIH;;;;;;WAMG;;;;;YA/KH;;;;;eAKG;;YAGH;;;eAGG;;;;;;;;IAuNH;;;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

@@ -1,4 +1,4 @@
-import { object, UuidStruct } from "@metamask/keyring-utils";
+import { exactOptional, object, UuidStruct } from "@metamask/keyring-utils";
 import { array, enums, nullable, number, string } from "@metamask/superstruct";
 import { AssetStruct } from "./asset.mjs";
 import { CaipChainIdStruct } from "./caip.mjs";
@@ -152,6 +152,61 @@ export var TransactionType;
      */
     TransactionType["Unknown"] = "unknown";
 })(TransactionType || (TransactionType = {}));
+/**
+ * Security alert response values from the Security Alert API.
+ */
+export var SecurityAlertResponse;
+(function (SecurityAlertResponse) {
+    /**
+     * The transaction is considered safe with no detected security issues.
+     */
+    SecurityAlertResponse["Benign"] = "Benign";
+    /**
+     * The transaction has potential security concerns that warrant user attention.
+     */
+    SecurityAlertResponse["Warning"] = "Warning";
+    /**
+     * The transaction has been identified as malicious and should be avoided.
+     */
+    SecurityAlertResponse["Malicious"] = "Malicious";
+})(SecurityAlertResponse || (SecurityAlertResponse = {}));
+/**
+ * This struct represents additional transaction details.
+ *
+ * @example
+ * ```ts
+ * {
+ *   origin: 'https://dapp.example.com',
+ *   securityAlertResponse: 'Benign',
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   origin: 'metamask',
+ *   securityAlertResponse: 'Warning',
+ * }
+ * ```
+ */
+export const TransactionDetailsStruct = object({
+    /**
+     * Origin of the original transaction request.
+     *
+     * This can be either 'metamask' for internally initiated transactions, or a URL
+     * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.
+     */
+    origin: exactOptional(string()),
+    /**
+     * Response from the Security Alert API indicating the security assessment of the
+     * transaction.
+     */
+    securityAlertResponse: exactOptional(enums([
+        `${SecurityAlertResponse.Benign}`,
+        `${SecurityAlertResponse.Warning}`,
+        `${SecurityAlertResponse.Malicious}`,
+    ])),
+});
 /**
  * This struct represents a transaction event.
  */
@@ -288,6 +343,14 @@ export const TransactionStruct = object({
      * all transactions.
      */
     events: array(TransactionEventStruct),
+    /**
+     * Additional transaction details {@see TransactionDetailsStruct}.
+     *
+     * Contains contextual information about the transaction such as its origin and
+     * security assessment. This field is optional and may not be present for all
+     * transactions.
+     */
+    details: exactOptional(TransactionDetailsStruct),
 });
 /**
  * This struct represents a page of transactions.

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,eAgDX;AAhDD,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;;OAEG;IACH,iDAA8B,CAAA;IAE9B;;OAEG;IACH,mDAAgC,CAAA;IAChC;;;OAGG;IACH,sCAAmB,CAAA;AACrB,CAAC,EAhDW,eAAe,KAAf,eAAe,QAgD1B;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,YAAY,EAAE;QACjC,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   * Represents a stake deposit transaction.\n   */\n  StakeDeposit = 'stake:deposit',\n\n  /**\n   * Represents a stake withdrawal transaction.\n   */\n  StakeWithdraw = 'stake:withdraw',\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.StakeDeposit}`,\n    `${TransactionType.StakeWithdraw}`,\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"]}
+{"version":3,"file":"transaction.mjs","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,gCAAgC;AAE5E,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,eAiDX;AAjDD,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;;OAEG;IACH,iDAA8B,CAAA;IAE9B;;OAEG;IACH,mDAAgC,CAAA;IAEhC;;;OAGG;IACH,sCAAmB,CAAA;AACrB,CAAC,EAjDW,eAAe,KAAf,eAAe,QAiD1B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,qBAeX;AAfD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,0CAAiB,CAAA;IAEjB;;OAEG;IACH,4CAAmB,CAAA;IAEnB;;OAEG;IACH,gDAAuB,CAAA;AACzB,CAAC,EAfW,qBAAqB,KAArB,qBAAqB,QAehC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;IAC7C;;;;;OAKG;IACH,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC;IAE/B;;;OAGG;IACH,qBAAqB,EAAE,aAAa,CAClC,KAAK,CAAC;QACJ,GAAG,qBAAqB,CAAC,MAAM,EAAE;QACjC,GAAG,qBAAqB,CAAC,OAAO,EAAE;QAClC,GAAG,qBAAqB,CAAC,SAAS,EAAE;KACrC,CAAC,CACH;CACF,CAAC,CAAC;AAEH;;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,YAAY,EAAE;QACjC,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;IAErC;;;;;;OAMG;IACH,OAAO,EAAE,aAAa,CAAC,wBAAwB,CAAC;CACjD,CAAC,CAAC;AAgBH;;;;;;;;;;;;;;;;;;;;;;;;;;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 { exactOptional, 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   * Represents a stake deposit transaction.\n   */\n  StakeDeposit = 'stake:deposit',\n\n  /**\n   * Represents a stake withdrawal transaction.\n   */\n  StakeWithdraw = 'stake:withdraw',\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 * Security alert response values from the Security Alert API.\n */\nexport enum SecurityAlertResponse {\n  /**\n   * The transaction is considered safe with no detected security issues.\n   */\n  Benign = 'Benign',\n\n  /**\n   * The transaction has potential security concerns that warrant user attention.\n   */\n  Warning = 'Warning',\n\n  /**\n   * The transaction has been identified as malicious and should be avoided.\n   */\n  Malicious = 'Malicious',\n}\n\n/**\n * This struct represents additional transaction details.\n *\n * @example\n * ```ts\n * {\n *   origin: 'https://dapp.example.com',\n *   securityAlertResponse: 'Benign',\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   origin: 'metamask',\n *   securityAlertResponse: 'Warning',\n * }\n * ```\n */\nexport const TransactionDetailsStruct = object({\n  /**\n   * Origin of the original transaction request.\n   *\n   * This can be either 'metamask' for internally initiated transactions, or a URL\n   * (e.g., 'https://dapp.example.com') for dapp-initiated transactions.\n   */\n  origin: exactOptional(string()),\n\n  /**\n   * Response from the Security Alert API indicating the security assessment of the\n   * transaction.\n   */\n  securityAlertResponse: exactOptional(\n    enums([\n      `${SecurityAlertResponse.Benign}`,\n      `${SecurityAlertResponse.Warning}`,\n      `${SecurityAlertResponse.Malicious}`,\n    ]),\n  ),\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.StakeDeposit}`,\n    `${TransactionType.StakeWithdraw}`,\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   * Additional transaction details {@see TransactionDetailsStruct}.\n   *\n   * Contains contextual information about the transaction such as its origin and\n   * security assessment. This field is optional and may not be present for all\n   * transactions.\n   */\n  details: exactOptional(TransactionDetailsStruct),\n});\n\n/**\n * Transaction details object.\n *\n * See {@link TransactionDetailsStruct}.\n */\nexport type TransactionDetails = Infer<typeof TransactionDetailsStruct>;\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/v2/create-account/bip44.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateAccountBip44DiscoverOptionsStruct = exports.CreateAccountBip44DeriveIndexOptionsStruct = exports.CreateAccountBip44DerivePathOptionsStruct = void 0;
+exports.CreateAccountBip44DeriveIndexRangeOptionsStruct = exports.CreateAccountBip44DiscoverOptionsStruct = exports.CreateAccountBip44DeriveIndexOptionsStruct = exports.CreateAccountBip44DerivePathOptionsStruct = void 0;
 const superstruct_1 = require("@metamask/superstruct");
 const derivation_1 = require("../../derivation.cjs");
 /**
@@ -54,4 +54,30 @@ exports.CreateAccountBip44DiscoverOptionsStruct = (0, superstruct_1.object)({
      */
     groupIndex: (0, superstruct_1.number)(),
 });
+/**
+ * Struct for {@link CreateAccountBip44DeriveIndexRangeOptions}.
+ */
+exports.CreateAccountBip44DeriveIndexRangeOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * The type of the options.
+     */
+    type: (0, superstruct_1.literal)('bip44:derive-index-range'),
+    /**
+     * ID of the entropy source to be used to derive the accounts.
+     */
+    entropySource: (0, superstruct_1.string)(),
+    /**
+     * The range of account group indices to derive (inclusive on both ends).
+     */
+    range: (0, superstruct_1.object)({
+        /**
+         * The starting index of the account group range (inclusive).
+         */
+        from: (0, superstruct_1.number)(),
+        /**
+         * The ending index of the account group range (inclusive).
+         */
+        to: (0, superstruct_1.number)(),
+    }),
+});
 //# sourceMappingURL=bip44.cjs.map

package/dist/api/v2/create-account/bip44.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"bip44.cjs","sourceRoot":"","sources":["../../../../src/api/v2/create-account/bip44.ts"],"names":[],"mappings":";;;AAAA,uDAM+B;AAE/B,qDAAwD;AAExD;;GAEG;AACU,QAAA,yCAAyC,GAAG,IAAA,oBAAM,EAAC;IAC9D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,mBAAmB,CAAC;IAClC;;OAEG;IACH,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB;;OAEG;IACH,cAAc,EAAE,iCAAoB;CACrC,CAAC,CAAC;AASH;;GAEG;AACU,QAAA,0CAA0C,GAAG,IAAA,oBAAM,EAAC;IAC/D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,oBAAoB,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB;;OAEG;IACH,UAAU,EAAE,IAAA,oBAAM,GAAE;CACrB,CAAC,CAAC;AAYH;;GAEG;AACU,QAAA,uCAAuC,GAAG,IAAA,oBAAM,EAAC;IAC5D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,gBAAgB,CAAC;IAC/B;;OAEG;IACH,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB;;OAEG;IACH,UAAU,EAAE,IAAA,oBAAM,GAAE;CACrB,CAAC,CAAC","sourcesContent":["import {\n  literal,\n  number,\n  object,\n  string,\n  type Infer,\n} from '@metamask/superstruct';\n\nimport { DerivationPathStruct } from '../../derivation';\n\n/**\n * Struct for {@link CreateAccountBip44DerivePathOptions}.\n */\nexport const CreateAccountBip44DerivePathOptionsStruct = object({\n  /**\n   * Type of the options.\n   */\n  type: literal('bip44:derive-path'),\n  /**\n   * ID of the entropy source to be used to derive the account.\n   */\n  entropySource: string(),\n  /**\n   * BIP-44 derivation path to be used to derive the account.\n   */\n  derivationPath: DerivationPathStruct,\n});\n\n/**\n * Options for creating an account using the given BIP-44 derivation path.\n */\nexport type CreateAccountBip44DerivePathOptions = Infer<\n  typeof CreateAccountBip44DerivePathOptionsStruct\n>;\n\n/**\n * Struct for {@link CreateAccountBip44DeriveIndexOptions}.\n */\nexport const CreateAccountBip44DeriveIndexOptionsStruct = object({\n  /**\n   * The type of the options.\n   */\n  type: literal('bip44:derive-index'),\n  /**\n   * ID of the entropy source to be used to derive the account.\n   */\n  entropySource: string(),\n  /**\n   * The index of the account group to be derived.\n   */\n  groupIndex: number(),\n});\n\n/**\n * Options for creating an account using the given BIP-44 account group index.\n *\n * Note that the keyring can support non-standard BIP-44 paths for\n * compatibility with other wallets.\n */\nexport type CreateAccountBip44DeriveIndexOptions = Infer<\n  typeof CreateAccountBip44DeriveIndexOptionsStruct\n>;\n\n/**\n * Struct for {@link CreateAccountBip44DiscoverOptions}.\n */\nexport const CreateAccountBip44DiscoverOptionsStruct = object({\n  /**\n   * The type of the options.\n   */\n  type: literal('bip44:discover'),\n  /**\n   * ID of the entropy source to be used to derive the account.\n   */\n  entropySource: string(),\n  /**\n   * The index of the account group to be derived.\n   */\n  groupIndex: number(),\n});\n\n/**\n * Options for creating accounts by performing a BIP-44 account discovery.\n *\n * Note that the keyring can support non-standard BIP-44 paths for\n * compatibility with other wallets.\n */\nexport type CreateAccountBip44DiscoverOptions = Infer<\n  typeof CreateAccountBip44DiscoverOptionsStruct\n>;\n"]}
+{"version":3,"file":"bip44.cjs","sourceRoot":"","sources":["../../../../src/api/v2/create-account/bip44.ts"],"names":[],"mappings":";;;AAAA,uDAM+B;AAE/B,qDAAwD;AAExD;;GAEG;AACU,QAAA,yCAAyC,GAAG,IAAA,oBAAM,EAAC;IAC9D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,mBAAmB,CAAC;IAClC;;OAEG;IACH,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB;;OAEG;IACH,cAAc,EAAE,iCAAoB;CACrC,CAAC,CAAC;AASH;;GAEG;AACU,QAAA,0CAA0C,GAAG,IAAA,oBAAM,EAAC;IAC/D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,oBAAoB,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB;;OAEG;IACH,UAAU,EAAE,IAAA,oBAAM,GAAE;CACrB,CAAC,CAAC;AAYH;;GAEG;AACU,QAAA,uCAAuC,GAAG,IAAA,oBAAM,EAAC;IAC5D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,gBAAgB,CAAC;IAC/B;;OAEG;IACH,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB;;OAEG;IACH,UAAU,EAAE,IAAA,oBAAM,GAAE;CACrB,CAAC,CAAC;AAYH;;GAEG;AACU,QAAA,+CAA+C,GAAG,IAAA,oBAAM,EAAC;IACpE;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,0BAA0B,CAAC;IACzC;;OAEG;IACH,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB;;OAEG;IACH,KAAK,EAAE,IAAA,oBAAM,EAAC;QACZ;;WAEG;QACH,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd;;WAEG;QACH,EAAE,EAAE,IAAA,oBAAM,GAAE;KACb,CAAC;CACH,CAAC,CAAC","sourcesContent":["import {\n  literal,\n  number,\n  object,\n  string,\n  type Infer,\n} from '@metamask/superstruct';\n\nimport { DerivationPathStruct } from '../../derivation';\n\n/**\n * Struct for {@link CreateAccountBip44DerivePathOptions}.\n */\nexport const CreateAccountBip44DerivePathOptionsStruct = object({\n  /**\n   * Type of the options.\n   */\n  type: literal('bip44:derive-path'),\n  /**\n   * ID of the entropy source to be used to derive the account.\n   */\n  entropySource: string(),\n  /**\n   * BIP-44 derivation path to be used to derive the account.\n   */\n  derivationPath: DerivationPathStruct,\n});\n\n/**\n * Options for creating an account using the given BIP-44 derivation path.\n */\nexport type CreateAccountBip44DerivePathOptions = Infer<\n  typeof CreateAccountBip44DerivePathOptionsStruct\n>;\n\n/**\n * Struct for {@link CreateAccountBip44DeriveIndexOptions}.\n */\nexport const CreateAccountBip44DeriveIndexOptionsStruct = object({\n  /**\n   * The type of the options.\n   */\n  type: literal('bip44:derive-index'),\n  /**\n   * ID of the entropy source to be used to derive the account.\n   */\n  entropySource: string(),\n  /**\n   * The index of the account group to be derived.\n   */\n  groupIndex: number(),\n});\n\n/**\n * Options for creating an account using the given BIP-44 account group index.\n *\n * Note that the keyring can support non-standard BIP-44 paths for\n * compatibility with other wallets.\n */\nexport type CreateAccountBip44DeriveIndexOptions = Infer<\n  typeof CreateAccountBip44DeriveIndexOptionsStruct\n>;\n\n/**\n * Struct for {@link CreateAccountBip44DiscoverOptions}.\n */\nexport const CreateAccountBip44DiscoverOptionsStruct = object({\n  /**\n   * The type of the options.\n   */\n  type: literal('bip44:discover'),\n  /**\n   * ID of the entropy source to be used to derive the account.\n   */\n  entropySource: string(),\n  /**\n   * The index of the account group to be derived.\n   */\n  groupIndex: number(),\n});\n\n/**\n * Options for creating accounts by performing a BIP-44 account discovery.\n *\n * Note that the keyring can support non-standard BIP-44 paths for\n * compatibility with other wallets.\n */\nexport type CreateAccountBip44DiscoverOptions = Infer<\n  typeof CreateAccountBip44DiscoverOptionsStruct\n>;\n\n/**\n * Struct for {@link CreateAccountBip44DeriveIndexRangeOptions}.\n */\nexport const CreateAccountBip44DeriveIndexRangeOptionsStruct = object({\n  /**\n   * The type of the options.\n   */\n  type: literal('bip44:derive-index-range'),\n  /**\n   * ID of the entropy source to be used to derive the accounts.\n   */\n  entropySource: string(),\n  /**\n   * The range of account group indices to derive (inclusive on both ends).\n   */\n  range: object({\n    /**\n     * The starting index of the account group range (inclusive).\n     */\n    from: number(),\n    /**\n     * The ending index of the account group range (inclusive).\n     */\n    to: number(),\n  }),\n});\n\n/**\n * Options for creating accounts by deriving a range of BIP-44 account indices.\n *\n * The range is inclusive on both ends, meaning range.from=0 and range.to=5\n * will create accounts for group indices 0, 1, 2, 3, 4, and 5.\n *\n * Note that the keyring can support non-standard BIP-44 paths for\n * compatibility with other wallets.\n */\nexport type CreateAccountBip44DeriveIndexRangeOptions = Infer<\n  typeof CreateAccountBip44DeriveIndexRangeOptionsStruct\n>;\n"]}

package/dist/api/v2/create-account/bip44.d.cts

@@ -80,4 +80,50 @@ export declare const CreateAccountBip44DiscoverOptionsStruct: import("@metamask/
  * compatibility with other wallets.
  */
 export type CreateAccountBip44DiscoverOptions = Infer<typeof CreateAccountBip44DiscoverOptionsStruct>;
+/**
+ * Struct for {@link CreateAccountBip44DeriveIndexRangeOptions}.
+ */
+export declare const CreateAccountBip44DeriveIndexRangeOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "bip44:derive-index-range";
+    range: {
+        from: number;
+        to: number;
+    };
+    entropySource: string;
+}, {
+    /**
+     * The type of the options.
+     */
+    type: import("@metamask/superstruct").Struct<"bip44:derive-index-range", "bip44:derive-index-range">;
+    /**
+     * ID of the entropy source to be used to derive the accounts.
+     */
+    entropySource: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The range of account group indices to derive (inclusive on both ends).
+     */
+    range: import("@metamask/superstruct").Struct<{
+        from: number;
+        to: number;
+    }, {
+        /**
+         * The starting index of the account group range (inclusive).
+         */
+        from: import("@metamask/superstruct").Struct<number, null>;
+        /**
+         * The ending index of the account group range (inclusive).
+         */
+        to: import("@metamask/superstruct").Struct<number, null>;
+    }>;
+}>;
+/**
+ * Options for creating accounts by deriving a range of BIP-44 account indices.
+ *
+ * The range is inclusive on both ends, meaning range.from=0 and range.to=5
+ * will create accounts for group indices 0, 1, 2, 3, 4, and 5.
+ *
+ * Note that the keyring can support non-standard BIP-44 paths for
+ * compatibility with other wallets.
+ */
+export type CreateAccountBip44DeriveIndexRangeOptions = Infer<typeof CreateAccountBip44DeriveIndexRangeOptionsStruct>;
 //# sourceMappingURL=bip44.d.cts.map

package/dist/api/v2/create-account/bip44.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"bip44.d.cts","sourceRoot":"","sources":["../../../../src/api/v2/create-account/bip44.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,KAAK,EACX,8BAA8B;AAI/B;;GAEG;AACH,eAAO,MAAM,yCAAyC;;;;;IACpD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,KAAK,CACrD,OAAO,yCAAyC,CACjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0CAA0C;;;;;IACrD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,oCAAoC,GAAG,KAAK,CACtD,OAAO,0CAA0C,CAClD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uCAAuC;;;;;IAClD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,iCAAiC,GAAG,KAAK,CACnD,OAAO,uCAAuC,CAC/C,CAAC"}
+{"version":3,"file":"bip44.d.cts","sourceRoot":"","sources":["../../../../src/api/v2/create-account/bip44.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,KAAK,EACX,8BAA8B;AAI/B;;GAEG;AACH,eAAO,MAAM,yCAAyC;;;;;IACpD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,KAAK,CACrD,OAAO,yCAAyC,CACjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0CAA0C;;;;;IACrD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,oCAAoC,GAAG,KAAK,CACtD,OAAO,0CAA0C,CAClD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uCAAuC;;;;;IAClD;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAEH,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,iCAAiC,GAAG,KAAK,CACnD,OAAO,uCAAuC,CAC/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+CAA+C;;;;;;;;IAC1D;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;;;;QAED;;WAEG;;QAEH;;WAEG;;;EAGL,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,MAAM,yCAAyC,GAAG,KAAK,CAC3D,OAAO,+CAA+C,CACvD,CAAC"}