From 1609124b443c99317265ed3809e46e4efe5b5773 Mon Sep 17 00:00:00 2001 From: guilhermefleury Date: Tue, 19 May 2026 13:50:06 -0300 Subject: [PATCH] docs: add auto-generated syscoinwallet RPC reference (Syscoin Core 5.0.5) --- docs/cli/syscoinwallet/_category_.json | 4 ++ docs/cli/syscoinwallet/getauxblock.mdx | 38 +++++++++++++++ docs/cli/syscoinwallet/signmessagebech32.mdx | 46 +++++++++++++++++++ .../syscoinwallet/syscoincreatenevmblob.mdx | 39 ++++++++++++++++ .../syscoincreaterawnevmblob.mdx | 39 ++++++++++++++++ 5 files changed, 166 insertions(+) create mode 100644 docs/cli/syscoinwallet/_category_.json create mode 100644 docs/cli/syscoinwallet/getauxblock.mdx create mode 100644 docs/cli/syscoinwallet/signmessagebech32.mdx create mode 100644 docs/cli/syscoinwallet/syscoincreatenevmblob.mdx create mode 100644 docs/cli/syscoinwallet/syscoincreaterawnevmblob.mdx diff --git a/docs/cli/syscoinwallet/_category_.json b/docs/cli/syscoinwallet/_category_.json new file mode 100644 index 00000000..dbd91a04 --- /dev/null +++ b/docs/cli/syscoinwallet/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Syscoin Wallet", + "position": 12 +} \ No newline at end of file diff --git a/docs/cli/syscoinwallet/getauxblock.mdx b/docs/cli/syscoinwallet/getauxblock.mdx new file mode 100644 index 00000000..b962dc2a --- /dev/null +++ b/docs/cli/syscoinwallet/getauxblock.mdx @@ -0,0 +1,38 @@ +--- +title: getauxblock +sidebar_label: getauxblock +description: "Syscoin Core CLI reference: getauxblock" +--- + +# `getauxblock` + +Creates or submits a merge-mined block. + +Without arguments, creates a new block and returns information +required to merge-mine it. With arguments, submits a solved +auxpow for a previously returned block. + +## Synopsis + +``` +getauxblock ( "hash" "auxpow" ) +``` + +## Arguments + +``` +1. hash (string, optional) Hash of the block to submit +2. auxpow (string, optional) Serialised auxpow found +``` + +## Examples + +``` +> syscoin-cli getauxblock +> syscoin-cli getauxblock "hash" "serialised auxpow" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getauxblock", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/services/rpc/wallet/nevmwalletrpc.cpp](https://github.com/syscoin/syscoin/blob/master/src/services/rpc/wallet/nevmwalletrpc.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/syscoinwallet/signmessagebech32.mdx b/docs/cli/syscoinwallet/signmessagebech32.mdx new file mode 100644 index 00000000..8a2c757d --- /dev/null +++ b/docs/cli/syscoinwallet/signmessagebech32.mdx @@ -0,0 +1,46 @@ +--- +title: signmessagebech32 +sidebar_label: signmessagebech32 +description: "Syscoin Core CLI reference: signmessagebech32" +--- + +# `signmessagebech32` + +Sign a message with the private key of an address (p2pkh or p2wpkh) +Requires wallet passphrase to be set with walletpassphrase call if wallet is encrypted. + +## Synopsis + +``` +signmessagebech32 "address" "message" +``` + +## Arguments + +``` +1. address (string, required) The syscoin address to use for the private key. +2. message (string, required) Message to sign. +``` + +## Result + +``` +"str" (string) The signature of the message encoded in base 64 +``` + +## Examples + +``` +Unlock the wallet for 30 seconds +> syscoin-cli walletpassphrase "mypassphrase" 30 + +Create the signature +> syscoin-cli signmessagebech32 "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "message" + +As a JSON-RPC signmessagebech32 +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "signmessagebech32", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "message"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/syscoinwallet/syscoincreatenevmblob.mdx b/docs/cli/syscoinwallet/syscoincreatenevmblob.mdx new file mode 100644 index 00000000..d091de51 --- /dev/null +++ b/docs/cli/syscoinwallet/syscoincreatenevmblob.mdx @@ -0,0 +1,39 @@ +--- +title: syscoincreatenevmblob +sidebar_label: syscoincreatenevmblob +description: "Syscoin Core CLI reference: syscoincreatenevmblob" +--- + +# `syscoincreatenevmblob` + +Create NEVM blob data used by rollups + +## Synopsis + +``` +syscoincreatenevmblob "data" ( overwrite_existing conf_target "estimate_mode" fee_rate ) +``` + +## Arguments + +``` +1. data (string, required) blob in hex +2. overwrite_existing (boolean, optional, default=true) true to overwrite an existing blob if it exists, false to return versionhash of data on duplicate. +3. conf_target (numeric, optional, default=wallet -txconfirmtarget) Confirmation target in blocks +4. estimate_mode (string, optional, default="unset") The fee estimate mode, must be one of (case insensitive): + "unset" + "economical" + "conservative" +5. fee_rate (numeric or string, optional, default=not set, fall back to wallet fee estimation) Specify a fee rate in sat/vB. +``` + +## Examples + +``` +> syscoin-cli syscoincreatenevmblob "data" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "syscoincreatenevmblob", "params": ["data"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/services/rpc/wallet/nevmwalletrpc.cpp](https://github.com/syscoin/syscoin/blob/master/src/services/rpc/wallet/nevmwalletrpc.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/syscoinwallet/syscoincreaterawnevmblob.mdx b/docs/cli/syscoinwallet/syscoincreaterawnevmblob.mdx new file mode 100644 index 00000000..840b9ec1 --- /dev/null +++ b/docs/cli/syscoinwallet/syscoincreaterawnevmblob.mdx @@ -0,0 +1,39 @@ +--- +title: syscoincreaterawnevmblob +sidebar_label: syscoincreaterawnevmblob +description: "Syscoin Core CLI reference: syscoincreaterawnevmblob" +--- + +# `syscoincreaterawnevmblob` + +Create NEVM blob data used by rollups via a custom raw parameters + +## Synopsis + +``` +syscoincreaterawnevmblob "versionhash" "data" ( conf_target "estimate_mode" fee_rate ) +``` + +## Arguments + +``` +1. versionhash (string, required) Version hash of the blob +2. data (string, required) data in hex +3. conf_target (numeric, optional, default=wallet -txconfirmtarget) Confirmation target in blocks +4. estimate_mode (string, optional, default="unset") The fee estimate mode, must be one of (case insensitive): + "unset" + "economical" + "conservative" +5. fee_rate (numeric or string, optional, default=not set, fall back to wallet fee estimation) Specify a fee rate in sat/vB. +``` + +## Examples + +``` +> syscoin-cli syscoincreaterawnevmblob "versionhash" "data" 6 economical 25 +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "syscoincreaterawnevmblob", "params": ["versionhash" "data" 6 economical 25]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/services/rpc/wallet/nevmwalletrpc.cpp](https://github.com/syscoin/syscoin/blob/master/src/services/rpc/wallet/nevmwalletrpc.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*