Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Build for Wasm

We offer several ways to use Wasm Rings, including:

  1. Using Rings SDK
  2. Using Rings Browser Extension
  3. Build your custom-rings

Rings SDK

To fetch the SDK from npm, just:

npm i @ringsnetwork/rings-node

If you want to use the latest version of Rings Network, you can also directly incorporate the latest version or a specific branch of Rings Network into your Node.js project by modifying the package.json file. For example:

# package.json
"@ringsnetwork/rings-node": "https://github.com/RingsNetwork/rings.git#master",

As a developer, if you want to build local offline dependencies, you can do the following.

```text
"@ringsnetwork/rings-node": "git+file:../rings#master",

Note: The reason for using a git path instead of a local path is that npm, after a certain version, no longer executes the prepare script in local path packages, and the package relies on the prepare script to help with wasm compilation.

Rings Browser Extension

The browser extension is the repository’s frontend packaged as a Chrome Manifest V3 extension; Browser Node and Extension covers the hosted console and the packaging steps.

Custom Build

To build Rings Network for WebAssembly, run the following commands:

cargo build --release --target wasm32-unknown-unknown --no-default-features --features browser
wasm-bindgen --out-dir pkg --target web ./target/wasm32-unknown-unknown/release/rings_node.wasm

Or build with wasm-pack

wasm-pack build --scope ringsnetwork -t web --no-default-features --features browser --features console_error_panic_hook

For core-only development, cargo wasm and cargo test-wasm select rings-core with its wasm feature and no default features. Both aliases work from the repository root or crates/core. The root .cargo/config.toml also supplies the WASM test runner and timeout to both locations.

Rings Network

A peer-to-peer network for the sovereign age. Browser tabs and native daemons join one overlay, find each other by DID, and talk over direct WebRTC datachannels routed by a Chord DHT.

License
The Rings source code is released under the GNU Affero General Public License, version 3.0 only (AGPL-3.0-only). Works derived from it, including services that offer it over a network, must be released under the same license.
Commercial use
Commercial use is permitted only on the AGPL's terms: products and hosted services built on Rings must publish their source. A commercial license for use outside those terms is available from Rings Network on request. The Rings Network name, logo, and the hosted rings.rs service are not covered by the license.
No warranty
The software and this site are provided as is, without warranty of any kind, express or implied, as set out in sections 15 and 16 of the AGPL.
Security boundary
DID authentication proves control of a key. It is not Sybil or eclipse resistance for permissionless membership; read the threat model before deploying.
Privacy
rings.rs is a static site: no accounts, no analytics, no tracking cookies. Browser-node settings are kept in your browser's local storage.
© 2021–2026 Rings Network AGPL-3.0-only · Built with Rust, mdBook, and WebAssembly