https://github.com/civkit/civkit-node
CivKit Node
https://github.com/civkit/civkit-node
Last synced: 11 days ago
JSON representation
CivKit Node
- Host: GitHub
- URL: https://github.com/civkit/civkit-node
- Owner: civkit
- License: other
- Created: 2023-04-21T03:33:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-26T11:00:45.000Z (about 1 year ago)
- Last Synced: 2024-08-02T15:14:14.802Z (9 months ago)
- Language: Rust
- Homepage:
- Size: 231 KB
- Stars: 66
- Watchers: 8
- Forks: 14
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-bolt12 - CivKit - An open-source P2P makertplace use Nostr and Lightning Network (Planned) (Ecosystem / Projects)
README
Civkit Node
===========
https://civkit.org/
About Civkit Node
-----------------
The CivKit Node represents an experimental NIP-01 Rust relay, complemented by ongoing development of communication gateways for BOLT8 Noise transport and BOLT4 sphinx onion routing. Alongside this, there is a companion client binary designed specifically for development and testing purposes.
CivKit Node aims to enable a peer-to-peer electronic market system as described in the [paper](https://github.com/civkit/paper/blob/main/civ_kit_paper.pdf).
This is not production-ready software, please do not use it for real deployment for now.
Development Process
-------------------
The CivKit Node project embraces an open contributor model, inviting individuals to contribute
through peer reviews, documentation, testing, and patches.
If you're new to the project, it's advisable to begin with smaller tasks to get acquainted.
Discussions regarding codebase enhancements take place on GitHub issues and pull requests,
while communication regarding the development of CivKit Node primarily occurs on the CivKit Discord platform.
For more "how-to" on contributing to an open-source in the Bitcoin ecosystem, have a look on
documentation written by experienced Bitcoin protocols developers on [how to make a PR](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md)
and [how to review a PR](https://github.com/jonatack/bitcoin-development/blob/master/how-to-review-bitcoin-core-prs.md).
Building
--------
Install protobuf
```
cargo build
cd target/debug
#run commands above like ./civkitd
```
Tagline
-------
*"Empathy with the users!"*
License
-------
CivKit Node is licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) at your option.