install-chain: Add alias feature via avalanched (#412)

* install-chain: Add alias feature via avalanched

Signed-off-by: Dan Sover <[email protected]>

* alias: Send dummy command to SSM

Signed-off-by: Dan Sover <[email protected]>

---------

Signed-off-by: Dan Sover <[email protected]>

Author: exdx

avalanche-ops/src/aws/cfn-templates/ssm_install_subnet_chain.yaml

@@ -35,6 +35,9 @@ Resources:
           avalanchedArgs:
             type: String
             description: New blockchain id to move configuration to.
+          aliasArgs:
+            type: String
+            description: Aliasing arguments for avalanched.
         mainSteps:
           - action: aws:runShellScript
             name: installSubnetChain
@@ -50,6 +53,9 @@ Resources:
                   # to download vm binary, write/update subnet/chain config
                   /usr/local/bin/avalanched-aws {{ avalanchedArgs }}
 
+                  # to set the chain alias 
+                  /usr/local/bin/avalanched-aws {{ aliasArgs }}
+
                   # to reload updated configs
                   sudo systemctl restart --no-block avalanchego.service
                   sleep 7

avalanched-aws/Cargo.toml

@@ -27,6 +27,7 @@ log = "0.4.18"
 prometheus-manager = "0.0.30"
 random-manager = "0.0.5"
 serde = { version = "1.0.163", features = ["derive"] }
+serde_json = "1.0.103"
 tempfile = "3.5.0"
 tokio = { version = "1.29.1", features = ["full"] } # https://github.com/tokio-rs/tokio/releases
 

avalanched-aws/src/alias_chain/mod.rs

@@ -0,0 +1,69 @@
+use std::{collections::HashMap, fs::File, io, path::Path};
+
+use clap::{Arg, Command};
+use serde::{Deserialize, Serialize};
+
+pub const NAME: &str = "alias-chain";
+
+/// Defines "alias-chain" option.
+#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Clone)]
+pub struct Flags {
+    pub log_level: String,
+
+    pub chain_id: String,
+    pub chain_name: String,
+}
+
+pub fn command() -> Command {
+    Command::new(NAME)
+        .about("Sets chain alias (WARN: ALWAYS OVERWRITES)")
+        .arg(
+            Arg::new("LOG_LEVEL")
+                .long("log-level")
+                .short('l')
+                .help("Sets the log level")
+                .required(false)
+                .num_args(1)
+                .value_parser(["debug", "info"])
+                .default_value("info"),
+        )
+        .arg(
+            Arg::new("CHAIN_ID")
+                .long("chain-id")
+                .help("Chain ID")
+                .required(false)
+                .num_args(1),
+        )
+        .arg(
+            Arg::new("CHAIN_NAME")
+                .long("chain-name")
+                .help("Chain name to use as an alias")
+                .required(false)
+                .num_args(1),
+        )
+}
+
+pub async fn execute(opts: Flags) -> io::Result<()> {
+    // ref. <https://github.com/env-logger-rs/env_logger/issues/47>
+    env_logger::init_from_env(
+        env_logger::Env::default().filter_or(env_logger::DEFAULT_FILTER_ENV, opts.log_level),
+    );
+
+    // Create alias.json file
+    // TODO: import type from avalanche-rust
+    pub type Aliases = HashMap<String, Vec<String>>;
+    let mut aliases = Aliases::new();
+    aliases.insert(opts.chain_id, Vec::from([opts.chain_name]));
+
+    // Write it to default location
+    // TODO: import location from avalanche-rust
+    pub const DEFAULT_CHAIN_ALIASES_PATH: &str = "/data/avalanche-configs/chains/aliases.json";
+    let path = Path::new(DEFAULT_CHAIN_ALIASES_PATH);
+
+    let file = File::create(path)?;
+    ::serde_json::to_writer(file, &aliases)?;
+
+    // At this point avalanchego should be restarted to notice the new alias.
+    // This is done via the ssm_install_subnet_chain SSM document under src/aws/cfn-templates.
+    Ok(())
+}

avalanched-aws/src/main.rs

@@ -1,4 +1,5 @@
 mod agent;
+mod alias_chain;
 mod install_artifacts;
 mod install_chain;
 mod install_subnet;
@@ -17,6 +18,7 @@ async fn main() {
             install_artifacts::command(),
             install_chain::command(),
             install_subnet::command(),
+            alias_chain::command(),
         ])
         .get_matches();
 
@@ -154,6 +156,25 @@ async fn main() {
             .unwrap();
         }
 
