Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "CLI Reference",
"position": 5
}
4 changes: 4 additions & 0 deletions docs/cli/wallet/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Wallet",
"position": 1
}
42 changes: 42 additions & 0 deletions docs/cli/wallet/abandontransaction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: abandontransaction
sidebar_label: abandontransaction
description: "Syscoin Core CLI reference: abandontransaction"
---

# `abandontransaction`

Mark in-wallet transaction `<txid>` 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.*
39 changes: 39 additions & 0 deletions docs/cli/wallet/abortrescan.mdx
Original file line number Diff line number Diff line change
@@ -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.*
61 changes: 61 additions & 0 deletions docs/cli/wallet/addmultisigaddress.mdx
Original file line number Diff line number Diff line change
@@ -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.*
38 changes: 38 additions & 0 deletions docs/cli/wallet/backupwallet.mdx
Original file line number Diff line number Diff line change
@@ -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.*
95 changes: 95 additions & 0 deletions docs/cli/wallet/bumpfee.mdx
Original file line number Diff line number Diff line change
@@ -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 <txid>
```

---

*Auto-generated from Syscoin Core 5.0.5 on 2026-05-15.*
53 changes: 53 additions & 0 deletions docs/cli/wallet/createwallet.mdx
Original file line number Diff line number Diff line change
@@ -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.*
41 changes: 41 additions & 0 deletions docs/cli/wallet/dumpprivkey.mdx
Original file line number Diff line number Diff line change
@@ -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.*
Loading