feat: added limit IDs to tradingLimits script

Author: chapati23

scripts/tradingLimits/README.md

@@ -26,8 +26,12 @@ yarn tradingLimits --exchange BiPoolManager
 yarn tradingLimits --exchange=BiPoolManager
 yarn tradingLimits -e BiPoolManager
 
+# Show verbose output with Limit IDs
+yarn tradingLimits --verbose
+yarn tradingLimits -v
+
 # Combine options
-yarn tradingLimits --token cUSD --exchange BiPoolManager
+yarn tradingLimits --token cUSD --exchange BiPoolManager --verbose
 
 # Connect to a specific RPC endpoint
 RPC_URL=https://your-rpc-url.com yarn tradingLimits
@@ -42,6 +46,18 @@ In normal mode, the tool shows a simplified view focused on usability:
 - Exchange column shows human-readable format (e.g., "cUSD <-> CELO")
 - Technical details like Exchange IDs, Asset addresses, and Limit IDs are hidden
 
+### Verbose Mode
+
+Use the `--verbose` or `-v` flag to enable verbose output:
+
+```bash
+yarn tradingLimits --verbose
+```
+
+In verbose mode, the tool displays additional technical information:
+
+- **Limit ID** column: Shows the unique identifier for each trading limit (a hex string generated from the exchange ID and asset address using XOR operation)
+
 ## Understanding Trading Limits
 
 Mento uses a multi-tiered trading limit system:
@@ -70,6 +86,7 @@ The script produces a table with the following columns:
 | Resets In   | Time until limit window resets                                         |
 | Reset Time  | Unix timestamp when limit resets                                       |
 | Status      | Current status (ACTIVE, INFLOWS BLOCKED, OUTFLOWS BLOCKED, or BLOCKED) |
+| Limit ID    | Unique identifier for the trading limit (visible in verbose mode only) |
 
 The tool uses color-coded statuses to indicate the current state of each trading limit:
 
@@ -80,7 +97,7 @@ The tool uses color-coded statuses to indicate the current state of each trading
 
 ## Project Structure
 
-```
+```text
 scripts/tradingLimits/
 ├── index.ts                   # Main script entry point
 ├── types.ts                   # Type definitions

scripts/tradingLimits/index.ts

