80 releases (30 breaking)

0.36.0 Apr 15, 2024
0.35.2 Mar 27, 2024
0.35.1 Feb 29, 2024
0.31.0 Dec 14, 2023
0.1.12 Nov 9, 2020

#1217 in Magic Beans

Download history 431/week @ 2024-03-13 296/week @ 2024-03-20 300/week @ 2024-03-27 282/week @ 2024-04-03 279/week @ 2024-04-10 219/week @ 2024-04-17 176/week @ 2024-04-24 89/week @ 2024-05-01 246/week @ 2024-05-08 521/week @ 2024-05-15 448/week @ 2024-05-22 389/week @ 2024-05-29 293/week @ 2024-06-05 73/week @ 2024-06-12 142/week @ 2024-06-19 133/week @ 2024-06-26

779 downloads per month
Used in 11 crates (7 directly)

Apache-2.0

200KB
3.5K SLoC

Marine

marine version on crates.io Coverage Status

Marine is a modern general purpose Wasm runtime based on the component model capable of running multi-module Wasm applications, aka services, with interface-types and a shared-nothing linking scheme. This execution model is well suited for a variety of scenarios and especially applicable to implementations following the entity component system (ECS) pattern or plugin-based architectures.

Fluence peers, such as Fluence Rust node, include Marine to execute the hosted Wasm services composed with Aqua.

Motivational example

To illustrate the capabilities of Marine, let's have a look at a multi-module Wasm service as implemented in this example.

cd into the examples/motivational-example directory and have a look at the shrek/src/main.rs file:

// examples/motivational-example/shrek/src/main.rs
use marine_rs_sdk::marine;

fn main() {}

#[marine]
pub fn greeting(name: &str) -> Vec<String> {
    let donkey_greeting = donkey::greeting(name);         // 1
    let shrek_greeting = format!("Shrek: hi, {}", name);  // 2
    
    vec![shrek_greeting, donkey_greeting]                 
}

mod donkey {                                               // 3
    use super::*;

    #[marine]
    #[link(wasm_import_module = "donkey")]                 // 4
    extern "C" {
        pub fn greeting(name: &str) -> String;
    }
}

In this Marine (Wasm) module (and namespace) shrek, we declare a function greeting that creates a donkey_greeting (1) from the donkey module's (3)greeting function, which itself is dependent on importing the donkey Wasm module with Rust's FFI link (4) from donkey/src/main.rs (see below).

// examples/motivational-example/donkey/src/main.rs
use marine_rs_sdk::marine;

fn main() {}

#[marine]
pub fn greeting(name: &str) -> String {
    format!("Donkey: hi, {}", name)
}

In summary, our example is comprised of two independent Wasm modules, shrek and donkey, and illustrates how to link one module into another one, i.e., use the donkey module in the shrek module. Please note that the shrek module is called a facade module following the facade pattern and there can only be one facade module per service.

Make sure you have the Marine tools installed and compile the donkey and shrek, respectively, which we can do with the build.sh script:

$> ./build.sh

which creates two independent Wasm modules that are placed in the artifacts directory:

$> ls artifacts
donkey.wasm    shrek.wasm

Now that we have our modules, we can explore them with the Marine REPL. Note that we use the Config.toml file to help out the REPL by providing the module location and names. Once we got the REPL up and running, we can interact with both modules and, as expected, the shrek module is successfully able to access the donkey module's exposed functions.

$> marine repl Config.toml
...
1> interface
Loaded modules interface:

shrek:
  fn greeting(name: string) -> []string
donkey:
  fn greeting(name: string) -> string

2> call donkey greeting "no link module"
result: "Donkey: hi, no link module"
 elapsed time: 42.985µs

3> call shrek greeting "facade with link module"
result: [
  "Shrek: hi, facade with link module",
  "Donkey: hi, facade with link module"
]
 elapsed time: 39.25µs

4> q

Looks like everything is in order and the modules are ready for deployment to the network and composition with Aqua.

Documentation

Do not forget to check our YouTube channel.

Repository structure

  • crates
  • examples: several Marine examples used mostly for tests
  • fluence-faas: a Fluence FaaS layer that provides host closures, IT<->JSON conversion, logger, config handling and other things
  • fluence-app-service: a Fluence Application Service layer that provides basic API for service running
  • runtime: a runtime layer that provides basic functionality for loading, unloading and calling modules
  • marine-js: a web runtime layer aimed to run Marine in a browser
  • tools
    • REPL: a REPL intended to test Marine Wasm modules
    • CLI: a CLI intended to build and extract some info from Marine Wasm modules

Support

Please, file an issue if you find a bug. You can also contact us at Discord or Telegram. We will do our best to resolve the issue ASAP.

Contributing

Any interested person is welcome to contribute to the project. Please, make sure you read and follow some basic rules.

License

All software code is copyright (c) Fluence Labs, Inc. under the Apache-2.0 license.

Dependencies

~37–49MB
~873K SLoC