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/blockchain/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Blockchain",
"position": 2
}
45 changes: 45 additions & 0 deletions docs/cli/blockchain/dumptxoutset.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: dumptxoutset
sidebar_label: dumptxoutset
description: "Syscoin Core CLI reference: dumptxoutset"
---

# `dumptxoutset`

Write the serialized UTXO set to disk.

## Synopsis

```
dumptxoutset "path"
```

## Arguments

```
1. path (string, required) Path to the output file. If relative, will be prefixed by datadir.
```

## Result

```
{ (json object)
"coins_written" : n, (numeric) the number of coins written in the snapshot
"base_hash" : "hex", (string) the hash of the base of the snapshot
"base_height" : n, (numeric) the height of the base of the snapshot
"path" : "str", (string) the absolute path that the snapshot was written to
"pathjson" : "str", (string) the absolute path that the json snapshot was written to
"txoutset_hash" : "hex", (string) the hash of the UTXO set contents
"nchaintx" : n (numeric) the number of transactions in the chain up to and including the base block
}
```

## Examples

```
> syscoin-cli dumptxoutset utxo.dat
```

---

*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
32 changes: 32 additions & 0 deletions docs/cli/blockchain/getbestblockhash.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: getbestblockhash
sidebar_label: getbestblockhash
description: "Syscoin Core CLI reference: getbestblockhash"
---

# `getbestblockhash`

Returns the hash of the best (tip) block in the most-work fully-validated chain.

## Synopsis

```
getbestblockhash
```

## Result

```
"hex" (string) the block hash, hex-encoded
```

## Examples

```
> syscoin-cli getbestblockhash
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getbestblockhash", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
36 changes: 36 additions & 0 deletions docs/cli/blockchain/getblock.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: getblock
sidebar_label: getblock
description: "Syscoin Core CLI reference: getblock"
---

# `getblock`

If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.
If verbosity is 1, returns an Object with information about block `<hash>`.
If verbosity is 2, returns an Object with information about block `<hash>` and information about each transaction.
If verbosity is 3, returns an Object with information about block `<hash>` and information about each transaction, including prevout information for inputs (only for unpruned blocks in the current best chain).

## Synopsis

```
getblock "blockhash" ( verbosity )
```

## Arguments

```
1. blockhash (string, required) The block hash
2. verbosity (numeric, optional, default=1) 0 for hex-encoded data, 1 for a JSON object, 2 for JSON object with transaction data, and 3 for JSON object with transaction data including prevout information for inputs
```

## Examples

```
> syscoin-cli getblock "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblock", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
49 changes: 49 additions & 0 deletions docs/cli/blockchain/getblockchaininfo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: getblockchaininfo
sidebar_label: getblockchaininfo
description: "Syscoin Core CLI reference: getblockchaininfo"
---

# `getblockchaininfo`

Returns an object containing various state info regarding blockchain processing.

## Synopsis

```
getblockchaininfo
```

## Result

```
{ (json object)
"chain" : "str", (string) current network name (main, test, signet, regtest)
"blocks" : n, (numeric) the height of the most-work fully-validated chain. The genesis block has height 0
"headers" : n, (numeric) the current number of headers we have validated
"bestblockhash" : "str", (string) the hash of the currently best block
"difficulty" : n, (numeric) the current difficulty
"time" : xxx, (numeric) The block time expressed in UNIX epoch time
"mediantime" : xxx, (numeric) The median block time expressed in UNIX epoch time
"verificationprogress" : n, (numeric) estimate of verification progress [0..1]
"initialblockdownload" : true|false, (boolean) (debug information) estimate of whether this node is in Initial Block Download mode
"chainwork" : "hex", (string) total amount of work in active chain, in hexadecimal
"size_on_disk" : n, (numeric) the estimated size of the block and undo files on disk
"pruned" : true|false, (boolean) if the blocks are subject to pruning
"pruneheight" : n, (numeric, optional) height of the last block pruned, plus one (only present if pruning is enabled)
"automatic_pruning" : true|false, (boolean, optional) whether automatic pruning is enabled (only present if pruning is enabled)
"prune_target_size" : n, (numeric, optional) the target size used by pruning (only present if automatic pruning is enabled)
"warnings" : "str" (string) any network and blockchain warnings
}
```

