Skip to content

README.md

Latest commit

 

History

History
37 lines (23 loc) · 2.03 KB

README.md

File metadata and controls

37 lines (23 loc) · 2.03 KB

Bitcoin Light Client

Project Status: Active – The project has reached a stable, usable state and is being actively developed. GoDoc Go Report Card Version License: MPL-2.0 Contributor Covenant

Bitcoin Light Client for Native chain.

Contributing

Participating in open source is often a highly collaborative experience. We’re encouraged to create in public view, and we’re incentivized to welcome contributions of all kinds from people around the world.

Check out contributing repo for our guidelines & policies for how to contribute. Note: we require DCO! Thank you to all those who have contributed!

After cloning the repository, make sure to run make setup-hooks.

Security

Check out SECURITY.md for security concerns.

Setup

  1. Make sure you have go, make installed
  2. Build the project: make build

To build and start you can run: make build start

Running as a docker container

  1. Build the image docker build -t bitcoin-lightclient .
  2. Run the container docker run -e DATA_FILE_PATH=/custom/path/data.json bitcoin-lightclient