diff --git a/hook/generate_extern.sh b/hook/generate_extern.sh index 468b9aab6..b70be2d09 100755 --- a/hook/generate_extern.sh +++ b/hook/generate_extern.sh @@ -41,6 +41,21 @@ APPLY_HOOK="$SCRIPT_DIR/../include/xrpl/hook/hook_api.macro" # Insert __attribute__((noduplicate)) before _g sub(/[[:space:]]+_g/, " __attribute__((noduplicate)) _g", line); } + + if (line ~ /[[:space:]]+dice[[:space:]]*\(/) { + print "/*"; + print " Consensus entropy APIs."; + print ""; + print " min_tier is a fail-closed floor:"; + print " 1 = consensus_fallback, 2 = participant_aligned, 3 = validator_quorum."; + print " min_count is the minimum validator/reveal count the caller accepts."; + print ""; + print " If the most recent finalized entropy object does not satisfy both floors,"; + print " these APIs return TOO_LITTLE_ENTROPY. Open-ledger and simulate execution"; + print " are provisional previews over the entropy currently visible to the node;"; + print " final ordered ledger execution may see a different entropy object."; + print "*/"; + } # printf("\n");