@metamask/keyring-api 14.0.0 → 15.0.0

package/dist/events.d.cts

@@ -1,3 +1,4 @@
+import type { Infer } from "@metamask/superstruct";
 /**
  * Supported keyring events.
  */
@@ -6,7 +7,10 @@ export declare enum KeyringEvent {
     AccountUpdated = "notify:accountUpdated",
     AccountDeleted = "notify:accountDeleted",
     RequestApproved = "notify:requestApproved",
-    RequestRejected = "notify:requestRejected"
+    RequestRejected = "notify:requestRejected",
+    AccountBalancesUpdated = "notify:accountBalancesUpdated",
+    AccountAssetListUpdated = "notify:accountAssetListUpdated",
+    AccountTransactionsUpdated = "notify:accountTransactionsUpdated"
 }
 export declare const AccountCreatedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:accountCreated";
@@ -177,4 +181,239 @@ export declare const RequestRejectedEventStruct: import("@metamask/superstruct")
         id: import("@metamask/superstruct").Struct<string, null>;
     }>;
 }>;
+export declare const AccountBalancesUpdatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountBalancesUpdated";
+    params: {
+        balances: Record<string, Record<`${string}:${string}/${string}:${string}`, {
+            unit: string;
+            amount: string;
+        }>>;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountBalancesUpdated", "notify:accountBalancesUpdated">;
+    params: import("@metamask/superstruct").Struct<{
+        balances: Record<string, Record<`${string}:${string}/${string}:${string}`, {
+            unit: string;
+            amount: string;
+        }>>;
+    }, {
+        /**
+         * Balances updates of accounts owned by the Snap.
+         */
+        balances: import("@metamask/superstruct").Struct<Record<string, Record<`${string}:${string}/${string}:${string}`, {
+            unit: string;
+            amount: string;
+        }>>, null>;
+    }>;
+}>;
+/**
+ * Event emitted when the balances of an account are updated.
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
+export type AccountBalancesUpdatedEvent = Infer<typeof AccountBalancesUpdatedEventStruct>;
+export type AccountBalancesUpdatedEventPayload = AccountBalancesUpdatedEvent['params'];
+export declare const AccountTransactionsUpdatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountTransactionsUpdated";
+    params: {
+        transactions: Record<string, {
+            type: "send" | "receive";
+            id: string;
+            from: {
+                address: string;
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    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}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                } | null;
+            }[];
+            fees: {
+                type: "base" | "priority";
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                };
+            }[];
+        }[]>;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountTransactionsUpdated", "notify:accountTransactionsUpdated">;
+    params: import("@metamask/superstruct").Struct<{
+        transactions: Record<string, {
+            type: "send" | "receive";
+            id: string;
+            from: {
+                address: string;
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    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}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                } | null;
+            }[];
+            fees: {
+                type: "base" | "priority";
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                };
+            }[];
+        }[]>;
+    }, {
+        /**
+         * Transactions updates of accounts owned by the Snap.
+         */
+        transactions: import("@metamask/superstruct").Struct<Record<string, {
+            type: "send" | "receive";
+            id: string;
+            from: {
+                address: string;
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    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}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                } | null;
+            }[];
+            fees: {
+                type: "base" | "priority";
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                };
+            }[];
+        }[]>, null>;
+    }>;
+}>;
+/**
+ * Event emitted when the transactions of an account are updated (added or
+ * changed).
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
+export type AccountTransactionsUpdatedEvent = Infer<typeof AccountTransactionsUpdatedEventStruct>;
+export type AccountTransactionsUpdatedEventPayload = AccountTransactionsUpdatedEvent['params'];
+export declare const AccountAssetListUpdatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountAssetListUpdated";
+    params: {
+        assets: Record<string, {
+            added: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+            removed: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+        }>;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountAssetListUpdated", "notify:accountAssetListUpdated">;
+    params: import("@metamask/superstruct").Struct<{
+        assets: Record<string, {
+            added: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+            removed: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+        }>;
+    }, {
+        /**
+         * Asset list update of accounts owned by the Snap.
+         */
+        assets: import("@metamask/superstruct").Struct<Record<string, {
+            added: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+            removed: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+        }>, null>;
+    }>;
+}>;
+/**
+ * Event emitted when the assets of an account are updated.
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
+export type AccountAssetListUpdatedEvent = Infer<typeof AccountAssetListUpdatedEventStruct>;
+export type AccountAssetListUpdatedEventPayload = AccountAssetListUpdatedEvent['params'];
 //# sourceMappingURL=events.d.cts.map

package/dist/events.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.cts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,oBAAY,YAAY;IAEtB,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IAGxC,eAAe,2BAA2B;IAC1C,eAAe,2BAA2B;CAC3C;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;;QAGH;;;WAGG;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;QAGlC;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;QAGnC;;WAEG;;QAGH;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;QAGnC;;WAEG;;;EAGL,CAAC"}
+{"version":3,"file":"events.d.cts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAWnD;;GAEG;AACH,oBAAY,YAAY;IAEtB,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IAGxC,eAAe,2BAA2B;IAC1C,eAAe,2BAA2B;IAG1C,sBAAsB,kCAAkC;IACxD,uBAAuB,mCAAmC;IAC1D,0BAA0B,sCAAsC;CACjE;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;;QAGH;;;WAGG;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;QAGlC;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;QAGnC;;WAEG;;QAGH;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;QAGnC;;WAEG;;;EAGL,CAAC;AAKH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;QAG1C;;WAEG;;;;;;EAuBL,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AACF,MAAM,MAAM,kCAAkC,GAC5C,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AAExC,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAG9C;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAaL,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,+BAA+B,GAAG,KAAK,CACjD,OAAO,qCAAqC,CAC7C,CAAC;AACF,MAAM,MAAM,sCAAsC,GAChD,+BAA+B,CAAC,QAAQ,CAAC,CAAC;AAE5C,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;QAG3C;;WAEG;;;;;;EAuBL,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AACF,MAAM,MAAM,mCAAmC,GAC7C,4BAA4B,CAAC,QAAQ,CAAC,CAAC"}

package/dist/events.d.mts

@@ -1,3 +1,4 @@
+import type { Infer } from "@metamask/superstruct";
 /**
  * Supported keyring events.
  */
