MCPcopy Index your code
hub / github.com/ZeroNetX/zeronet-rs

github.com/ZeroNetX/zeronet-rs @v0.3.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.3.1 ↗ · + Follow
705 symbols 1,645 edges 70 files 29 documented · 4% updated 14mo agov0.3.1 · 2025-04-27★ 8410 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

ZeroNetX

FOSSA Status

Rust Implementation of ZeroNet Protocol

Currently This Repo is open to Code Reviews/Security Audit/Best Code Practice Suggestions. You can freely review and suggest your opinions to us.

Features:

  • Site Create => Create New Site
  • Site Download => Download Site from internet peers
  • Site Need File => Download Site Single(Inner) File from peers
  • Find Peers via Trackers => Discover Peers using torrent tracker network
  • Site Sign => sign changes in site files
  • Site Verify => verify content file hashes with files
  • PeerExchange => Get more peers from connected peers
  • PeerPing => Get peer alive status
  • dbRebuild => Build db from data files using dbschema.json
  • dbQuery => Sql Query on built db to fetch data
  • getConfig => Client Config data

Available Commands:

  • siteCreate
  • siteDownload
  • siteNeedFile
  • siteFindPeers
  • sitePeerExchange
  • siteFetchChanges
  • siteSign
  • siteVerify
  • peerPing
  • dbRebuild
  • dbQuery
  • getConfig

pass -s "Your Site Address" for above commands

Download :

Latest Packages Available on Github Releases.

Usage :

Window :

zeronet.exe siteDownload -s "1HELLoE3sFD9569CLCbHEAVqvqV7U2Ri9d"

Linux/Mac :

./zeronet siteDownload -s "1HELLoE3sFD9569CLCbHEAVqvqV7U2Ri9d"

You may need to give exec permission on Linux/Mac OS

chmod +x zeronet

and rerun the cmd

Building ZeroNetX

Repository

Clone the ZNX repository.

Dependencies

  • Install rustup

  • cd zeronet-rs

  • Windows : Install nightly rust toolchain using

    rustup override set nightly-2025-04-26-x86_64-pc-windows-msvc

  • rustc --version info for other platforms

rustc 1.88.0-nightly (b4c8b0c3f 2025-04-25)

Once you have the dependencies installed, you can build ZNX using Cargo.

For a debug build:

cargo run

For a release build:

cargo run --release

And to run the tests:

cargo test

Troubleshooting

Cargo errors claiming that a dependency is using unstable features

Try cargo clean and cargo build.

License

FOSSA Status

Extension points exported contracts — how you extend this code

SiteIO (Interface)
(no doc) [1 implementers]
src/core/io.rs
UserIO (Interface)
(no doc) [1 implementers]
src/core/io.rs
ContentMod (Interface)
(no doc) [1 implementers]
src/core/io.rs
Discovery (Interface)
(no doc) [1 implementers]
src/core/discovery.rs

Core symbols most depended-on inside this repo

get
called by 135
src/controllers/sites.rs
$
called by 90
assets/media/all.js
g
called by 40
assets/media/all.js
w
called by 39
assets/media/all.js
respond
called by 39
src/plugins/websocket/request.rs
bind
called by 36
assets/media/all.js
address
called by 33
src/core/peer.rs
cmd
called by 31
src/plugins/websocket/mod.rs

Shape

Function 383
Method 230
Class 72
Enum 16
Interface 4

Languages

Rust72%
TypeScript28%

Modules by API surface

assets/media/all.js101 symbols
assets/media/lib/00-jquery.min.js92 symbols
src/core/user.rs53 symbols
src/plugins/websocket/handlers/sites.rs28 symbols
src/controllers/sites.rs28 symbols
src/plugins/websocket/mod.rs24 symbols
src/io/db.rs24 symbols
src/io/site.rs23 symbols
src/core/site.rs20 symbols
src/plugins/site_server/handlers/sites.rs19 symbols
src/core/peer.rs18 symbols
src/io/content.rs14 symbols

For agents

$ claude mcp add zeronet-rs \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact