fixes make commands & docs

Dockerfile

@@ -26,7 +26,7 @@ RUN mkdir -p /app \
 WORKDIR /app
 
 ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update && apt-get install -y curl clang git
+RUN apt-get update && apt-get install -y curl clang git pkg-config libssl-dev
 
 RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
 ENV PATH=/root/.cargo/bin:$PATH
@@ -45,15 +45,15 @@ ENV ROCKET_ENV "production"
 RUN apt-get update && apt-get install -y libssl-dev
 
 RUN mkdir -p /app/data \
-    && chown -R nobody:nogroup /app 
+    && chown -R nobody:nogroup /app
 
 WORKDIR /app
 
 # Copy binary from bitcoin-node-builder
 COPY --from=bitcoin-node-builder /app/node-runner /app/node-runner
 
 # Copy binary from rosetta-bitcoin-server
-COPY --from=rosetta-mentat-builder /app/* /app 
+COPY --from=rosetta-mentat-builder /app/* /app
 
 # Set permissions for everything added to /app
 RUN chmod -R 755 /app/*

Makefile

@@ -17,17 +17,20 @@ build-release:
 	docker build -t mentat-rosetta-bitcoin:$(version) .
 	docker save mentat-rosetta-bitcoin:$(version) | gzip > mentat-rosetta-bitcoin-$(version).tar.gz;
 
-run-mainnet-online:
-	docker run -d --rm --ulimit "nofile=${NOFILE}:${NOFILE}" -v "${PWD}/data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
+run:
+	docker run -d --rm --ulimit "nofile=${NOFILE}:${NOFILE}" -v "${PWD}/data:/data" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
 
-run-mainnet-offline:
-	docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
+# run-mainnet-online:
+# 	docker run -d --rm --ulimit "nofile=${NOFILE}:${NOFILE}" -v "${PWD}/data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
 
-run-testnet-online:
-	docker run -d --rm --ulimit "nofile=${NOFILE}:${NOFILE}" -v "${PWD}/data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
+# run-mainnet-offline:
+# 	docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
 
-run-testnet-offline:
-	docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
+# run-testnet-online:
+# 	docker run -d --rm --ulimit "nofile=${NOFILE}:${NOFILE}" -v "${PWD}/data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
+
+# run-testnet-offline:
+# 	docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
 
 tracing:
 	docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 -p14268:14268 jaegertracing/all-in-one:latest

README.md

@@ -12,17 +12,31 @@ make build-local
 
 #### Run Docker
 
-Running these commands will start a Docker container in [detached mode](https://docs.docker.com/engine/reference/run/#detached--d) with a data directory at `<working directory>/bitcoin-data` and the Rosetta API accessible at port `8080`.
+Running these commands will start a Docker container in [detached mode](https://docs.docker.com/engine/reference/run/#detached--d) with a data directory at `<working directory>/data` and the Rosetta API accessible at port `8080`.
 
 ##### Configuration
 
-the file [docker.conf.toml](docker.conf.toml) contains the settings that the docker image will use
+the file [docker.conf.toml](docker.conf.toml) contains the settings that the docker image will use. You can control if the node runs in `Online` or `Offline` mode, as well as if it runs on `Mainnet` or `Testnet`
 
 ##### Command Examples
 
 You can run these commands from the command line. If you cloned the repository, you can use the `make` commands shown after the examples.
 
-###### **Mainnet:Online**
+###### **Running a Container**
+
+Uncloned repo:
+
+```text
+docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/data:/data" -p 8080:8080 -p 4132:4132 mentat-rosetta-bitcoin:latest
+```
+
+Cloned repo:
+
+```text
+make run
+```
+
+<!-- ###### **Mainnet:Online**
 
 Uncloned repo:
 ```text
@@ -51,7 +65,7 @@ Uncloned repo:
 docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/bitcoin-data:/data" -p 8080:8080 -p 18333:18333 rosetta-bitcoin:latest
 ```
 
-Cloned repo: 
+Cloned repo:
 ```text
 make run-testnet-online
 ```
@@ -63,10 +77,10 @@ Uncloned repo:
 docker run -d --rm -p 8081:8081 rosetta-bitcoin:latest
 ```
 
-Cloned repo: 
+Cloned repo:
 ```text
 make run-testnet-offline
-```
+``` -->
 
 ### Example Requests
 

docker.conf.toml

@@ -2,7 +2,7 @@ address = '0.0.0.0'
 port = 8080
 mode = 'ONLINE'
 node_path = './node-runner'
-network = 'TESTNET'
+network = 'MAINNET'
 secure_http = false
 node_address = '0.0.0.0'
 node_rpc_port = 4032

dockerdev.conf.toml

@@ -2,7 +2,7 @@ address = '0.0.0.0'
 port = 8080
 mode = 'ONLINE'
 node_path = '/usr/bin/bitcoind'
-network = 'TESTNET'
+network = 'MAINNET'
 secure_http = false
 node_address = '0.0.0.0'
 node_rpc_port = 4032

src/node.rs

@@ -4,7 +4,7 @@ use std::{path::PathBuf, process::Command, str::FromStr};
 
 use mentat_server::{
     axum::async_trait,
-    conf::{Configuration, NodeConf},
+    conf::{Configuration, Network, NodeConf},
     reqwest::Url,
     serde::{Deserialize, Serialize},
 };
@@ -27,20 +27,24 @@ impl NodeConf for BitcoinConfig {
 
     fn node_command(config: &Configuration<Self>) -> Command {
         let mut command = Command::new(&config.node_path);
-        command.args(&[
+        let mut args = vec![
             // TODO cant bind to address without setting a whitelist
             // &format!("--bind={address}:4132"),
             // &format!("--rpcbind={address}:3032"),
-            "-port=4132",
+            "-port=4132".to_string(),
             // TODO `Config options rpcuser and rpcpassword will soon be deprecated.
             // Locally-run instances may remove rpcuser to use cookie-based auth, or may be
             // replaced with rpcauth. Please see share/rpcauth for rpcauth auth generation.`
-            &format!("-rpcport={}", config.node_rpc_port),
-            &format!("-rpcuser={}", config.custom.user),
-            &format!("-rpcpassword={}", config.custom.pass),
-            "-txindex=1",
-            &format!("--datadir={}", config.custom.data_dir.display()),
-        ]);
+            format!("-rpcport={}", config.node_rpc_port),
+            format!("-rpcuser={}", config.custom.user),
+            format!("-rpcpassword={}", config.custom.pass),
+            "-txindex=1".into(),
+            format!("--datadir={}", config.custom.data_dir.display()),
+        ];
+        if config.network == Network::Testnet {
+            args.push("--testnet".to_string())
+        }
+        command.args(&args);
         command
     }
 }