Rust implementation of NextGraph, a Decentralized and local-first web 3.0 ecosystem https://nextgraph.org

8.6 KiB

Raw Blame History

Contributors or compilation guide

Install Rust minimum required MSRV 1.74.0
Install Nodejs
Install LLVM

On OpenBSD, for LLVM you need to choose llvm-17.

Until this PR is accepted, will have to install wasm-pack this way:

cargo install wasm-pack --git https://github.com/rustwasm/wasm-pack.git --rev c2b663f25abe50631a236d57a8c6d7fd806413b2

cargo install cargo-watch
cargo install cargo-run-script
// optionally, if you want a Rust REPL: cargo install evcxr_repl
git clone git@git.nextgraph.org:NextGraph/nextgraph-rs.git
// or if you don't have a git account with us: git clone https://git.nextgraph.org/NextGraph/nextgraph-rs.git
cd nextgraph-rs
npm install -g pnpm
cd ng-sdk-js
cargo run-script app
npm install --no-save pkg
cd ../ng-app
pnpm install
pnpm webfilebuild
cd ..

For building the native apps, see the ng-app/README

First run

The current directory will be used to save all the config, keys and storage data. If you prefer to change the base directory, use the argument --base [PATH] when using ngd and/or ngcli.

// runs the daemon in one terminal
cargo run -p ngd -- -vv --save-key -l 14400

If you are developing also the front-end, you should run it with this command in a separate terminal:

cd ng-app
pnpm webdev

In the logs/output of ngd, you will see an invitation link that you should open in your web browser. If there are many links, choose the one that starts with http://localhost:, and if you run a local front-end, replace the prefix http://localhost:14400/ with http://localhost:1421/ before you open the link in your browser.

The computer you use to open the link should have direct access to the ngd server on localhost. In most of the cases, it will work, as you are running ngd on localhost. If you are running ngd in a docker container, then you need to give access to the container to the local network of the host by using docker run --network="host". see more here https://docs.docker.com/network/drivers/host/

Follow the steps on the screen to create your wallet :)

Once your ngd server will run in your dev env, replace the string in nextgraph/src/local_broker_dev_env.rs with the actual PEER ID of your ngd server that is displayed when you first start ngd, with a line starting with INFO ngd] PeerId of node:.

Using ngcli with the account you just created

The current directory will be used to save all the config, keys and storage data. If you prefer to change the base directory, use the argument --base [PATH] when using ngd and/or ngcli.

PEER_ID_OF_SERVER is displayed when you first start ngd, with a line starting with INFO ngd] PeerId of node:.

THE_PRIVATE_KEY_OF_THE_USER_YOU_JUST_CREATED can be found in the app, after you opened your wallet, click on the logo of NextGraph, and you will see the User Panel. Click on Accounts and you will find the User Private Key.

By example, to list all the admin users :

cargo run -p ngcli -- --save-key --save-config -s 127.0.0.1,14400,<PEER_ID_OF_SERVER> -u <THE_PRIVATE_KEY_OF_THE_USER_YOU_JUST_CREATED> admin list-users -a

Adding more accounts and wallets

In your dev env, if you want to create more wallets and accounts, you have 2 options:

creating an invitation link from the admin account

cargo run -p ngcli -- -s 127.0.0.1,14400,<PEER_ID_OF_SERVER> -u <THE_PRIVATE_KEY_OF_THE_USER_YOU_JUST_CREATED> admin add-invitation --notos

and then open the link after replacing the port number from 14400 to 1421 (if you are running the front-end in development mode).

run a local instance of ngaccount. this is useful if you want to test or develop the ngaccount part of the flow..

See the README of ngaccount here.

Then you need to stop your ngd and start it again with the additional option :

--registration-url="http://127.0.0.1:5173/#/create"

Packages

The crates are organized as follow :

nextgraph : Client library. Use this crate to embed NextGraph client in your Rust application
ngcli : CLI tool to manipulate the local documents and repos and administrate the server
ngd : binary executable of the daemon (that can run a broker, verifier and/or Rust services)
ng-app : all the native apps, based on Tauri, and the official web app.
ng-sdk-js : contains the JS SDK, with example for: web app, react app, or node service.
ng-sdk-python : contains the Python SDK.
ng-repo : Repositories common library
ng-net : Network common library
ng-oxigraph : Fork of OxiGraph. contains our CRDT of RDF
ng-verifier : Verifier library, that exposes the document API to the app
ng-wallet : keeps the secret keys of all identities of the user in a safe wallet
ng-broker : Core and Server Broker library
ng-client-ws : Websocket client library
ng-storage-rocksdb : RocksDB backed stores. see also dependency repo here
ngone : server for nextgraph.one. helps user bootstrap into the right app. Not useful to you. Published here for transparency
ngaccount : server for nextgraph's Broker Service Provider account manager. Not useful to you. Published here for transparency

Test

Please test by following this order (as we need to generate some files locally)

cargo test --package nextgraph -r --lib -- local_broker::test::gen_wallet_for_test --show-output --nocapture
cargo test -r
cargo test --package nextgraph -r --lib -- local_broker::test::import_session_for_test_to_disk --show-output --nocapture --ignored

Test a single crate:

cargo test --package ng-repo --lib --  --show-output --nocapture
cargo test --package ng-wallet --lib --  --show-output --nocapture
cargo test --package ng-verifier --lib --  --show-output --nocapture
cargo test --package ng-sdk-js --lib --  --show-output --nocapture
cargo test --package ng-broker --lib --  --show-output --nocapture
cargo test --package ng-client-ws --lib --  --show-output --nocapture

Test WASM websocket

First you need to install the chromedriver that matches your version of Chrome

https://googlechromelabs.github.io/chrome-for-testing/

then:

cd ng-sdk-js
wasm-pack test --chrome --headless

Test Rust websocket

cargo test --package ng-client-ws --lib -- remote_ws::test::test_ws --show-output --nocapture

Build release binaries

First you will need to have the production build of the frontend. If you do not want to setup a whole development environment for the frontend, you can use the precompiled release of the frontend available in dist-file.tar.gz that you can download from the release page.

cd ng-app
tar -xzf dist-file.tar.gz
cd ..

Otherwise, build from source the single-file release of ng-app

cargo install cargo-run-script
npm install -g pnpm
cd ng-sdk-js
cargo run-script app
npm install --no-save pkg
cd ../ng-app
pnpm install
pnpm webfilebuild
cd ..

then build the ngd daemon

cargo build -r -p ngd

you can then find the binary ngd in target/release

The CLI tool can be obtained with :

cargo build -r -p ngcli

you can then use the binary target/release/ngcli

For usage, see the documentation here.

For building the apps, see this documentation.

OpenBSD

On OpenBSD, a conflict between the installed LibreSSL library and the reqwest crate, needs a bit of attention. Before compiling the daemon for OpenBSD, please comment out lines 41-42 of ng-net/Cargo.toml. This will be solved soon by using resolver = "2".

#[target.'cfg(target_arch = "wasm32")'.dependencies]
#reqwest = { version = "0.11.18", features = ["json","native-tls-vendored"] }

to use the app on OpenBSD, you need to run the daemon locally.

ngd -l 14400 --save-key

then open chrome (previously installed with doas pkg_add chrome)

env ENABLE_WASM=1 chrome --enable-wasm --process-per-site --new-window --app=http://localhost:14400

Generate documentation

Generate documentation for all packages without their dependencies:

cargo doc --no-deps

The generated documentation can be found in target/doc/nextgraph.

Contributions license

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as below, without any additional terms or conditions.

8.6 KiB Raw Blame History