feat: MGP12 token renaming (#98)

Author: nvtaveras

README.md

@@ -30,25 +30,25 @@ Current token connectivity on Celo Mainnet (last updated: 2025-10-02):
 ```mermaid
 graph TD
     USDT["USD₮"]
-    USDC --- cUSD
-    axlUSDC --- cUSD
-    USDT --- cUSD
-    cAUD --- cUSD
-    cCAD --- cUSD
-    CELO --- cUSD
-    cGBP --- cUSD
-    cUSD --- cZAR
-    cCHF --- cUSD
-    PUSO --- cUSD
-    cJPY --- cUSD
-    cCOP --- cUSD
-    cREAL --- cUSD
-    axlEUROC --- cEUR
-    cEUR --- cUSD
-    cGHS --- cUSD
-    cNGN --- cUSD
-    cKES --- cUSD
-    cUSD --- eXOF
+    USDC --- USDm
+    axlUSDC --- USDm
+    USDT --- USDm
+    AUDm --- USDm
+    CADm --- USDm
+    CELO --- USDm
+    GBPm --- USDm
+    USDm --- ZARm
+    CHFm --- USDm
+    PHPm --- USDm
+    JPYm --- USDm
+    COPm --- USDm
+    BRLm --- USDm
+    axlEUROC --- EURm
+    EURm --- USDm
+    GHSm --- USDm
+    NGNm --- USDm
+    KESm --- USDm
+    USDm --- XOFm
 ```
 
 **Network Stats:** 20 tokens, 19 direct trading pairs

TRADING_MODE_EXAMPLE.md

@@ -122,15 +122,15 @@ This method:
 ### Multi-Hop Routes
 
 The `isPairTradable()` method intelligently handles multi-hop routes. For example, if you want to swap CELO → USDT but there's no direct exchange, the route might be:
-- CELO → cUSD (hop 1)
-- cUSD → USDT (hop 2)
+- CELO → USDm (hop 1)
+- USDm → USDT (hop 2)
 
 The method will check that **ALL** rate feeds in the path are in BIDIRECTIONAL mode. If any hop is HALTED or DISABLED, the entire pair is considered not tradable.
 
 ```typescript
 // Example: Multi-hop route check
 const isTradable = await mento.isPairTradable(celoAddress, usdtAddress)
-// Returns true ONLY if both CELO/cUSD AND cUSD/USDT rate feeds are BIDIRECTIONAL
+// Returns true ONLY if both CELO/USDm AND USDm/USDT rate feeds are BIDIRECTIONAL
 ```
 
 ### Method Comparison

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [

scripts/breakerBox/README.md

@@ -22,9 +22,9 @@ A CLI tool for visualizing all circuit breaker configurations and their current
 yarn breakerBox
 
 # Filter by token symbol
-yarn breakerBox --token cUSD
-yarn breakerBox --token=cUSD
-yarn breakerBox -t cUSD
+yarn breakerBox --token USDm
+yarn breakerBox --token=USDm
+yarn breakerBox -t USDm
 
 # Connect to a specific RPC endpoint
 RPC_URL=https://your-rpc-url.com yarn breakerBox

scripts/breakerBox/index.ts

@@ -30,10 +30,10 @@ const RATEFEED_REVERSE_LOOKUP: Record<string, string> = CURRENCIES.reduce((acc,
     }, {} as Record<string, string>)
   }
 }, {
-  ["0x765DE816845861e75A25fCA122bb6898B8B1282a".toLocaleLowerCase()]: "cUSD (CELOUSD)",
-  ["0xD8763CBa276a3738E6DE85b4b3bF5FDed6D6cA73".toLocaleLowerCase()]: "cEUR (CELOEUR)",
-  ["0xe8537a3d056DA446677B9E9d6c5dB704EaAb4787".toLocaleLowerCase()]: "cREAL (CELOBRL)",
-  ["0x73F93dcc49cB8A239e2032663e9475dd5ef29A08".toLocaleLowerCase()]: "eXOF (CELOXOF)",
+  ["0x765DE816845861e75A25fCA122bb6898B8B1282a".toLocaleLowerCase()]: "USDm (CELOUSD)",
+  ["0xD8763CBa276a3738E6DE85b4b3bF5FDed6D6cA73".toLocaleLowerCase()]: "EURm (CELOEUR)",
+  ["0xe8537a3d056DA446677B9E9d6c5dB704EaAb4787".toLocaleLowerCase()]: "BRLm (CELOBRL)",
+  ["0x73F93dcc49cB8A239e2032663e9475dd5ef29A08".toLocaleLowerCase()]: "XOFm (CELOXOF)",
 })
 
 

scripts/breakerBox/utils/parseCommandLineArgs.ts

