Eclair supports deterministic builds for the eclair-core submodule, this is the 'core' of the eclair application and its artifact can be deterministically built achieving byte-to-byte equality for each build. To build the exact same artifacts that we release, you must use the build environment (OS, JDK, maven...) that we specify in our release notes.
To build the project and run the tests, simply run:
Other build options
To skip all tests, run:
mvn install -DskipTests
To only build the
eclair-node module, run:
mvn install -pl eclair-node -am -DskipTests
To run the tests, run:
To run tests for a specific class, run:
mvn test -Dsuites=*<TestClassName>
Build the API documentation
The API doc is generated via slate and hosted on github pages. To make a change and update the doc follow the steps:
git checkout slate-doc
- Install your local dependencies for slate, more info here
source/index.html.mdand save your changes.
- Commit all the changes to git, before deploying the repo should be clean.
- Push your commit to remote.
- Wait a few minutes and the doc should be updated at https://acinq.github.io/eclair