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.
This is not production-ready software, please do not use it for real deployment for now.
There are 3 binaries available:
civkitd: The relay binary accepting Nostr clients and BOLT8 peers connectionscivkit-cli: A utility to manage the servercivkit-sample: An interactive language shell Nostr client for testing and development purposes
As of v0.0.1, the sample can send the following requests to the relay:
sendtextnote content: send a NIP-01 EVENT kind 1 to the relaysetmetadata username about picture: send a NIP-01 EVENT kind 0 to the relayrecommendserver urlrelay: send a NIP-01 EVENT kind 2 to the relayopensubscription subscriptionid kinds since until: send a NIP-01 REQ to the relayclosesubscription subscriptionid: send a NIP-01 to the relay
The civkit-cli is based on gRPC and can send the following requests:
publishnotice: send a demo NIP-01 NOTICE to all the connected clientspublishtextnote: send a demo NIP-01 EVENT kind 1 to all the connected clientsconnectpeer localport: connect to a BOLT8 peer on local port
Opening a subscription and sending basic text note.
./civkitd
./civkit-sample (civkit-sample #1)
Civkit sample startup successful. Enter "help" to view available commands.
> opensubscription helloworld /*kinds*/ 1 /*since*/ 0 /*until*/ 10000000000
>
[EOSE] helloworld
> sendtextnote hola
>
[EVENT] hola
>
/* Second sample connect and subscribes */
[EVENT] bonjour
> recommendserver https://civkit.org
>
./civkit-sample (civkit-sample #2)
Civkit sample startup successful. Enter "help" to view available commands.
> opensubscription helloworld /*kinds*/ 1 */since*/ 0 /*until*/ 1000000000
>
[EOSE] helloworld
>
[EVENT] bonjour
>
/* On logs of civkitd */
[CIVKITD] - INIT: CivKit node starting up...
[CIVKITD] - INIT: noise port 9735 nostr port 50021 cli_port 50031
[CIVKITD] - NET: ready to listen tcp connection for clients !
[CIVKITD] - NET: receive a tcp connection !
[CIVKITD] - NET: incoming tcp Connection from :[::1]:50422
[CIVKITD] - NET: websocket established: [::1]:50422
[CIVKITD] - NOSTR: Message received from 1!
[CIVKITD] - NOSTR: New subscription id 1
[CIVKITD] - NOSTR: Message received from 1!
[CIVKITD] - NET: receive a tcp connection !
[CIVKITD] - NET: incoming tcp Connection from :[::1]:50423
[CIVKITD] - NET: websocket established: [::1]:50423
[CIVKITD] - NOSTR: Message received from 2!
[CIVKITD] - NOSTR: New subscription id 2
[CIVKITD] - NOSTR: Message received from 2!
[CIVKITD] - NOSTR: Message received from 1!
Connecting to a BOLT8 peer on local.
./civkitd (civtkid #1)
./civkitd
./civkitd --noise-port 60001 --nostr-port 60011 --cli-port 60021 (civkitd #2)
./civkit-cli connectpeer 60001
/* On logs of civkitd #1 */
[CIVKITD] - INIT: CivKit node starting up...
[CIVKITD] - INIT: noise port 9735 nostr port 50021 cli_port 50031
[CIVKITD] - NET: ready to listen tcp connection for clients !
[CIVKITD] - CONTROL: sending port to noise gateway !
[CIVKITD] - NOISE: opening outgoing noise connection!
/* On logs of civkitd #2 */
[CIVKITD] - INIT: CivKit node starting up...
[CIVKITD] - INIT: noise port 60001 nostr port 60011 cli_port 60021
[CIVKITD] - NET: ready to listen tcp connection for clients !
[CIVKITD] - NET: inbound noise connection !
Publishing a trade order (BOLT11 version).
./civkitd
./civkit-cli publishinvoice lnbc2500u1pvjluezsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygspp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdq5xysxxatsyp3k7enxv4jsxqzpu9qrsgquk0rl77nj30yxdy8j9vdx85fkpmdla2087ne0xh8nhedh8w27kyke0lp53ut353s06fv3qfegext0eh0ymjpf39tuven09sam30g4vgpfna3rh
./civkit-sample
/* On logs of civkitd */
[CIVKITD] - INIT: CivKit node starting up...
[CIVKITD] - INIT: noise port 9735 nostr port 50021 cli_port 50031
[CIVKITD] - NET: ready to listen tcp connection for clients !
[CIVKITD] - NET: receive a tcp connection !
[CIVKITD] - NET: incoming tcp Connection from :[::1]:50911
[CIVKITD] - NET: websocket established: [::1]:50911
[CIVKITD] - PROCESSING: received an event from service manager
[CIVKITD] - NOSTR: sending event for client 1
/* On logs of civkit-sample */
Civkit sample startup successful. Enter "help" to view available commands
>
[EVENT] new trade offer: lnbc1pj2aey9dpzfpjhyefqvys8gunpv3jjq6twwehkjcm9yypp5qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqsp59g4z52329g4z52329g4z52329g4z52329g4z52329g4z52329g4q9qrsgqcqzysk7er2zn07fwp0drlja8lf9lrre28qutvkqg4mrt8aa3y7kr33qhyfp903uyhtzlngv7a0yyg7kmx9alvejzk970p7834djwzxz60eggqt6upps
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 and how to review a PR.
Install protobuf
cargo build
cd target/debug
#run commands above like ./civkitd
"Empathy with the users!"
CivKit Node is licensed under Apache 2.0 or MIT at your option.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent