MCPcopy Index your code
hub / github.com/civkit/civkit-node

github.com/civkit/civkit-node @v0.0.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.0.2 ↗ · + Follow
161 symbols 241 edges 25 files 9 documented · 6%
What it actually does AI analysis from the code graph — generated when you open this
loading…
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.

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 and how to review a PR.

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 or MIT at your option.

Extension points exported contracts — how you extend this code

EventsProvider (Interface)
(no doc)
src/events.rs

Core symbols most depended-on inside this repo

send
called by 39
src/mainstay.rs
run
called by 7
src/peerhandler.rs
call
called by 3
src/rpcclient.rs
write_new_event_db
called by 2
src/nostr_db.rs
query_events_db
called by 2
src/nostr_db.rs
get_cumulative_hash_of_last_event
called by 2
src/nostr_db.rs
get_user_pass
called by 1
src/rpcclient.rs
is_our_id
called by 1
src/lib.rs

Shape

Method 74
Class 43
Function 33
Enum 10
Interface 1

Languages

Rust100%

Modules by API surface

src/server.rs21 symbols
src/nostr_db.rs17 symbols
src/credentialgateway.rs17 symbols
src/sample.rs15 symbols
src/lib.rs10 symbols
src/config.rs9 symbols
src/bitcoind_client.rs8 symbols
src/mainstay.rs7 symbols
src/rpcclient.rs6 symbols
src/peerhandler.rs6 symbols
src/util.rs5 symbols
src/oniongateway.rs5 symbols

For agents

$ claude mcp add civkit-node \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page