@@ -6,7 +7,10 @@ export declare enum KeyringEvent {
     AccountUpdated = "notify:accountUpdated",
     AccountDeleted = "notify:accountDeleted",
     RequestApproved = "notify:requestApproved",
-    RequestRejected = "notify:requestRejected"
+    RequestRejected = "notify:requestRejected",
+    AccountBalancesUpdated = "notify:accountBalancesUpdated",
+    AccountAssetListUpdated = "notify:accountAssetListUpdated",
+    AccountTransactionsUpdated = "notify:accountTransactionsUpdated"
 }
 export declare const AccountCreatedEventStruct: import("@metamask/superstruct").Struct<{
     method: "notify:accountCreated";
@@ -177,4 +181,239 @@ export declare const RequestRejectedEventStruct: import("@metamask/superstruct")
         id: import("@metamask/superstruct").Struct<string, null>;
     }>;
 }>;
+export declare const AccountBalancesUpdatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountBalancesUpdated";
+    params: {
+        balances: Record<string, Record<`${string}:${string}/${string}:${string}`, {
+            unit: string;
+            amount: string;
+        }>>;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountBalancesUpdated", "notify:accountBalancesUpdated">;
+    params: import("@metamask/superstruct").Struct<{
+        balances: Record<string, Record<`${string}:${string}/${string}:${string}`, {
+            unit: string;
+            amount: string;
+        }>>;
+    }, {
+        /**
+         * Balances updates of accounts owned by the Snap.
+         */
+        balances: import("@metamask/superstruct").Struct<Record<string, Record<`${string}:${string}/${string}:${string}`, {
+            unit: string;
+            amount: string;
+        }>>, null>;
+    }>;
+}>;
+/**
+ * Event emitted when the balances of an account are updated.
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
+export type AccountBalancesUpdatedEvent = Infer<typeof AccountBalancesUpdatedEventStruct>;
+export type AccountBalancesUpdatedEventPayload = AccountBalancesUpdatedEvent['params'];
+export declare const AccountTransactionsUpdatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountTransactionsUpdated";
+    params: {
+        transactions: Record<string, {
+            type: "send" | "receive";
+            id: string;
+            from: {
+                address: string;
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    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}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                } | null;
+            }[];
+            fees: {
+                type: "base" | "priority";
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                };
+            }[];
+        }[]>;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountTransactionsUpdated", "notify:accountTransactionsUpdated">;
+    params: import("@metamask/superstruct").Struct<{
+        transactions: Record<string, {
+            type: "send" | "receive";
+            id: string;
+            from: {
+                address: string;
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    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}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                } | null;
+            }[];
+            fees: {
+                type: "base" | "priority";
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                };
+            }[];
+        }[]>;
+    }, {
+        /**
+         * Transactions updates of accounts owned by the Snap.
+         */
+        transactions: import("@metamask/superstruct").Struct<Record<string, {
+            type: "send" | "receive";
+            id: string;
+            from: {
+                address: string;
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    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}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                } | null;
+            }[];
+            fees: {
+                type: "base" | "priority";
+                asset: {
+                    unit: string;
+                    type: `${string}:${string}/${string}:${string}`;
+                    amount: string;
+                    fungible: true;
+                } | {
+                    id: `${string}:${string}/${string}:${string}/${string}`;
+                    fungible: false;
+                };
+            }[];
+        }[]>, null>;
+    }>;
+}>;
+/**
+ * Event emitted when the transactions of an account are updated (added or
+ * changed).
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
+export type AccountTransactionsUpdatedEvent = Infer<typeof AccountTransactionsUpdatedEventStruct>;
+export type AccountTransactionsUpdatedEventPayload = AccountTransactionsUpdatedEvent['params'];
+export declare const AccountAssetListUpdatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountAssetListUpdated";
+    params: {
+        assets: Record<string, {
+            added: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+            removed: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+        }>;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountAssetListUpdated", "notify:accountAssetListUpdated">;
+    params: import("@metamask/superstruct").Struct<{
+        assets: Record<string, {
+            added: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+            removed: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+        }>;
+    }, {
+        /**
+         * Asset list update of accounts owned by the Snap.
+         */
+        assets: import("@metamask/superstruct").Struct<Record<string, {
+            added: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+            removed: (`${string}:${string}/${string}:${string}` | `${string}:${string}/${string}:${string}/${string}`)[];
+        }>, null>;
+    }>;
+}>;
+/**
+ * Event emitted when the assets of an account are updated.
+ *
+ * Only changes are reported.
+ *
+ * The Snap can choose to emit this event for multiple accounts at once.
+ */
+export type AccountAssetListUpdatedEvent = Infer<typeof AccountAssetListUpdatedEventStruct>;
+export type AccountAssetListUpdatedEventPayload = AccountAssetListUpdatedEvent['params'];
 //# sourceMappingURL=events.d.mts.map

