WebNative FileSystem (WNFS)

_{⚠️ Work in progress ⚠️}

This is a Rust implementation of the WebNative FileSystem (WNFS) specification. WNFS is a versioned content-addressable distributed filesystem with private and public sub systems. The private filesystem is encrypted so that only users with the right keys can access its contents. It is designed to prevent inferring metadata like the structure of the file tree. The other part of the WNFS filesystem is a simpler public filesystem that is not encrypted and can be accessed by anyone with the right address.

WNFS also features collaborative editing of file trees, where multiple users can edit the same tree at the same time.

WNFS file trees can serialize and be deserialized from IPLD graphs with an extensible metadata section. This allows WNFS to be understood by other IPLD-based tools and systems.

This library is designed with WebAssembly in mind. You can follow instructions on how to use it in your browser applications here.

Outline

• Crates
• Building the Project
• Usage
• Testing the Project
• Contributing
• Getting Help
• External Resources
• License

Crates

• wnfs
• wnfs-wasm

Building the Project

REQUIREMENTS

• The Rust Toolchain

  Follow the instructions here to install the official Rust toolchain.

• The WebAssembly Toolchain

  If you are interested in compiling the project for WebAssembly, you can follow the instructions below.

  Read more

  • Install wasm32-unknown-unknown target

    rustup target add wasm32-unknown-unknown

  • rust-analyzer is the go-to IDE tool for Rust and if you have it set up, you may want to set the rust-analyzer.cargo.target setting to wasm32-unknown-unknown

  • Install wasm-pack

    cargo install wasm-pack

  • Install playwright binaries

    npx playwright install

  Architecture-specifics

  • On ARM-based (M1 family) macOS, you might need to explicitly install the following:

    • Install wasm-bindgen

      cargo install -f wasm-bindgen-cli

    • Install wasm-opt

      brew install binaryen

  • On Arch Linux based distributions, you might need to explicitly install the following:

    • Install wasm-opt

      sudo pacman -S binaryen

• The rs-wnfs Command

  You can optionally set up the rs-wnfs script.

  Read more

  • Install it using the following command:

    sh ./scripts/rs-wnfs.sh setup

  • This lets you run the rs-wnfs.sh script as a command.

    rs-wnfs help

STEPS

• Clone the repository.

  git clone https://github.com/wnfs-wg/rs-wnfs.git

• Change directory

  cd rs-wnfs

• Build the project

  Check REQUIREMENTS on how to set up the rs-wnfs command.

  scripts/rs-wnfs build --all

• You can also build for specific crates

  scripts/rs-wnfs build --wasm

Usage

WNFS does not have an opinion on where you want to persist your content or the file tree. Instead, the API expects any object that implements the async BlockStore interface. This implementation also defers system-level operations to the user; requiring that operations like time and random number generation be passed in from the interface. This makes for a clean wasm interface that works everywhere.

Let's see an example of working with a public directory. Here we are going to use the memory-based blockstore provided by the library.

use wnfs::{MemoryBlockStore, PublicDirectory};
use chrono::Utc;
use std::rc::Rc;

#[async_std::main]
async fn main() {
    // Create a new public directory.
    let dir = &mut Rc::new(PublicDirectory::new(Utc::now()));

    // Create a memory-based blockstore.
    let store = &mut MemoryBlockStore::default();

    // Add a /pictures/cats subdirectory.
    dir
        .mkdir(&["pictures".into(), "cats".into()], Utc::now(), store)
        .await
        .unwrap();

    // Store the the file tree in the memory blockstore.
    root_dir.store(store).await.unwrap();

    // Print root directory.
    println!("{:#?}", root_dir);
}

You may notice that we store the root_dir returned by the mkdir operation, not the dir we started with. That is because WNFS internal state is immutable and every operation potentially returns a new root directory. This allows us to track and rollback changes when needed. It also makes collaborative editing easier to implement and reason about. You can find more examples in the wnfs/examples/ folder. And there is a basic demo of the filesystem immutability here.

The private filesystem, on the other hand, is a bit more involved. Hash Array Mapped Trie (HAMT) is used as the intermediate format of private file tree before it is persisted to the blockstore. Our use of HAMTs obfuscate the file tree hierarchy.

use wnfs::{
    private::PrivateForest, MemoryBlockStore, Namefilter, PrivateDirectory,
};
use chrono::Utc;
use rand::thread_rng;
use std::rc::Rc;

#[async_std::main]
async fn main() {
    // Create a memory-based blockstore.
    let store = &mut MemoryBlockStore::default();

    // A random number generator the private filesystem can use.
    let rng = &mut thread_rng();

    // Create a private forest.
    let forest = &mut Rc::new(PrivateForest::new());

    // Create a new private directory.
    let dir = &mut Rc::new(PrivateDirectory::new(
        Namefilter::default(),
        Utc::now(),
        rng,
    ));

    // Add a file to /pictures/cats directory.
    dir
        .mkdir(
            &["pictures".into(), "cats".into()],
            true,
            Utc::now(),
            forest,
            store,
            rng,
        )
        .await
        .unwrap();

    // Add a file to /pictures/dogs/billie.jpg file.
    dir
        .write(
            &["pictures".into(), "dogs".into(), "billie.jpeg".into()],
            true,
            Utc::now(),
            b"hello world".to_vec(),
            forest,
            store,
            rng,
        )
        .await
        .unwrap();

    // List all files in /pictures directory.
    let result = dir
        .ls(&["pictures".into()], true, forest, store)
        .await
        .unwrap();

    println!("Files in /pictures: {:#?}", result);
}

Namefilters are currently how we identify private node blocks in the filesystem. They have nice properties, one of which is the ability to check if one node belongs to another. This is necessary in a filesystem where metadata like hierarchy needs to be hidden from observing agents. One notable caveat with namefilters is that they can only reliably store information of a file tree 47 levels deep or less so there is a plan to replace them with other cryptographic accumlators in the near future.

Check the wnfs/examples/ folder for more examples.

Testing the Project

• Run all tests

  scripts/rs-wnfs test --all

• Show code coverage

  scripts/rs-wnfs coverage

• Run benchmarks

  scripts/rs-wnfs bench

  You can also find a nice graph of the CI benchmarks here.

Contributing

Pre-commit Hook

This library recommends using pre-commit for running pre-commit hooks. Please run this before every commit and/or push.

• Once installed, Run pre-commit install to setup the pre-commit hooks locally. This will reduce failed CI builds.
• If you are doing interim commits locally, and for some reason if you don't want pre-commit hooks to fire, you can run git commit -a -m "Your message here" --no-verify.

Conventional Commits

This project lightly follows the Conventional Commits convention to help explain commit history and tie in with our release process. The full specification can be found here. We recommend prefixing your commits with a type of fix, feat, docs, ci, refactor, etc..., structured like so:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Getting Help

For usage questions, usecases, or issues reach out to us in our Discord webnative-fs channel. We would be happy to try to answer your question or try opening a new issue on Github.

License

This project is licensed under the Apache License 2.0.