Merge branch 'gen_example_conf'

Author: luke-jr

.gitignore

@@ -9,6 +9,7 @@ datum_gateway
 
 *.conf
 *.json
+!doc/example_datum_gateway_config.json
 .DS_Store
 *.orig
 *.rej

CMakeLists.txt

@@ -2,6 +2,9 @@ cmake_minimum_required(VERSION 3.21)
 
 project(DATUM VERSION 0.2 LANGUAGES C)
 set(CMAKE_C_STANDARD 23)
+
+include(GNUInstallDirs)
+
 add_executable(datum_gateway
 	src/datum_api.c
 	src/datum_blocktemplates.c
@@ -100,3 +103,18 @@ target_compile_options(datum_gateway
 	${JANSSON_CFLAGS} ${JANSSON_CFLAGS_OTHER}
 	${SODIUM_CFLAGS} ${SODIUM_CFLAGS_OTHER}
 )
+
+set(PREGEN_DOC ${CMAKE_SOURCE_DIR}/doc/example_datum_gateway_config.json)
+install(FILES ${PREGEN_DOC} DESTINATION ${CMAKE_INSTALL_DOCDIR})
+
+if(NOT CMAKE_CROSSCOMPILING)
+	set(GENERATED_DOC ${CMAKE_BINARY_DIR}/CMakeFiles/generated_example_datum_gateway_config.json)
+	
+	add_custom_command(
+		TARGET datum_gateway
+		POST_BUILD
+		COMMAND ${CMAKE_COMMAND} -DDATUM_GATEWAY=$<TARGET_FILE:datum_gateway> -DGENERATED_DOC=${GENERATED_DOC} -DPREGEN_DOC=${PREGEN_DOC} -P ${PROJECT_SOURCE_DIR}/cmake/script/VerifyExample.cmake
+		COMMENT "Verifying pre-generated documentation is up-to-date"
+		VERBATIM
+	)
+endif()

cmake/script/VerifyExample.cmake

@@ -0,0 +1,15 @@
+execute_process(
+	COMMAND ${DATUM_GATEWAY} --example-conf
+	OUTPUT_VARIABLE CURRENT_EXAMPLE
+	RESULT_VARIABLE _result
+)
+if (_result)
+	message(FATAL_ERROR "${DATUM_GATEWAY} exited with code ${_result}")
+endif()
+file(WRITE ${GENERATED_DOC} ${CURRENT_EXAMPLE})
+file(READ ${PREGEN_DOC} PREGEN_EXAMPLE)
+# string(STRIP ${PREGEN_EXAMPLE} PREGEN_EXAMPLE)
+# string(STRIP ${CURRENT_EXAMPLE} CURRENT_EXAMPLE)
+if(NOT "${CURRENT_EXAMPLE}" STREQUAL "${PREGEN_EXAMPLE}")
+	message(FATAL_ERROR "${PREGEN_DOC} is outdated. Update it with ${GENERATED_DOC}")
+endif()

doc/example_datum_gateway_config.json

@@ -0,0 +1,34 @@
+{
+	"bitcoind": {
+		"rpcuser": "datum",
+		"rpcpassword": "something only you know",
+		"rpcurl": "http://localhost:8332",
+		"notify_fallback": true
+	},
+	"stratum": {
+		"listen_port": 23334
+	},
+	"mining": {
+		"pool_address": "put your own Bitcoin invoice address here",
+		"coinbase_tag_primary": "DATUM Gateway",
+		"coinbase_tag_secondary": "DATUM User"
+	},
+	"api": {
+		"admin_password": "",
+		"listen_port": 7152,
+		"modify_conf": false
+	},
+	"logger": {
+		"log_to_console": true,
+		"log_to_file": false,
+		"log_file": "/var/log/datum.log",
+		"log_rotate_daily": true,
+		"log_level_console": 2,
+		"log_level_file": 1
+	},
+	"datum": {
+		"pool_pass_workers": true,
+		"pool_pass_full_users": true,
+		"pooled_mining_only": true
+	}
+}

src/datum_conf.c

@@ -45,18 +45,20 @@
 
 #include <jansson.h>
 
-#define DATUM_CONF_BOOL 1
-#define DATUM_CONF_INT 2
-#define DATUM_CONF_STRING 3
-#define DATUM_CONF_STRING_ARRAY 4
-
-#define DATUM_CONF_TYPES 5
+enum datum_conf_vartype {
+	DATUM_CONF_BOOL,
+	DATUM_CONF_INT,
+	DATUM_CONF_STRING,
+	DATUM_CONF_STRING_ARRAY,
+};
 
 typedef struct {
 	char category[32];
 	char name[64];
 	char description[512];
-	int var_type;
+	const char *example;
+	bool example_default;
+	enum datum_conf_vartype var_type;
 	union {
 		int default_int;
 		bool default_bool;
@@ -146,6 +148,7 @@ typedef struct {
 extern global_config_t datum_config;
 
 int datum_read_config(const char *conffile);
-void datum_gateway_help(void);
+void datum_gateway_help(const char *argv0);
+void datum_gateway_example_conf(void);
 
 #endif

src/datum_conf.h

@@ -70,6 +70,7 @@ static char doc[] = "Decentralized Alternative Templates for Universal Mining -
 static char args_doc[] = "";
 static struct argp_option options[] = {
 	{"help", '?', 0, 0, "Show custom help", 0},
+	{"example-conf", 0x100, NULL, 0, "Print an example configuration JSON file", 0},
 	{"usage", '?', 0, 0, "Show custom help", 0},
 	{"config", 'c', "FILE", 0, "Configuration JSON file"},
 	{0}
@@ -83,14 +84,19 @@ static error_t parse_opt(int key, char *arg, struct argp_state *state) {
 	struct arguments *arguments = state->input;
 	switch (key) {
 		case '?': {
-			datum_gateway_help();
+			datum_print_banner();
+			datum_gateway_help(state->argv[0]);
 			exit(0);
 			break;
 		}
 		case 'c': {
 			arguments->config_file = arg;
 			break;
 		}
+		case 0x100:  // example-conf
+			datum_gateway_example_conf();
+			exit(0);
+			break;
 		default:
 			return ARGP_ERR_UNKNOWN;
 	}
@@ -100,6 +106,14 @@ static error_t parse_opt(int key, char *arg, struct argp_state *state) {
 static struct argp argp = {options, parse_opt, args_doc, doc};
 // END ARGP Stuff
 
+void datum_print_banner(void) {
+	printf("\n **************************************************************************\n");
+	printf(" * DATUM Gateway --- Copyright (c) 2024 Bitcoin Ocean, LLC & Jason Hughes *\n");
+	printf(" * git commit: %-58s *\n", GIT_COMMIT_HASH);
+	printf(" **************************************************************************\n\n");
+	fflush(stdout);
+}
+
 void handle_sigusr1(int sig) {
 	datum_blocktemplates_notifynew(NULL, 0);
 }
@@ -119,19 +133,14 @@ int main(const int argc, const char * const * const argv) {
 	bool rejecting_stratum = false;
 	uint32_t next_reconnect_attempt_ms = 5000;
 
-	printf("\n **************************************************************************\n");
-	printf(" * DATUM Gateway --- Copyright (c) 2024 Bitcoin Ocean, LLC & Jason Hughes *\n");
-	printf(" * git commit: %-58s *\n", GIT_COMMIT_HASH);
-	printf(" **************************************************************************\n\n");
-	fflush(stdout);
-	
 	// listen for block notifications
 	// set this up early so a notification doesn't break our init
 	sa.sa_handler = handle_sigusr1;
 	sa.sa_flags = 0;
 	sigemptyset(&sa.sa_mask);
 
 	if (sigaction(SIGUSR1, &sa, NULL) == -1) {
+		datum_print_banner();
 		DLOG_FATAL("Could not setup signal handler!");
 		perror("sigaction");
 		usleep(100000);
@@ -148,9 +157,11 @@ int main(const int argc, const char * const * const argv) {
 
 	arguments.config_file = "datum_gateway_config.json";  // Default config file
 	if (argp_parse(&argp, argc, datum_deepcopy_charpp(argv), 0, 0, &arguments) != 0) {
+		datum_print_banner();
 		DLOG_FATAL("Error parsing arguments. Check --help");
 		exit(1);
 	}
+	datum_print_banner();
 
 	if (datum_read_config(arguments.config_file) != 1) {
 		DLOG_FATAL("Error reading config file. Check --help");

src/datum_gateway.c

@@ -55,6 +55,8 @@
 
 #define STRATUM_JOB_INDEX_XOR ((uint16_t)0xC0DE)
 
+void datum_print_banner(void);
+
 extern const char *datum_gateway_config_filename;
 
 extern const char * const *datum_argv;