[network] onchain discovery tool (#228)

larryl3u · web-flow · commit e0e9f60dc61c · 2025-10-15T12:00:11.000-07:00
## Description  This change implements a tool that can decodes a node address into BCS format and validator can update their onchain address to make them discoverable. * Top level ``` adhoc command for l1 migration Usage: l1-migration <COMMAND> Commands: generate-waypoint-genesis Generate waypoint and genesis files from database network-address Convert between multiaddr strings and BCS hex format help Print this message or the help of the given subcommand(s) Options: -h, --help Print help -V, --version Print version ``` * Network address command ``` Convert between multiaddr strings and BCS hex format Usage: l1-migration network-address <COMMAND> Commands: encode Encode multiaddr string to BCS hex decode Decode BCS hex to multiaddr string help Print this message or the help of the given subcommand(s) Options: -h, --help Print help ``` * Encode ``` ./l1-migration network-address encode --help Encode multiaddr string to BCS hex Usage: l1-migration network-address encode <MULTIADDR> Arguments: <MULTIADDR> Multiaddr string to encode to BCS hex format Example: /dns/validator.example.com/tcp/6180/noise-ik/a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890/handshake/1 Options: -h, --help Print help (see a summary with '-h') ``` * Decode ``` ./l1-migration network-address decode --help Decode BCS hex to multiaddr string Usage: l1-migration network-address decode <HEX> Arguments: <HEX> BCS hex string to decode to multiaddr format Example: 0x013f04021576616c696461746f722e6578616d706c652e636f6d0524180720a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef12345678900801 Options: -h, --help Print help (see a summary with '-h') ``` ## Type of Change - [x] New feature - [ ] Bug fix - [ ] Breaking change - [ ] Performance improvement - [ ] Refactoring - [ ] Dependency update - [ ] Documentation update - [ ] Tests ## Which Components or Systems Does This Change Impact? - [ ] Validator Node - [ ] Full Node (API, Indexer, etc.) - [ ] Move/Aptos Virtual Machine - [ ] Aptos Framework - [ ] Aptos CLI/SDK - [ ] Developer Infrastructure - [x] Other (specify) tools ## How Has This Been Tested?  Testnet address is updated onchain. everything looks good. ## Key Areas to Review  ## Checklist - [ ] I have read and followed the [CONTRIBUTING](https://github.com/aptos-labs/aptos-core/blob/main/CONTRIBUTING.md) doc - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I identified and added all stakeholders and component owners affected by this change as reviewers - [ ] I tested both happy and unhappy path of the functionality - [ ] I have made corresponding changes to the documentation
diff --git a/tools/l1-migration/Cargo.toml b/tools/l1-migration/Cargo.toml
@@ -12,7 +12,7 @@ rust-version = { workspace = true }
 
 
 [dependencies]
-anyhow = "1.0"
+anyhow = { workspace = true }
 aptos-config = { workspace = true }
 aptos-crypto = { workspace = true }
 aptos-db = { workspace = true }
@@ -21,4 +21,4 @@ aptos-types = { workspace = true }
 bcs = { workspace = true }
 clap = { workspace = true }
 serde_yaml = { workspace = true }
-hex = "0.4"
+hex = { workspace = true }
diff --git a/tools/l1-migration/src/main.rs b/tools/l1-migration/src/main.rs
@@ -1,6 +1,9 @@
 use anyhow::Result;
 use clap::Parser;
-use l1_migration::extract_genesis_and_waypoint;
+use l1_migration::{
+    extract_genesis_and_waypoint,
+    utils::{decode_network_address, encode_network_address},
+};
 use std::path::PathBuf;
 
 /// L1 Migration Tool - Extract genesis and waypoint from database
@@ -22,6 +25,32 @@ enum Commands {
         /// Destination directory for extracted files
         destination_path: PathBuf,
     },
+    /// Network address encoding/decoding tool
+    #[command(about = "Convert between multiaddr strings and BCS hex format")]
+    NetworkAddress {
+        #[command(subcommand)]
+        command: NetworkAddressCommands,
+    },
+}
+
+#[derive(Parser)]
+enum NetworkAddressCommands {
+    /// Encode multiaddr string to BCS hex
+    Encode {
+        /// Multiaddr string to encode to BCS hex format
+        ///
+        /// Example: /dns/validator.example.com/tcp/6180/noise-ik/a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890/handshake/1
+        #[arg(help = "Multiaddr string to encode to BCS hex format")]
+        multiaddr: String,
+    },
+    /// Decode BCS hex to multiaddr string
+    Decode {
+        /// BCS hex string to decode to multiaddr format
+        ///
+        /// Example: 0x013f04021576616c696461746f722e6578616d706c652e636f6d0524180720a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef12345678900801
+        #[arg(help = "BCS hex string to decode to multiaddr format")]
+        hex: String,
+    },
 }
 
 fn main() -> Result<()> {
@@ -52,5 +81,9 @@ fn main() -> Result<()> {
 
             extract_genesis_and_waypoint(&db_path_str, &destination_path_str)
         },
+        Commands::NetworkAddress { command } => match command {
+            NetworkAddressCommands::Encode { multiaddr } => encode_network_address(&multiaddr),
+            NetworkAddressCommands::Decode { hex } => decode_network_address(&hex),
+        },
     }
 }
