https://github.com/filecoin-station/zinnia

Runtime for worker nodes executing modules in a resource-limited sandbox
https://github.com/filecoin-station/zinnia

deno ipfs isolates javascript libp2p runtime

Last synced: 26 days ago
JSON representation

Runtime for worker nodes executing modules in a resource-limited sandbox

• Host: GitHub
• URL: https://github.com/filecoin-station/zinnia
• Owner: filecoin-station
• License: other
• Created: 2023-01-16T07:16:56.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T04:29:48.000Z (7 months ago)
• Last Synced: 2024-04-12T12:11:53.575Z (7 months ago)
• Topics: deno, ipfs, isolates, javascript, libp2p, runtime
• Language: Rust
• Homepage: https://crates.io/crates/zinnia
• Size: 1.05 MB
• Stars: 15
• Watchers: 3
• Forks: 2
• Open Issues: 54
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


	


	 🌼

	


	


	Zinnia

	


	


	




> A sandboxed and resource-limited runtime for distributed workers.

>

> Powering 🛰️ [Filecoin Station](https://github.com/filecoin-station/filecoin-station).

## Installation

See [CLI Installation](./cli/README.md#installation).

## Basic use

```js

while (true) {

  const start = new Date();

  const res = await fetch(

    "https://ipfs.io/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi/",

  );

  console.log(`TTFB: ${new Date() - start}ms`);

  await new Promise((resolve) => setTimeout(resolve, 1000));

}

```

```bash

$ zinnia run example.js

TTFB: 235ms

...

```

See also [example modules](./examples).

## API

See [Building Modules](./docs/building-modules.md).

## Architecture

![](./docs/images/runtime-diagram.png)

### Components

- **JS/WASM engine:** [deno_core](https://crates.io/crates/deno_core), see the decision record for

  [Switching to Deno Core](docs/architecture-decision-records/2023-01-switching-to-deno-core.md)

- **Non-blocking I/O:** [Async Rust](https://rust-lang.github.io/async-book/),

  [Tokio](https://tokio.rs)

- **Networking**: [deno_fetch](https://crates.io/crates/deno_fetch),

  [rust-libp2p](https://github.com/libp2p/rust-libp2p)

- **IPFS:** [Rusty Lassie](https://github.com/filecoin-station/rusty-lassie) for retrievals. _TBD:

  Publish content to IPFS_

- **Block (K/V) storage:** _TBD_

## Contributing

The [roadmap](https://www.notion.so/pl-strflt/Zinnia-Roadmap-b849d322502f4c079525cd8cc887df02) and

[issue tracker](https://github.com/filecoin-station/zinnia/issues) are great places to check out for

your first time to contribute! You can also look up some past decisions in

[docs/architecture-decisions-records/](docs/architecture-decision-records/).

If you see something broken or missing, please

[create a new issue](https://github.com/filecoin-station/zinnia/issues/new).

Finally, don't forget to stop by and **say hi** :wave: in #filecoin-station-module-builders-wg on

[Filecoin Slack](https://filecoin.io/slack)!

## Fun fact

Zinnia was

[named after the first flower to blossom in space](https://www.nasa.gov/image-feature/first-flower-grown-in-space-stations-veggie-facility).