smith.rs

use crate::*;

#[cfg(feature = "gdev")]
use runtime::runtime_types::gdev_runtime::opaque::SessionKeys as RuntimeSessionKeys;
use std::ops::Deref;

type SessionKeys = [u8; 128];

/// decode byte array into runtime session keys
// TODO find a way to avoid doing this manually by importing session keys trait implementation
fn session_keys_decode(session_keys: SessionKeys) -> RuntimeSessionKeys {
	RuntimeSessionKeys {
		grandpa: runtime::runtime_types::sp_consensus_grandpa::app::Public(
			runtime::runtime_types::sp_core::ed25519::Public(
				session_keys[0..32].try_into().unwrap(),
			),
		)
		.into(),
		babe: runtime::runtime_types::sp_consensus_babe::app::Public(
			runtime::runtime_types::sp_core::sr25519::Public(
				session_keys[32..64].try_into().unwrap(),
			),
		)
		.into(),
		im_online: runtime::runtime_types::pallet_im_online::sr25519::app_sr25519::Public(
			runtime::runtime_types::sp_core::sr25519::Public(
				session_keys[64..96].try_into().unwrap(),
			),
		)
		.into(),
		authority_discovery: runtime::runtime_types::sp_authority_discovery::app::Public(
			runtime::runtime_types::sp_core::sr25519::Public(
				session_keys[96..128].try_into().unwrap(),
			),
		)
		.into(),
	}
}

/// define smith subcommands
#[derive(Clone, Default, Debug, clap::Parser)]
pub enum Subcommand {
	/// Request smith membership
	Request,
	/// Emit a smith certification
	Cert { to: IdtyId },
	/// Claim smith membership
	Claim,
	/// Renew smith membership
	Renew,
	/// Revoke smith membership
	Revoke,
	/// go online
	GoOnline,
	/// go offline
	#[default]
	GoOffline,
	/// Rotate and set session keys
	UpdateKeys,
	/// Set session keys
	SetSessionKeys { session_keys: String },
	/// List upcoming expirations that require an action
	ShowExpire {
		/// Show certs that expire within less than this number of blocks
		#[clap(short, long, default_value_t = 100800)]
		blocks: u32,
		/// Show authorities that should rotate keys within less than this number of sessions
		#[clap(short, long, default_value_t = 100)]
		sessions: u32,
	},
	/// List online authorities
	ShowOnline,
	/// count of smith member
	MemberCount,
}

/// handle smith commands
pub async fn handle_command(data: Data, command: Subcommand) -> Result<(), GcliError> {
	let mut data = data.build_client().await?;
	match command {
		Subcommand::Request => {
			request_smith_membership(&data).await?;
		}
		Subcommand::Claim => {
			claim_smith_membership(&data).await?;
		}
		Subcommand::Renew => {
			renew_smith_membership(&data).await?;
		}
		Subcommand::Revoke => {
			revoke_smith_membership(&data).await?;
		}
		Subcommand::GoOnline => {
			go_online(&data).await?;
		}
		Subcommand::GoOffline => {
			go_offline(&data).await?;
		}
		Subcommand::Cert { to } => {
			data = data.fetch_idty_index().await?;
			cert(&data, to).await?
		}
		Subcommand::UpdateKeys => {
			update_session_keys(&data).await?;
		}
		Subcommand::SetSessionKeys { session_keys } => {
			let session_keys = session_keys_decode(
				hex::decode(session_keys)
					.expect("wrong hexadecimal")
					.try_into()
					.expect("wrong format"),
			); // decode session keys from hex string
			set_session_keys(&data, session_keys).await?;
		}
		Subcommand::ShowExpire { blocks, sessions } => {
			data = data.build_client().await?.build_indexer().await?;
			commands::expire::monitor_expirations(&data, blocks, sessions).await?
		}
		Subcommand::ShowOnline => {
			data = data.build_client().await?;
			online(&data).await?
		}
		Subcommand::MemberCount => {
			println!(
				"smith member count: {:?}",
				data.client()
					.storage()
					.at_latest()
					.await?
					.fetch(
						&runtime::storage()
							.smith_membership()
							.counter_for_membership(),
					)
					.await?
			)
		}
	};

	Ok(())
}

/// rotate session keys
/// (needs to be connected to unsafe RPC)
pub async fn rotate_keys(data: &Data) -> Result<SessionKeys, anyhow::Error> {
	data.legacy_rpc_methods()
		.await
		.author_rotate_keys()
		.await
		.map_err(|e| {
			anyhow!(
				"Please make sure you are connected to your validator node with the unsafe RPC \
				 API enabled {e}"
			)
		})?
		.deref()
		.try_into()
		.map_err(|e| anyhow!("Session keys have wrong length: {:?}", e))
}

/// request smith membership
pub async fn request_smith_membership(data: &Data) -> Result<(), subxt::Error> {
	submit_call_and_look_event::<
		runtime::smith_membership::events::MembershipRequested,
		Payload<runtime::smith_membership::calls::types::RequestMembership>,
	>(data, &runtime::tx().smith_membership().request_membership())
	.await
}

