stellar-core can be controlled via the following commands.
Common options can be placed at any place in the command line.
http-command llbut we need this form if you want to change the log level during test runs.
Command options can only by placed after command.
$ stellar-core convert-id SDQVDISRYN2JXBS7ICL7QJAEKB3HWBJFP2QECXG7GZICAHBK4UNJCWK2
$ stellar-core http-command info
.well-known/stellar-history.jsonfile in the archive root.
--c infofor an offline instance
base64). The private signing key is read from standard input, unless
/dev/tty. In either event, if the signing key appears to be coming from a terminal, stellar-core disables echo. Note that if you do not have a STELLAR_NETWORK_ID environment variable, then before this argument you must specify the --netid option. For example, the production stellar network is “
Public Global Stellar Network ; September 2015” while the test network is “
Test SDF Network ; September 2015”.
--all-versions: run with all possible protocol versions
--version <N>: run tests for protocol version N, can be specified multiple times (default latest)
--base-instance <N>: run tests with instance numbers offset by N, used to run tests in parallel
[tx]using protocol versions 9 and 10 and stop after the first failure:
stellar-core test -a --version 9 --version 10 "[tx]"
By default stellar-core listens for connections from localhost on port 11626. You can send commands to stellar-core via a web browser, curl, or using the --c command line option (see above). Most commands return their results in JSON format.
self-check: Perform history-related sanity checks, and it is planned to support other kinds of sanity checks in the future.
bans List current active bans
checkdb Triggers the instance to perform a background check of the database’s state.
checkpoint Triggers the instance to write an immediate history checkpoint. And uploads it to the archive.
Triggers the instance to connect to peer NAME at port NNN.
Deletes the tracking cursor identified by
Drops peer identified by NODE_ID, when D is 1 the peer is also banned.
info Returns information about the server in JSON format (sync state, connected peers, etc).
Adjust the log level for partition P where P is one of Bucket, Database, Fs, Herder, History, Ledger, Overlay, Process, SCP, Tx (or all if no partition is specified). Level is one of FATAL, ERROR, WARNING, INFO, DEBUG, VERBOSE, TRACE.
logrotate Rotate log files.
Performs maintenance tasks on the instance.
queueperforms deletion of queue data. See
setcursorfor more information.
metrics Returns a snapshot of the metrics registry (for monitoring and debugging purpose).
Clear metrics for a specified domain. If no domain specified, clear all metrics (for testing purposes).
Returns the list of known peers in JSON format.
fullkeys is set, outputs unshortened public keys.
Returns information about the quorum for
NODE_ID (local node by default).
transitive is set, information is for the transitive quorum centered on
NODE_ID, otherwise only for nodes in the quorum set of
NODE_ID is either a full key (
GABCD...), an alias (
$name) or an
abbreviated ID (
compact is set, only returns a summary version.
fullkeys is set, outputs unshortened public keys.
Sets or creates a cursor identified by
ID with value
N. ID is an
uppercase AlphaNum, N is an uint32 that represents the last ledger sequence
number that the instance ID processed. Cursors are used by dependent services
to tell stellar-core which data can be safely deleted by the instance. The
data is historical data stored in the SQL tables such as txhistory or
ledgerheaders. When all consumers processed the data for ledger sequence N
the data can be safely removed by the instance. The actual deletion is
performed by invoking the
maintenance endpoint or on startup. See also
Gets the cursor identified by
ID. If ID is not defined then all cursors
will be returned.
Returns a JSON object with the internal state of the SCP engine for the last n (default 2) ledgers. Outputs unshortened public keys if fullkeys is set.
Submit a transaction to the network. blob is a base64 encoded XDR serialized ‘TransactionEnvelope’, and it returns a JSON object with the following properties status:
1970-01-01T00:00:00Z. It is the time the upgrade will be scheduled for. If it is in the past by less than 12 hours, the upgrade will occur immediately. If it’s more than 12 hours, then the upgrade will be ignored
Starts a survey that will request peer connectivity information from nodes in the backlog.
DURATION is the number of seconds this survey will run
NODE_ID is the public key you will add to the backlog to survey.
Running this command while the survey is running will add the node to the
backlog and reset the timer to run for
DURATION seconds. By default, this
node will respond to/relay a survey message if the message originated
from a node in it’s transitive quorum. This behaviour can be overridden by adding
SURVEYOR_KEYS in the config file, which will be the set of keys to check
instead of the transitive quorum. If you would like to opt-out of this survey mechanism,
$self or a bogus key
Will stop the survey if one is running. Noop if no survey is running
Returns the current survey results. The results will be reset every time a new survey is started
Artificially generate load for testing; must be used with
ARTIFICIALLY_GENERATE_LOAD_FOR_TESTING set to true. Depending on the mode,
either creates new accounts or generates payments on accounts specified
(where number of accounts can be offset). Additionally, allows batching up to
100 account creations per transaction via ‘batchsize’.
When a nonzero I is given, a spike will occur every I seconds injecting S transactions on top of
manualclose If MANUAL_CLOSE is set to true in the .cfg file, this will cause the current ledger to close. If MANUAL_CLOSE is set to false, allows a validating node that is waiting to hear about consensus from the network to force ledger close, and start a new consensus round.
Returns basic information about the account identified by name. Note that N is a string used as seed, but “root” can be used as well to specify the root account used for the test instance.
Injects a payment transaction (or a create transaction if “create” is specified) from the account F to the account T, sending N XLM to the account. Note that F and T are seed strings but can also be specified as “root” as shorthand for the root account for the test instance.