Update README.md with latest json schema (automated)

Reviewed-on: #15

Makefile

@@ -0,0 +1,10 @@
+
+BUILD="_build/default/lib/gmhive_client"
+SCHEMA_OUT=$(BUILD)/priv/gmhc_schema.json
+
+schema:
+	ERL_LIBS=_build/default/lib \
+	erl -run gmhc_config_schema export $(SCHEMA_OUT) -run init stop
+	scripts/update_readme_json.sh README.md $(SCHEMA_OUT)
+
+

README.md

@@ -155,6 +155,16 @@ server. (For `"testnet"` this will be `"test.gajumining.com"`.)
             "pattern": "^ak_[1-9A-HJ-NP-Za-km-z]*$",
             "type": "string"
         },
+        "report": {
+            "default": "silent",
+            "description": "Progress reporting",
+            "enum": [
+                "debug",
+                "progress",
+                "silent"
+            ],
+            "type": "string"
+        },
         "type": {
             "default": "worker",
             "description": "monitor mode can be used to see if a pool is alive",
@@ -174,7 +184,7 @@ server. (For `"testnet"` this will be `"test.gajumining.com"`.)
                 "properties": {
                     "executable": {
                         "default": "mean29-generic",
-                        "description": "Executable binary of the worker. Can be a fully qualified path, but the software may apply default logic to locate a plain basename.",
+                        "description": "Executable binary of the worker. Can be a fully qualified path, \nbut the software may apply default logic to locate a plain basename.",
                         "type": "string"
                     },
                     "extra_args": {

ebin/gmhive_client.app

@@ -1,6 +1,6 @@
 {application,gmhive_client,
              [{description,"Gajumaru Hive Client"},
-              {vsn,"0.4.8"},
+              {vsn,"0.6.3"},
               {registered,[]},
               {applications,[kernel,stdlib,sasl,gproc,inets,ssl,enoise,
                              gmconfig,gmhive_protocol,gmhive_worker]},

rebar.config

@@ -5,12 +5,14 @@
 {erl_opts, [debug_info]}.
 {plugins, [rebar3_hex]}.
 
+{post_hooks, [{compile, "make schema"}]}.
+
 {deps, [
         {enoise, {git, "https://git.qpq.swiss/QPQ-AG/enoise.git", {ref, "029292817e"}}},
         {gmhive_protocol,
          {git, "https://git.qpq.swiss/QPQ-AG/gmhive_protocol.git",
           {ref, "818ce33"}}},
-        {gmhive_worker, {git, "https://git.qpq.swiss/QPQ-AG/gmhive_worker", {ref, "fac460714f"}}},
+        {gmhive_worker, {git, "https://git.qpq.swiss/QPQ-AG/gmhive_worker", {ref, "cabd104114"}}},
         {gmconfig, {git, "https://git.qpq.swiss/QPQ-AG/gmconfig.git",
                     {ref, "38620ff9e2"}}},
         {gproc, "1.0.0"},

rebar.lock

@@ -21,7 +21,7 @@
   0},
  {<<"gmcuckoo">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmcuckoo.git",
-       {ref,"106e1cd2e4ff81286f6bc7d7c85f83bc20e14b82"}},
+       {ref,"256e14e7c88043132245be902ff9756070d285b4"}},
   1},
  {<<"gmhive_protocol">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmhive_protocol.git",
@@ -29,7 +29,7 @@
   0},
  {<<"gmhive_worker">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmhive_worker",
-       {ref,"fac460714fc228eb0b723a3f292a44aec77f094a"}},
+       {ref,"cabd104114691edb925aacd7e04d431d47bac420"}},
   0},
  {<<"gmserialization">>,
   {git,"https://git.qpq.swiss/QPQ-AG/gmserialization.git",

scripts/update_readme_json.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+README="$1"
+SCHEMA="$2"
+
+if [[ ! -f "$README" || ! -f "$SCHEMA" ]]; then
+  echo "Usage: $0 README.md schema.json"
+  exit 1
+fi
+
+tmpfile=$(mktemp)
+
+awk -v schema_file="$SCHEMA" '
+  BEGIN {
+    in_json_block = 0
+    in_schema_section = 0
+  }
+
+  /^##[[:space:]]+JSON[[:space:]]+Schema/ {
+    in_schema_section = 1
+    print
+    next
+  }
+
+  /^##[[:space:]]+/ && in_schema_section {
+    # Another section starts, end the schema section
+    in_schema_section = 0
+  }
+
+  in_schema_section && /^```json/ {
+    print "```json"
+    while ((getline line < schema_file) > 0) print line
+    close(schema_file)
+    in_json_block = 1
+    next
+  }
+
+  in_json_block && /^```$/ {
+    print "```"
+    in_json_block = 0
+    next
+  }
+
+  !(in_schema_section && in_json_block) {
+    print
+  }
+' "$README" > "$tmpfile"
+
+mv "$tmpfile" "$README"
+echo "✅ Updated JSON schema block in $README"

