Replace pool_pass_full_users/pool_pass_workers with pool_username_behaviour and add "strip_worker" option by luke-jr · Pull Request #180 · OCEAN-xyz/datum_gateway

luke-jr · 2026-04-04T20:55:47Z

No description provided.

Copilot

Pull request overview

This PR introduces a new datum.pool_username_behaviour configuration option (including a new strip_worker mode) and refactors username submission logic to centralize handling and add tests.

Changes:

Add strip_worker behaviour and expose it in the web configurator and docs.
Refactor POW submission username formatting into a shared helper with new protocol tests.
Extend config parsing/help to support function-based config items (DATUM_CONF_FUNC) and migrate toward pool_username_behaviour.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
www/config.html	Adds `strip_worker` option to “Send Miner Usernames To Pool” UI
src/datum_protocol.c	Refactors username formatting into `datum_protocol_submit_username` and uses it in POW submit
src/datum_protocol_tests.c	Adds unit tests for username formatting behaviours
src/datum_gateway.c	Hooks protocol tests into `--test`
src/datum_conf.h	Adds `DATUM_CONF_FUNC` and function-pointer support in config item struct
src/datum_conf.c	Adds `pool_username_behaviour` config parsing and deprecation handling
src/datum_api.c	Updates configurator variable fill + config-set logic for new behaviours
doc/usernames.md	Documents `pool_username_behaviour` and new `strip_worker` mode
doc/example_datum_gateway_config.json	Updates example config to use `pool_username_behaviour`
CMakeLists.txt	Adds `src/datum_protocol_tests.c` to build

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-04T21:01:38Z

+	i += datum_protocol_submit_username(username, 385, &datum_config, pow->username);
 	i++;  // already 0 from snprintf


datum_protocol_submit_username returns snprintf's would-have-been-written length, but the caller uses it to advance i into msg. If the formatted username is truncated (buffer is 385 bytes, but mining_pool_address + '.' + username can exceed that), i will advance past the actual written bytes and subsequent writes will go out of bounds / corrupt the message. Clamp the returned length to the actual bytes written (<= username_sz-1) or have datum_protocol_submit_username return the clamped length.

Suggested change

i += datum_protocol_submit_username(username, 385, &datum_config, pow->username);

i++; // already 0 from snprintf

datum_protocol_submit_username(username, 385, &datum_config, pow->username);

i += strnlen(username, 385);

i++; // skip the terminating NUL written by snprintf

Existing bug; addressing in #181

Without this, only 384 bytes get written for the username, but extra space is included in the message before the rest of the data

…ntf errors

…otocol_submit_username

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

… with datum.pool_pass_full_users=true

…trip worker names

…me_behaviour and add "strip_worker" option Backward compatibility included

luke-jr · 2026-04-07T02:41:24Z

Rebased on #181

…"strip_worker"

Copilot

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-07T14:22:09Z