@@ -108,7 +108,7 @@ async function main(): Promise<void> {
     // Display usage information
     console.log('\n' + chalk.bold('Usage:'))
     console.log(
-      '  yarn tradingLimits [--token|-t <symbol>] [--exchange|-e <exchangeId>] [--network|-n <network>] [--chainId|-c <chainId>]'
+      '  yarn tradingLimits [--token|-t <symbol>] [--exchange|-e <exchangeId>] [--network|-n <network>] [--chainId|-c <chainId>] [--verbose|-v]'
     )
     console.log('\n' + chalk.bold('Network options:'))
     console.log('  --network celo       # Celo mainnet')

scripts/tradingLimits/tradingLimitsOrchestrator.ts

@@ -49,7 +49,7 @@ export async function processTradingLimits(
   args: ScriptArgs
 ): Promise<void> {
   // Create table for displaying results
-  const limitsTable = createLimitsTable()
+  const limitsTable = createLimitsTable(args.verbose)
 
   // Filter exchanges if a token filter is provided
   let exchangesToProcess = exchanges
@@ -150,7 +150,8 @@ export async function processTradingLimits(
           result.tokenAssets,
           result.exchangeName,
           limitsTable,
-          false // Pass false to ensure the exchange name is displayed in the first row for this exchange
+          false, // Pass false to ensure the exchange name is displayed in the first row for this exchange
+          args.verbose
         )
       }
     } else {

scripts/tradingLimits/types.ts

@@ -14,6 +14,7 @@ export interface ScriptArgs {
   exchange: string
   chainId?: number
   rpcUrl?: string
+  verbose?: boolean
 }
 
 // Export types from SDK to avoid importing from multiple places

scripts/tradingLimits/utils/assetLimitProcessor.ts

@@ -5,6 +5,7 @@ import {
   TradingLimitsConfig,
   TradingLimitsState,
 } from '../../../src/interfaces'
+import { getLimitId } from '../../../src/limits'
 import { ScriptArgs, TradingLimit } from '../types'
 
 /**
@@ -98,6 +99,7 @@ export function getLimitDetails(
  *
  * @param asset - The token asset
  * @param exchangeName - Formatted exchange name
+ * @param exchangeId - The exchange ID
  * @param limits - Trading limits for this asset
  * @param configByAsset - Config by asset mapping
  * @param stateByAsset - State by asset mapping
@@ -109,6 +111,7 @@ export function getLimitDetails(
 export function processAssetWithLimits(
   asset: { address: string; symbol: string },
   exchangeName: string,
+  exchangeId: string,
   limits: TradingLimit[],
   configByAsset: Record<string, TradingLimitsConfig>,
   stateByAsset: Record<string, TradingLimitsState>,
@@ -157,6 +160,7 @@ export function processAssetWithLimits(
       const row = createLimitRow(
         asset,
         exchangeName,
+        exchangeId,
         limit,
         limitType,
         limitValue,
@@ -181,6 +185,7 @@ export function processAssetWithLimits(
       const row = createPlaceholderLimitRow(
         asset,
         exchangeName,
+        exchangeId,
         limitType,
         i,
         args,
@@ -205,6 +210,7 @@ export function processAssetWithLimits(
  *
  * @param asset - The token asset
  * @param exchangeName - Formatted exchange name
+ * @param exchangeId - The exchange ID
  * @param limit - The trading limit
  * @param limitType - The limit type (L0, L1, LG)
  * @param limitValue - The limit value
@@ -221,6 +227,7 @@ export function processAssetWithLimits(
 export function createLimitRow(
   asset: { address: string; symbol: string },
   exchangeName: string,
+  exchangeId: string,
   limit: TradingLimit,
   limitType: string,
   limitValue: number,
@@ -289,6 +296,12 @@ export function createLimitRow(
   // Status column
   row.push(status)
 
+  // Add limit ID column if verbose mode is enabled
+  if (args.verbose) {
+    const limitId = getLimitId(exchangeId, asset.address)
+    row.push(chalk.gray(limitId))
+  }
+
   // Return the completed row
   return row
 }
@@ -298,6 +311,7 @@ export function createLimitRow(
  *
  * @param asset - The token asset
  * @param exchangeName - Formatted exchange name
+ * @param exchangeId - The exchange ID
  * @param limitType - The limit type (L0, L1, LG)
  * @param limitIndex - The index of this limit
  * @param args - Script command line arguments (currently unused but passed through)
@@ -308,6 +322,7 @@ export function createLimitRow(
 export function createPlaceholderLimitRow(
   asset: { address: string; symbol: string },
   exchangeName: string,
+  exchangeId: string,
   limitType: string,
   limitIndex: number,
   args: ScriptArgs,
@@ -336,6 +351,12 @@ export function createPlaceholderLimitRow(
   row.push(chalk.gray('—')) // Max Out
   row.push(chalk.gray('NOT CONFIGURED')) // Status
 
+  // Add limit ID column if verbose mode is enabled
+  if (args.verbose) {
+    const limitId = getLimitId(exchangeId, asset.address)
+    row.push(chalk.gray(limitId))
+  }
+
   return row
 }
 

scripts/tradingLimits/utils/exchangeLimitProcessor.ts

@@ -42,6 +42,7 @@ export function processExchangeWithLimits(
       processAssetWithLimits(
         asset,
         exchangeName,
+        exchange.id,
         limits,
         exchangeData.configByAsset,
         exchangeData.stateByAsset,
@@ -57,7 +58,8 @@ export function processExchangeWithLimits(
         [asset],
         exchangeName,
         limitsTable,
-        exchangeNameDisplayed
+        exchangeNameDisplayed,
+        args.verbose
       )
 
       // Mark that we've displayed the exchange name

scripts/tradingLimits/utils/parseCommandLineArgs.ts

@@ -14,15 +14,18 @@ import './typeExtensions'
 export function parseCommandLineArgs(): ScriptArgs {
   const argv = yargsParser(process.argv.slice(2), {
     string: ['token', 'exchange', 'chainId', 'network'],
+    boolean: ['verbose'],
     alias: {
       t: 'token',
       e: 'exchange',
       c: 'chainId',
       n: 'network',
+      v: 'verbose',
     },
     default: {
       token: '',
       exchange: '',
+      verbose: false,
     },
     configuration: {
       'short-option-groups': true,
@@ -38,5 +41,6 @@ export function parseCommandLineArgs(): ScriptArgs {
     exchange: argv.exchange,
     chainId: networkConfig.chainId,
     rpcUrl: networkConfig.rpcUrl,
+    verbose: argv.verbose,
   }
 }

scripts/tradingLimits/utils/tableFormatter.ts

@@ -4,25 +4,33 @@ import Table from 'cli-table3'
 /**
  * Create a table for displaying trading limits
  *
+ * @param verbose - Whether to include the limit ID column
  * @returns A configured table instance
  */
-export function createLimitsTable(): Table.Table {
+export function createLimitsTable(verbose = false): Table.Table {
   // Create table configuration with clean and properly aligned headers
+  const headers = [
+    'Exchange',
+    'Symbol',
+    'Type',
+    'Limit',
+    'Netflow',
+    'Utilization',
+    'Timeframe',
+    'Resets In',
+    'Reset Time',
+    'Max In',
+    'Max Out',
+    'Status',
+  ]
+
+  // Add Limit ID column at the end if verbose mode is enabled
+  if (verbose) {
+    headers.push('Limit ID')
+  }
+
   const tableConfig: Table.TableConstructorOptions = {
-    head: [
-      'Exchange',
-      'Symbol',
-      'Type',
-      'Limit',
-      'Netflow',
-      'Utilization',
-      'Timeframe',
-      'Resets In',
-      'Reset Time',
-      'Max In',
-      'Max Out',
-      'Status',
-    ],
+    head: headers,
     style: {
       head: ['white', 'bold'],
       border: ['gray'],
@@ -56,12 +64,14 @@ export function createLimitsTable(): Table.Table {
  * @param exchangeName - Formatted exchange name
  * @param limitsTable - The table for displaying results
  * @param exchangeNameDisplayed - Whether the exchange name has been displayed already
+ * @param verbose - Whether to include the limit ID column
  */
 export function handleExchangeWithNoLimits(
   tokenAssets: Array<{ address: string; symbol: string }>,
   exchangeName: string,
   limitsTable: Table.Table,
-  exchangeNameDisplayed = false
+  exchangeNameDisplayed = false,
+  verbose = false
 ): void {
   // No limits for any assets in this exchange
   let isExchangeNameDisplayed = exchangeNameDisplayed
@@ -88,6 +98,11 @@ export function handleExchangeWithNoLimits(
       chalk.gray('NO LIMITS CONFIGURED') // Status - changed to match the text from createPlaceholderLimitRow
     )
 
+    // Add limit ID column if verbose mode is enabled
+    if (verbose) {
+      row.push(chalk.gray('—'))
+    }
+
     limitsTable.push(row)
     isExchangeNameDisplayed = true
   }