@metamask-previews/keyring-api 11.0.0-cd6bf38 → 11.1.0-1c468fa

package/dist/api/transaction.d.cts

@@ -1,6 +1,6 @@
+import type { InferEquals } from "@metamask/keyring-utils";
 import type { Infer } from "@metamask/superstruct";
-import type { InferEquals } from "../superstruct.cjs";
-import type { Paginated } from "../utils/index.cjs";
+import type { Paginated } from "./pagination.cjs";
 /**
  * Fee types.
  */
@@ -141,28 +141,32 @@ export declare const TransactionEventStruct: import("@metamask/superstruct").Str
 export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     type: "send" | "receive";
     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}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
             fungible: false;
         } | null;
     }[];
+    events: {
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
+    }[];
+    chain: `${string}:${string}`;
+    account: string;
+    status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+    timestamp: number | null;
     to: {
         address: string;
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -172,19 +176,15 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     fees: {
         type: "base" | "priority";
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
             fungible: false;
         };
     }[];
-    events: {
-        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-        timestamp: number | null;
-    }[];
 }, {
     /**
      * Chain-specific transaction ID.
@@ -227,9 +227,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     from: import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -238,9 +238,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     }[], import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -255,9 +255,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
          * Asset being transferred.
          */
         asset: import("@metamask/superstruct").Struct<{
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -270,9 +270,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     to: import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -281,9 +281,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     }[], import("@metamask/superstruct").Struct<{
         address: string;
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -298,9 +298,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
          * Asset being transferred.
          */
         asset: import("@metamask/superstruct").Struct<{
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -313,9 +313,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     fees: import("@metamask/superstruct").Struct<{
         type: "base" | "priority";
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -324,9 +324,9 @@ export declare const TransactionStruct: import("@metamask/superstruct").Struct<{
     }[], import("@metamask/superstruct").Struct<{
         type: "base" | "priority";
         asset: {
+            unit: string;
             type: `${string}:${string}/${string}:${string}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -344,9 +344,9 @@ 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}`;
             fungible: true;
-            unit: string;
             amount: string;
         } | {
             id: `${string}:${string}/${string}:${string}/${string}`;
@@ -401,34 +401,49 @@ export type Transaction = Infer<typeof TransactionStruct>;
  *   next: 'c3y1Q6QtqtstbxKX+oqVdEW6',
  * }
  * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   data: [
+ *     {
+ *       // Transaction object
+ *     }
+ *   ],
+ *   next: null, // No more results
+ * }**
+ * ```
  */
 export declare const TransactionsPageStruct: import("@metamask/superstruct").Struct<{
-    next: string | null;
     data: {
         type: "send" | "receive";
         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}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
                 fungible: false;
             } | null;
         }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
+        chain: `${string}:${string}`;
+        account: string;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
         to: {
             address: string;
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -438,20 +453,17 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: {
             type: "base" | "priority";
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
                 fungible: false;
             };
         }[];
-        events: {
-            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-            timestamp: number | null;
-        }[];
     }[];
+    next: string | null;
 }, {
     /**
      * List of transactions.
@@ -459,28 +471,32 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
     data: import("@metamask/superstruct").Struct<{
         type: "send" | "receive";
         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}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
                 fungible: false;
             } | null;
         }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
+        chain: `${string}:${string}`;
+        account: string;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
         to: {
             address: string;
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -490,44 +506,44 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: {
             type: "base" | "priority";
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
                 fungible: false;
             };
         }[];
-        events: {
-            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-            timestamp: number | null;
-        }[];
     }[], import("@metamask/superstruct").Struct<{
         type: "send" | "receive";
         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}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
                 fungible: false;
             } | null;
         }[];
+        events: {
+            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+            timestamp: number | null;
+        }[];
+        chain: `${string}:${string}`;
+        account: string;
+        status: "submitted" | "unconfirmed" | "confirmed" | "failed";
+        timestamp: number | null;
         to: {
             address: string;
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -537,19 +553,15 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: {
             type: "base" | "priority";
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
                 fungible: false;
             };
         }[];
-        events: {
-            status: "submitted" | "unconfirmed" | "confirmed" | "failed";
-            timestamp: number | null;
-        }[];
     }, {
         /**
          * Chain-specific transaction ID.
@@ -592,9 +604,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         from: import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -603,9 +615,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         }[], import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -620,9 +632,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
              * Asset being transferred.
              */
             asset: import("@metamask/superstruct").Struct<{
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -635,9 +647,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         to: import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -646,9 +658,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         }[], import("@metamask/superstruct").Struct<{
             address: string;
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -663,9 +675,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
              * Asset being transferred.
              */
             asset: import("@metamask/superstruct").Struct<{
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -678,9 +690,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         fees: import("@metamask/superstruct").Struct<{
             type: "base" | "priority";
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -689,9 +701,9 @@ export declare const TransactionsPageStruct: import("@metamask/superstruct").Str
         }[], import("@metamask/superstruct").Struct<{
             type: "base" | "priority";
             asset: {
+                unit: string;
                 type: `${string}:${string}/${string}:${string}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;
@@ -709,9 +721,9 @@ 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}`;
                 fungible: true;
-                unit: string;
                 amount: string;
             } | {
                 id: `${string}:${string}/${string}:${string}/${string}`;

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,KAAK,EAAE,8BAA8B;AAKnD,OAAO,KAAK,EAAE,WAAW,EAAE,2BAAuB;AAElD,OAAO,KAAK,EAAE,SAAS,EAAE,2BAAiB;AAkD1C;;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;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;;;;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAnNH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA+MH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAxNH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAoNH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAxLH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAoLH;;;;;OAKG;;;;;;;;QApIH;;WAEG;;;;;;;QAQH;;WAEG;;;EA0HH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAvFH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;QAGH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAnNH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA+MH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAxNH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAoNH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAxLH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAoLH;;;;;WAKG;;;;;;;;YApIH;;eAEG;;;;;;;YAQH;;eAEG;;;;IAwJH;;;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;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;;;;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAnNH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IA+MH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAxNH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;IAoNH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;QAxLH;;WAEG;;;;;QAGH;;WAEG;;;;;;;;;;;IAoLH;;;;;OAKG;;;;;;;;QApIH;;WAEG;;;;;;;QAQH;;WAEG;;;EA0HH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACjC;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAnGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAQH;;;;WAIG;;QAGH;;;WAGG;;;;;QAGH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAnNH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QA+MH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAxNH;;eAEG;;YAGH;;eAEG;;;;;;;;;;;QAoNH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;YAxLH;;eAEG;;;;;YAGH;;eAEG;;;;;;;;;;;QAoLH;;;;;WAKG;;;;;;;;YApIH;;eAEG;;;;;;;YAQH;;eAEG;;;;IAoKH;;;OAGG;;EAEH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,OAAO,sBAAsB,EAC7B,SAAS,CAAC,WAAW,CAAC,CACvB,CAAC"}