MileStone checkin 1.1, 1.2 & 1.3

[Fatman13]

Background

This is a compilation of milestone checkins for the go-fvm-sdk grant. Checkins are arranged in the following format...

• Requirements in the original grants

The work has been done to meet such requirement

Milestone 1.1

• Adaptive transformation of TinyGo

Upper stream contributions to TinyGo to make it have better affinity with WASM.

• feat:add new target to support wasm freestanding tinygo-org/tinygo#3072
• reflect: implement CanInterface and fix string Index() tinygo-org/tinygo#3111
• how to write this code pointer := reflect.ValueOf(reflect.TypeOf(false)).Pointer() in tinygo? tinygo-org/tinygo#2858
• add new target like wasm32-unknown-unknown in rust tinygo-org/tinygo#3068
• Allow goroutines from exported wasm functions tinygo-org/tinygo#3095

• Implement system calls

All system calls supported by ref-fvm have been implemented by go-fvm-sdk here.

• Revamp TinyGo libraries that are being used by the go-fvm-sdk; Make modifications to reflection, output stream, platform and network related code (See background above)

Modifies TinyGo libraries to make it compatible with fvm. Also built a CLI interface to allow user to patch their TinyGo installations.

replace (
   //remove os.stdout
   github.com/davecgh/go-spew => github.com/ipfs-force-community/go-spew v1.1.2-0.20220524052205-0034150c051a
   //remove package github.com/ipfs/go-ipfs-util
   github.com/ipfs/go-block-format => github.com/ipfs-force-community/go-block-format v0.0.4-0.20220425095807-073e9266335c
   //remove anything about reflect
   github.com/filecoin-project/go-address => github.com/ipfs-force-community/go-address v0.0.7-0.20220524010936-42617a156be1
   github.com/ipfs/go-ipld-cbor => github.com/ipfs-force-community/go-ipld-cbor v0.0.7-0.20220713070731-f5190aacb1a4
   github.com/polydawn/refmt => github.com/hunjixin/refmt v0.0.0-20220520091210-cb3c7d292019
   github.com/whyrusleeping/cbor-gen => github.com/ipfs-force-community/cbor-gen v0.0.0-20220421100448-dc345220256c
   
   //remove http/file asset and reflect code
   github.com/stretchr/testify => github.com/ipfs-force-community/testify v1.7.1-0.20220616060316-ea4f53121ac3
   //remove implement baseon specify platform only keep pure go implement
   golang.org/x/crypto => github.com/ipfs-force-community/crypto v0.0.0-20220523090957-2aff239c26f7
   lukechampine.com/blake3 => github.com/ipfs-force-community/blake3 v1.1.8-0.20220609024944-51450f2b2fc0
   github.com/klauspost/cpuid/v2 => github.com/ipfs-force-community/cpuid/v2 v2.0.13-0.20220523085810-ac111993ce74
   github.com/minio/blake2b-simd => github.com/ipfs-force-community/blake2b-simd v0.0.0-20220523083450-6e9a68832d69
   github.com/minio/sha256-simd => github.com/ipfs-force-community/sha256-simd v1.0.1-0.20220421100150-fcbba4b6ea96
)

Patch command could be used like the following...

$ fvm_go_sdk patch

Milestone 1.2

• hello world example

hello world example could be found here.

Follow the main document to install go-fvm-sdk and run the example.

• ERC20 example

erc-20 example could be found here.

Follow the main document to install go-fvm-sdk and run the example.

• Add compile tooling; Enable compiling using TinyGo and allow processing on the output through inject init code in invoke function (See above background)

Compiling tools have been integrated into CLI which allows user to compile their GO contract into FVM native actors.

$ fvm_go_sdk build

• Add abilities for creation of template (generation of a working actor directory structure and compilable actor template for user)

Use the new command from CLI to create a work space for you to write new contracts.

$ fvm_go_sdk new -- <YOUR_ACTOR_NAME>

The following structure will be created for user...

.
├── 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
├── <YOUR_ACTOR_NAME>.wasm # WASM contract compiled from actor.go
└── test.json

• Add testing tools which allows feature testing of actors

Feature test cases of actors can be found here.

Milestone 1.3

• Add generator tools
  • generation of actor Cbor struct (actor states)
  • generation of actor entry file
  • generation of go client for actor, through which user can have actor generation, creation and invocation

We have built a series of generator tools to support development on go-fvm-sdk. For example...

• client.go is the generator for your actor client which allows a programatic way for developers to deploy, create or invoke it's contract.
• entry_gen.go mimics inter-actor communication protocols on the reference fvm implementation. entry_gen produces method invocation switch cases and scaffolding code, which is comparable to the macro functions on Rust side.
• type_gen.go is the generator for various actor types, cbor functions, structs and etc.

• CI integration (incremental integration, lint checks, actor test run, auto-publish, CI harness/checks)

CI integration has been cooperated into the go-fvm-sdk project to facilitate its development. We have three separate actions defined. One for Go part of the code base, one for Rust and one for when tagging and releasing new version of the sdk.

• Add amt and hamt support; import spec-actors and support map & array for data storage with read on demand support

For amt and hmt support, relevant ported code and examples can be found here...

• https://github.com/ipfs-force-community/go-fvm-sdk/tree/v0.1/sdk/adt
• https://github.com/ipfs-force-community/go-fvm-sdk/blob/v0.1/sdk/cases/adt.go

• Add mock layer to fvm for actor unit testing

Mock system APIs will return simulated results during integration/unit testing to facilitate overall testing experiences of developers.

• Metrics on gas usages of each methods

Metrics on gas usage was determined by the team that was unfit for the milestone as there will be a lot of change made to native fvm. At the time of writing the grant application the decision of launching fevm first hadn’t been made yet. Thus need change of plan.

• More examples

• FRC46 example
• Wallet example (inspired by eth smart contract wallet example)
• queuecall example (inspired by another eth smart contract example)