src/gmhc_app.erl

@@ -1,6 +1,6 @@
 %% -*- mode: erlang; erlang-indent-level: 4; indent-tabs-mode: nil -*-
 -module(gmhc_app).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -behaviour(application).
 
@@ -45,8 +45,31 @@ stop(_State) ->
     ok.
 
 set_things_up() ->
+    maybe_add_logger_handler(),
     gmhc_counters:initialize(),
     gmhc_config:load_config(),
     logger:set_module_level([gmhw_pow_cuckoo], notice),
     ?LOG_DEBUG("Config: ~p", [gmconfig:user_config()]),
+    case gmhc_config:get_config([<<"report">>]) of
+        <<"debug">> ->
+            ?LOG_NOTICE("Starting debug reporter", []),
+            gmhc_events:debug();
+        <<"progress">> ->
+            ?LOG_NOTICE("Starting progress reporter", []),
+            gmhc_events:progress();
+        _ -> ok
+    end,
     ok.
+
+maybe_add_logger_handler() ->
+    case is_headless() orelse application:get_env(gmhive_client, tty_logger, false) of
+        true ->
+            Level = application:get_env(gmhive_client, tty_logger_level, error),
+            io:fwrite("Adding logger handler: ~p~n", [Level]),
+            logger:add_handler(gmhc_tty, logger_std_h, #{level => Level});
+        false ->
+            ok
+    end.
+
+is_headless() ->
+    undefined == application:get_key(gajumine, vsn).

src/gmhc_config.erl

@@ -1,5 +1,5 @@
 -module(gmhc_config).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -export([ load_config/0
         , get_config/1
@@ -14,8 +14,20 @@ load_config() ->
     gmconfig:apply_os_env(),
     gmconfig:process_plain_args(),
     check_application_env(),
+    check_final_config(),
     ok.
 
+check_final_config() ->
+    ExtraPubkeys = get_config([<<"extra_pubkeys">>]),
+    AllKeys = [get_config([<<"pubkey">>]) | ExtraPubkeys],
+    case AllKeys -- lists:usort(AllKeys) of
+        [] ->
+            ok;
+        Duplicates ->
+            ?LOG_ERROR("Duplicate account ids found: ~p", [Duplicates]),
+            error({duplicate_account_ids, Duplicates})
+    end.
+
 instrument_gmconfig() ->
     gmconfig:set_gmconfig_env(gmconfig_env()).
 

src/gmhc_config_schema.erl

@@ -1,8 +1,9 @@
 -module(gmhc_config_schema).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -export([ schema/0
-        , to_json/0 ]).
+        , to_json/0
+        , export/1 ]).
 
 -import(gmconfig_schema_helpers,
         [ str/1
@@ -22,6 +23,17 @@
 to_json() ->
     json:encode(schema()).
 
+export(ToFile) ->
+    case file:open(ToFile, [write]) of
+        {ok, Fd} ->
+            try ok = io:put_chars(Fd, json:format(schema(), #{indent => 4}))
+            after
+                file:close(Fd)
+            end;
+        {error, _} = Error ->
+            Error
+    end.
+
 schema() ->
     obj(schema_init(),
         #{
@@ -39,6 +51,9 @@ schema() ->
          , pool => pool()
          , pool_admin => pool_admin()
          , workers => workers()
+         , report => str(#{ enum  => [<<"debug">>, <<"progress">>, <<"silent">>]
+                          , default => <<"silent">>
+                          , description => <<"Progress reporting">> })
          }).
 
 pool() ->

src/gmhc_connector.erl

@@ -1,5 +1,5 @@
 -module(gmhc_connector).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -behaviour(gen_server).
 

src/gmhc_connectors_sup.erl

@@ -1,5 +1,5 @@
 -module(gmhc_connectors_sup).
--vsn("0.4.8").
+-vsn("0.6.1").
 -behavior(supervisor).
 
 -export([ start_link/0

src/gmhc_counters.erl

@@ -1,5 +1,5 @@
 -module(gmhc_counters).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -export([ initialize/0 ]).
 

src/gmhc_eureka.erl

@@ -1,5 +1,5 @@
 -module(gmhc_eureka).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -export([get_pool_address/0]).
 

src/gmhc_events.erl

@@ -1,5 +1,5 @@
 -module(gmhc_events).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -export([subscribe/1,
          ensure_subscribed/1,
@@ -7,7 +7,17 @@
          ensure_unsubscribed/1,
          publish/2]).
 
--export([debug/0]).
+-export([debug/0,
+         progress/0,
+         stop/0]).
+
+-export([rpt_debug/2,
+         rpt_progress/2]).
+
+%% internal
+-export([init_reporter/2]).
+
+-include_lib("kernel/include/logger.hrl").
 
 -export_type([event/0]).
 
@@ -60,22 +70,100 @@ ensure_unsubscribed(Event) ->
 
 debug() ->
     ok = application:ensure_started(gproc),
-    spawn(fun() ->
+    spawn_reporter(fun() ->
-                  subscribe(pool_notification),
+                           sub(),
-                  subscribe({pool_notification, new_generation}),
+                           gmhive_worker:subscribe_returns(),
-                  subscribe(connected),
+                           loop(fun rpt_debug/2, false)
-                  subscribe(puzzle),
+                   end).
-                  subscribe(result),
-                  subscribe(error),
-                  subscribe(disconnected),
-                  loop()
-          end).
 
-loop() ->
+progress() ->
+    ok = application:ensure_started(gproc),
+    spawn_reporter(fun() ->
+                           sub(),
+                           loop(fun rpt_progress/2, true)
+                   end).
+
+spawn_reporter(F) ->
+    Parent = self(),
+    proc_lib:start_link(?MODULE, init_reporter, [F, Parent]).
+
+init_reporter(F, Parent) ->
+    try_register_reporter(),
+    proc_lib:init_ack(Parent, self()),
+    F().
+
+stop() ->
+    case whereis(gmhc_reporter) of
+        undefined ->
+            not_running;
+        Pid ->
+            exit(Pid, kill)
+    end.
+
+sub() ->
+    subscribe(pool_notification),
+    subscribe({pool_notification, new_generation}),
+    subscribe(connected),
+    subscribe(puzzle),
+    subscribe(result),
+    subscribe(error),
+    subscribe(disconnected).
+
+loop(F, Ts) ->
     receive
         stop -> ok;
         {gproc_ps_event, E, Data} ->
-            io:fwrite("EVENT ~p: ~p~n", [E, Data]),
+            maybe_print(F(E, Data), Ts),
-            loop()
+            loop(F, Ts)
     end.
 
+try_register_reporter() ->
+    try register(gmhc_reporter, self())
+    catch
+        error:_ ->
+            ?LOG_ERROR("Reporter already running. Try gmhc_events:stop().", []),
+            error(already_running)
+    end.
+
+maybe_print([], _) ->
+    ok;
+maybe_print(String, Ts) when is_boolean(Ts) ->
+    TSstr = [[ts(), " "] || Ts],
+    io:put_chars([TSstr, String, "\n"]).
+
+ts() ->
+    calendar:system_time_to_rfc3339(erlang:system_time(millisecond),
+                                    [{unit, millisecond}, {offset, "Z"}]).
+
+rpt_debug(E, Data) ->
+    io_lib:fwrite("EVENT ~p: ~p", [E, Data]).
+
+rpt_progress(puzzle, #{info := {_Data, _Target, Nonce, _Config}}) ->
+    w("Trying nonce: ~p", [Nonce]);
+rpt_progress(result, #{info := Info}) ->
+    case Info of
+        {error, no_solution} ->
+            [];
+        {ok, Cycles} ->
+            w("Found! Reporting ~w cycles to leader.", [length(Cycles)]);
+        Other ->
+            w("Unexpected 'result': ~tp", [Other])
+    end;
+rpt_progress(pool_notification, #{info := #{msg := Msg}}) ->
+    case Msg of
+        #{solution_accepted := #{seq := Seq}} ->
+            w("The hive has produced a solution! Sequence: ~w", [Seq]);
+        #{new_generation := _} -> [];
+        #{candidate := _}      -> [];
+        Other ->
+            w("Unexpected 'pool_notification': ~tp", [Other])
+    end;
+rpt_progress(connected, _) ->
+    w("Connected!", []);
+rpt_progress(disconnected, _) ->
+    w("Disconnected!", []);
+rpt_progress(_, _) ->
+    [].
+
+w(Fmt, Args) ->
+    io_lib:fwrite(Fmt, Args).

src/gmhc_handler.erl

@@ -1,5 +1,5 @@
 -module(gmhc_handler).
--vsn("0.4.8").
+-vsn("0.6.1").
 -behavior(gen_server).
 
 -export([ start_link/0
@@ -12,6 +12,7 @@
         ]).
 
 -export([ call/1
+        , async_call/1
         , notify/1
         , pool_connected/2
         , from_pool/1 ]).
@@ -38,6 +39,13 @@ call(Req) ->
             {error, Reason}
     end.
 
+async_call(Req) ->
+    try gen_server:call(?MODULE, {async_call, Req}, ?CALL_TIMEOUT)
+    catch
+        exit:Reason ->
+            {error, Reason}
+    end.
+
 notify(Msg) ->
     gen_server:cast(?MODULE, {notify, Msg}).
 
@@ -56,6 +64,8 @@ init([]) ->
 
 handle_call({call, Req}, _From, #st{} = S) ->
     {reply, call_connector(Req), S};
+handle_call({async_call, Req}, _From, #st{} = S) ->
+    {reply, call_connector(Req, false), S};
 handle_call(_Req, _From, S) ->
     {reply, {error, unknown_method}, S}.
 
@@ -119,27 +129,39 @@ maybe_publish(_) ->
 maybe_via(#{via := Via}, Info) ->
     Info#{via => Via}.
 
-call_connector(Req0) ->
+call_connector(Req) ->
+    call_connector(Req, true).
+
+call_connector(Req0, Wait) ->
     {ViaId, Req} = maps:take(via, Req0),
     case gmhc_connector:whereis_id(ViaId) of
         undefined ->
             {error, no_connection};
         Pid when is_pid(Pid) ->
             Id = erlang:unique_integer(),
-            MRef = erlang:monitor(process, Pid),
+            MRef = case Wait of
+                       true  -> erlang:monitor(process, Pid);
+                       false -> none
+                   end,
             gmhc_connector:send(ViaId, #{call => Req#{ id => Id }}),
-            receive
+            case Wait of
-                {from_pool, #{reply := #{ id := Id, result := Result }}} ->
+                true ->
-                    erlang:demonitor(MRef),
+                    receive
-                    Result;
+                        {from_pool, #{reply := #{ id := Id
-                {from_pool, #{error := #{ id := Id } = Error}} ->
+                                                , result := Result }}} ->
-                    erlang:demonitor(MRef),
+                            erlang:demonitor(MRef),
-                    {error, maps:remove(id, Error)};
+                            Result;
-                {'DOWN', MRef, _, _, _} ->
+                        {from_pool, #{error := #{ id := Id } = Error}} ->
-                    {error, no_connection}
+                            erlang:demonitor(MRef),
-            after 5000 ->
+                            {error, maps:remove(id, Error)};
-                    erlang:demonitor(MRef),
+                        {'DOWN', MRef, _, _, _} ->
-                    {error, {timeout, process_info(self(), messages)}}
+                            {error, no_connection}
+                    after 5000 ->
+                            erlang:demonitor(MRef),
+                            {error, {timeout, process_info(self(), messages)}}
+                    end;
+                false ->
+                    ok
             end
     end.
 

src/gmhc_server.erl

@@ -1,5 +1,5 @@
 -module(gmhc_server).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -behaviour(gen_server).
 
@@ -184,6 +184,9 @@ code_change(_FromVsn, S, _Extra) ->
 
 report_solutions(Solutions, W, #st{} = S) when ?CONNECTED(S) ->
     #{via := Via, seq := Seq} = W#worker.cand,
+    Nonces = all_nonces(W),
+    [report_no_solution_(Via, Seq, N)
+     || N <- Nonces, not lists:keymember(N, 1, Solutions)],
     gmhc_handler:call(
       #{via => Via,
         solutions => #{ seq => Seq
@@ -191,18 +194,23 @@ report_solutions(Solutions, W, #st{} = S) when ?CONNECTED(S) ->
                                    , evidence => Evd }
                                   || {Nonce, Evd} <- Solutions] }}).
 
-%% report_solution(Nonce, Solution, W, #st{connected = true}) ->
+report_no_solution(_Nonce, W, #st{} = S) when ?CONNECTED(S) ->
-%%     #{seq := Seq} = W#worker.cand,
-%%     gmhc_handler:call(#{solution => #{ seq => Seq
-%%                                       , nonce => Nonce
-%%                                       , evidence => Solution }}).
-
-report_no_solution(Nonce, W, #st{} = S) when ?CONNECTED(S) ->
     #{via := Via, seq := Seq} = W#worker.cand,
+    Nonces = all_nonces(W),
     %% ?LOG_DEBUG("report no_solution Seq = ~p, Nonce = ~p", [Seq, Nonce]),
-    gmhc_handler:call(#{via => Via,
+    [report_no_solution_(Via, Seq, Nonce1) || Nonce1 <- Nonces],
-                         no_solution => #{ seq => Seq
+    ok.
-                                         , nonce => Nonce}}).
+
+report_no_solution_(Via, Seq, Nonce) ->
+    gmhc_handler:async_call(#{via => Via,
+                              no_solution => #{ seq => Seq
+                                              , nonce => Nonce}}).
+
+all_nonces(#worker{nonce = Nonce, config = Config}) ->
+    case gmhw_pow_cuckoo:repeats(Config) of
+        1  -> [Nonce];
+        Rs -> lists:seq(Nonce, Nonce + Rs - 1)
+    end.
 
 maybe_request_nonces(#st{ candidate = #{via := Via, seq := Seq, nonces := Nonces}
                         , nonces = N} = S) when ?CONNECTED(S) ->

src/gmhc_sup.erl

@@ -1,6 +1,6 @@
 %% -*- mode: erlang; erlang-indent-level: 4; indent-tabs-mode: nil -*-
 -module(gmhc_sup).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -behaviour(supervisor).
 

src/gmhc_workers.erl

@@ -8,7 +8,7 @@
 %%%-------------------------------------------------------------------
 
 -module(gmhc_workers).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -export([
           get_worker_configs/0

src/gmhive_client.app.src

@@ -1,7 +1,7 @@
 %% -*- mode: erlang; erlang-indent-level: 4; indent-tabs-mode: nil -*-
 {application, gmhive_client,
  [{description, "Gajumaru Hive Client"},
-  {vsn, "0.1.0"},
+  {vsn, "zomp"},
   {registered, []},
   {applications,
    [

src/gmhive_client.app.src.script

@@ -0,0 +1,14 @@
+%% -*- erlang-mode; erlang-indent-level: 4; indent-tabs-mode: nil -*-
+
+[{application, Name, Opts}] = CONFIG.
+case lists:keyfind(vsn, 1, Opts) of
+    {vsn, "zomp"} ->
+        ZompMetaF = filename:join(filename:dirname(filename:dirname(SCRIPT)), "zomp.meta"),
+        {ok, ZMeta} = file:consult(ZompMetaF),
+        {_, {_, _, {Vmaj,Vmin,Vpatch}}} = lists:keyfind(package_id, 1, ZMeta),
+        VsnStr = unicode:characters_to_list(io_lib:fwrite("~w.~w.~w", [Vmaj, Vmin, Vpatch])),
+        Opts1 = lists:keyreplace(vsn, 1, Opts, {vsn, VsnStr}),
+        [{application, Name, Opts1}];
+    _ ->
+        CONFIG
+end.

src/gmhive_client.erl

@@ -1,5 +1,5 @@
 -module(gmhive_client).
--vsn("0.4.8").
+-vsn("0.6.1").
 
 -export([ connect/1
         , disconnect/1

zomp.meta

@@ -2,11 +2,11 @@
 {type,app}.
 {modules,[]}.
 {prefix,"gmhc"}.
-{author,"Ulf Wiger, QPQ AG"}.
 {desc,"Gajumaru Hive Client"}.
-{package_id,{"uwiger","gmhive_client",{0,4,8}}}.
+{author,"Ulf Wiger, QPQ AG"}.
-{deps,[{"uwiger","gmhive_worker",{0,4,0}},
+{package_id,{"uwiger","gmhive_client",{0,6,3}}}.
-       {"uwiger","gmcuckoo",{1,2,3}},
+{deps,[{"uwiger","gmhive_worker",{0,5,1}},
+       {"uwiger","gmcuckoo",{1,2,4}},
        {"otpr","eblake2",{1,0,1}},
        {"otpr","base58",{0,1,1}},
        {"otpr","gmserialization",{0,1,3}},

zompify.sh

@@ -38,5 +38,12 @@ rm "$IGNORE_TEMP"
 cp "$PWD/zomp.meta" "$DST/"
 cp "$PWD/Emakefile" "$DST/"
 
+# copy generated schema
+SCHEMA="$SRC/priv/gmhc_schema.json"
+if [ -e "$SCHEMA" ]; then
+    mkdir -p "$DST/priv"
+    cp -a "$SCHEMA" "$DST/priv/$(basename "$SCHEMA")"
+fi
+
 # Clean up beam files just in case
 [ -d "$DST/ebin" ] && find "$DST/ebin" -name '*.beam' -exec rm -f {} + || true