@metamask-previews/keyring-api 23.0.1-7275dbc → 23.1.0-862665d

package/dist/api/transaction.d.mts

@@ -84,6 +84,10 @@ export declare enum TransactionType {
      * Represents a stake withdrawal transaction.
      */
     StakeWithdraw = "stake:withdraw",
+    /**
+     * Represents a token approval transaction.
+     */
+    TokenApprove = "token:approve",
     /**
      * The transaction type is unknown. It's not possible to determine the
      * transaction type based on the information available.
@@ -226,13 +230,17 @@ export declare const TransactionEventStruct: import("@metamask/superstruct").Str
  * ```
  */
 export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
-    type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw";
+    type: "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "unknown";
     id: string;
+    account: string;
+    status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+    timestamp: number | null;
+    chain: `${string}:${string}`;
     from: {
         address: string;
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -240,19 +248,11 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
             fungible: false;
         } | null;
     }[];
-    events: {
-        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-        timestamp: number | null;
-    }[];
-    chain: `${string}:${string}`;
-    status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-    account: string;
-    timestamp: number | null;
     to: {
         address: string;
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -263,8 +263,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     fees: {
         type: "base" | "priority";
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -272,6 +272,10 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
             fungible: false;
         };
     }[];
+    events: {
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
+    }[];
     details?: {
         origin?: string;
         securityAlertResponse?: "Benign" | "Warning" | "Malicious";
@@ -308,8 +312,7 @@ 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<"unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw", {
-        unknown: "unknown";
+    type: import("@metamask/superstruct").Struct<"send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "unknown", {
         send: "send";
         receive: "receive";
         swap: "swap";
@@ -317,6 +320,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
         "bridge:receive": "bridge:receive";
         "stake:deposit": "stake:deposit";
         "stake:withdraw": "stake:withdraw";
+        "token:approve": "token:approve";
+        unknown: "unknown";
     }>;
     /**
      * Transaction sender addresses and amounts.
@@ -324,8 +329,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     from: import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -335,8 +340,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     }[], import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -352,8 +357,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
          * Asset being transferred.
          */
         asset: import("@metamask/superstruct").Struct<{
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -367,8 +372,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     to: import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -378,8 +383,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     }[], import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -395,8 +400,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
          * Asset being transferred.
          */
         asset: import("@metamask/superstruct").Struct<{
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -410,8 +415,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     fees: import("@metamask/superstruct").Struct<{
         type: "base" | "priority";
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -421,8 +426,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     }[], import("@metamask/superstruct").Struct<{
         type: "base" | "priority";
         asset: {
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -441,8 +446,8 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
          * Asset used to pay for the fee.
          */
         asset: import("@metamask/superstruct").Struct<{
-            unit: string;
             type: `${string}:${string}/${string}:${string}`;
+            unit: string;
             amount: string;
             fungible: true;
         } | {
@@ -546,14 +551,19 @@ export type Transaction = Infer<typeof TransactionStruct>;
  * ```
  */
 export declare const TransactionsPageStruct: import("@metamask/superstruct").Struct<{
+    next: string | null;
     data: {
-        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw";
+        type: "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "unknown";
         id: string;
+        account: string;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
+        chain: `${string}:${string}`;
         from: {
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -561,19 +571,11 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             } | null;
         }[];
-        events: {
-            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-            timestamp: number | null;
-        }[];
-        chain: `${string}:${string}`;
-        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-        account: string;
-        timestamp: number | null;
         to: {
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -584,8 +586,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: {
             type: "base" | "priority";
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -593,24 +595,31 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
         details?: {
             origin?: string;
             securityAlertResponse?: "Benign" | "Warning" | "Malicious";
         };
     }[];
-    next: string | null;
 }, {
     /**
      * List of transactions.
      */
     data: import("@metamask/superstruct").Struct<{
-        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw";
+        type: "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "unknown";
         id: string;
+        account: string;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
+        chain: `${string}:${string}`;
         from: {
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -618,19 +627,11 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             } | null;
         }[];
-        events: {
-            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-            timestamp: number | null;
-        }[];
-        chain: `${string}:${string}`;
-        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-        account: string;
-        timestamp: number | null;
         to: {
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -641,8 +642,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: {
             type: "base" | "priority";
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -650,18 +651,26 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
         details?: {
             origin?: string;
             securityAlertResponse?: "Benign" | "Warning" | "Malicious";
         };
     }[], import("@metamask/superstruct").Struct<{
-        type: "unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw";
+        type: "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "unknown";
         id: string;
+        account: string;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
+        chain: `${string}:${string}`;
         from: {
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -669,19 +678,11 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             } | null;
         }[];
-        events: {
-            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-            timestamp: number | null;
-        }[];
-        chain: `${string}:${string}`;
-        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-        account: string;
-        timestamp: number | null;
         to: {
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -692,8 +693,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: {
             type: "base" | "priority";
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -701,6 +702,10 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
                 fungible: false;
             };
         }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
         details?: {
             origin?: string;
             securityAlertResponse?: "Benign" | "Warning" | "Malicious";
@@ -737,8 +742,7 @@ 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<"unknown" | "send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw", {
-            unknown: "unknown";
+        type: import("@metamask/superstruct").Struct<"send" | "receive" | "swap" | "bridge:send" | "bridge:receive" | "stake:deposit" | "stake:withdraw" | "token:approve" | "unknown", {
             send: "send";
             receive: "receive";
             swap: "swap";
@@ -746,6 +750,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
             "bridge:receive": "bridge:receive";
             "stake:deposit": "stake:deposit";
             "stake:withdraw": "stake:withdraw";
+            "token:approve": "token:approve";
+            unknown: "unknown";
         }>;
         /**
          * Transaction sender addresses and amounts.
@@ -753,8 +759,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         from: import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -764,8 +770,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         }[], import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -781,8 +787,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
              * Asset being transferred.
              */
             asset: import("@metamask/superstruct").Struct<{
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -796,8 +802,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         to: import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -807,8 +813,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         }[], import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -824,8 +830,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
              * Asset being transferred.
              */
             asset: import("@metamask/superstruct").Struct<{
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -839,8 +845,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: import("@metamask/superstruct").Struct<{
             type: "base" | "priority";
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -850,8 +856,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         }[], import("@metamask/superstruct").Struct<{
             type: "base" | "priority";
             asset: {
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {
@@ -870,8 +876,8 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
              * Asset used to pay for the fee.
              */
             asset: import("@metamask/superstruct").Struct<{
-                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
+                unit: string;
                 amount: string;
                 fungible: true;
             } | {

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;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"}
+{"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;;OAEG;IACH,YAAY,kBAAkB;IAE9B;;;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;;;;;;;;;;;;IAaH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAnUH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA+TH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAxUH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAoUH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAxSH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAoSH;;;;;OAKG;;;;;;;;QA9IH;;WAEG;;;;;;;QAQH;;WAEG;;;IAqIH;;;;;;OAMG;;;;;QAhLH;;;;;WAKG;;QAGH;;;WAGG;;;;;;;EAuKH,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA7HH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;;;;;;;;QAaH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAnUH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA+TH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAxUH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAoUH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAxSH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAoSH;;;;;WAKG;;;;;;;;YA9IH;;eAEG;;;;;;;YAQH;;eAEG;;;QAqIH;;;;;;WAMG;;;;;YAhLH;;;;;eAKG;;YAGH;;;eAGG;;;;;;;;IAwNH;;;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

@@ -146,6 +146,10 @@ export var TransactionType;
      * Represents a stake withdrawal transaction.
      */
     TransactionType["StakeWithdraw"] = "stake:withdraw";
+    /**
+     * Represents a token approval transaction.
+     */
+    TransactionType["TokenApprove"] = "token:approve";
     /**
      * The transaction type is unknown. It's not possible to determine the
      * transaction type based on the information available.
@@ -322,6 +326,7 @@ export const TransactionStruct = object({
         `${TransactionType.BridgeReceive}`,
         `${TransactionType.StakeDeposit}`,
         `${TransactionType.StakeWithdraw}`,
+        `${TransactionType.TokenApprove}`,
         `${TransactionType.Unknown}`,
     ]),
     /**

package/dist/api/transaction.mjs.map

@@ -1 +1 @@
-{"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"]}
+{"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,eAsDX;AAtDD,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;;OAEG;IACH,iDAA8B,CAAA;IAE9B;;;OAGG;IACH,sCAAmB,CAAA;AACrB,CAAC,EAtDW,eAAe,KAAf,eAAe,QAsD1B;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,YAAY,EAAE;QACjC,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   * Represents a token approval transaction.\n   */\n  TokenApprove = 'token:approve',\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.TokenApprove}`,\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/btc/types.d.cts

@@ -20,6 +20,8 @@ export declare enum BtcMethod {
 export declare const BtcP2pkhAccountStruct: import("@metamask/superstruct").Struct<{
     type: "bip122:p2pkh";
     id: string;
+    address: string;
+    scopes: `${string}:${string}`[];
     options: Record<string, import("@metamask/utils").Json> & {
         entropy?: {
             type: "mnemonic";
@@ -33,8 +35,6 @@ export declare const BtcP2pkhAccountStruct: import("@metamask/superstruct").Stru
         };
         exportable?: boolean;
     };
-    address: string;
-    scopes: `${string}:${string}`[];
     methods: BtcMethod[];
 }, {
     /**
@@ -81,6 +81,8 @@ export declare const BtcP2pkhAccountStruct: import("@metamask/superstruct").Stru
 export declare const BtcP2shAccountStruct: import("@metamask/superstruct").Struct<{
     type: "bip122:p2sh";
     id: string;
+    address: string;
+    scopes: `${string}:${string}`[];
     options: Record<string, import("@metamask/utils").Json> & {
         entropy?: {
             type: "mnemonic";
@@ -94,8 +96,6 @@ export declare const BtcP2shAccountStruct: import("@metamask/superstruct").Struc
         };
         exportable?: boolean;
     };
-    address: string;
-    scopes: `${string}:${string}`[];
     methods: BtcMethod[];
 }, {
     /**
@@ -142,6 +142,8 @@ export declare const BtcP2shAccountStruct: import("@metamask/superstruct").Struc
 export declare const BtcP2wpkhAccountStruct: import("@metamask/superstruct").Struct<{
     type: "bip122:p2wpkh";
     id: string;
+    address: string;
+    scopes: `${string}:${string}`[];
     options: Record<string, import("@metamask/utils").Json> & {
         entropy?: {
             type: "mnemonic";
@@ -155,8 +157,6 @@ export declare const BtcP2wpkhAccountStruct: import("@metamask/superstruct").Str
         };
         exportable?: boolean;
     };
-    address: string;
-    scopes: `${string}:${string}`[];
     methods: BtcMethod[];
 }, {
     /**
@@ -203,6 +203,8 @@ export declare const BtcP2wpkhAccountStruct: import("@metamask/superstruct").Str
 export declare const BtcP2trAccountStruct: import("@metamask/superstruct").Struct<{
     type: "bip122:p2tr";
     id: string;
+    address: string;
+    scopes: `${string}:${string}`[];
     options: Record<string, import("@metamask/utils").Json> & {
         entropy?: {
             type: "mnemonic";
@@ -216,8 +218,6 @@ export declare const BtcP2trAccountStruct: import("@metamask/superstruct").Struc
         };
         exportable?: boolean;
     };
-    address: string;
-    scopes: `${string}:${string}`[];
     methods: BtcMethod[];
 }, {
     /**