@metamask-previews/perps-controller 0.0.0-preview-685dbf46b → 1.0.0-preview-bc00f2c

package/dist/constants/eventNames.d.mts

@@ -0,0 +1,387 @@
+/**
+ * Perps event property keys and values - matching dashboard requirements exactly
+ * Event names are defined in MetaMetrics.events.ts as the single source of truth
+ */
+/**
+ * Event property keys - ensures consistent property naming
+ */
+export declare const PERPS_EVENT_PROPERTY: {
+    readonly TIMESTAMP: "timestamp";
+    readonly ASSET: "asset";
+    readonly DIRECTION: "direction";
+    readonly SOURCE: "source";
+    readonly TAB_NAME: "tab_name";
+    readonly LOCATION: "location";
+    readonly LEVERAGE: "leverage";
+    readonly LEVERAGE_USED: "leverage_used";
+    readonly ORDER_SIZE: "order_size";
+    readonly MARGIN_USED: "margin_used";
+    readonly ORDER_TYPE: "order_type";
+    readonly ORDER_TIMESTAMP: "order_timestamp";
+    readonly LIMIT_PRICE: "limit_price";
+    readonly FEES: "fees";
+    readonly FEE: "fee";
+    readonly METAMASK_FEE: "metamask_fee";
+    readonly METAMASK_FEE_RATE: "metamask_fee_rate";
+    readonly DISCOUNT_PERCENTAGE: "discount_percentage";
+    readonly ESTIMATED_REWARDS: "estimated_rewards";
+    readonly ASSET_PRICE: "asset_price";
+    readonly COMPLETION_DURATION: "completion_duration";
+    readonly OPEN_POSITION: "open_position";
+    readonly OPEN_POSITION_SIZE: "open_position_size";
+    readonly UNREALIZED_PNL_DOLLAR: "unrealized_dollar_pnl";
+    readonly UNREALIZED_PNL_PERCENT: "unrealized_percent_pnl";
+    readonly CLOSE_VALUE: "close_value";
+    readonly CLOSE_PERCENTAGE: "close_percentage";
+    readonly CLOSE_TYPE: "close_type";
+    readonly PERCENTAGE_CLOSED: "percentage_closed";
+    readonly PNL_DOLLAR: "dollar_pnl";
+    readonly PNL_PERCENT: "percent_pnl";
+    readonly RECEIVED_AMOUNT: "received_amount";
+    readonly CURRENT_ORDER_TYPE: "current_order_type";
+    readonly SELECTED_ORDER_TYPE: "selected_order_type";
+    readonly SOURCE_CHAIN: "source_chain";
+    readonly SOURCE_ASSET: "source_asset";
+    readonly SOURCE_AMOUNT: "source_amount";
+    readonly DESTINATION_AMOUNT: "destination_amount";
+    readonly NETWORK_FEE: "network_fee";
+    readonly WITHDRAWAL_AMOUNT: "withdrawal_amount";
+    readonly INTERACTION_TYPE: "interaction_type";
+    readonly TIME_SERIE_SELECTED: "time_serie_selected";
+    readonly CANDLE_PERIOD: "candle_period";
+    readonly STOP_LOSS_PRICE: "stop_loss_price";
+    readonly STOP_LOSS_PERCENT: "stop_loss_percent";
+    readonly TAKE_PROFIT_PRICE: "take_profit_price";
+    readonly TAKE_PROFIT_PERCENT: "take_profit_percent";
+    readonly POSITION_SIZE: "position_size";
+    readonly POSITION_AGE: "position_age";
+    readonly LIQUIDATION_DISTANCE_OLD: "liquidation_distance_old";
+    readonly LIQUIDATION_DISTANCE_NEW: "liquidation_distance_new";
+    readonly NOTIFICATION_TYPE: "notification_type";
+    readonly INPUT_METHOD: "input_method";
+    readonly ACTION_TYPE: "action_type";
+    readonly SETTING_TYPE: "setting_type";
+    readonly FAILURE_REASON: "failure_reason";
+    readonly WARNING_TYPE: "warning_type";
+    readonly WARNING_MESSAGE: "warning_message";
+    readonly ERROR_TYPE: "error_type";
+    readonly ERROR_MESSAGE: "error_message";
+    readonly AB_TESTS: "ab_tests";
+    readonly COMPLETION_DURATION_TUTORIAL: "completion_duration_tutorial";
+    readonly STEPS_VIEWED: "steps_viewed";
+    readonly VIEW_OCCURRENCES: "view_occurrences";
+    readonly AMOUNT_FILLED: "amount_filled";
+    readonly REMAINING_AMOUNT: "remaining_amount";
+    readonly PREVIOUS_SCREEN: "previous_screen";
+    readonly CURRENT_SCREEN: "current_screen";
+    readonly SCREEN_POSITION: "screen_position";
+    readonly TOTAL_SCREENS: "total_screens";
+    readonly NAVIGATION_METHOD: "navigation_method";
+    readonly STATUS: "status";
+    readonly SCREEN_TYPE: "screen_type";
+    readonly SCREEN_NAME: "screen_name";
+    readonly ACTION: "action";
+    readonly RETRY_ATTEMPTS: "retry_attempts";
+    readonly SHOW_BACK_BUTTON: "show_back_button";
+    readonly ATTEMPT_NUMBER: "attempt_number";
+    readonly IMAGE_SELECTED: "image_selected";
+    readonly TAB_NUMBER: "tab_number";
+    readonly AB_TEST_BUTTON_COLOR: "ab_test_button_color";
+    readonly BUTTON_CLICKED: "button_clicked";
+    readonly BUTTON_LOCATION: "button_location";
+    readonly HAS_PERP_BALANCE: "has_perp_balance";
+    readonly IS_GEO_BLOCKED: "is_geo_blocked";
+    readonly HAS_TAKE_PROFIT: "has_take_profit";
+    readonly HAS_STOP_LOSS: "has_stop_loss";
+    readonly TAKE_PROFIT_PERCENTAGE: "take_profit_percentage";
+    readonly STOP_LOSS_PERCENTAGE: "stop_loss_percentage";
+    readonly FAVORITES_COUNT: "favorites_count";
+    readonly SECTION_VIEWED: "section_viewed";
+    readonly TRADE_WITH_TOKEN: "trade_with_token";
+    readonly MM_PAY_TOKEN_SELECTED: "mm_pay_token_selected";
+    readonly MM_PAY_NETWORK_SELECTED: "mm_pay_network_selected";
+    readonly INITIAL_PAYMENT_METHOD: "initial_payment_method";
+    readonly NEW_PAYMENT_METHOD: "new_payment_method";
+};
+/**
+ * Property value constants
+ */
+export declare const PERPS_EVENT_VALUE: {
+    readonly DIRECTION: {
+        readonly LONG: "long";
+        readonly SHORT: "short";
+    };
+    readonly ORDER_TYPE: {
+        readonly MARKET: "market";
+        readonly LIMIT: "limit";
+    };
+    readonly ORDER_TYPE_CAPITALIZED: {
+        readonly MARKET: "market";
+        readonly LIMIT: "limit";
+    };
+    readonly INPUT_METHOD: {
+        readonly SLIDER: "slider";
+        readonly KEYBOARD: "keyboard";
+        readonly PRESET: "preset";
+        readonly MANUAL: "manual";
+        readonly PERCENTAGE_BUTTON: "percentage_button";
+    };
+    readonly SOURCE: {
+        readonly BANNER: "banner";
+        readonly NOTIFICATION: "notification";
+        readonly MAIN_ACTION_BUTTON: "main_action_button";
+        readonly POSITION_TAB: "position_tab";
+        readonly PERP_MARKETS: "perp_markets";
+        readonly DEEPLINK: "deeplink";
+        readonly TUTORIAL: "tutorial";
+        readonly TRADE_SCREEN: "trade_screen";
+        readonly HOMESCREEN_TAB: "homescreen_tab";
+        readonly PERP_ASSET_SCREEN: "perp_asset_screen";
+        readonly PERP_MARKET: "perp_market";
+        readonly PERP_MARKET_SEARCH: "perp_market_search";
+        readonly POSITION_SCREEN: "position_screen";
+        readonly TP_SL_VIEW: "tp_sl_view";
+        readonly PERPS_HOME: "perps_home";
+        readonly PERPS_TUTORIAL: "perps_tutorial";
+        readonly PERPS_HOME_EMPTY_STATE: "perps_home_empty_state";
+        readonly PERPS_ASSET_SCREEN_NO_FUNDS: "perps_asset_screen_no_funds";
+        readonly TRADE_MENU_ACTION: "trade_menu_action";
+        readonly WALLET_HOME: "wallet_home";
+        readonly TOOLTIP: "tooltip";
+        readonly MAGNIFYING_GLASS: "magnifying_glass";
+        readonly CRYPTO_BUTTON: "crypto_button";
+        readonly STOCKS_BUTTON: "stocks_button";
+        readonly CLOSE_TOAST: "close_toast";
+        readonly PERPS_HOME_POSITION: "perps_home_position";
+        readonly PERPS_HOME_ORDERS: "perps_home_orders";
+        readonly PERPS_HOME_WATCHLIST: "perps_home_watchlist";
+        readonly PERPS_HOME_EXPLORE_CRYPTO: "perps_home_explore_crypto";
+        readonly PERPS_HOME_EXPLORE_STOCKS: "perps_home_explore_stocks";
+        readonly PERPS_HOME_ACTIVITY: "perps_home_activity";
+        readonly PERPS_MARKET_LIST_ALL: "perps_market_list_all";
+        readonly PERPS_MARKET_LIST_CRYPTO: "perps_market_list_crypto";
+        readonly PERPS_MARKET_LIST_STOCKS: "perps_market_list_stocks";
+        readonly PERPS_TAB: "perps_tab";
+        readonly WALLET_MAIN_ACTION_MENU: "wallet_main_action_menu";
+        readonly PUSH_NOTIFICATION: "push_notification";
+        readonly ORDER_BOOK: "order_book";
+        readonly FULL_SCREEN_CHART: "full_screen_chart";
+        readonly STOP_LOSS_PROMPT_BANNER: "stop_loss_prompt_banner";
+        readonly OPEN_POSITION: "open_position";
+        readonly POSITION_CLOSE_TOAST: "position_close_toast";
+        readonly TRADE_DETAILS: "trade_details";
+        readonly DEPOSIT_BUTTON: "deposit_button";
+        readonly WITHDRAW_BUTTON: "withdraw_button";
+        readonly TRADE_ACTION: "trade_action";
+        readonly ADD_FUNDS_ACTION: "add_funds_action";
+        readonly CANCEL_ORDER: "cancel_order";
+        readonly ASSET_DETAIL_SCREEN: "asset_detail_screen";
+        readonly CLOSE_POSITION_ACTION: "close_position_action";
+        readonly MODIFY_POSITION_ACTION: "modify_position_action";
+        readonly ORDER_BOOK_LONG_BUTTON: "order_book_long_button";
+        readonly ORDER_BOOK_SHORT_BUTTON: "order_book_short_button";
+        readonly ORDER_BOOK_CLOSE_BUTTON: "order_book_close_button";
+        readonly ORDER_BOOK_MODIFY_BUTTON: "order_book_modify_button";
+        readonly AUTO_CLOSE_ACTION: "auto_close_action";
+        readonly ADJUST_MARGIN_ACTION: "adjust_margin_action";
+        readonly STOP_LOSS_PROMPT_ADD_MARGIN: "stop_loss_prompt_add_margin";
+        readonly STOP_LOSS_PROMPT_SET_SL: "stop_loss_prompt_set_sl";
+        readonly CLOSE_ALL_POSITIONS_BUTTON: "close_all_positions_button";
+    };
+    readonly WARNING_TYPE: {
+        readonly MINIMUM_DEPOSIT: "minimum_deposit";
+        readonly MINIMUM_ORDER_SIZE: "minimum_order_size";
+        readonly INSUFFICIENT_BALANCE: "insufficient_balance";
+    };
+    readonly ERROR_TYPE: {
+        readonly NETWORK: "network";
+        readonly APP_CRASH: "app_crash";
+        readonly BACKEND: "backend";
+        readonly VALIDATION: "validation";
+        readonly WARNING: "warning";
+    };
+    readonly ERROR_MESSAGE_KEY: {
+        readonly ORDER_CHANGED_FROM_LIMIT_TO_MARKET: "order_changed_from_limit_to_market";
+        readonly OPEN_CROSS_MARGIN_POSITION_DETECTED: "open_cross_margin_position_detected";
+        readonly INSUFFICIENT_BALANCE: "insufficient_balance";
+        readonly ORDER_FAILED: "order_failed";
+        readonly GEO_RESTRICTION: "geo_restriction";
+        readonly MINIMUM_ORDER_SIZE: "minimum_order_size";
+        readonly MAXIMUM_LEVERAGE_EXCEEDED: "maximum_leverage_exceeded";
+        readonly PRICE_DEVIATION_TOO_HIGH: "price_deviation_too_high";
+        readonly MARKET_AT_CAPACITY: "market_at_capacity";
+        readonly NETWORK_ERROR: "network_error";
+        readonly CONNECTION_FAILED: "connection_failed";
+        readonly POSITION_UPDATE_FAILED: "position_update_failed";
+        readonly TP_SL_UPDATE_FAILED: "tp_sl_update_failed";
+        readonly MARGIN_UPDATE_FAILED: "margin_update_failed";
+    };
+    readonly INTERACTION_TYPE: {
+        readonly TAP: "tap";
+        readonly ZOOM: "zoom";
+        readonly SLIDE: "slide";
+        readonly SEARCH_CLICKED: "search_clicked";
+        readonly ORDER_TYPE_VIEWED: "order_type_viewed";
+        readonly ORDER_TYPE_SELECTED: "order_type_selected";
+        /** @deprecated Use LEVERAGE_CHANGED instead for clarity */
+        readonly SETTING_CHANGED: "setting_changed";
+        readonly LEVERAGE_CHANGED: "leverage_changed";
+        readonly TUTORIAL_STARTED: "tutorial_started";
+        readonly TUTORIAL_COMPLETED: "tutorial_completed";
+        readonly TUTORIAL_NAVIGATION: "tutorial_navigation";
+        readonly CANDLE_PERIOD_VIEWED: "candle_period_viewed";
+        readonly CANDLE_PERIOD_CHANGED: "candle_period_changed";
+        readonly FAVORITE_TOGGLED: "favorite_toggled";
+        readonly BUTTON_CLICKED: "button_clicked";
+        readonly CONTACT_SUPPORT: "contact_support";
+        readonly STOP_LOSS_ONE_CLICK_PROMPT: "stop_loss_one_click_prompt";
+        readonly ADD_MARGIN: "add_margin";
+        readonly REMOVE_MARGIN: "remove_margin";
+        readonly INCREASE_EXPOSURE: "increase_exposure";
+        readonly REDUCE_EXPOSURE: "reduce_exposure";
+        readonly FLIP_POSITION: "flip_position";
+        readonly DISPLAY_HERO_CARD: "display_hero_card";
+        readonly SHARE_PNL_HERO_CARD: "share_pnl_hero_card";
+        readonly FULL_SCREEN_CHART: "full_screen_chart";
+        readonly PAYMENT_TOKEN_SELECTOR: "payment_token_selector";
+        readonly PAYMENT_METHOD_CHANGED: "payment_method_changed";
+    };
+    readonly ACTION_TYPE: {
+        readonly START_TRADING: "start_trading";
+        readonly SKIP: "skip";
+        readonly STOP_LOSS_SET: "stop_loss_set";
+        readonly TAKE_PROFIT_SET: "take_profit_set";
+        readonly ADL_LEARN_MORE: "adl_learn_more";
+        readonly LEARN_MORE: "learn_more";
+        readonly FAVORITE_MARKET: "favorite_market";
+        readonly UNFAVORITE_MARKET: "unfavorite_market";
+    };
+    readonly NOTIFICATION_TYPE: {
+        readonly POSITION_LIQUIDATED: "position_liquidated";
+        readonly TP_EXECUTED: "tp_executed";
+        readonly SL_EXECUTED: "sl_executed";
+        readonly LIMIT_ORDER_EXECUTED: "limit_order_executed";
+    };
+    readonly CLOSE_TYPE: {
+        readonly FULL: "full";
+        readonly PARTIAL: "partial";
+    };
+    readonly NAVIGATION_METHOD: {
+        readonly SWIPE: "swipe";
+        readonly CONTINUE_BUTTON: "continue_button";
+        readonly PROGRESS_DOT: "progress_dot";
+    };
+    readonly STATUS: {
+        readonly VIEWED: "viewed";
+        readonly STARTED: "started";
+        readonly COMPLETED: "completed";
+        readonly INITIATED: "initiated";
+        readonly SUBMITTED: "submitted";
+        readonly EXECUTED: "executed";
+        readonly PARTIALLY_FILLED: "partially_filled";
+        readonly FAILED: "failed";
+        readonly SUCCESS: "success";
+    };
+    readonly SCREEN_TYPE: {
+        readonly MARKETS: "markets";
+        readonly MARKET_LIST: "market_list";
+        readonly ASSET_DETAILS: "asset_details";
+        readonly TRADING: "trading";
+        /** @deprecated Use PERPS_HOME or WALLET_HOME_PERPS_TAB instead */
+        readonly HOMESCREEN: "homescreen";
+        readonly PERPS_HOME: "perps_home";
+        readonly WALLET_HOME_PERPS_TAB: "wallet_home_perps_tab";
+        readonly POSITION_CLOSE: "position_close";
+        readonly LEVERAGE: "leverage";
+        readonly TUTORIAL: "tutorial";
+        readonly WITHDRAWAL: "withdrawal";
+        readonly TP_SL: "tp_sl";
+        readonly CREATE_TPSL: "create_tpsl";
+        readonly EDIT_TPSL: "edit_tpsl";
+        readonly DEPOSIT_INPUT: "deposit_input";
+        readonly DEPOSIT_REVIEW: "deposit_review";
+        readonly CLOSE_ALL_POSITIONS: "close_all_positions";
+        readonly CANCEL_ALL_ORDERS: "cancel_all_orders";
+        readonly PNL_HERO_CARD: "pnl_hero_card";
+        readonly ORDER_BOOK: "order_book";
+        readonly ERROR: "error";
+        readonly MARKET_LIST_ALL: "market_list_all";
+        readonly MARKET_LIST_CRYPTO: "market_list_crypto";
+        readonly MARKET_LIST_STOCKS: "market_list_stocks";
+        readonly FULL_SCREEN_CHART: "full_screen_chart";
+        readonly ACTIVITY: "activity";
+        readonly INCREASE_EXPOSURE: "increase_exposure";
+        readonly ADD_MARGIN: "add_margin";
+        readonly REMOVE_MARGIN: "remove_margin";
+        readonly GEO_BLOCK_NOTIF: "geo_block_notif";
+    };
+    readonly SETTING_TYPE: {
+        readonly LEVERAGE: "leverage";
+    };
+    readonly SCREEN_NAME: {
+        readonly CONNECTION_ERROR: "connection_error";
+        readonly PERPS_HERO_CARD: "perps_hero_card";
+        readonly PERPS_ACTIVITY_HISTORY: "perps_activity_history";
+        readonly PERPS_HOME: "perps_home";
+        readonly PERPS_MARKET_DETAILS: "perps_market_details";
+        readonly PERPS_ORDER: "perps_order";
+    };
+    readonly ACTION: {
+        readonly CONNECTION_RETRY: "connection_retry";
+        readonly SHARE: "share";
+        readonly ADD_MARGIN: "add_margin";
+        readonly REMOVE_MARGIN: "remove_margin";
+        readonly EDIT_TP_SL: "edit_tp_sl";
+        readonly CREATE_TP_SL: "create_tp_sl";
+        readonly CREATE_POSITION: "create_position";
+        readonly INCREASE_EXPOSURE: "increase_exposure";
+    };
+    readonly RISK_MANAGEMENT_SOURCE: {
+        readonly TRADE_SCREEN: "trade_screen";
+        readonly POSITION_SCREEN: "position_screen";
+        readonly STOP_LOSS_PROMPT_BANNER: "stop_loss_prompt_banner";
+    };
+    readonly PERPS_HISTORY_TABS: {
+        readonly TRADES: "trades";
+        readonly ORDERS: "orders";
+        readonly FUNDING: "funding";
+        readonly DEPOSITS: "deposits";
+    };
+    readonly AB_TEST: {
+        readonly BUTTON_COLOR_TEST: "button_color_test";
+        readonly CONTROL: "control";
+        readonly MONOCHROME: "monochrome";
+    };
+    readonly BUTTON_CLICKED: {
+        readonly DEPOSIT: "deposit";
+        readonly WITHDRAW: "withdraw";
+        readonly PERPS_HOME: "perps_home";
+        readonly TUTORIAL: "tutorial";
+        readonly TOOLTIP: "tooltip";
+        readonly MARKET_LIST: "market_list";
+        readonly OPEN_POSITION: "open_position";
+        readonly MAGNIFYING_GLASS: "magnifying_glass";
+        readonly CRYPTO: "crypto";
+        readonly STOCKS: "stocks";
+        readonly COMMODITIES: "commodities";
+        readonly FOREX: "forex";
+        readonly NEW: "new";
+        readonly GIVE_FEEDBACK: "give_feedback";
+    };
+    readonly BUTTON_LOCATION: {
+        readonly PERPS_HOME: "perps_home";
+        readonly PERPS_TUTORIAL: "perps_tutorial";
+        readonly PERPS_HOME_EMPTY_STATE: "perps_home_empty_state";
+        readonly PERPS_ASSET_SCREEN: "perps_asset_screen";
+        readonly PERPS_TAB: "perps_tab";
+        readonly TRADE_MENU_ACTION: "trade_menu_action";
+        readonly WALLET_HOME: "wallet_home";
+        readonly MARKET_LIST: "market_list";
+        readonly SCREEN: "screen";
+        readonly TOOLTIP: "tooltip";
+        readonly PERP_MARKET_DETAILS: "perp_market_details";
+        readonly ORDER_BOOK: "order_book";
+        readonly FULL_SCREEN_CHART: "full_screen_chart";
+    };
+};
+//# sourceMappingURL=eventNames.d.mts.map

package/dist/constants/eventNames.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventNames.d.mts","sourceRoot":"","sources":["../../src/constants/eventNames.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0IvB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAgI1B,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAoE3D,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwG5D,CAAC"}