@@ -3,7 +3,7 @@ import { parseNetworkArgs } from '../../shared/network'
 
 /**
  * Parse command line arguments using yargs-parser
- * Supports both "--token=cGHS" and "--token cGHS" formats, as well as short flags (-t, -e)
+ * Supports both "--token=GHSm" and "--token GHSm" formats, as well as short flags (-t, -e)
  * Also supports network selection via --network/-n and --chainId/-c flags
  *
  * @returns Object containing parsed arguments

scripts/cacheTokens/README.md

@@ -21,7 +21,7 @@ yarn cacheTokens
 ### Cache tokens for specific chains
 
 ```bash
-yarn cacheTokens --chain-ids=42220,44787
+yarn cacheTokens --chain-ids=42220,11142220
 ```
 
 ## Output
@@ -31,7 +31,6 @@ The script generates TypeScript files in `src/constants/`:
 **Individual token files (per chain):**
 
 - `tokens.42220.ts` - Celo Mainnet tokens (readonly Token[])
-- `tokens.44787.ts` - Alfajores Testnet tokens (readonly Token[])
 - `tokens.11142220.ts` - Celo Sepolia Testnet tokens (readonly Token[])
 
 **Main index file (dynamically generated):**
@@ -48,7 +47,7 @@ The script generates TypeScript files in `src/constants/`:
 
 Everything is computed dynamically from blockchain data:
 
-✅ **Token enum** - Unique symbols across all chains (e.g., `TokenSymbol.CELO`, `TokenSymbol.cUSD`)  
+✅ **Token enum** - Unique symbols across all chains (e.g., `TokenSymbol.CELO`, `TokenSymbol.USDm`)  
 ✅ **Address mappings** - Complete `TOKEN_ADDRESSES_BY_CHAIN` for all chains  
 ✅ **Helper functions** - Type-safe address lookups and token search  
 ✅ **Chain support** - Auto-detects supported chains from network config  
@@ -59,7 +58,6 @@ Everything is computed dynamically from blockchain data:
 RPC URLs can be configured via environment variables:
 
 - `CELO_RPC_URL` - Celo Mainnet RPC URL (default: <https://forno.celo.org>)
-- `ALFAJORES_RPC_URL` - Alfajores RPC URL (default: <https://alfajores-forno.celo-testnet.org>)
 - `CELO_SEPOLIA_RPC_URL` - Celo Sepolia RPC URL (default: <https://forno.celo-sepolia.celo-testnet.org>)
 
 ## When to Regenerate
@@ -74,13 +72,10 @@ Regenerate cached tokens when:
 ## Example Output
 
 ```bash
-📡 Cache tokens for chain(s): 42220, 44787, 11142220
+📡 Cache tokens for chain(s): 42220, 11142220
 🔄 Generating tokens for chain 42220...
 ✅ Successfully cached 20 tokens to tokens.42220.ts
 
-🔄 Generating tokens for chain 44787...
-✅ Successfully cached 20 tokens to tokens.44787.ts
-
 🔄 Generating tokens for chain 11142220...
 ✅ Successfully cached 20 tokens to tokens.11142220.ts
 

scripts/cacheTokens/cli.ts

@@ -28,7 +28,7 @@ export function parseCommandLineArgs(): CommandLineArgs {
 export function printUsageTips(): void {
   console.log('\n💡 Usage tips:')
   console.log('   - To cache tokens for specific chains:')
-  console.log('     yarn cacheTokens --chain-ids=42220,44787')
+  console.log('     yarn cacheTokens --chain-ids=42220,11142220')
   console.log('   - To cache tokens for all chains:')
   console.log('     yarn cacheTokens')
 }

scripts/cacheTokens/tokensIndexGenerator.ts

@@ -65,7 +65,6 @@ export function generateTokensIndexFile(
     .map((chainId) => {
       const names: { [key: string]: string } = {
         '42220': 'Celo',
-        '44787': 'Alfajores',
         '11142220': 'Celo Sepolia',
       }
       return `${chainId} (${names[chainId] || 'Unknown'})`

scripts/cacheTradablePairs/README.md

@@ -32,7 +32,6 @@ The script can be run via the original entry point for backward compatibility:
 yarn cacheTradablePairs
 
 # Cache specific network
-yarn cacheTradablePairs --network alfajores
 yarn cacheTradablePairs --network celo
 
 # Cache specific chain ID
@@ -42,15 +41,14 @@ yarn cacheTradablePairs --chainId 42220
 Or directly via the modular entry point:
 
 ```bash
-npx ts-node scripts/cacheTradablePairs/index.ts --network alfajores
+npx ts-node scripts/cacheTradablePairs/index.ts --network celo
 ```
 
 ## Output
 
 The script generates TypeScript files in `src/constants/` with the format:
 
 - `tradablePairs.42220.ts` (Celo mainnet)
-- `tradablePairs.44787.ts` (Alfajores testnet)
 
 Each file contains: