@metamask/notification-services-controller 19.0.0 → 20.0.0

package/dist/NotificationServicesController/processors/process-notifications.d.cts

@@ -25,401 +25,425 @@ export declare const processAndFilterNotifications: (ns: RawNotificationUnion[],
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.METAMASK_SWAP_COMPLETED;
-    data: {
-        kind: "metamask_swap_completed";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        rate: string;
-        token_in: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
-        };
-        token_out: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "metamask_swap_completed";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            rate: string;
+            token_in: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
+            token_out: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ERC20_SENT;
-    data: {
-        kind: "erc20_sent";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        token: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "erc20_sent";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            token: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ERC20_RECEIVED;
-    data: {
-        kind: "erc20_received";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        token: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "erc20_received";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            token: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ETH_SENT;
-    data: {
-        kind: "eth_sent";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        amount: {
-            usd: string;
-            eth: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "eth_sent";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            amount: {
+                usd: string;
+                eth: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ETH_RECEIVED;
-    data: {
-        kind: "eth_received";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        amount: {
-            usd: string;
-            eth: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "eth_received";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            amount: {
+                usd: string;
+                eth: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ROCKETPOOL_STAKE_COMPLETED;
-    data: {
-        kind: "rocketpool_stake_completed";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        stake_in: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
-        };
-        stake_out: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "rocketpool_stake_completed";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            stake_in: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
+            stake_out: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ROCKETPOOL_UNSTAKE_COMPLETED;
-    data: {
-        kind: "rocketpool_unstake_completed";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        stake_in: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
-        };
-        stake_out: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "rocketpool_unstake_completed";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            stake_in: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
+            stake_out: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.LIDO_STAKE_COMPLETED;
-    data: {
-        kind: "lido_stake_completed";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        stake_in: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
-        };
-        stake_out: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "lido_stake_completed";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            stake_in: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
+            stake_out: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.LIDO_WITHDRAWAL_REQUESTED;
-    data: {
-        kind: "lido_withdrawal_requested";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        stake_in: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
-        };
-        stake_out: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "lido_withdrawal_requested";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            stake_in: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
+            stake_out: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.LIDO_WITHDRAWAL_COMPLETED;
-    data: {
-        kind: "lido_withdrawal_completed";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        stake_in: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
-        };
-        stake_out: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "lido_withdrawal_completed";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            stake_in: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
+            stake_out: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.LIDO_STAKE_READY_TO_BE_WITHDRAWN;
-    data: {
-        kind: "lido_stake_ready_to_be_withdrawn";
-        request_id: string;
-        staked_eth: {
-            address: string;
-            symbol: string;
-            name: string;
-            amount: string;
-            decimals: string;
-            image: string;
-            usd: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "lido_stake_ready_to_be_withdrawn";
+            request_id: string;
+            staked_eth: {
+                address: string;
+                symbol: string;
+                name: string;
+                amount: string;
+                decimals: string;
+                image: string;
+                usd: string;
+            };
         };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ERC721_SENT;
-    data: {
-        kind: "erc721_sent";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        nft: {
-            name: string;
-            token_id: string;
-            image: string;
-            collection: {
-                address: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "erc721_sent";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            nft: {
                 name: string;
-                symbol: string;
+                token_id: string;
                 image: string;
+                collection: {
+                    address: string;
+                    name: string;
+                    symbol: string;
+                    image: string;
+                };
             };
         };
     };
@@ -427,32 +451,34 @@ export declare const processAndFilterNotifications: (ns: RawNotificationUnion[],
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ERC721_RECEIVED;
-    data: {
-        kind: "erc721_received";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        nft: {
-            name: string;
-            token_id: string;
-            image: string;
-            collection: {
-                address: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "erc721_received";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            nft: {
                 name: string;
-                symbol: string;
+                token_id: string;
                 image: string;
+                collection: {
+                    address: string;
+                    name: string;
+                    symbol: string;
+                    image: string;
+                };
             };
         };
     };
@@ -460,175 +486,89 @@ export declare const processAndFilterNotifications: (ns: RawNotificationUnion[],
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ERC1155_SENT;
-    data: {
-        kind: "erc1155_sent";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        nft?: {
-            name: string;
-            token_id: string;
-            image: string;
-            collection: {
-                address: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "erc1155_sent";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            nft?: {
                 name: string;
-                symbol: string;
+                token_id: string;
                 image: string;
-            };
-        } | undefined;
+                collection: {
+                    address: string;
+                    name: string;
+                    symbol: string;
+                    image: string;
+                };
+            } | undefined;
+        };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    block_number: number;
-    block_timestamp: string;
-    tx_hash: string;
+    notification_type: "on-chain";
     unread: boolean;
     created_at: string;
     type: TRIGGER_TYPES.ERC1155_RECEIVED;
-    data: {
-        kind: "erc1155_received";
-        network_fee: {
-            gas_price: string;
-            native_token_price_in_usd: string;
-        };
-        from: string;
-        to: string;
-        nft?: {
-            name: string;
-            token_id: string;
-            image: string;
-            collection: {
-                address: string;
+    payload: {
+        address: string;
+        chain_id: number;
+        block_number: number;
+        block_timestamp: string;
+        tx_hash: string;
+        data: {
+            kind: "erc1155_received";
+            network_fee: {
+                gas_price: string;
+                native_token_price_in_usd: string;
+            };
+            from: string;
+            to: string;
+            nft?: {
                 name: string;
-                symbol: string;
+                token_id: string;
                 image: string;
-            };
-        } | undefined;
-    };
-    createdAt: string;
-    isRead: boolean;
-} | {
-    id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    unread: boolean;
-    created_at: string;
-    type: TRIGGER_TYPES.AAVE_V3_HEALTH_FACTOR;
-    data: {
-        kind: "aave_v3_health_factor";
-        chainId: number;
-        healthFactor: string;
-        threshold: string;
-    };
-    createdAt: string;
-    isRead: boolean;
-} | {
-    id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    unread: boolean;
-    created_at: string;
-    type: TRIGGER_TYPES.ENS_EXPIRATION;
-    data: {
-        kind: "ens_expiration";
-        chainId: number;
-        reverseEnsName: string;
-        expirationDateIso: string;
-        reminderDelayInSeconds: number;
-    };
-    createdAt: string;
-    isRead: boolean;
-} | {
-    id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    unread: boolean;
-    created_at: string;
-    type: TRIGGER_TYPES.LIDO_STAKING_REWARDS;
-    data: {
-        kind: "lido_staking_rewards";
-        chainId: number;
-        currentStethBalance: string;
-        currentEthValue: string;
-        estimatedTotalRewardInPeriod: string;
-        daysSinceLastNotification: number;
-        notificationIntervalDays: number;
-    };
-    createdAt: string;
-    isRead: boolean;
-} | {
-    id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    unread: boolean;
-    created_at: string;
-    type: TRIGGER_TYPES.ROCKETPOOL_STAKING_REWARDS;
-    data: {
-        kind: "rocketpool_staking_rewards";
-        chainId: number;
-        currentRethBalance: string;
-        currentEthValue: string;
-        estimatedTotalRewardInPeriod: string;
-        daysSinceLastNotification: number;
-        notificationIntervalDays: number;
+                collection: {
+                    address: string;
+                    name: string;
+                    symbol: string;
+                    image: string;
+                };
+            } | undefined;
+        };
     };
     createdAt: string;
     isRead: boolean;
 } | {
     id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
+    notification_type: "platform";
     unread: boolean;
-    created_at: string;
-    type: TRIGGER_TYPES.NOTIONAL_LOAN_EXPIRATION;
-    data: {
-        kind: "notional_loan_expiration";
-        chainId: number;
-        loans: {
-            amount: string;
-            symbol: string;
-            maturityDateIso: string;
-        }[];
-        reminderDelayInSeconds: number;
+    template: {
+        image_url: string;
+        cta?: {
+            content: string;
+            link: string;
+        } | undefined;
+        title: string;
+        body: string;
     };
-    createdAt: string;
-    isRead: boolean;
-} | {
-    id: string;
-    address: string;
-    trigger_id: string;
-    chain_id: number;
-    unread: boolean;
     created_at: string;
-    type: TRIGGER_TYPES.SPARK_FI_HEALTH_FACTOR;
-    data: {
-        kind: "spark_fi_health_factor";
-        chainId: number;
-        healthFactor: string;
-        threshold: string;
-    };
+    type: TRIGGER_TYPES.PLATFORM;
     createdAt: string;
     isRead: boolean;
 } | {