+        Some((alias_chain::NAME, sub_matches)) => {
+            alias_chain::execute(alias_chain::Flags {
+                log_level: sub_matches
+                    .get_one::<String>("LOG_LEVEL")
+                    .unwrap_or(&String::from("info"))
+                    .to_string(),
+                chain_name: sub_matches
+                    .get_one::<String>("CHAIN_NAME")
+                    .unwrap()
+                    .to_string(),
+                chain_id: sub_matches
+                    .get_one::<String>("CHAIN_ID")
+                    .unwrap()
+                    .to_string(),
+            })
+            .await
+            .unwrap();
+        }
+
         _ => unreachable!("unknown subcommand"),
     }
 }

avalancheup-aws/src/install_subnet_chain/mod.rs

@@ -12,7 +12,7 @@ use avalanche_types::{
     jsonrpc::client::info as json_client_info,
     key, subnet, units, wallet,
 };
-use aws_manager::{self, s3, ssm, sts};
+use aws_manager::{self, s3, ssm};
 use aws_sdk_ssm::types::CommandInvocationStatus;
 use clap::{value_parser, Arg, Command};
 use crossterm::{
@@ -515,11 +515,12 @@ pub async fn execute(opts: Flags) -> io::Result<()> {
         Some(Duration::from_secs(opts.s3_upload_timeout)),
     )
     .await;
-    let sts_manager = sts::Manager::new(&shared_config);
+    // let sts_manager = sts::Manager::new(&shared_config);
     let s3_manager = s3::Manager::new(&shared_config);
 
-    let current_identity = sts_manager.get_identity().await.unwrap();
-    log::info!("current AWS identity: {:?}", current_identity);
+    // TODO: This is now causing an error. It's optional so we can leave it is as is for now.
+    // let current_identity = sts_manager.get_identity().await.unwrap();
+    // log::info!("current AWS identity: {:?}", current_identity);
 
     if !opts.skip_prompt {
         println!();
@@ -814,6 +815,8 @@ pub async fn execute(opts: Flags) -> io::Result<()> {
             .document_name(ssm_doc.clone())
             .set_instance_ids(Some(instance_ids.clone()))
             .parameters("avalanchedArgs", vec![avalanched_args.clone()])
+            // hack: send in dummy alias parameters in the no-op case
+            .parameters("aliasArgs", vec!["--version".to_string()])
             .output_s3_region(opts.s3_region.clone())
             .output_s3_bucket_name(opts.s3_bucket.clone())
             .output_s3_key_prefix(format!(
@@ -955,6 +958,12 @@ pub async fn execute(opts: Flags) -> io::Result<()> {
             file_stem.to_str().unwrap()
         );
 
+        let avalanched_alias_args = format!(
+            "alias-chain --log-level info --chain_id {chain_id} --chain_alias {alias}",
+            chain_id = blockchain_id,
+            alias = opts.chain_name.clone(),
+        );
+
         // If a Subnet's chain id is 2ebCneCbwthjQ1rYT41nhd7M76Hc6YmosMAQrTFhBq8qeqh6tt,
         // the config file for this chain is located at {chain-config-dir}/2ebCneCbwthjQ1rYT41nhd7M76Hc6YmosMAQrTFhBq8qeqh6tt/config.json.
         let avalanched_args = format!("install-chain --log-level info --s3-region {region} --s3-bucket {s3_bucket} --chain-config-s3-key {chain_config_s3_key} --chain-config-local-path {chain_config_local_path}",
@@ -992,6 +1001,7 @@ pub async fn execute(opts: Flags) -> io::Result<()> {
                 .document_name(ssm_doc.clone())
                 .set_instance_ids(Some(instance_ids.clone()))
                 .parameters("avalanchedArgs", vec![avalanched_args.clone()])
+                .parameters("aliasArgs", vec![avalanched_alias_args.clone()])
                 .output_s3_region(opts.s3_region.clone())
                 .output_s3_bucket_name(opts.s3_bucket.clone())
                 .output_s3_key_prefix(format!(
@@ -1034,7 +1044,8 @@ pub async fn execute(opts: Flags) -> io::Result<()> {
         stdout(),
         SetForegroundColor(Color::Blue),
         Print(format!(
-            "\n\n\nSUCCESS!\nsubnet Id: {created_subnet_id}\nblockchain Id: {blockchain_id}\n\n"
+            "\n\n\nSUCCESS!\nsubnet Id: {created_subnet_id}\nblockchain Id: {blockchain_id}\nchain alias: {chain_name}\n\n",
+            chain_name = opts.chain_name.clone(),
         )),
         ResetColor
     )?;