It is not ready yet for production.
Stellar-core is a replicated state machine that maintains a local copy of a cryptographic ledger and processes transactions against it, in consensus with a set of peers. It implements the Stellar Consensus Protocol, a federated consensus protocol. It is written in C++11 and runs on Linux, OSX and Windows. Learn more by reading the overview document.
Documentation of the code's layout and abstractions, as well as for the
functionality available, can be found in
./docs.
See Installation
See Contributing
run tests with:
src/stellar-core --test
run one test with:
src/stellar-core --test testName
run one test category with:
src/stellar-core --test '[categoryName]'
Categories (or tags) can be combined: AND-ed (by juxtaposition) or OR-ed (by comma-listing).
Tests tagged as [.] or [hide] are not part of the default test test.
supported test options can be seen with
src/stellar-core --test --help
display tests timing information:
src/stellar-core --test -d yes '[categoryName]'
xml test output (includes nested section information):
src/stellar-core --test -r xml '[categoryName]'
There are two options. The easiest is to have the test suite just
create a temporary postgreSQL database cluster in /tmp and delete it
after the test. That will happen by default if you run make check.
You can also create a temporary database cluster manually, by running
./src/test/selftest-pg bash to get a shell, then running tests
manually. The advantage of this is that you can examine the database
log in $PGDATA/pg_log/ after running tests, as well as manually
inspect the database with psql.
Finally, you can use an existing database cluster so long as it has
databases named test0, test1, ..., test8, and test. Do set
this up, make sure your PGHOST and PGUSER environment variables
are appropriately set, then run the following from bash:
for i in $(seq 0 8) ''; do
psql -c "create database test$i;"
done
We adopt the convention of tagging a stress-test for subsystem foo as [foo-stress][stress][hide].
Then, running
stellar-core --test [stress]will run all the stress tests,stellar-core --test [foo-stress]will run the stress tests for subsystem foo alone, and- neither
stellar-core --testnorstellar-core --test [foo]will run stress tests.