diff --git a/tools/l1-migration/src/utils.rs b/tools/l1-migration/src/utils.rs
@@ -2,8 +2,8 @@ use anyhow::Result;
 use aptos_config::config::{RocksdbConfigs, StorageDirPaths, NO_OP_STORAGE_PRUNER_CONFIG};
 use aptos_db::AptosDB;
 use aptos_storage_interface::DbReader;
-use aptos_types::{transaction::Transaction, waypoint::Waypoint};
-use std::{fs, path::Path};
+use aptos_types::{network_address::NetworkAddress, transaction::Transaction, waypoint::Waypoint};
+use std::{fs, path::Path, str::FromStr};
 
 /// Extract genesis transaction and waypoint from an Aptos database
 pub fn extract_genesis_and_waypoint(db_path: &str, output_dir: &str) -> Result<()> {
@@ -155,3 +155,59 @@ fn print_genesis_transaction_info(genesis_transaction: &Transaction) {
         },
     }
 }
+
+/// Encode a network address from multiaddr string to BCS hex format
+pub fn encode_network_address(multiaddr_input: &str) -> Result<()> {
+    let mut addresses = Vec::new();
+
+    // Split by comma and parse each address
+    for addr_str in multiaddr_input.split(',') {
+        let addr_str = addr_str.trim();
+        if !addr_str.is_empty() {
+            let network_address = NetworkAddress::from_str(addr_str)
+                .map_err(|e| anyhow::anyhow!("Invalid multiaddr string '{}': {}. Please provide a valid multiaddr string (e.g., /dns/example.com/tcp/6180/noise-ik/.../handshake/1)", addr_str, e))?;
+            addresses.push(network_address);
+        }
+    }
+
+    if addresses.is_empty() {
+        return Err(anyhow::anyhow!(
+            "No valid network addresses found. Please provide at least one valid multiaddr string"
+        ));
+    }
+
+    let encoded_bytes = bcs::to_bytes(&addresses)?;
+    let hex_output = format!("0x{}", hex::encode(&encoded_bytes));
+
+    println!("{}", hex_output);
+
+    Ok(())
+}
+
+/// Decode a network address from BCS hex format to multiaddr string
+pub fn decode_network_address(bcs_hex: &str) -> Result<()> {
+    let hex_str = bcs_hex.strip_prefix("0x").unwrap_or(bcs_hex);
+    let bcs_bytes = hex::decode(hex_str).map_err(|e| {
+        anyhow::anyhow!(
+            "Invalid hex string: {}. Please provide a valid hex string (with or without 0x prefix)",
+            e
+        )
+    })?;
+
+    // Try to decode as Vec<NetworkAddress> first (most common case)
+    if let Ok(addresses) = bcs::from_bytes::<Vec<NetworkAddress>>(&bcs_bytes) {
+        let addr_strings: Vec<String> = addresses.iter().map(|addr| addr.to_string()).collect();
+        let multiaddr_output = addr_strings.join(", ");
+
+        println!("{}", multiaddr_output);
+
+        Ok(())
+    } else if let Ok(network_address) = bcs::from_bytes::<NetworkAddress>(&bcs_bytes) {
+        // Try to decode as single NetworkAddress
+        println!("{}", network_address);
+
+        Ok(())
+    } else {
+        Err(anyhow::anyhow!("Failed to decode network address from BCS hex. Please ensure the input is a valid BCS-encoded NetworkAddress or Vec<NetworkAddress>"))
+    }
+}