package/dist/events.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.mts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,oBAAY,YAAY;IAEtB,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IAGxC,eAAe,2BAA2B;IAC1C,eAAe,2BAA2B;CAC3C;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;;QAGH;;;WAGG;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;QAGlC;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;QAGnC;;WAEG;;QAGH;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;QAGnC;;WAEG;;;EAGL,CAAC"}
+{"version":3,"file":"events.d.mts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAWnD;;GAEG;AACH,oBAAY,YAAY;IAEtB,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IAGxC,eAAe,2BAA2B;IAC1C,eAAe,2BAA2B;IAG1C,sBAAsB,kCAAkC;IACxD,uBAAuB,mCAAmC;IAC1D,0BAA0B,sCAAsC;CACjE;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;;QAGH;;;WAGG;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;QAGlC;;WAEG;;;;;;;;;;;;;;;;;;;;;;EAGL,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;QAGlC;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;QAGnC;;WAEG;;QAGH;;WAEG;;;EAGL,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;QAGnC;;WAEG;;;EAGL,CAAC;AAKH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;QAG1C;;WAEG;;;;;;EAuBL,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AACF,MAAM,MAAM,kCAAkC,GAC5C,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AAExC,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAG9C;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAaL,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,+BAA+B,GAAG,KAAK,CACjD,OAAO,qCAAqC,CAC7C,CAAC;AACF,MAAM,MAAM,sCAAsC,GAChD,+BAA+B,CAAC,QAAQ,CAAC,CAAC;AAE5C,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;QAG3C;;WAEG;;;;;;EAuBL,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AACF,MAAM,MAAM,mCAAmC,GAC7C,4BAA4B,CAAC,QAAQ,CAAC,CAAC"}

package/dist/events.mjs

