https://github.com/ipfs-force-community/go-fvm-sdk
go-fvm-sdk generate wasm to run on fvm from golang code
https://github.com/ipfs-force-community/go-fvm-sdk
blockchain fvm sdk wasm webassembly
Last synced: 5 months ago
JSON representation
go-fvm-sdk generate wasm to run on fvm from golang code
- Host: GitHub
- URL: https://github.com/ipfs-force-community/go-fvm-sdk
- Owner: ipfs-force-community
- License: apache-2.0
- Created: 2022-04-13T01:37:56.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T03:12:11.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T03:01:22.615Z (9 months ago)
- Topics: blockchain, fvm, sdk, wasm, webassembly
- Language: Go
- Homepage:
- Size: 23.6 MB
- Stars: 30
- Watchers: 7
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: README.MD
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-filecoin - FVM Go SDK
README
# go-fvm-sdk
`go-fvm-sdk` enables GO developers to write [FVM](https://fvm.filecoin.io/) contracts in TinyGo. To learn more about FVM, please check out resources on [fvm forum](https://fvm-forum.filecoin.io/).
Key features of `go-fvm-sdk` are...
- Compiles GO contracts into WASM
- Full compatibility with FVM system call interface
- unit/integration test support
- Deploy native WASM actor on FVM!
## Why TinyGO
- Support most Go syntax and libraries.
- Smaller footprint which is great for use cases on the blockchain.
- Nimble management of GC and Memory, which is great for contracts with runtime constraints of tens to hundreds of milliseconds and memory constraints of a few megabytes.
## Install
Install [Go](https://go.dev/doc/install)v1.20.x or above and [TinyGo](https://tinygo.org/getting-started/install/)v0.27 or above.
*Note: latest Go or TinyGo versions may not be tested.*
### Use Binary
Go to [releases](https://github.com/ipfs-force-community/go-fvm-sdk/releases) and download the executables.
Rename your executable to `fvm_go_sdk` and add execution permission.
```bash
$ mv fvm_go_sdk_vX.Y.Z_xxx fvm_go_sdk
$ chmod +x fvm_go_sdk
```
### Build from source
Install `OpenCl` and [Rust](https://www.rust-lang.org/tools/install).
Clone `fvm_go_sdk` repo and make.
```bash
$ sudo apt install ocl-icd-opencl-dev jq # install dependencies
$ cargo install cargo-edit # install cargo plugin, builtin-actor require
$ rustup target add wasm32-unknown-unknown # install wasm target
$ git clone [email protected]:ipfs-force-community/go-fvm-sdk.git
$ make
```
*Note: it may take a while before you finish buiding from source.*
Check if `fvm_go_sdk` is operational.
```bash
$ fvm_go_sdk -h
```
Once you have `fvm_go_sdk` ready, `Go` and `TinyGo` need to be patched in order to have the compiled WASM contract compatible with FVM.
```bash
$ fvm_go_sdk patch
```
Successful patching of `go-fvm-sdk` will give the following output. And you are done with installation!
```
patching file src/reflect/value.go
Hunk #1 succeeded at 754 (offset 3 lines).
patching file targets/wasi.json
Hunk #2 succeeded at 10 with fuzz 1.
```
## Create your first Contract!
It is recommended that you create your first project using our template.
```bash
$ fvm_go_sdk new --
```
`fvm_go_sdk` will generate the following scaffolding for you.
```bash
.
├── README.md
├── actor
│ ├── actor.go # Write your contract here
│ └── cbor_gen.go
├── client
│ └── client.go # client for installation and deployment of the contract
├── entry.go # Main entry point of the contract. If you change interfaces of your actor, please build again to renew the entry point file
├── gen
│ ├── go.mod
│ ├── go.sum
│ └── main.go
├── go.mod
├── go.sum
├── .wasm # WASM contract compiled from actor.go
└── test.json
```
Compile your contract. And you now have your very first contract ready to be depolyed!
```bash
$ fvm_go_sdk build
```
## Deploy your Contract
Follow this [instruction](https://lotus.filecoin.io/developers/local-network/) to setup local devnet with fvm branch `experimental/fvm-m2`.
Install actor.
```bash
$ lotus chain install-actor
```
Instantiate actor.
```bash
$ lotus chain create-actor
```
Invoke actor.
```bash
$ lotus chain invoke
```
## Tips
- Do not use ASM code.
- Avoid using the reflect library. If you have to, make sure that `TinyGo` supports it.
- Use `go list` command to check actor dependency issue.
```bash
$ go list -json -deps > deps.json
```