## Examples

```
> syscoin-cli getblockchaininfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockchaininfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
33 changes: 33 additions & 0 deletions docs/cli/blockchain/getblockcount.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: getblockcount
sidebar_label: getblockcount
description: "Syscoin Core CLI reference: getblockcount"
---

# `getblockcount`

Returns the height of the most-work fully-validated chain.
The genesis block has height 0.

## Synopsis

```
getblockcount
```

## Result

```
n (numeric) The current block count
```

## Examples

```
> syscoin-cli getblockcount
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockcount", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
42 changes: 42 additions & 0 deletions docs/cli/blockchain/getblockfilter.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: getblockfilter
sidebar_label: getblockfilter
description: "Syscoin Core CLI reference: getblockfilter"
---

# `getblockfilter`

Retrieve a BIP 157 content filter for a particular block.

## Synopsis

```
getblockfilter "blockhash" ( "filtertype" )
```

## Arguments

```
1. blockhash (string, required) The hash of the block
2. filtertype (string, optional, default="basic") The type name of the filter
```

## Result

```
{ (json object)
"filter" : "hex", (string) the hex-encoded filter data
"header" : "hex" (string) the hex-encoded filter header
}
```

## Examples

```
> syscoin-cli getblockfilter "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" "basic"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockfilter", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09", "basic"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
47 changes: 47 additions & 0 deletions docs/cli/blockchain/getblockfrompeer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: getblockfrompeer
sidebar_label: getblockfrompeer
description: "Syscoin Core CLI reference: getblockfrompeer"
---

# `getblockfrompeer`

Attempt to fetch block from a given peer.

We must have the header for this block, e.g. using submitheader.
Subsequent calls for the same block may cause the response from the previous peer to be ignored.
Peers generally ignore requests for a stale block that they never fully verified, or one that is more than a month old.
When a peer does not respond with a block, we will disconnect.
Note: The block could be re-pruned as soon as it is received.

Returns an empty JSON object if the request was successfully scheduled.

## Synopsis

```
getblockfrompeer "blockhash" peer_id
```

## Arguments

```
1. blockhash (string, required) The block hash to try to fetch
2. peer_id (numeric, required) The peer to fetch it from (see getpeerinfo for peer IDs)
```

## Result

```
{} (empty JSON object)
```

## Examples

```
> syscoin-cli getblockfrompeer "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" 0
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockfrompeer", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" 0]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
38 changes: 38 additions & 0 deletions docs/cli/blockchain/getblockhash.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: getblockhash
sidebar_label: getblockhash
description: "Syscoin Core CLI reference: getblockhash"
---

# `getblockhash`

Returns hash of block in best-block-chain at height provided.

## Synopsis

```
getblockhash height
```

## Arguments

```
1. height (numeric, required) The height index
```

## Result

```
"hex" (string) The block hash
```

## Examples

```
> syscoin-cli getblockhash 1000
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockhash", "params": [1000]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
34 changes: 34 additions & 0 deletions docs/cli/blockchain/getblockheader.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: getblockheader
sidebar_label: getblockheader
description: "Syscoin Core CLI reference: getblockheader"
---

# `getblockheader`

If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'.
If verbose is true, returns an Object with information about blockheader `<hash>`.

## Synopsis

```
getblockheader "blockhash" ( verbose )
```

## Arguments

```
1. blockhash (string, required) The block hash
2. verbose (boolean, optional, default=true) true for a json object, false for the hex-encoded data
```

## Examples

```
> syscoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*
Loading