Skip to content

docs(rpc): introduce GetJsonHelp() to complement ToJson() for Dash-specific objects to aid generating RPC help text #6872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PastaPastaPasta merged 10 commits into from
Oct 8, 2025
Merged

docs(rpc): introduce GetJsonHelp() to complement ToJson() for Dash-specific objects to aid generating RPC help text #6872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a9218b1
rpc: introduce `GetJsonHelp()` to provide help text for Dash RPC objects
kwvg Oct 6, 2025
9de8c9c
trivial: add missing headers
kwvg Oct 4, 2025
7219a29
rpc: `GetJsonHelp()` defs for `CbTx`, `SimplifiedMNList`, final commitm.
kwvg Oct 6, 2025
73da03e
refactor: move LLMQ-specific `ToJson()` definitions to separate file
kwvg Oct 4, 2025
ddc698b
refactor: move pending `evo/`-specific definitions to `core_write.cpp`
kwvg Oct 5, 2025
ae4e05c
rpc: `GetJsonHelp()` defs for `MNHFTx`, `CAsset{Un,}lock`
kwvg Oct 6, 2025
1be2226
rpc: `GetJsonHelp()` defs for `Quorum{Rotation,Snapshot}`,`RecoveredSig`
kwvg Oct 6, 2025
b7eb196
rpc: `GetJsonHelp()` defs for `DeterministicMN{,State{,{Diff}}}`
kwvg Oct 6, 2025
f01930b
chore: remove redundant `[[nodiscard]]` attributions in source file
kwvg Oct 5, 2025
56514c7
chore: move RpcResult map outside `GetRpcResult()`
kwvg Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,7 @@ libbitcoin_common_a_SOURCES = \
init/common.cpp \
key.cpp \
key_io.cpp \
llmq/core_write.cpp \
merkleblock.cpp \
net_types.cpp \
netaddress.cpp \
Expand Down
14 changes: 9 additions & 5 deletions src/core_io.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
#ifndef BITCOIN_CORE_IO_H
#define BITCOIN_CORE_IO_H

#include <consensus/amount.h>
#include <attributes.h>
#include <consensus/amount.h>

#include <string>
#include <vector>
Expand All @@ -15,12 +15,13 @@ class CBlock;
class CBlockHeader;
class CScript;
class CTransaction;
struct CMutableTransaction;
class uint256;
class UniValue;
class CTxUndo;

class uint256;
struct CMutableTransaction;
struct CSpentIndexTxInfo;
struct RPCResult;

Copy link
Collaborator

@knst knst Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: no \n here is needed

class UniValue;

/**
* Verbose level for block's transaction
Expand Down Expand Up @@ -57,4 +58,7 @@ std::string SighashToStr(unsigned char sighash_type);
void ScriptToUniv(const CScript& script, UniValue& out, bool include_hex = true, bool include_address = false);
void TxToUniv(const CTransaction& tx, const uint256& block_hash, UniValue& entry, bool include_hex = true, int serialize_flags = 0, const CTxUndo* txundo = nullptr, TxVerbosity verbosity = TxVerbosity::SHOW_DETAILS, const CSpentIndexTxInfo* ptxSpentInfo = nullptr);

// evo/core_write.cpp
RPCResult GetRpcResult(const std::string& key, bool optional = false);

#endif // BITCOIN_CORE_IO_H
3 changes: 3 additions & 0 deletions src/evo/assetlocktx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
class CBlockIndex;
class CRangesSet;
class TxValidationState;
struct RPCResult;
namespace llmq {
class CQuorumManager;
} // namespace llmq
Expand Down Expand Up @@ -51,6 +52,7 @@ class CAssetLockPayload

std::string ToString() const;

[[nodiscard]] static RPCResult GetJsonHelp(const std::string& key, bool optional);
[[nodiscard]] UniValue ToJson() const;

// getters
Expand Down Expand Up @@ -108,6 +110,7 @@ class CAssetUnlockPayload

std::string ToString() const;

[[nodiscard]] static RPCResult GetJsonHelp(const std::string& key, bool optional);
[[nodiscard]] UniValue ToJson() const;

bool VerifySig(const llmq::CQuorumManager& qman, const uint256& msgHash, gsl::not_null<const CBlockIndex*> pindexTip, TxValidationState& state) const;
Expand Down
5 changes: 5 additions & 0 deletions src/evo/cbtx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@
#define BITCOIN_EVO_CBTX_H

#include <bls/bls.h>

Copy link
Collaborator

@knst knst Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: no \n there is needed

#include <primitives/transaction.h>

Copy link
Collaborator

@knst knst Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: no \n there is needed

#include <univalue.h>

#include <optional>
#include <string>

class BlockValidationState;
class CBlock;
class CBlockIndex;
class CDeterministicMNList;
class TxValidationState;
struct RPCResult;

namespace llmq {
class CQuorumBlockProcessor;
Expand Down Expand Up @@ -57,6 +61,7 @@ class CCbTx

}

[[nodiscard]] static RPCResult GetJsonHelp(const std::string& key, bool optional);
std::string ToString() const;

[[nodiscard]] UniValue ToJson() const;
Expand Down
Loading
Loading