https://github.com/gonative-cc/bitcoin-lightclient

Native Bitcoin Lightclienet
https://github.com/gonative-cc/bitcoin-lightclient

Last synced: about 1 year ago
JSON representation

Native Bitcoin Lightclienet

• Host: GitHub
• URL: https://github.com/gonative-cc/bitcoin-lightclient
• Owner: gonative-cc
• License: mpl-2.0
• Created: 2024-09-12T21:06:32.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2025-03-17T22:25:21.000Z (over 1 year ago)
• Last Synced: 2025-03-24T15:52:20.611Z (about 1 year ago)
• Language: Go
• Size: 306 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


# Bitcoin Light Client

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#wip)

[![GoDoc](https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go)](https://godoc.org/github.com/gonative-cc/bitcoin-lightclient)

[![Go Report Card](https://goreportcard.com/badge/github.com/gonative-cc/bitcoin-lightclient?style=flat-square)](https://goreportcard.com/report/github.com/gonative-cc/bitcoin-lightclient)

[![Version](https://img.shields.io/github/tag/gonative-cc/bitcoin-lightclient.svg?style=flat-square)](https://github.com/gonative-cc/bitcoin-lightclient)

[![License: MPL-2.0](https://img.shields.io/github/license/gonative-cc/bitcoin-lightclient.svg?style=flat-square)](https://github.com/gonative-cc/bitcoin-lightclient/blob/main/LICENSE)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/gonative-cc/contributig/blob/master/CODE_OF_CONDUCT.md)

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](https://github.com/gonative-cc/contributig) 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](./SECURITY.md) for security concerns.

## Setup

1. Make sure you have `go`, `make` installed

1. 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`