feat: announcement banner on deposit withdraw screens

.github/markets/pr_template.md

@@ -26,7 +26,7 @@ Each json file under the [configs](../../configs) folder correspond to their res
 |`wswth_contract`   |`string`   |false   |wSWTH ERC-20 contract.   |
 |`market_banners`   |`MarketBanner[]`   |true   |market banner configs.   |
 | `native_token_contracts_map` | `object` | false    | Map of token denoms to their respective contract addresses on the native chain. |       |
-| `native_depositor_contracts_map`  | `object`                 | false    | Map of axelar connection ids to their respective native depositor contract addresses      
+| `native_depositor_contracts_map`  | `object`                 | false    | Map of axelar connection ids to their respective native depositor contract addresses
 |`market_promo`   |`MarketPromo`   |false   |Map of Objects that contains market promo parameters for each market   |If the `market_promo` property is omitted, no promo will be shown. The key of each entry is the ids of the market with existing promo.   |
 |`spot_pool_config`   |`SpotPoolConfig`   |false   |Object that contains the config parameters for the [Spot Pools](https://app.dem.exchange/pools/spot) page on Demex   |
 |`quick_select_tokens`   |`QuickSelectToken[]`   |true   |List of quick select tokens for deposit and withdrawal forms.   |
@@ -95,19 +95,19 @@ Each json file under the [configs](../../configs) folder correspond to their res
 |---|---|---|---|---|
 |`perp_pool_id`   |`string`   |true   |Perp pool id where the banner will be shown.  |Perp pool id **MUST** match one of the existing perp pool ids from the PerpPool PoolInfoAll RPC call.<br /><br /> To view the values of PoolInfoAll RPC call, simply run `yarn get-perp-pool-ids [network]` on the command line. Sample for mainnet: `yarn get-perp-pool-ids mainnet`    |
 |`show_from`   |`string`   |false   |The date and time when the perp pool banner is scheduled to begin displaying. |If not provided, the banner will be shown immediately.<br /><br /> This field **MUST** follow the valid ISO 8601 format <br /> e.g. *2024-01-23T09:00+00:00* (23 Jan 2024, 9am UTC) |
-|`show_until`   |`string`   |false   |The date and time when the perp pool banner is scheduled to stop displaying. |If not provided, the banner will continue to display indefinitely.<br /><br /> This field **MUST** follow the valid ISO 8601 format <br /> e.g. *2024-01-23T09:00+00:00* (23 Jan 2024, 9am UTC) | 
-|`title`   |`string`   |true   |The title shown on the perp pool banner. | 
+|`show_until`   |`string`   |false   |The date and time when the perp pool banner is scheduled to stop displaying. |If not provided, the banner will continue to display indefinitely.<br /><br /> This field **MUST** follow the valid ISO 8601 format <br /> e.g. *2024-01-23T09:00+00:00* (23 Jan 2024, 9am UTC) |
+|`title`   |`string`   |true   |The title shown on the perp pool banner. |
 |`removed_markets`   |`string`   |false   |The message describing markets being removed, shown below the perp-pool banner title. | e.g. "BTCETH Perp will be removed on 6 Mar, 09:00AM UTC". If the field is omitted, no message describing markets being removed will be shown. |
-|`added_markets`   |`string`   |false   |The message describing markets being added, shown below the markets being removed (if any). | e.g. "ATOM Perp & SOL Perp will be added on 8 Mar, 12:00AM UTC". If the field is omitted, no message describing markets being added will be shown. | 
-|`subtext`   |`string`   |false   |The subtext shown on the perp pool banner (below the removed and added market descriptions). | 
+|`added_markets`   |`string`   |false   |The message describing markets being added, shown below the markets being removed (if any). | e.g. "ATOM Perp & SOL Perp will be added on 8 Mar, 12:00AM UTC". If the field is omitted, no message describing markets being added will be shown. |
+|`subtext`   |`string`   |false   |The subtext shown on the perp pool banner (below the removed and added market descriptions). |
 
 ## MarketBanner
 |Field   |Type   |Required   |Description   |Notes   |
 |---|---|---|---|---|
 |`market_id`   |`string`   |true   |Market id where the banner will be shown.  |Market id **MUST** match one of the existing market ids from the Market MarketAll RPC call.<br /><br /> To view the values of MarketAll RPC call, simply run `yarn get-market-ids [network]` on the command line. Sample for mainnet: `yarn get-market-ids mainnet`    |
 |`show_from`   |`string`   |false   |The date and time when the market banner is scheduled to begin displaying. |If not provided, the banner will be shown immediately.<br /><br /> This field **MUST** follow the valid ISO 8601 format <br /> e.g. *2024-01-23T09:00+00:00* (23 Jan 2024, 9am UTC) |
-|`show_until`   |`string`   |false   |The date and time when the market banner is scheduled to stop displaying. |If not provided, the banner will continue to display indefinitely.<br /><br /> This field **MUST** follow the valid ISO 8601 format <br /> e.g. *2024-01-23T09:00+00:00* (23 Jan 2024, 9am UTC) | 
-|`content`   |`string`   |true   |The content shown on the market banner. | 
+|`show_until`   |`string`   |false   |The date and time when the market banner is scheduled to stop displaying. |If not provided, the banner will continue to display indefinitely.<br /><br /> This field **MUST** follow the valid ISO 8601 format <br /> e.g. *2024-01-23T09:00+00:00* (23 Jan 2024, 9am UTC) |
+|`content`   |`string`   |true   |The content shown on the market banner. |
 |`hideable`   |`boolean`   |false   |Indicates if user can hide the banner by clicking on the close button |If set to `false`, the close button will not be rendered on the banner, and user will not be able to dismiss the banner. |
 
 ## MarketPromo Data Structure
@@ -127,3 +127,10 @@ Each json file under the [configs](../../configs) folder correspond to their res
 |---|---|---|---|---|
 |`label_denom`   |`string`   |true   |The default token will be show on UI deposit/withdrawal forms    |
 |`target_denom`   |`string`   |true   |The default token will be use to transfer in deposit/withdrawal    |
+
+## TransferBanner Data Structure
+|Field   |Type   |Required   |Description   |Notes   |
+|---|---|---|---|---|
+|`no_longer_supported_tokens`   |`string[]`  |false   |List of tokens are no longer supported |
+|`temporary_disabled_transfer_tokens`   |`object`  |false   |List of tokens for which deposits and withdrawals have been temporarily disabled |
+|`temporary_disabled_bridges`   |`object`  |false   |List of bridges for which deposits and withdrawals have been temporarily disabled |

README.md

@@ -90,7 +90,7 @@ More metadata will be added in the future if required by the Demex frontend. Ple
     "baseDenom": "denom_3",
     "chainRoutes": ["blockchain_5", "blockchain_6"],
     "denomOnCarbon": "carbon_denom_1"
-  }], 
+  }],
   "demex_trading_league_config": {
     "promoMarkets": [
       "promo_market_1",
@@ -99,6 +99,21 @@ More metadata will be added in the future if required by the Demex frontend. Ple
     ],
     "currentPrizeSymbol": "market_symbol",
     "currentCompPerpPoolId": 1
+  },
+  "transfer_banner": {
+    "no_longer_supported_tokens": ["denom_1", "denom_2"],
+    "temporary_disabled_transfer_tokens": {
+      "denom_1": {
+        "start": "",
+        "end": ""
+      }
+    },
+    "temporary_disabled_bridges": {
+      "bridge_address_1": {
+        "start": "",
+        "end": ""
+      }
+    }
   }
 }
 ```

config.schema.json

@@ -516,6 +516,61 @@
         }
       }
     },
+    "transfer_banner": {
+      "type": "object",
+      "description": "Config parameters to show banner for deposit and withdraw screens",
+      "properties": {
+        "no_longer_supported_tokens": {
+          "type": "array",
+          "description": "List of tokens are no longer supported",
+          "items": {
+            "type": "string"
+          }
+        },
+        "temporary_disabled_transfer_tokens": {
+          "type": "object",
+          "description": "List of tokens for which deposits and withdrawals have been temporarily disabled",
+          "patternProperties": {
+            ".*": {
+              "type": "object",
+              "required": [
+                "start",
+                "end"
+              ],
+              "properties": {
+                "start": {
+                  "$ref": "#/$defs/start"
+                },
+                "end": {
+                  "$ref": "#/$defs/end"
+                }
+              }
+            }
+          }
+        },
+        "temporary_disabled_bridges": {
+          "type": "object",
+          "description": "List of bridges for which deposits and withdrawals have been temporarily disabled",
+          "patternProperties": {
+            ".*": {
+              "type": "object",
+              "required": [
+                "start",
+                "end"
+              ],
+              "properties": {
+                "start": {
+                  "$ref": "#/$defs/start"
+                },
+                "end": {
+                  "$ref": "#/$defs/end"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "quick_select_token": {
       "type": "object",
       "description": "Token denom for quick select in transfer form",

configs/devnet.json

@@ -61,7 +61,12 @@
     },
     {
       "label_denom": "dai",
-      "target_denom" : "dai" 
+      "target_denom" : "dai"
     }
-  ]
+  ],
+  "transfer_banner": {
+    "no_longer_supported_tokens": [],
+    "temporary_disabled_transfer_tokens": {},
+    "temporary_disabled_bridges": {}
+  }
 }

configs/mainnet.json

@@ -500,5 +500,10 @@
       "label_denom": "brdg/a02afc2c1edf77cc023eefa25fc036c184612faf9365cda9c1daa3b1675ebf8f",
       "target_denom": "brdg/a02afc2c1edf77cc023eefa25fc036c184612faf9365cda9c1daa3b1675ebf8f"
     }
-  ]
+  ],
+  "transfer_banner": {
+    "no_longer_supported_tokens": [],
+    "temporary_disabled_transfer_tokens": {},
+    "temporary_disabled_bridges": {}
+  }
 }

configs/testnet.json

@@ -77,5 +77,10 @@
       "label_denom": "dai",
       "target_denom" : "dai"
     }
-  ]
+  ],
+  "transfer_banner": {
+    "no_longer_supported_tokens": [],
+    "temporary_disabled_transfer_tokens": {},
+    "temporary_disabled_bridges": {}
+  }
 }

scripts/check_configs.ts

@@ -34,6 +34,7 @@ interface ConfigJSON {
   market_banners?: MarketBanner[];
   market_promo?: {[marketId: string]: MarketPromo};
   spot_pool_config?: SpotPoolConfig;
+  transfer_banner?: TransferBanner;
   quick_select_deposit_options?: QuickSelectToken[];
 }
 
@@ -133,6 +134,22 @@ interface SpotPoolConfig {
   show_apr_tooltip: boolean;
 }
 
+interface TransferBanner {
+  no_longer_supported_tokens: [],
+  temporary_disabled_transfer_tokens: {
+    [denom: string]: {
+      start: string,
+      end: string
+    }
+  },
+  temporary_disabled_bridges: {
+    [bridgeAddress: string]: {
+      start: string,
+      end: string
+    }
+  }
+}
+
 interface QuickSelectToken {
   label_denom: string;
   target_denom: string;
@@ -207,7 +224,7 @@ function joinEntriesIntoStr(entriesArr: string[]): string {
     : entriesArr[0];
 }
 
-// check list of markets to ensure that it does not have blacklisted markets 
+// check list of markets to ensure that it does not have blacklisted markets
 function checkBlacklistedMarkets(marketData: string[], blacklistedMarkets: string[]): InvalidEntry {
   let overlappingMarkets: string[] = [];
   marketData.forEach(market => {
@@ -426,6 +443,35 @@ function isValidMarketPromo(marketPromo: {[marketId: string]: MarketPromo}, netw
   return true;
 }
 
+function isValidTransferBanner(transferBanner: TransferBanner, network: CarbonSDK.Network): boolean {
+  const { temporary_disabled_transfer_tokens, temporary_disabled_bridges } = transferBanner;
+  if (Object.keys(temporary_disabled_transfer_tokens).length > 0) {
+    Object.keys(temporary_disabled_transfer_tokens).map((key) => {
+      const { start, end } = temporary_disabled_transfer_tokens[key];
+      const startTime = new Date(start);
+      const endTime = new Date(end);
+      if (endTime < startTime) {
+        console.error(`ERROR: ${network}.json has invalid end time (${end}) is before start time (${start}) for token denom ${key}.`);
+        return false;
+      }
+    });
+  }
+
+  if (Object.keys(temporary_disabled_bridges).length > 0) {
+    Object.keys(temporary_disabled_bridges).map((key) => {
+      const { start, end } = temporary_disabled_bridges[key];
+      const startTime = new Date(start);
+      const endTime = new Date(end);
+      if (endTime < startTime) {
+        console.error(`ERROR: ${network}.json has invalid end time (${end}) is before start time (${start}) for bridge address ${key}.`);
+        return false;
+      }
+    });
+  }
+
+  return true
+}
+
 function isValidQuickSelectTokens(quickSelectTokens: QuickSelectToken[], network: CarbonSDK.Network, denoms: string[]): boolean {
   const duplicateQuickSelectTokens = checkDuplicateEntries(quickSelectTokens.map(token => token.label_denom));
   const invalidQuickSelectTokens = checkValidEntries(quickSelectTokens.map(token => token.label_denom), denoms);
@@ -784,7 +830,7 @@ async function main() {
       if(jsonData.market_promo && !isValidMarketPromo(jsonData.market_promo, network, marketIds)) {
         outcomeMap[network] = false;
       }
-      
+
       // check for spot pool config
       if (jsonData.spot_pool_config) {
         const spotPoolConfig = jsonData.spot_pool_config
@@ -808,6 +854,11 @@ async function main() {
         if (!isDemexTradingLeagueConfigValid) outcomeMap[network] = false;
       }
 
+      // transfer banner check
+      if (jsonData.transfer_banner && !isValidTransferBanner(jsonData.transfer_banner, network)) {
+        outcomeMap[network] = false;
+      }
+
       // check for validate quick select tokens
       if (jsonData.quick_select_deposit_options && !isValidQuickSelectTokens(jsonData.quick_select_deposit_options, network, tokens)) {
         outcomeMap[network] = false;