@@ -1,7 +1,7 @@
-import { exactOptional, object, UuidStruct } from "@metamask/keyring-utils";
-import { boolean, literal, string } from "@metamask/superstruct";
-import { JsonStruct } from "@metamask/utils";
-import { KeyringAccountStruct } from "./api/index.mjs";
+import { exactOptional, object, UuidStruct, AccountIdStruct } from "@metamask/keyring-utils";
+import { array, boolean, literal, record, string } from "@metamask/superstruct";
+import { CaipAssetTypeStruct, JsonStruct } from "@metamask/utils";
+import { CaipAssetTypeOrIdStruct, FungibleAssetAmountStruct, KeyringAccountStruct, TransactionStruct } from "./api/index.mjs";
 /**
  * Supported keyring events.
  */
@@ -14,6 +14,10 @@ export var KeyringEvent;
     // Request events
     KeyringEvent["RequestApproved"] = "notify:requestApproved";
     KeyringEvent["RequestRejected"] = "notify:requestRejected";
+    // Assets related events
+    KeyringEvent["AccountBalancesUpdated"] = "notify:accountBalancesUpdated";
+    KeyringEvent["AccountAssetListUpdated"] = "notify:accountAssetListUpdated";
+    KeyringEvent["AccountTransactionsUpdated"] = "notify:accountTransactionsUpdated";
 })(KeyringEvent || (KeyringEvent = {}));
 export const AccountCreatedEventStruct = object({
     method: literal(`${KeyringEvent.AccountCreated}`),
@@ -77,4 +81,74 @@ export const RequestRejectedEventStruct = object({
         id: UuidStruct,
     }),
 });
+// Assets related events:
+// -----------------------------------------------------------------------------------------------
+export const AccountBalancesUpdatedEventStruct = object({
+    method: literal(`${KeyringEvent.AccountBalancesUpdated}`),
+    params: object({
+        /**
+         * Balances updates of accounts owned by the Snap.
+         */
+        balances: record(
+        /**
+         * Account ID.
+         */
+        AccountIdStruct, 
+        /**
+         * Mapping of each owned assets and their respective balances for that account.
+         */
+        record(
+        /**
+         * Asset type (CAIP-19).
+         */
+        CaipAssetTypeStruct, 
+        /**
+         * Balance information for a given asset.
+         */
+        FungibleAssetAmountStruct)),
+    }),
+});
+export const AccountTransactionsUpdatedEventStruct = object({
+    method: literal(`${KeyringEvent.AccountTransactionsUpdated}`),
+    params: object({
+        /**
+         * Transactions updates of accounts owned by the Snap.
+         */
+        transactions: record(
+        /**
+         * Account ID.
+         */
+        AccountIdStruct, 
+        /**
+         * List of updated transactions for that account.
+         */
+        array(TransactionStruct)),
+    }),
+});
+export const AccountAssetListUpdatedEventStruct = object({
+    method: literal(`${KeyringEvent.AccountAssetListUpdated}`),
+    params: object({
+        /**
+         * Asset list update of accounts owned by the Snap.
+         */
+        assets: record(
+        /**
+         * Account ID.
+         */
+        AccountIdStruct, 
+        /**
+         * Asset list changes for that account.
+         */
+        object({
+            /**
+             * New assets detected.
+             */
+            added: array(CaipAssetTypeOrIdStruct),
+            /**
+             * Assets no longer available on that account.
+             */
+            removed: array(CaipAssetTypeOrIdStruct),
+        })),
+    }),
+});
 //# sourceMappingURL=events.mjs.map

