https://github.com/polyphene/fvm-rs-sdk

Repository for the development of the Rust SDK to build FVM actors
https://github.com/polyphene/fvm-rs-sdk

Last synced: about 2 months ago
JSON representation

Repository for the development of the Rust SDK to build FVM actors

• Host: GitHub
• URL: https://github.com/polyphene/fvm-rs-sdk
• Owner: polyphene
• License: other
• Created: 2022-07-22T15:11:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-22T08:37:35.000Z (over 2 years ago)
• Last Synced: 2024-08-02T03:01:25.157Z (5 months ago)
• Language: Rust
• Size: 239 KB
• Stars: 14
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

• awesome-filecoin - fvm-rs-sdk - FVM Rust SDK for building actors (FVM(Filecoin Virtual Machine) / 🧰 FVM Libraries and Tools)

README

        
# Filecoin Virtual Machine Rust SDK

> 👉 To start using the FVM Rust SDK, checkout the documentation: [polyphene.github.io/fvm-rs-sdk-docs/](https://polyphene.github.io/fvm-rs-sdk-docs/) 

This repository contains the implementation of a Rust SDK to build actor for the Filecoin Virtual Machine (FVM). It 

exposes useful structures and functions that could be needed by developers while also serving procedural macros to generate

glue code for state management and actor's interface definition.

## Code structure

Here is a quick description of what you will be able to find in every directory:

- `sdk`

  - The entry point for the Rust SDK. The key concepts are:

    - `StateObject`: a trait that contains logic needed to handle read and write on the FVM state. A standard Cbor 

    implementation is available.

- `macro`

  - The procedural macro crate, responsible to expose the `fvm_state`, `fvm_actor` and `fvm_export` procedural macros.

- `macro-support`

  - This crate contains the logic for parsing Rust code tokens to usable structures that we will use to generate glue code.

  A dedicated parser is available for each of our procedural macros.

- `backend`

  - The `backend` crate is dedicated to two things: representing Rust code with dedicated structures and generating glue 

  code to ensure proper state management and interface definition for actors.

    - Structures used to represent the actor's code can be found in the `ast` module.

    - Each procedural macro have its own generation logic in their dedicated module (e.g. `state` for `fvm_state`).

## License

Dual-licensed: [MIT](./LICENSE-MIT), [Apache Software License v2](./LICENSE-APACHE), by way of the

[Permissive License Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack/).