+	cat = json_object_get(config, "datum");
+	if (json_is_object(cat)) {
+		item = json_object_get(cat, "pool_pass_full_users");
+		if (item && (!json_is_false(item)) ? !(datum_config.datum_pool_pass_full_users && datum_config.datum_pool_pass_workers) : datum_config.datum_pool_pass_full_users) {


The conditional intended to warn only when the deprecated key datum.pool_pass_full_users is present appears to have ?: precedence issues: when the key is missing (item == NULL), the expression evaluates to datum_config.datum_pool_pass_full_users and can emit a deprecation warning even though the deprecated option wasn’t configured. Wrap the ternary in parentheses (or restructure) so the warning is gated by item being non-NULL.

Suggested change

if (item && (!json_is_false(item)) ? !(datum_config.datum_pool_pass_full_users && datum_config.datum_pool_pass_workers) : datum_config.datum_pool_pass_full_users) {

if (item && (((!json_is_false(item)) ? !(datum_config.datum_pool_pass_full_users && datum_config.datum_pool_pass_workers) : datum_config.datum_pool_pass_full_users))) {

Copilot · 2026-04-07T14:22:10Z

+	if (json_is_string(j)) {
+		const char * const s = json_string_value(j);
+		switch (json_string_length(j)) {
+			case 4:
+				if (0 == strcasecmp("pass", s)) break;
+				return -1;
+			case 6:
+				if (0 == strcasecmp("worker", s)) {


datum_conf_username_behaviour uses strcasecmp, but this file doesn’t include <strings.h> (POSIX), which can cause build failures (especially with C23 where implicit declarations are not allowed). Add the proper include (or avoid strcasecmp).

Copilot · 2026-04-07T14:22:10Z

+				if (!datum_config.datum_pool_pass_full_users) {
+					datum_api_json_modify_new("datum", "pool_pass_workers", json_boolean(datum_config.datum_pool_pass_workers));
+				}


When writing legacy keys for backward compatibility, the passthrough path updates pool_pass_full_users but may leave an existing pool_pass_workers key set to false (e.g. after switching from "private"). That makes the persisted config internally inconsistent and triggers the new startup deprecation warnings/UI state mismatches. Ensure pool_pass_workers is also set to true (or delete it) when pool_pass_full_users is true and you choose to keep legacy keys.

Suggested change

if (!datum_config.datum_pool_pass_full_users) {

datum_api_json_modify_new("datum", "pool_pass_workers", json_boolean(datum_config.datum_pool_pass_workers));

}

datum_api_json_modify_new("datum", "pool_pass_workers", json_boolean(datum_config.datum_pool_pass_workers));

Copilot · 2026-04-07T14:22:10Z

 There are three different ways to pass usernames to your pool.

 By default, the Stratum username is always passed in full, as-is.
-You can make this explicit by setting `datum`.`pool_pass_full_users` to `true` in the config file, or "Send Miner Usernames To Pool: Override Bitcoin Address" in the web configurator.
+You can make this explicit by setting `datum`.`pool_username_behaviour` to `"passthrough"` in the config file, or "Send Miner Usernames To Pool: Override Bitcoin Address" in the web configurator.

-If you change `datum`.`pool_pass_full_users` to `false`, you can then set `datum`.`pool_pass_workers` instead (or "Send Miner Usernames To Pool: Send as worker names" in the web configurator).
+You can also set `datum`.`pool_username_behaviour` to `"worker"` (or "Send Miner Usernames To Pool: Send as worker names" in the web configurator).


The doc still says there are “three different ways” to pass usernames, but this PR adds a fourth (strip_worker). Update that sentence/count to match the newly documented behaviors.

luke-jr added this to the v0.5.0 milestone Apr 4, 2026

luke-jr requested review from Copilot and wizkid057 April 4, 2026 20:55

luke-jr added enhancement New feature or request refactor Reorganizing code labels Apr 4, 2026

Copilot started reviewing on behalf of luke-jr April 4, 2026 20:56 View session

Copilot AI reviewed Apr 4, 2026

View reviewed changes

Bugfix: protocol: Enforce username length limit seeking into message

9463f72

Without this, only 384 bytes get written for the username, but extra space is included in the message before the rest of the data

luke-jr force-pushed the full_users_without_workers branch from 7b97492 to b772e10 Compare April 5, 2026 03:29

Bugfix: protocol: Check for and handle (to the extent possible) snpri…

4c85eeb

…ntf errors

luke-jr force-pushed the full_users_without_workers branch from b772e10 to 89b8142 Compare April 5, 2026 03:34

protocol: Remove redunant condition from final else block in datum_pr…

bb9b25a

…otocol_submit_username

luke-jr requested a review from Copilot April 5, 2026 03:48

Copilot started reviewing on behalf of luke-jr April 5, 2026 03:49 View session

Copilot AI reviewed Apr 5, 2026

View reviewed changes

Comment thread src/datum_api.c Outdated

luke-jr added 9 commits April 6, 2026 15:09

protocol: Define and use DATUM_PROTOCOL_MAX_USERNAME_LEN

d613935

Merge branch 'fix_username_overflow' into full_users_without_workers

3148e7e

protocol: Split datum_protocol_submit_username out of datum_protocol_pow

da7b267

Add unit tests for datum_protocol_submit_username

deab68d

conf: Add support for function calls for config items

d7ada48

conf: Add support for hidden/deprecated config items

1405f3f

conf: Warn (and ensure) that datum.pool_pass_workers=false is ignored…

cd4248c

… with datum.pool_pass_full_users=true

protocol: Treat pass_full_users && !pass_workers as instructions to s…

aea7417

…trip worker names

conf: Replace pool_pass_full_users/pool_pass_workers with pool_userna…

ddfdbf5

…me_behaviour and add "strip_worker" option Backward compatibility included

luke-jr force-pushed the full_users_without_workers branch from 89b8142 to 9cd58f5 Compare April 7, 2026 02:40

luke-jr added 3 commits April 7, 2026 02:43

api: Update for datum.pool_username_behaviour config

b9627b8

doc/usernames: Update for new datum.pool_username_behaviour config

aa2bd4b

protocol_tests: Add unit tests for datum_protocol_submit_username w/ …

1e33e50

…"strip_worker"

luke-jr force-pushed the full_users_without_workers branch from 9cd58f5 to 1e33e50 Compare April 7, 2026 02:43

luke-jr requested a review from Copilot April 7, 2026 14:15

Copilot started reviewing on behalf of luke-jr April 7, 2026 14:15 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

		i += datum_protocol_submit_username(username, 385, &datum_config, pow->username);
		i++; // already 0 from snprintf

	if (item && (!json_is_false(item)) ? !(datum_config.datum_pool_pass_full_users && datum_config.datum_pool_pass_workers) : datum_config.datum_pool_pass_full_users) {
	if (item && (((!json_is_false(item)) ? !(datum_config.datum_pool_pass_full_users && datum_config.datum_pool_pass_workers) : datum_config.datum_pool_pass_full_users))) {

Conversation

luke-jr commented Apr 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

luke-jr Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

luke-jr commented Apr 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants