diff --git a/docs/cli/control/_category_.json b/docs/cli/control/_category_.json new file mode 100644 index 00000000..854405d3 --- /dev/null +++ b/docs/cli/control/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Control", + "position": 9 +} \ No newline at end of file diff --git a/docs/cli/control/getmemoryinfo.mdx b/docs/cli/control/getmemoryinfo.mdx new file mode 100644 index 00000000..72d62f8f --- /dev/null +++ b/docs/cli/control/getmemoryinfo.mdx @@ -0,0 +1,34 @@ +--- +title: getmemoryinfo +sidebar_label: getmemoryinfo +description: "Syscoin Core CLI reference: getmemoryinfo" +--- + +# `getmemoryinfo` + +Returns an object containing information about memory usage. + +## Synopsis + +``` +getmemoryinfo ( "mode" ) +``` + +## Arguments + +``` +1. mode (string, optional, default="stats") determines what kind of information is returned. + - "stats" returns general statistics about memory usage in the daemon. + - "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc). +``` + +## Examples + +``` +> syscoin-cli getmemoryinfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getmemoryinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/node.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/node.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/control/getrpcinfo.mdx b/docs/cli/control/getrpcinfo.mdx new file mode 100644 index 00000000..942a9c5e --- /dev/null +++ b/docs/cli/control/getrpcinfo.mdx @@ -0,0 +1,41 @@ +--- +title: getrpcinfo +sidebar_label: getrpcinfo +description: "Syscoin Core CLI reference: getrpcinfo" +--- + +# `getrpcinfo` + +Returns details of the RPC server. + +## Synopsis + +``` +getrpcinfo +``` + +## Result + +``` +{ (json object) + "active_commands" : [ (json array) All active commands + { (json object) Information about an active command + "method" : "str", (string) The name of the RPC command + "duration" : n (numeric) The running time in microseconds + }, + ... + ], + "logpath" : "str" (string) The complete file path to the debug log +} +``` + +## Examples + +``` +> syscoin-cli getrpcinfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getrpcinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/control/help.mdx b/docs/cli/control/help.mdx new file mode 100644 index 00000000..1c7ec7a1 --- /dev/null +++ b/docs/cli/control/help.mdx @@ -0,0 +1,31 @@ +--- +title: help +sidebar_label: help +description: "Syscoin Core CLI reference: help" +--- + +# `help` + +List all commands, or get help for a specified command. + +## Synopsis + +``` +help ( "command" ) +``` + +## Arguments + +``` +1. command (string, optional, default=all commands) The command to get help on +``` + +## Result + +``` +"str" (string) The help text +``` + +--- + +*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/control/logging.mdx b/docs/cli/control/logging.mdx new file mode 100644 index 00000000..a3fab803 --- /dev/null +++ b/docs/cli/control/logging.mdx @@ -0,0 +1,58 @@ +--- +title: logging +sidebar_label: logging +description: "Syscoin Core CLI reference: logging" +--- + +# `logging` + +Gets and sets the logging configuration. +When called without an argument, returns the list of categories with status that are currently being debug logged or not. +When called with arguments, adds or removes categories from debug logging and return the lists above. +The arguments are evaluated in order "include", "exclude". +If an item is both included and excluded, it will thus end up being excluded. +The valid logging categories are: addrman, bench, blockstorage, chainlocks, cmpctblock, coindb, estimatefee, gobject, http, i2p, ipc, leveldb, libevent, llmq, llmq-dkg, llmq-sigs, mempool, mempoolrej, mnlist, mnpayments, mnsync, net, netconn, proxy, prune, qt, rand, reindex, rpc, scan, selectcoins, spork, syscoin, tor, txpackages, txreconciliation, util, validation, walletdb, zmq +In addition, the following are available as category names with special meanings: + - "all", "1" : represent all logging categories. + - "none", "0" : even if other logging categories are specified, ignore all of them. + +## Synopsis + +``` +logging ( ["include_category",...] ["exclude_category",...] ) +``` + +## Arguments + +``` +1. include (json array, optional) The categories to add to debug logging + [ + "include_category", (string) the valid logging category + ... + ] +2. exclude (json array, optional) The categories to remove from debug logging + [ + "exclude_category", (string) the valid logging category + ... + ] +``` + +## Result + +``` +{ (json object) keys are the logging categories, and values indicates its status + "category" : true|false, (boolean) if being debug logged or not. false:inactive, true:active + ... +} +``` + +## Examples + +``` +> syscoin-cli logging "[\"all\"]" "[\"http\"]" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "logging", "params": [["all"], ["libevent"]]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/node.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/node.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/control/stop.mdx b/docs/cli/control/stop.mdx new file mode 100644 index 00000000..306e3952 --- /dev/null +++ b/docs/cli/control/stop.mdx @@ -0,0 +1,25 @@ +--- +title: stop +sidebar_label: stop +description: "Syscoin Core CLI reference: stop" +--- + +# `stop` + +Request a graceful shutdown of Syscoin Core. + +## Synopsis + +``` +stop +``` + +## Result + +``` +"str" (string) A string with the content 'Syscoin Core stopping' +``` + +--- + +*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/control/uptime.mdx b/docs/cli/control/uptime.mdx new file mode 100644 index 00000000..12b084cd --- /dev/null +++ b/docs/cli/control/uptime.mdx @@ -0,0 +1,32 @@ +--- +title: uptime +sidebar_label: uptime +description: "Syscoin Core CLI reference: uptime" +--- + +# `uptime` + +Returns the total uptime of the server. + +## Synopsis + +``` +uptime +``` + +## Result + +``` +n (numeric) The number of seconds that the server has been running +``` + +## Examples + +``` +> syscoin-cli uptime +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "uptime", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/governancewallet/_category_.json b/docs/cli/governancewallet/_category_.json new file mode 100644 index 00000000..8d5f0135 --- /dev/null +++ b/docs/cli/governancewallet/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Governance Wallet", + "position": 15 +} \ No newline at end of file diff --git a/docs/cli/governancewallet/gobject_list_prepared.mdx b/docs/cli/governancewallet/gobject_list_prepared.mdx new file mode 100644 index 00000000..a8d58726 --- /dev/null +++ b/docs/cli/governancewallet/gobject_list_prepared.mdx @@ -0,0 +1,32 @@ +--- +title: gobject_list_prepared +sidebar_label: gobject_list_prepared +description: "Syscoin Core CLI reference: gobject_list_prepared" +--- + +# `gobject_list_prepared` + +Returns a list of governance objects prepared by this wallet with "gobject_prepare" sorted by their creation time. + +## Synopsis + +``` +gobject_list_prepared ( count ) +``` + +## Arguments + +``` +1. count (numeric, optional) Maximum number of objects to return. +``` + +## Examples + +``` +> syscoin-cli gobject_list_prepared +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_list_prepared", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/governancewallet/gobject_prepare.mdx b/docs/cli/governancewallet/gobject_prepare.mdx new file mode 100644 index 00000000..85290b4d --- /dev/null +++ b/docs/cli/governancewallet/gobject_prepare.mdx @@ -0,0 +1,43 @@ +--- +title: gobject_prepare +sidebar_label: gobject_prepare +description: "Syscoin Core CLI reference: gobject_prepare" +--- + +# `gobject_prepare` + +Prepare governance object by signing and creating tx. + +## Synopsis + +``` +gobject_prepare "parentHash" revision time "dataHex" ( "outputHash" outputIndex ) +``` + +## Arguments + +``` +1. parentHash (string, required) Hash of the parent object, "0" is root. +2. revision (numeric, required) Object revision in the system. +3. time (numeric, required) Time this object was created. +4. dataHex (string, required) Data in hex string form. +5. outputHash (string, optional) The single output to submit the proposal fee from. +6. outputIndex (numeric, optional) The output index. +``` + +## Result + +``` +"hex" (string) txid +``` + +## Examples + +``` +> syscoin-cli gobject_prepare +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_prepare", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/governancewallet/gobject_vote_alias.mdx b/docs/cli/governancewallet/gobject_vote_alias.mdx new file mode 100644 index 00000000..ea8bebdb --- /dev/null +++ b/docs/cli/governancewallet/gobject_vote_alias.mdx @@ -0,0 +1,35 @@ +--- +title: gobject_vote_alias +sidebar_label: gobject_vote_alias +description: "Syscoin Core CLI reference: gobject_vote_alias" +--- + +# `gobject_vote_alias` + +Vote on a governance object by masternode's voting key (if present in local wallet). + +## Synopsis + +``` +gobject_vote_alias "governanceHash" "vote" "voteOutome" "protxHash" +``` + +## Arguments + +``` +1. governanceHash (string, required) Hash of the governance object. +2. vote (string, required) Vote, possible values: [funding|valid|delete|endorsed]. +3. voteOutome (string, required) Vote outcome, possible values: [yes|no|abstain]. +4. protxHash (string, required) Masternode's proTxHash. +``` + +## Examples + +``` +> syscoin-cli gobject_vote_alias +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_vote_alias", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/governancewallet/gobject_vote_many.mdx b/docs/cli/governancewallet/gobject_vote_many.mdx new file mode 100644 index 00000000..4ebb05de --- /dev/null +++ b/docs/cli/governancewallet/gobject_vote_many.mdx @@ -0,0 +1,34 @@ +--- +title: gobject_vote_many +sidebar_label: gobject_vote_many +description: "Syscoin Core CLI reference: gobject_vote_many" +--- + +# `gobject_vote_many` + +Vote on a governance object by all masternodes for which the voting key is present in the local wallet. + +## Synopsis + +``` +gobject_vote_many "governanceHash" "vote" "voteOutome" +``` + +## Arguments + +``` +1. governanceHash (string, required) Hash of the governance object. +2. vote (string, required) Vote, possible values: [funding|valid|delete|endorsed]. +3. voteOutome (string, required) Vote outcome, possible values: [yes|no|abstain]. +``` + +## Examples + +``` +> syscoin-cli gobject_vote_many +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_vote_many", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/_category_.json b/docs/cli/util/_category_.json new file mode 100644 index 00000000..ddf034a2 --- /dev/null +++ b/docs/cli/util/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Util", + "position": 8 +} \ No newline at end of file diff --git a/docs/cli/util/createmultisig.mdx b/docs/cli/util/createmultisig.mdx new file mode 100644 index 00000000..39ab5dfc --- /dev/null +++ b/docs/cli/util/createmultisig.mdx @@ -0,0 +1,56 @@ +--- +title: createmultisig +sidebar_label: createmultisig +description: "Syscoin Core CLI reference: createmultisig" +--- + +# `createmultisig` + +Creates a multi-signature address with n signature of m keys required. +It returns a json object with the address and redeemScript. + +## Synopsis + +``` +createmultisig nrequired ["key",...] ( "address_type" ) +``` + +## Arguments + +``` +1. nrequired (numeric, required) The number of required signatures out of the n keys. +2. keys (json array, required) The hex-encoded public keys. + [ + "key", (string) The hex-encoded public key + ... + ] +3. address_type (string, optional, default="legacy") The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". +``` + +## Result + +``` +{ (json object) + "address" : "str", (string) The value of the new multisig address. + "redeemScript" : "hex", (string) The string value of the hex-encoded redemption script. + "descriptor" : "str", (string) The descriptor for this multisig + "warnings" : [ (json array, optional) Any warnings resulting from the creation of this multisig + "str", (string) + ... + ] +} +``` + +## Examples + +``` +Create a multisig address from 2 public keys +> syscoin-cli createmultisig 2 "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]" + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createmultisig", "params": [2, ["03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd","03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626"]]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/output_script.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/output_script.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/deriveaddresses.mdx b/docs/cli/util/deriveaddresses.mdx new file mode 100644 index 00000000..dfb34ca0 --- /dev/null +++ b/docs/cli/util/deriveaddresses.mdx @@ -0,0 +1,43 @@ +--- +title: deriveaddresses +sidebar_label: deriveaddresses +description: "Syscoin Core CLI reference: deriveaddresses" +--- + +# `deriveaddresses` + +Derives one or more addresses corresponding to an output descriptor. + +## Synopsis + +``` +deriveaddresses "descriptor" ( range ) +``` + +## Arguments + +``` +1. descriptor (string, required) The descriptor. +2. range (numeric or array, optional) If a ranged descriptor is used, this specifies the end or the range (in [begin,end] notation) to derive. +``` + +## Result + +``` +[ (json array) + "str", (string) the derived addresses + ... +] +``` + +## Examples + +``` +First three native segwit receive addresses +> syscoin-cli deriveaddresses "wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu" "[0,2]" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "deriveaddresses", "params": ["wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu", "[0,2]"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/output_script.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/output_script.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/estimatesmartfee.mdx b/docs/cli/util/estimatesmartfee.mdx new file mode 100644 index 00000000..1090e406 --- /dev/null +++ b/docs/cli/util/estimatesmartfee.mdx @@ -0,0 +1,61 @@ +--- +title: estimatesmartfee +sidebar_label: estimatesmartfee +description: "Syscoin Core CLI reference: estimatesmartfee" +--- + +# `estimatesmartfee` + +Estimates the approximate fee per kilobyte needed for a transaction to begin +confirmation within conf_target blocks if possible and return the number of blocks +for which the estimate is valid. Uses virtual transaction size as defined +in BIP 141 (witness data is discounted). + +## Synopsis + +``` +estimatesmartfee conf_target ( "estimate_mode" ) +``` + +## Arguments + +``` +1. conf_target (numeric, required) Confirmation target in blocks (1 - 1008) +2. estimate_mode (string, optional, default="conservative") The fee estimate mode. + Whether to return a more conservative estimate which also satisfies + a longer history. A conservative estimate potentially returns a + higher feerate and is more likely to be sufficient for the desired + target, but is not as responsive to short term drops in the + prevailing fee market. Must be one of (case insensitive): + "unset" + "economical" + "conservative" +``` + +## Result + +``` +{ (json object) + "feerate" : n, (numeric, optional) estimate fee rate in SYS/kvB (only present if no errors were encountered) + "errors" : [ (json array, optional) Errors encountered during processing (if there are any) + "str", (string) error + ... + ], + "blocks" : n (numeric) block number where estimate was found + The request target will be clamped between 2 and the highest target + fee estimation is able to return based on how long it has been running. + An error is returned if not enough transactions and blocks + have been observed to make an estimate for any number of blocks. +} +``` + +## Examples + +``` +> syscoin-cli estimatesmartfee 6 +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "estimatesmartfee", "params": [6]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/fees.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/fees.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/getdescriptorinfo.mdx b/docs/cli/util/getdescriptorinfo.mdx new file mode 100644 index 00000000..cbc0ee9a --- /dev/null +++ b/docs/cli/util/getdescriptorinfo.mdx @@ -0,0 +1,45 @@ +--- +title: getdescriptorinfo +sidebar_label: getdescriptorinfo +description: "Syscoin Core CLI reference: getdescriptorinfo" +--- + +# `getdescriptorinfo` + +Analyses a descriptor. + +## Synopsis + +``` +getdescriptorinfo "descriptor" +``` + +## Arguments + +``` +1. descriptor (string, required) The descriptor. +``` + +## Result + +``` +{ (json object) + "descriptor" : "str", (string) The descriptor in canonical form, without private keys + "checksum" : "str", (string) The checksum for the input descriptor + "isrange" : true|false, (boolean) Whether the descriptor is ranged + "issolvable" : true|false, (boolean) Whether the descriptor is solvable + "hasprivatekeys" : true|false (boolean) Whether the input descriptor contained at least one private key +} +``` + +## Examples + +``` +Analyse a descriptor +> syscoin-cli getdescriptorinfo "wpkh([d34db33f/84h/0h/0h]0279be667ef9dcbbac55a06295Ce870b07029Bfcdb2dce28d959f2815b16f81798)" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getdescriptorinfo", "params": ["wpkh([d34db33f/84h/0h/0h]0279be667ef9dcbbac55a06295Ce870b07029Bfcdb2dce28d959f2815b16f81798)"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/output_script.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/output_script.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/getindexinfo.mdx b/docs/cli/util/getindexinfo.mdx new file mode 100644 index 00000000..85edd504 --- /dev/null +++ b/docs/cli/util/getindexinfo.mdx @@ -0,0 +1,46 @@ +--- +title: getindexinfo +sidebar_label: getindexinfo +description: "Syscoin Core CLI reference: getindexinfo" +--- + +# `getindexinfo` + +Returns the status of one or all available indices currently running in the node. + +## Synopsis + +``` +getindexinfo ( "index_name" ) +``` + +## Arguments + +``` +1. index_name (string, optional) Filter results for an index with a specific name. +``` + +## Result + +``` +{ (json object) + "name" : { (json object) The name of the index + "synced" : true|false, (boolean) Whether the index is synced or not + "best_block_height" : n (numeric) The block height to which the index is synced + }, + ... +} +``` + +## Examples + +``` +> syscoin-cli getindexinfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getindexinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> syscoin-cli getindexinfo txindex +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getindexinfo", "params": [txindex]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/node.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/node.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/signmessagewithprivkey.mdx b/docs/cli/util/signmessagewithprivkey.mdx new file mode 100644 index 00000000..73618d4b --- /dev/null +++ b/docs/cli/util/signmessagewithprivkey.mdx @@ -0,0 +1,45 @@ +--- +title: signmessagewithprivkey +sidebar_label: signmessagewithprivkey +description: "Syscoin Core CLI reference: signmessagewithprivkey" +--- + +# `signmessagewithprivkey` + +Sign a message with the private key of an address + +## Synopsis + +``` +signmessagewithprivkey "privkey" "message" +``` + +## Arguments + +``` +1. privkey (string, required) The private key to sign the message with. +2. message (string, required) The message to create a signature of. +``` + +## Result + +``` +"str" (string) The signature of the message encoded in base 64 +``` + +## Examples + +``` +Create the signature +> syscoin-cli signmessagewithprivkey "privkey" "my message" + +Verify the signature +> syscoin-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "signmessagewithprivkey", "params": ["privkey", "my message"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/signmessage.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/signmessage.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/validateaddress.mdx b/docs/cli/util/validateaddress.mdx new file mode 100644 index 00000000..d05f9dbd --- /dev/null +++ b/docs/cli/util/validateaddress.mdx @@ -0,0 +1,51 @@ +--- +title: validateaddress +sidebar_label: validateaddress +description: "Syscoin Core CLI reference: validateaddress" +--- + +# `validateaddress` + +Return information about the given syscoin address. + +## Synopsis + +``` +validateaddress "address" +``` + +## Arguments + +``` +1. address (string, required) The syscoin address to validate +``` + +## Result + +``` +{ (json object) + "isvalid" : true|false, (boolean) If the address is valid or not + "address" : "str", (string, optional) The syscoin address validated + "scriptPubKey" : "hex", (string, optional) The hex-encoded scriptPubKey generated by the address + "isscript" : true|false, (boolean, optional) If the key is a script + "iswitness" : true|false, (boolean, optional) If the address is a witness address + "witness_version" : n, (numeric, optional) The version number of the witness program + "witness_program" : "hex", (string, optional) The hex value of the witness program + "error" : "str", (string, optional) Error message, if any + "error_locations" : [ (json array, optional) Indices of likely error locations in address, if known (e.g. Bech32 errors) + n, (numeric) index of a potential error + ... + ] +} +``` + +## Examples + +``` +> syscoin-cli validateaddress "sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "validateaddress", "params": ["sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/util/verifymessage.mdx b/docs/cli/util/verifymessage.mdx new file mode 100644 index 00000000..1d518165 --- /dev/null +++ b/docs/cli/util/verifymessage.mdx @@ -0,0 +1,49 @@ +--- +title: verifymessage +sidebar_label: verifymessage +description: "Syscoin Core CLI reference: verifymessage" +--- + +# `verifymessage` + +Verify a signed message. + +## Synopsis + +``` +verifymessage "address" "signature" "message" +``` + +## Arguments + +``` +1. address (string, required) The syscoin address to use for the signature. +2. signature (string, required) The signature provided by the signer in base 64 encoding (see signmessage). +3. message (string, required) The message that was signed. +``` + +## Result + +``` +true|false (boolean) If the signature is verified or not. +``` + +## Examples + +``` +Unlock the wallet for 30 seconds +> syscoin-cli walletpassphrase "mypassphrase" 30 + +Create the signature +> syscoin-cli signmessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "my message" + +Verify the signature +> syscoin-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "verifymessage", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "signature", "my message"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/signmessage.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/signmessage.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.* diff --git a/docs/cli/zmq/_category_.json b/docs/cli/zmq/_category_.json new file mode 100644 index 00000000..a29b9f93 --- /dev/null +++ b/docs/cli/zmq/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "ZMQ", + "position": 10 +} \ No newline at end of file diff --git a/docs/cli/zmq/getzmqnotifications.mdx b/docs/cli/zmq/getzmqnotifications.mdx new file mode 100644 index 00000000..8588998e --- /dev/null +++ b/docs/cli/zmq/getzmqnotifications.mdx @@ -0,0 +1,40 @@ +--- +title: getzmqnotifications +sidebar_label: getzmqnotifications +description: "Syscoin Core CLI reference: getzmqnotifications" +--- + +# `getzmqnotifications` + +Returns information about the active ZeroMQ notifications. + +## Synopsis + +``` +getzmqnotifications +``` + +## Result + +``` +[ (json array) + { (json object) + "type" : "str", (string) Type of notification + "address" : "str", (string) Address of the publisher + "addresssub" : "str", (string, optional) Address of the subscriber, omitted if there is no subscriber assigned to this notification + "hwm" : n (numeric) Outbound message high water mark + }, + ... +] +``` + +## Examples + +``` +> syscoin-cli getzmqnotifications +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getzmqnotifications", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/zmq/zmqrpc.cpp](https://github.com/syscoin/syscoin/blob/master/src/zmq/zmqrpc.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*