package/dist/events.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"events.mjs","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,gCAAgC;AAC5E,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,8BAA8B;AACjE,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAE7C,OAAO,EAAE,oBAAoB,EAAE,wBAAc;AAE7C;;GAEG;AACH,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,iBAAiB;IACjB,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IAExC,iBAAiB;IACjB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;AAC5C,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,OAAO,EAAE,oBAAoB;QAE7B;;;;;;WAMG;QACH,qBAAqB,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC;QAE9C;;;WAGG;QACH,mBAAmB,EAAE,aAAa,CAAC,OAAO,EAAE,CAAC;KAC9C,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,OAAO,EAAE,oBAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,EAAE,EAAE,UAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC/C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,EAAE,EAAE,UAAU;QAEd;;WAEG;QACH,MAAM,EAAE,UAAU;KACnB,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC/C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,EAAE,EAAE,UAAU;KACf,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { exactOptional, object, UuidStruct } from '@metamask/keyring-utils';\nimport { boolean, literal, string } from '@metamask/superstruct';\nimport { JsonStruct } from '@metamask/utils';\n\nimport { KeyringAccountStruct } from './api';\n\n/**\n * Supported keyring events.\n */\nexport enum KeyringEvent {\n  // Account events\n  AccountCreated = 'notify:accountCreated',\n  AccountUpdated = 'notify:accountUpdated',\n  AccountDeleted = 'notify:accountDeleted',\n\n  // Request events\n  RequestApproved = 'notify:requestApproved',\n  RequestRejected = 'notify:requestRejected',\n}\n\nexport const AccountCreatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountCreated}`),\n  params: object({\n    /**\n     * New account object.\n     */\n    account: KeyringAccountStruct,\n\n    /**\n     * Account name suggestion provided to the MetaMask client.\n     *\n     * The keyring can suggest a name for the account, but it's up to the\n     * client to decide whether to use it. The keyring won't be informed if the\n     * client decides to use a different name.\n     */\n    accountNameSuggestion: exactOptional(string()),\n\n    /**\n     * Instructs MetaMask to display the add account confirmation dialog in the UI.\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayConfirmation: exactOptional(boolean()),\n  }),\n});\n\nexport const AccountUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountUpdated}`),\n  params: object({\n    /**\n     * Updated account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\n\nexport const AccountDeletedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountDeleted}`),\n  params: object({\n    /**\n     * Deleted account ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\nexport const RequestApprovedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestApproved}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n});\n\nexport const RequestRejectedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestRejected}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n  }),\n});\n"]}
+{"version":3,"file":"events.mjs","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,MAAM,EACN,UAAU,EACV,eAAe,EAChB,gCAAgC;AAEjC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B;AAChF,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,wBAAwB;AAElE,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,oBAAoB,EACpB,iBAAiB,EAClB,wBAAc;AAEf;;GAEG;AACH,MAAM,CAAN,IAAY,YAcX;AAdD,WAAY,YAAY;IACtB,iBAAiB;IACjB,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IAExC,iBAAiB;IACjB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAE1C,wBAAwB;IACxB,wEAAwD,CAAA;IACxD,0EAA0D,CAAA;IAC1D,gFAAgE,CAAA;AAClE,CAAC,EAdW,YAAY,KAAZ,YAAY,QAcvB;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,OAAO,EAAE,oBAAoB;QAE7B;;;;;;WAMG;QACH,qBAAqB,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC;QAE9C;;;WAGG;QACH,mBAAmB,EAAE,aAAa,CAAC,OAAO,EAAE,CAAC;KAC9C,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,OAAO,EAAE,oBAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,EAAE,EAAE,UAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC/C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,EAAE,EAAE,UAAU;QAEd;;WAEG;QACH,MAAM,EAAE,UAAU;KACnB,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC/C,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,EAAE,EAAE,UAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEH,yBAAyB;AACzB,kGAAkG;AAElG,MAAM,CAAC,MAAM,iCAAiC,GAAG,MAAM,CAAC;IACtD,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,sBAAsB,EAAE,CAAC;IACzD,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,QAAQ,EAAE,MAAM;QACd;;WAEG;QACH,eAAe;QAEf;;WAEG;QACH,MAAM;QACJ;;WAEG;QACH,mBAAmB;QAEnB;;WAEG;QACH,yBAAyB,CAC1B,CACF;KACF,CAAC;CACH,CAAC,CAAC;AAeH,MAAM,CAAC,MAAM,qCAAqC,GAAG,MAAM,CAAC;IAC1D,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,0BAA0B,EAAE,CAAC;IAC7D,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,YAAY,EAAE,MAAM;QAClB;;WAEG;QACH,eAAe;QAEf;;WAEG;QACH,KAAK,CAAC,iBAAiB,CAAC,CACzB;KACF,CAAC;CACH,CAAC,CAAC;AAgBH,MAAM,CAAC,MAAM,kCAAkC,GAAG,MAAM,CAAC;IACvD,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,uBAAuB,EAAE,CAAC;IAC1D,MAAM,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,MAAM,EAAE,MAAM;QACZ;;WAEG;QACH,eAAe;QAEf;;WAEG;QACH,MAAM,CAAC;YACL;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC;YAErC;;eAEG;YACH,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC;SACxC,CAAC,CACH;KACF,CAAC;CACH,CAAC,CAAC","sourcesContent":["import {\n  exactOptional,\n  object,\n  UuidStruct,\n  AccountIdStruct,\n} from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, boolean, literal, record, string } from '@metamask/superstruct';\nimport { CaipAssetTypeStruct, JsonStruct } from '@metamask/utils';\n\nimport {\n  CaipAssetTypeOrIdStruct,\n  FungibleAssetAmountStruct,\n  KeyringAccountStruct,\n  TransactionStruct,\n} from './api';\n\n/**\n * Supported keyring events.\n */\nexport enum KeyringEvent {\n  // Account events\n  AccountCreated = 'notify:accountCreated',\n  AccountUpdated = 'notify:accountUpdated',\n  AccountDeleted = 'notify:accountDeleted',\n\n  // Request events\n  RequestApproved = 'notify:requestApproved',\n  RequestRejected = 'notify:requestRejected',\n\n  // Assets related events\n  AccountBalancesUpdated = 'notify:accountBalancesUpdated',\n  AccountAssetListUpdated = 'notify:accountAssetListUpdated',\n  AccountTransactionsUpdated = 'notify:accountTransactionsUpdated',\n}\n\nexport const AccountCreatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountCreated}`),\n  params: object({\n    /**\n     * New account object.\n     */\n    account: KeyringAccountStruct,\n\n    /**\n     * Account name suggestion provided to the MetaMask client.\n     *\n     * The keyring can suggest a name for the account, but it's up to the\n     * client to decide whether to use it. The keyring won't be informed if the\n     * client decides to use a different name.\n     */\n    accountNameSuggestion: exactOptional(string()),\n\n    /**\n     * Instructs MetaMask to display the add account confirmation dialog in the UI.\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayConfirmation: exactOptional(boolean()),\n  }),\n});\n\nexport const AccountUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountUpdated}`),\n  params: object({\n    /**\n     * Updated account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\n\nexport const AccountDeletedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountDeleted}`),\n  params: object({\n    /**\n     * Deleted account ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\nexport const RequestApprovedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestApproved}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n});\n\nexport const RequestRejectedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestRejected}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\n// Assets related events:\n// -----------------------------------------------------------------------------------------------\n\nexport const AccountBalancesUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountBalancesUpdated}`),\n  params: object({\n    /**\n     * Balances updates of accounts owned by the Snap.\n     */\n    balances: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * Mapping of each owned assets and their respective balances for that account.\n       */\n      record(\n        /**\n         * Asset type (CAIP-19).\n         */\n        CaipAssetTypeStruct,\n\n        /**\n         * Balance information for a given asset.\n         */\n        FungibleAssetAmountStruct,\n      ),\n    ),\n  }),\n});\n\n/**\n * Event emitted when the balances of an account are updated.\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport type AccountBalancesUpdatedEvent = Infer<\n  typeof AccountBalancesUpdatedEventStruct\n>;\nexport type AccountBalancesUpdatedEventPayload =\n  AccountBalancesUpdatedEvent['params'];\n\nexport const AccountTransactionsUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountTransactionsUpdated}`),\n  params: object({\n    /**\n     * Transactions updates of accounts owned by the Snap.\n     */\n    transactions: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * List of updated transactions for that account.\n       */\n      array(TransactionStruct),\n    ),\n  }),\n});\n\n/**\n * Event emitted when the transactions of an account are updated (added or\n * changed).\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport type AccountTransactionsUpdatedEvent = Infer<\n  typeof AccountTransactionsUpdatedEventStruct\n>;\nexport type AccountTransactionsUpdatedEventPayload =\n  AccountTransactionsUpdatedEvent['params'];\n\nexport const AccountAssetListUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountAssetListUpdated}`),\n  params: object({\n    /**\n     * Asset list update of accounts owned by the Snap.\n     */\n    assets: record(\n      /**\n       * Account ID.\n       */\n      AccountIdStruct,\n\n      /**\n       * Asset list changes for that account.\n       */\n      object({\n        /**\n         * New assets detected.\n         */\n        added: array(CaipAssetTypeOrIdStruct),\n\n        /**\n         * Assets no longer available on that account.\n         */\n        removed: array(CaipAssetTypeOrIdStruct),\n      }),\n    ),\n  }),\n});\n\n/**\n * Event emitted when the assets of an account are updated.\n *\n * Only changes are reported.\n *\n * The Snap can choose to emit this event for multiple accounts at once.\n */\nexport type AccountAssetListUpdatedEvent = Infer<\n  typeof AccountAssetListUpdatedEventStruct\n>;\nexport type AccountAssetListUpdatedEventPayload =\n  AccountAssetListUpdatedEvent['params'];\n"]}