shim: mass rename adapter -> dock

Author: pepyakin

sugondat-shim/src/cli.rs

@@ -38,7 +38,7 @@ pub struct Cli {
 }
 
 /// Common parameters for key management in a subcommand.
-// TODO: for adapters, this should not be required and for query submit it should
+// TODO: for docks, this should not be required and for query submit it should
 // be. Unfortunately, clap doesn't support this easily so it is handled manually
 // within the command execution for submit.
 #[derive(clap::Args, Debug)]
@@ -62,9 +62,9 @@ pub struct KeyManagementParams {
     pub submit_private_key: Option<std::path::PathBuf>,
 }
 
-/// Common parameters for the adapter subcommands.
+/// Common parameters for the subcommands that run docks.
 #[derive(clap::Args, Debug)]
-pub struct AdapterServerParams {
+pub struct DockParams {
     /// The address on which the shim should listen for incoming connections from the rollup nodes.
     #[clap(short, long, default_value = "127.0.0.1", group = "listen")]
     pub address: String,
@@ -79,7 +79,7 @@ pub struct AdapterServerParams {
     )]
     pub port: u16,
 
-    // TODO: e.g. prometheus stuff, enabled adapters, etc.
+    // TODO: e.g. prometheus stuff, enabled docks, etc.
 }
 
 /// Common parameters for that commands that connect to the sugondat-node.
@@ -90,8 +90,8 @@ pub struct SugondatRpcParams {
     pub node_url: String,
 }
 
-impl AdapterServerParams {
-    /// Whether the sovereign adapter should be enabled.
+impl DockParams {
+    /// Whether the sovereign dock should be enabled.
     pub fn enable_sovereign(&self) -> bool {
         true
     }
@@ -110,7 +110,7 @@ pub enum Commands {
 pub mod serve {
     //! CLI definition for the `serve` subcommand.
 
-    use super::{AdapterServerParams, KeyManagementParams, SugondatRpcParams};
+    use super::{DockParams, KeyManagementParams, SugondatRpcParams};
     use clap::Args;
 
     #[derive(Debug, Args)]
@@ -119,7 +119,7 @@ pub mod serve {
         pub rpc: SugondatRpcParams,
 
         #[clap(flatten)]
-        pub adapter: AdapterServerParams,
+        pub dock: DockParams,
 
         #[clap(flatten)]
         pub key_management: KeyManagementParams,

sugondat-shim/src/cmd/serve.rs

@@ -1,6 +1,6 @@
 use crate::{
-    dock::sovereign::SovereignAdapter,
-    cli::{serve::Params, AdapterServerParams},
+    dock::sovereign::SovereignDock,
+    cli::{serve::Params, DockParams},
     key::Keypair,
     sugondat_rpc::Client,
 };
@@ -12,13 +12,13 @@ use tracing::{debug, info};
 pub async fn run(params: Params) -> anyhow::Result<()> {
     info!(
         "starting sugondat-shim server on {}:{}",
-        params.adapter.address, params.adapter.port
+        params.dock.address, params.dock.port
     );
-    let listen_on = (params.adapter.address.as_str(), params.adapter.port);
+    let listen_on = (params.dock.address.as_str(), params.dock.port);
     let maybe_key = crate::cmd::load_key(params.key_management)?;
     let server = Server::builder().build(listen_on).await?;
     let client = connect_client(&params.rpc.node_url).await?;
-    let handle = server.start(init_adapters(client, &params.adapter, maybe_key));
+    let handle = server.start(init_docks(client, &params.dock, maybe_key));
     handle.stopped().await;
     Ok(())
 }
@@ -28,16 +28,16 @@ async fn connect_client(url: &str) -> anyhow::Result<Client> {
     Ok(client)
 }
 
-fn init_adapters(
+fn init_docks(
     client: Client,
-    adapter: &AdapterServerParams,
+    dock_params: &DockParams,
     maybe_key: Option<Keypair>,
 ) -> Methods {
     let mut methods = Methods::new();
-    if adapter.enable_sovereign() {
-        debug!("enabling sovereign adapter");
-        let adapter = SovereignAdapter::new(client.clone(), maybe_key);
-        methods.merge(adapter.into_rpc()).unwrap();
+    if dock_params.enable_sovereign() {
+        debug!("enabling sovereign adapter dock");
+        let dock = SovereignDock::new(client.clone(), maybe_key);
+        methods.merge(dock.into_rpc()).unwrap();
     }
     methods
 }

sugondat-shim/src/dock/mod.rs

@@ -1 +1,4 @@
+//! A dock is a component that provides an ad-hoc API consumed by the corresponding adapter in the
+//! rollup.
+
 pub mod sovereign;

sugondat-shim/src/dock/sovereign.rs

@@ -4,19 +4,19 @@ use tracing::info;
 
 use crate::{key::Keypair, sugondat_rpc};
 
-pub struct SovereignAdapter {
+pub struct SovereignDock {
     client: sugondat_rpc::Client,
     submit_key: Option<Keypair>,
 }
 
-impl SovereignAdapter {
+impl SovereignDock {
     pub fn new(client: sugondat_rpc::Client, submit_key: Option<Keypair>) -> Self {
         Self { client, submit_key }
     }
 }
 
 #[async_trait::async_trait]
-impl SovereignRPCServer for SovereignAdapter {
+impl SovereignRPCServer for SovereignDock {
     async fn get_block(
         &self,
         height: u64,