Icon LinkWASM Modules

WebAssembly (WASM) modules are compiled binaries that are registered into a Fuel indexer at runtime. The WASM bytes are read in by the indexer and executors are created which will implement blocking calls to the WASM runtime.

The WASM module is generated based on your manifest, schema, and your lib.rs file.

Icon Linklib.rs

You can implement the logic for handling events and saving data to the database in your lib.rs file in the src folder.

Here, you can define which functions handle different events based on the function parameters. If you add a function parameter of a certain type, the function will handle all blocks, transactions, or transaction receipts that contain a matching type.

We can look at the function below as an example:

fn index_logged_greeting(greeter: Greeting) {
    // function logic goes here
}

All transactions that have a receipt that contains data with a type of Greeting will be handled by the function.

You can learn more about what data can be indexed in the Indexing section.

To save an instance of a schema type in your database, you can call the save method on the instance.

instance.save();

Icon LinkUsage

To compile your indexer code to WASM, you'll first need to install the wasm32-unknown-unknown target platform through rustup, if you haven't done so already.

rustup add target wasm32-unknown-unknown

After that, you would compile your indexer code by navigating to the root folder for your indexer code and build. An example of this can be found below:

cd /my/index-lib && cargo build --release

Icon LinkNotes on WASM

There are a few points that Fuel indexer users should know when using WASM:

1. WASM modules are only used if the execution mode specified in your manifest file is wasm.

2. Developers should be aware of what things may not work off-the-shelf in a module: file I/O, thread spawning, and anything that depends on system libraries. This is due to the technological limitations of WASM as a whole; more information can be found here Icon Link.

3. As of this writing, there is a small bug in newly built Fuel indexer WASM modules that produces a WASM runtime error due to an errant upstream dependency. For now, a quick workaround requires the use of wasm-snip to remove the errant symbols from the WASM module. More info can be found in the related script here Icon Link.

4. Users on Apple Silicon macOS systems may experience trouble when trying to build WASM modules due to its clang binary not supporting WASM targets. If encountered, you can install a binary with better support from Homebrew (brew install llvm) and instruct rustc to leverage it by setting the following environment variables:

• AR=/opt/homebrew/opt/llvm/bin/llvm-ar
• CC=/opt/homebrew/opt/llvm/bin/clang