https://github.com/ZeroNetX/zeronet-rs
Rust Implementation of ZeroNet Protocol
https://github.com/ZeroNetX/zeronet-rs
actix-web async p2p rust tokio-rs zeronet
Last synced: over 1 year ago
JSON representation
Rust Implementation of ZeroNet Protocol
- Host: GitHub
- URL: https://github.com/ZeroNetX/zeronet-rs
- Owner: ZeroNetX
- License: other
- Created: 2022-03-07T17:35:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T05:54:56.000Z (over 1 year ago)
- Last Synced: 2025-03-06T06:23:38.820Z (over 1 year ago)
- Topics: actix-web, async, p2p, rust, tokio-rs, zeronet
- Language: Rust
- Homepage: https://zeronet.dev
- Size: 640 KB
- Stars: 75
- Watchers: 6
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ZeroNetX
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcanewsin%2Fzeronet-rs?ref=badge_shield)
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](https://github.com/canewsin/zeronet-rs/releases/latest).
## 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](https://github.com/ZeroNetX/zeronet-rs).
### Dependencies
- Install [rustup](https://www.rust-lang.org/tools/install)
- > cd zeronet-rs
- Windows : Install nightly rust toolchain using
> rustup override set nightly-2024-01-24-x86_64-pc-windows-msvc
- `rustc --version` info for other platforms
> rustc 1.77.0-nightly (5d3d3479d 2024-01-23)
Once you have the dependencies installed, you can build ZNX using [Cargo](https://doc.rust-lang.org/cargo/).
For a debug build:
```sh
cargo run
```
For a release build:
```sh
cargo run --release
```
And to run the tests:
```sh
cargo test
```
### Troubleshooting
#### Cargo errors claiming that a dependency is using unstable features
Try `cargo clean` and `cargo build`.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcanewsin%2Fzeronet-rs?ref=badge_large)