diff --git a/docs/cli/_category_.json b/docs/cli/_category_.json new file mode 100644 index 00000000..d2c7701e --- /dev/null +++ b/docs/cli/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "CLI Reference", + "position": 5 +} diff --git a/docs/cli/wallet/_category_.json b/docs/cli/wallet/_category_.json new file mode 100644 index 00000000..1b3121c0 --- /dev/null +++ b/docs/cli/wallet/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Wallet", + "position": 1 +} diff --git a/docs/cli/wallet/abandontransaction.mdx b/docs/cli/wallet/abandontransaction.mdx new file mode 100644 index 00000000..78d67965 --- /dev/null +++ b/docs/cli/wallet/abandontransaction.mdx @@ -0,0 +1,42 @@ +--- +title: abandontransaction +sidebar_label: abandontransaction +description: "Syscoin Core CLI reference: abandontransaction" +--- + +# `abandontransaction` + +Mark in-wallet transaction `` as abandoned +This will mark this transaction and all its in-wallet descendants as abandoned which will allow +for their inputs to be respent. It can be used to replace "stuck" or evicted transactions. +It only works on transactions which are not included in a block and are not currently in the mempool. +It has no effect on transactions which are already abandoned. + +## Synopsis + +``` +abandontransaction "txid" +``` + +## Arguments + +``` +1. txid (string, required) The transaction id +``` + +## Result + +``` +null (json null) +``` + +## Examples + +``` +> syscoin-cli abandontransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "abandontransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/transactions.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/transactions.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/abortrescan.mdx b/docs/cli/wallet/abortrescan.mdx new file mode 100644 index 00000000..134785b0 --- /dev/null +++ b/docs/cli/wallet/abortrescan.mdx @@ -0,0 +1,39 @@ +--- +title: abortrescan +sidebar_label: abortrescan +description: "Syscoin Core CLI reference: abortrescan" +--- + +# `abortrescan` + +Stops current wallet rescan triggered by an RPC call, e.g. by an importprivkey call. +Note: Use "getwalletinfo" to query the scanning progress. + +## Synopsis + +``` +abortrescan +``` + +## Result + +``` +true|false (boolean) Whether the abort was successful +``` + +## Examples + +``` +Import a private key +> syscoin-cli importprivkey "mykey" + +Abort the running wallet rescan +> syscoin-cli abortrescan + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "abortrescan", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/transactions.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/transactions.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/addmultisigaddress.mdx b/docs/cli/wallet/addmultisigaddress.mdx new file mode 100644 index 00000000..2084fd4b --- /dev/null +++ b/docs/cli/wallet/addmultisigaddress.mdx @@ -0,0 +1,61 @@ +--- +title: addmultisigaddress +sidebar_label: addmultisigaddress +description: "Syscoin Core CLI reference: addmultisigaddress" +--- + +# `addmultisigaddress` + +Add an nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup. +Each key is a Syscoin address or hex-encoded public key. +This functionality is only intended for use with non-watchonly addresses. +See `importaddress` for watchonly p2sh address support. +If 'label' is specified, assign address to that label. +Note: This command is only compatible with legacy wallets. + +## Synopsis + +``` +addmultisigaddress nrequired ["key",...] ( "label" "address_type" ) +``` + +## Arguments + +``` +1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses. +2. keys (json array, required) The syscoin addresses or hex-encoded public keys + [ + "key", (string) syscoin address or hex-encoded public key + ... + ] +3. label (string, optional) A label to assign the addresses to. +4. address_type (string, optional, default=set by -addresstype) 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 + +``` +Add a multisig address from 2 addresses +> syscoin-cli addmultisigaddress 2 "[\"sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl\",\"sys1qtyf33aa2tl62xhrzhralpytka0krxvt0a4e8ee\"]" + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "addmultisigaddress", "params": [2, "[\"sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl\",\"sys1qtyf33aa2tl62xhrzhralpytka0krxvt0a4e8ee\"]"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/addresses.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/addresses.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/backupwallet.mdx b/docs/cli/wallet/backupwallet.mdx new file mode 100644 index 00000000..ecfa4b2f --- /dev/null +++ b/docs/cli/wallet/backupwallet.mdx @@ -0,0 +1,38 @@ +--- +title: backupwallet +sidebar_label: backupwallet +description: "Syscoin Core CLI reference: backupwallet" +--- + +# `backupwallet` + +Safely copies the current wallet file to the specified destination, which can either be a directory or a path with a filename. + +## Synopsis + +``` +backupwallet "destination" +``` + +## Arguments + +``` +1. destination (string, required) The destination directory or file +``` + +## Result + +``` +null (json null) +``` + +## Examples + +``` +> syscoin-cli backupwallet "backup.dat" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "backupwallet", "params": ["backup.dat"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/backup.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/backup.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/bumpfee.mdx b/docs/cli/wallet/bumpfee.mdx new file mode 100644 index 00000000..99733880 --- /dev/null +++ b/docs/cli/wallet/bumpfee.mdx @@ -0,0 +1,95 @@ +--- +title: bumpfee +sidebar_label: bumpfee +description: "Syscoin Core CLI reference: bumpfee" +--- + +# `bumpfee` + +Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B. +An opt-in RBF transaction with the given txid must be in the wallet. +The command will pay the additional fee by reducing change outputs or adding inputs when necessary. +It may add a new change output if one does not already exist. +All inputs in the original transaction will be included in the replacement transaction. +The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs. +By default, the new fee will be calculated automatically using the estimatesmartfee RPC. +The user can specify a confirmation target for estimatesmartfee. +Alternatively, the user can specify a fee rate in sat/vB for the new transaction. +At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee +returned by getnetworkinfo) to enter the node's mempool. +* WARNING: before version 0.21, fee_rate was in SYS/kvB. As of 0.21, fee_rate is in sat/vB. * + +## Synopsis + +``` +bumpfee "txid" ( options ) +``` + +## Arguments + +``` +1. txid (string, required) The txid to be bumped +2. options (json object, optional) Options object that can be used to pass named arguments, listed below. + +Named Arguments: +conf_target (numeric, optional, default=wallet -txconfirmtarget) Confirmation target in blocks + +fee_rate (numeric or string, optional, default=not set, fall back to wallet fee estimation) + Specify a fee rate in sat/vB instead of relying on the built-in fee estimator. + Must be at least 1.000 sat/vB higher than the current transaction fee rate. + WARNING: before version 0.21, fee_rate was in SYS/kvB. As of 0.21, fee_rate is in sat/vB. + +replaceable (boolean, optional, default=true) Whether the new transaction should still be + marked bip-125 replaceable. If true, the sequence numbers in the transaction will + be left unchanged from the original. If false, any input sequence numbers in the + original transaction that were less than 0xfffffffe will be increased to 0xfffffffe + so the new transaction will not be explicitly bip-125 replaceable (though it may + still be replaceable in practice, for example if it has unconfirmed ancestors which + are replaceable). + +estimate_mode (string, optional, default="unset") The fee estimate mode, must be one of (case insensitive): + "unset" + "economical" + "conservative" +outputs (json array, optional, default=[]) The outputs specified as key-value pairs. + Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated. + At least one output of either type must be specified. + Cannot be provided if 'original_change_index' is specified. + [ + { (json object) + "address": amount, (numeric or string, required) A key-value pair. The key (string) is the syscoin address, + the value (float or string) is the amount in SYS + ... + }, + { (json object) + "data": "hex", (string, required) A key-value pair. The key must be "data", the value is hex-encoded data + }, + ... + ] +original_change_index (numeric, optional, default=not set, detect change automatically) The 0-based index of the change output on the original transaction. The indicated output will be recycled into the new change output on the bumped transaction. The remainder after paying the recipients and fees will be sent to the output script of the original change output. The change output’s amount can increase if bumping the transaction adds new inputs, otherwise it will decrease. Cannot be used in combination with the 'outputs' option. +``` + +## Result + +``` +{ (json object) + "txid" : "hex", (string) The id of the new transaction. + "origfee" : n, (numeric) The fee of the replaced transaction. + "fee" : n, (numeric) The fee of the new transaction. + "errors" : [ (json array) Errors encountered during processing (may be empty). + "str", (string) + ... + ] +} +``` + +## Examples + +``` +Bump the fee, get the new transaction's txid +> syscoin-cli bumpfee +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/createwallet.mdx b/docs/cli/wallet/createwallet.mdx new file mode 100644 index 00000000..fe07c757 --- /dev/null +++ b/docs/cli/wallet/createwallet.mdx @@ -0,0 +1,53 @@ +--- +title: createwallet +sidebar_label: createwallet +description: "Syscoin Core CLI reference: createwallet" +--- + +# `createwallet` + +Creates and loads a new wallet. + +## Synopsis + +``` +createwallet "wallet_name" ( disable_private_keys blank "passphrase" avoid_reuse descriptors load_on_startup external_signer ) +``` + +## Arguments + +``` +1. wallet_name (string, required) The name for the new wallet. If this is a path, the wallet will be created at the path location. +2. disable_private_keys (boolean, optional, default=false) Disable the possibility of private keys (only watchonlys are possible in this mode). +3. blank (boolean, optional, default=false) Create a blank wallet. A blank wallet has no keys or HD seed. One can be set using sethdseed. +4. passphrase (string, optional) Encrypt the wallet with this passphrase. +5. avoid_reuse (boolean, optional, default=false) Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind. +6. descriptors (boolean, optional, default=true) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation. Setting to "false" will create a legacy wallet; however, the legacy wallet type is being deprecated and support for creating and opening legacy wallets will be removed in the future. +7. load_on_startup (boolean, optional) Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged. +8. external_signer (boolean, optional, default=false) Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true. +``` + +## Result + +``` +{ (json object) + "name" : "str", (string) The wallet name if created successfully. If the wallet was created using a full path, the wallet_name will be the full path. + "warnings" : [ (json array, optional) Warning messages, if any, related to creating and loading the wallet. + "str", (string) + ... + ] +} +``` + +## Examples + +``` +> syscoin-cli createwallet "testwallet" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createwallet", "params": ["testwallet"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> syscoin-cli -named createwallet wallet_name=descriptors avoid_reuse=true descriptors=true load_on_startup=true +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createwallet", "params": {"wallet_name":"descriptors","avoid_reuse":true,"descriptors":true,"load_on_startup":true}}' -H 'content-type: text/plain;' http://127.0.0.1:8332/ +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/dumpprivkey.mdx b/docs/cli/wallet/dumpprivkey.mdx new file mode 100644 index 00000000..ef453552 --- /dev/null +++ b/docs/cli/wallet/dumpprivkey.mdx @@ -0,0 +1,41 @@ +--- +title: dumpprivkey +sidebar_label: dumpprivkey +description: "Syscoin Core CLI reference: dumpprivkey" +--- + +# `dumpprivkey` + +Reveals the private key corresponding to 'address'. +Then the importprivkey can be used with this output +Note: This command is only compatible with legacy wallets. + +## Synopsis + +``` +dumpprivkey "address" +``` + +## Arguments + +``` +1. address (string, required) The syscoin address for the private key +``` + +## Result + +``` +"str" (string) The private key +``` + +## Examples + +``` +> syscoin-cli dumpprivkey "myaddress" +> syscoin-cli importprivkey "mykey" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "dumpprivkey", "params": ["myaddress"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/backup.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/backup.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/dumpwallet.mdx b/docs/cli/wallet/dumpwallet.mdx new file mode 100644 index 00000000..be357d48 --- /dev/null +++ b/docs/cli/wallet/dumpwallet.mdx @@ -0,0 +1,44 @@ +--- +title: dumpwallet +sidebar_label: dumpwallet +description: "Syscoin Core CLI reference: dumpwallet" +--- + +# `dumpwallet` + +Dumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files. +Imported scripts are included in the dumpfile, but corresponding BIP173 addresses, etc. may not be added automatically by importwallet. +Note that if your wallet contains keys which are not derived from your HD seed (e.g. imported keys), these are not covered by +only backing up the seed itself, and must be backed up too (e.g. ensure you back up the whole dumpfile). +Note: This command is only compatible with legacy wallets. + +## Synopsis + +``` +dumpwallet "filename" +``` + +## Arguments + +``` +1. filename (string, required) The filename with path (absolute path recommended) +``` + +## Result + +``` +{ (json object) + "filename" : "str" (string) The filename with full absolute path +} +``` + +## Examples + +``` +> syscoin-cli dumpwallet "test" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "dumpwallet", "params": ["test"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/backup.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/backup.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/encryptwallet.mdx b/docs/cli/wallet/encryptwallet.mdx new file mode 100644 index 00000000..a0d204f4 --- /dev/null +++ b/docs/cli/wallet/encryptwallet.mdx @@ -0,0 +1,54 @@ +--- +title: encryptwallet +sidebar_label: encryptwallet +description: "Syscoin Core CLI reference: encryptwallet" +--- + +# `encryptwallet` + +Encrypts the wallet with 'passphrase'. This is for first time encryption. +After this, any calls that interact with private keys such as sending or signing +will require the passphrase to be set prior the making these calls. +Use the walletpassphrase call for this, and then walletlock call. +If the wallet is already encrypted, use the walletpassphrasechange call. + +## Synopsis + +``` +encryptwallet "passphrase" +``` + +## Arguments + +``` +1. passphrase (string, required) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long. +``` + +## Result + +``` +"str" (string) A string with further instructions +``` + +## Examples + +``` +Encrypt your wallet +> syscoin-cli encryptwallet "my pass phrase" + +Now set the passphrase to use the wallet, such as for signing or sending syscoin +> syscoin-cli walletpassphrase "my pass phrase" + +Now we can do something like sign +> syscoin-cli signmessage "address" "test message" + +Now lock the wallet again by removing the passphrase +> syscoin-cli walletlock + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "encryptwallet", "params": ["my pass phrase"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/encrypt.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/encrypt.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getaddressesbylabel.mdx b/docs/cli/wallet/getaddressesbylabel.mdx new file mode 100644 index 00000000..251b06fd --- /dev/null +++ b/docs/cli/wallet/getaddressesbylabel.mdx @@ -0,0 +1,43 @@ +--- +title: getaddressesbylabel +sidebar_label: getaddressesbylabel +description: "Syscoin Core CLI reference: getaddressesbylabel" +--- + +# `getaddressesbylabel` + +Returns the list of addresses assigned the specified label. + +## Synopsis + +``` +getaddressesbylabel "label" +``` + +## Arguments + +``` +1. label (string, required) The label. +``` + +## Result + +``` +{ (json object) json object with addresses as keys + "address" : { (json object) json object with information about address + "purpose" : "str" (string) Purpose of address ("send" for sending address, "receive" for receiving address) + }, + ... +} +``` + +## Examples + +``` +> syscoin-cli getaddressesbylabel "tabby" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getaddressesbylabel", "params": ["tabby"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/addresses.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/addresses.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getaddressinfo.mdx b/docs/cli/wallet/getaddressinfo.mdx new file mode 100644 index 00000000..fe59f307 --- /dev/null +++ b/docs/cli/wallet/getaddressinfo.mdx @@ -0,0 +1,76 @@ +--- +title: getaddressinfo +sidebar_label: getaddressinfo +description: "Syscoin Core CLI reference: getaddressinfo" +--- + +# `getaddressinfo` + +Return information about the given syscoin address. +Some of the information will only be present if the address is in the active wallet. + +## Synopsis + +``` +getaddressinfo "address" +``` + +## Arguments + +``` +1. address (string, required) The syscoin address for which to get information. +``` + +## Result + +``` +{ (json object) + "address" : "str", (string) The syscoin address validated. + "scriptPubKey" : "hex", (string) The hex-encoded scriptPubKey generated by the address. + "ismine" : true|false, (boolean) If the address is yours. + "iswatchonly" : true|false, (boolean) If the address is watchonly. + "solvable" : true|false, (boolean) If we know how to spend coins sent to this address, ignoring the possible lack of private keys. + "desc" : "str", (string, optional) A descriptor for spending coins sent to this address (only when solvable). + "parent_desc" : "str", (string, optional) The descriptor used to derive this address if this is a descriptor wallet + "isscript" : true|false, (boolean) If the key is a script. + "ischange" : true|false, (boolean) If the address was used for change output. + "iswitness" : true|false, (boolean) 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. + "script" : "str", (string, optional) The output script type. Only if isscript is true and the redeemscript is known. Possible + types: nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_keyhash, + witness_v0_scripthash, witness_unknown. + "hex" : "hex", (string, optional) The redeemscript for the p2sh address. + "pubkeys" : [ (json array, optional) Array of pubkeys associated with the known redeemscript (only if script is multisig). + "str", (string) + ... + ], + "sigsrequired" : n, (numeric, optional) The number of signatures required to spend multisig output (only if script is multisig). + "pubkey" : "hex", (string, optional) The hex value of the raw public key for single-key addresses (possibly embedded in P2SH or P2WSH). + "embedded" : { (json object, optional) Information about the address embedded in P2SH or P2WSH, if relevant and known. + ... Includes all getaddressinfo output fields for the embedded address, excluding metadata (timestamp, hdkeypath, hdseedid) + and relation to the wallet (ismine, iswatchonly). + }, + "iscompressed" : true|false, (boolean, optional) If the pubkey is compressed. + "timestamp" : xxx, (numeric, optional) The creation time of the key, if available, expressed in UNIX epoch time. + "hdkeypath" : "str", (string, optional) The HD keypath, if the key is HD and available. + "hdseedid" : "hex", (string, optional) The Hash160 of the HD seed. + "hdmasterfingerprint" : "hex", (string, optional) The fingerprint of the master key. + "labels" : [ (json array) Array of labels associated with the address. Currently limited to one label but returned + as an array to keep the API stable if multiple labels are enabled in the future. + "str", (string) Label name (defaults to ""). + ... + ] +} +``` + +## Examples + +``` +> syscoin-cli getaddressinfo "sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getaddressinfo", "params": ["sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/addresses.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/addresses.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getbalance.mdx b/docs/cli/wallet/getbalance.mdx new file mode 100644 index 00000000..ae775424 --- /dev/null +++ b/docs/cli/wallet/getbalance.mdx @@ -0,0 +1,49 @@ +--- +title: getbalance +sidebar_label: getbalance +description: "Syscoin Core CLI reference: getbalance" +--- + +# `getbalance` + +Returns the total available balance. +The available balance is what the wallet considers currently spendable, and is +thus affected by options which limit spendability such as -spendzeroconfchange. + +## Synopsis + +``` +getbalance ( "dummy" minconf include_watchonly avoid_reuse ) +``` + +## Arguments + +``` +1. dummy (string, optional) Remains for backward compatibility. Must be excluded or set to "*". +2. minconf (numeric, optional, default=0) Only include transactions confirmed at least this many times. +3. include_watchonly (boolean, optional, default=true for watch-only wallets, otherwise false) Also include balance in watch-only addresses (see 'importaddress') +4. avoid_reuse (boolean, optional, default=true) (only available if avoid_reuse wallet flag is set) Do not include balance in dirty outputs; addresses are considered dirty if they have previously been used in a transaction. +``` + +## Result + +``` +n (numeric) The total amount in SYS received for this wallet. +``` + +## Examples + +``` +The total amount in the wallet with 0 or more confirmations +> syscoin-cli getbalance + +The total amount in the wallet with at least 6 confirmations +> syscoin-cli getbalance "*" 6 + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getbalance", "params": ["*", 6]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/coins.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/coins.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getbalances.mdx b/docs/cli/wallet/getbalances.mdx new file mode 100644 index 00000000..ebdd1eaf --- /dev/null +++ b/docs/cli/wallet/getbalances.mdx @@ -0,0 +1,48 @@ +--- +title: getbalances +sidebar_label: getbalances +description: "Syscoin Core CLI reference: getbalances" +--- + +# `getbalances` + +Returns an object with all balances in SYS. + +## Synopsis + +``` +getbalances +``` + +## Result + +``` +{ (json object) + "mine" : { (json object) balances from outputs that the wallet can sign + "trusted" : n, (numeric) trusted balance (outputs created by the wallet or confirmed outputs) + "untrusted_pending" : n, (numeric) untrusted pending balance (outputs created by others that are in the mempool) + "immature" : n, (numeric) balance from immature coinbase outputs + "used" : n (numeric, optional) (only present if avoid_reuse is set) balance from coins sent to addresses that were previously spent from (potentially privacy violating) + }, + "watchonly" : { (json object, optional) watchonly balances (not present if wallet does not watch anything) + "trusted" : n, (numeric) trusted balance (outputs created by the wallet or confirmed outputs) + "untrusted_pending" : n, (numeric) untrusted pending balance (outputs created by others that are in the mempool) + "immature" : n (numeric) balance from immature coinbase outputs + }, + "lastprocessedblock" : { (json object) hash and height of the block this information was generated on + "hash" : "hex", (string) hash of the block this information was generated on + "height" : n (numeric) height of the block this information was generated on + } +} +``` + +## Examples + +``` +> syscoin-cli getbalances +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getbalances", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getnewaddress.mdx b/docs/cli/wallet/getnewaddress.mdx new file mode 100644 index 00000000..1bc2ec54 --- /dev/null +++ b/docs/cli/wallet/getnewaddress.mdx @@ -0,0 +1,41 @@ +--- +title: getnewaddress +sidebar_label: getnewaddress +description: "Syscoin Core CLI reference: getnewaddress" +--- + +# `getnewaddress` + +Returns a new Syscoin address for receiving payments. +If 'label' is specified, it is added to the address book +so payments received with the address will be associated with 'label'. + +## Synopsis + +``` +getnewaddress ( "label" "address_type" ) +``` + +## Arguments + +``` +1. label (string, optional, default="") The label name for the address to be linked to. It can also be set to the empty string "" to represent the default label. The label does not need to exist, it will be created if there is no label by the given name. +2. address_type (string, optional, default=set by -addresstype) The address type to use. Options are "legacy", "p2sh-segwit", "bech32", and "bech32m". +``` + +## Result + +``` +"str" (string) The new syscoin address +``` + +## Examples + +``` +> syscoin-cli getnewaddress +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getnewaddress", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/addresses.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/addresses.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getrawchangeaddress.mdx b/docs/cli/wallet/getrawchangeaddress.mdx new file mode 100644 index 00000000..f458e0c2 --- /dev/null +++ b/docs/cli/wallet/getrawchangeaddress.mdx @@ -0,0 +1,39 @@ +--- +title: getrawchangeaddress +sidebar_label: getrawchangeaddress +description: "Syscoin Core CLI reference: getrawchangeaddress" +--- + +# `getrawchangeaddress` + +Returns a new Syscoin address, for receiving change. +This is for use with raw transactions, NOT normal use. + +## Synopsis + +``` +getrawchangeaddress ( "address_type" ) +``` + +## Arguments + +``` +1. address_type (string, optional, default=set by -changetype) The address type to use. Options are "legacy", "p2sh-segwit", "bech32", and "bech32m". +``` + +## Result + +``` +"str" (string) The address +``` + +## Examples + +``` +> syscoin-cli getrawchangeaddress +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getrawchangeaddress", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/addresses.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/addresses.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getreceivedbyaddress.mdx b/docs/cli/wallet/getreceivedbyaddress.mdx new file mode 100644 index 00000000..fce18a4f --- /dev/null +++ b/docs/cli/wallet/getreceivedbyaddress.mdx @@ -0,0 +1,52 @@ +--- +title: getreceivedbyaddress +sidebar_label: getreceivedbyaddress +description: "Syscoin Core CLI reference: getreceivedbyaddress" +--- + +# `getreceivedbyaddress` + +Returns the total amount received by the given address in transactions with at least minconf confirmations. + +## Synopsis + +``` +getreceivedbyaddress "address" ( minconf include_immature_coinbase ) +``` + +## Arguments + +``` +1. address (string, required) The syscoin address for transactions. +2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. +3. include_immature_coinbase (boolean, optional, default=false) Include immature coinbase transactions. +``` + +## Result + +``` +n (numeric) The total amount in SYS received at this address. +``` + +## Examples + +``` +The amount from transactions with at least 1 confirmation +> syscoin-cli getreceivedbyaddress "sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" + +The amount including unconfirmed transactions, zero confirmations +> syscoin-cli getreceivedbyaddress "sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 0 + +The amount with at least 6 confirmations +> syscoin-cli getreceivedbyaddress "sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6 + +The amount with at least 6 confirmations including immature coinbase outputs +> syscoin-cli getreceivedbyaddress "sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6 true + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getreceivedbyaddress", "params": ["sys1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", 6]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/wallet/rpc/coins.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpc/coins.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.* diff --git a/docs/cli/wallet/getreceivedbylabel.mdx b/docs/cli/wallet/getreceivedbylabel.mdx new file mode 100644 index 00000000..74ca3d37 --- /dev/null +++ b/docs/cli/wallet/getreceivedbylabel.mdx @@ -0,0 +1,52 @@ +--- +title: getreceivedbylabel +sidebar_label: getreceivedbylabel +description: "Syscoin Core CLI reference: getreceivedbylabel" +--- + +# `getreceivedbylabel` + +Returns the total amount received by addresses with `