/// set session keys
pub async fn set_session_keys(
	data: &Data,
	session_keys: RuntimeSessionKeys,
) -> Result<TxProgress, subxt::Error> {
	submit_call::<Payload<runtime::authority_members::calls::types::SetSessionKeys>>(
		data,
		&runtime::tx()
			.authority_members()
			.set_session_keys(session_keys),
	)
	.await
}

// use runtime::runtime_types::sp_consensus_grandpa::app::Public

/// update session keys
pub async fn update_session_keys(data: &Data) -> Result<(), GcliError> {
	let session_keys = rotate_keys(data).await?;
	// manual session key conversion
	let session_keys = session_keys_decode(session_keys);
	let progress = set_session_keys(data, session_keys).await?;

	if data.args.no_wait {
		return Ok(());
	}
	let _ = track_progress(progress).await?; // TODO
	Ok(())
}

/// submit go_online
pub async fn go_online(data: &Data) -> Result<(), GcliError> {
	if data
		.client()
		.storage()
		.at_latest()
		.await?
		.fetch(&runtime::storage().session().next_keys(data.address()))
		.await?
		.is_none()
	{
		return Err(GcliError::Logic(
			"This account has not set session keys!".to_string(),
		));
	}

	submit_call_and_look_event::<
		runtime::authority_members::events::MemberGoOnline,
		Payload<runtime::authority_members::calls::types::GoOnline>,
	>(data, &runtime::tx().authority_members().go_online())
	.await
	.map_err(|e| e.into())
}

/// claim smith membership
pub async fn claim_smith_membership(data: &Data) -> Result<(), subxt::Error> {
	submit_call_and_look_event::<
		runtime::smith_membership::events::MembershipAcquired,
		Payload<runtime::smith_membership::calls::types::ClaimMembership>,
	>(data, &runtime::tx().smith_membership().claim_membership())
	.await
}

/// renew smith membership
pub async fn renew_smith_membership(data: &Data) -> Result<(), subxt::Error> {
	submit_call_and_look_event::<
		runtime::smith_membership::events::MembershipRenewed,
		Payload<runtime::smith_membership::calls::types::RenewMembership>,
	>(data, &runtime::tx().smith_membership().renew_membership())
	.await
}

/// revoke smith membership
pub async fn revoke_smith_membership(data: &Data) -> Result<(), subxt::Error> {
	submit_call_and_look_event::<
		runtime::smith_membership::events::MembershipRevoked,
		Payload<runtime::smith_membership::calls::types::RevokeMembership>,
	>(data, &runtime::tx().smith_membership().revoke_membership())
	.await
}

/// submit go_offline
pub async fn go_offline(data: &Data) -> Result<(), subxt::Error> {
	submit_call_and_look_event::<
		runtime::authority_members::events::MemberGoOffline,
		Payload<runtime::authority_members::calls::types::GoOffline>,
	>(data, &runtime::tx().authority_members().go_offline())
	.await
}

/// get online authorities
pub async fn online(data: &Data) -> Result<(), anyhow::Error> {
	let client = data.client();
	let indexer = data.indexer.clone();

	let parent_hash = client
		.clone()
		.storage()
		.at_latest()
		.await?
		.fetch(&runtime::storage().system().parent_hash())
		.await?
		.unwrap();

	let mut identity_cache = cache::IdentityCache::new(client.clone(), indexer);

	let online_authorities = client
		.storage()
		.at(parent_hash)
		.fetch(&runtime::storage().authority_members().online_authorities())
		.await?
		.unwrap_or_default();

	println!("Online:");
	for identity_id in online_authorities {
		println!(
			"  {}",
			identity_cache
				.fetch_identity(identity_id, parent_hash)
				.await
				.unwrap_or_else(|_| format!("{identity_id}"))
		);
	}

	let incoming_authorities = client
		.storage()
		.at(parent_hash)
		.fetch(
			&runtime::storage()
				.authority_members()
				.incoming_authorities(),
		)
		.await?
		.unwrap_or_default();

	println!("Incoming:");
	for identity_id in incoming_authorities {
		println!(
			"  {}",
			identity_cache
				.fetch_identity(identity_id, parent_hash)
				.await
				.unwrap_or_else(|_| format!("{identity_id}"))
		);
	}

	let outgoing_authorities = client
		.storage()
		.at(parent_hash)
		.fetch(
			&runtime::storage()
				.authority_members()
				.outgoing_authorities(),
		)
		.await?
		.unwrap_or_default();

	println!("Outgoing:");
	for identity_id in outgoing_authorities {
		println!(
			"  {}",
			identity_cache
				.fetch_identity(identity_id, parent_hash)
				.await
				.unwrap_or_else(|_| format!("{identity_id}"))
		);
	}

	Ok(())
}

/// submit a smith certification and track progress
pub async fn cert(data: &Data, receiver: IdtyId) -> Result<(), anyhow::Error> {
	let progress = submit_call(
		data,
		&runtime::tx()
			.smith_cert()
			.add_cert(data.idty_index(), receiver),
	)
	.await?;
	if data.args.no_wait {
		return Ok(());
	}
	let events = track_progress(progress).await?;
	// look for the expected event
	look_event::<runtime::smith_cert::events::NewCert>(data, &events)?;
	look_event::<runtime::smith_cert::events::RenewedCert>(data, &events)?;
	Ok(())
}