Filecoin Filecoin Virtual Machine - FVM, 1 Sep 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: FVM Foundry Update: Polyphene High-level Rust SDK Demo

Description

Polyphene is one of FVM's awesome community fil-der teams working on building out important infrastructure to support the native Filecoin Virtual Machine. They have also been working closely with the core team to enhance FVM core development.

Here they take us through the current progress of their High level Rust SDK. It contains extension of useful crates for your developer experience and a procedural macro, fvm_state, that will generate glue code to save and load your actors' state.

This release is now public and can be found on this repository
👉 https://github.com/polyphene/fvm-rs-sdk

Documentation
👉 https://github.com/polyphene/fvm-rs-sdk-docs
👉 https://polyphene.github.io/fvm-rs-sdk-docs/

You can also review their light paper here
👉 https://polyphene.github.io/morphee-lightpaper/paper.pdf

Please feel free to take a look and even try it out and give feedback if you are interested in making your actors development easier!

🌐 https://polyphene.io
🌐 https://github.com/polyphene

============================================================
About FVM Foundry:
FVM Foundry is a program for early-builders on the Filecoin Vitrual Machine.
We are working collaboratively with our amazing open source community in order to explore and build valuable use cases, infrastructure, tooling, and docs for the native FVM.
The aim is to collaborate, exchange knowledge and innovate together as well as gather feedback and input in order to build the best development experience possible on the FVM.

Want to help shape the future of FVM?
🏗️ FVM tooling & Infrastructure open grant RFPs: https://github.com/filecoin-project/devgrants/blob/master/rfps/fvm-open-tools-infra.md

✅ Follow & contribute to the design decisions being made on the FVM by subscribing to the
⭐ FVM-specs: https://github.com/filecoin-project/fvm-specs
⭐ FIP's: https://github.com/filecoin-project/FIPs

💬 Interested in joining a future Foundry Cohort? Let us know in the #fvm channel on the Filecoin Slack (visit filecoin.io to join the slack)

============================================================
About the FVM:

Currently Filecoin is known for being a decentralised storage and retrieval network, providing over 17 EiB of distributed data storage capacity to the world through thousands of Storage providers globally.

And we can think of this distributed storage network as being the layer zero of the Filecoin Architecture Network because ..
Storage is really only the start!

We want to be able to compute and analyse over and with the data on the Filecoin network!

And this is the goal of the FVM - to enable users to be able to deploy their own smart contracts (or actors as they are termed in the Filecoin ecosystem) and unlock the ability to perform on-chain computation over state data.

This additional layer of capability - which we can consider to be the layer 1 of the network - adds programmability to the already robust, permissionless storage network that is Filecoin.

Smart contracts + storage = FVM.

What will you build??

Links:
🌐 See more details on the website: https://fvm.filecoin.io
🦄 See the reference specification of FVM: https://github.com/filecoin-project/ref-fvm
👨‍👩‍👦‍👦 Join the chat: #fvm on the Filecoin Slack Channel (visit filecoin.io to join)

A

A

We have an exciting demo from um Polly Bean, uh who Thomas and Philip who are here have just released um their Milestone, so they are going to give us an awesome demo. On that um I'll hand over to you guys.

B

Yeah, thank you. Yes, so we're glad to present the release 1.0 over the rest. Sdk we've been working on it for the past few weeks and yeah, and we had some feedbacks from part of the community. It was really interesting. Raul made some issues and I could exchange on slack with a few people. So the goal here I think is like take 15 minutes to try and first present what we did. The resources are available and I go through the SDK and see.

B

What's there like different choices, also that were made, then we can talk about uh what are the different feedbacks that we received and iterations that we can do and I think that, apart from that in the in the same time, I would like to like go through some discussions, maybe with Alex, which is here, because we could exchange on the erc20 library that elix, built and I think that it would be awesome to like have a chat and see how it can go further in terms of integration and what we can do so I will share my screen right now.

B

uh Oh I can't I think I need to be like uh have more rights on the zoom, because I consider my screen right.

A

Now, all right that was uh it's it's off by default, should be right. There, oh.

B

Okay, perfect, thank you.

B

So the idea on the SDK was to build a an easy, an easy tool for developers to use and try to like have less um overhead code in their actors and make sure that it would be easy for them to actually like try to build an actor and for it to work inside the VM inside the network.

B

So for that, the design goal was to have some procedural macros available, which are some annotations, that you can use to tag some structures, implementation or other part of the wrist code and have them generate the glucose that is needed, like in Vogue, uh adding survey, serialization naturalization um code on structures Etc and to make sure that it would fit inside the network and properly work.

B

um The idea also was to have for these different procedural micro um kind of flexible design, so that in the future, if you want to like improve those macros and add, for example, new connects or new ways of defining entry points Etc, we could do it quite easily and iterate fast enough, so that it won't take too long. So for the SDK. What released is first repo here? That you can find at a VM, RS SDK I'll post the links in the chat later. If you want to access it, it's also available.

B

It's like I've posted a few messages, um there's also this AVM RS SDK docs, which contains the setting documentation which is available here um at polyphen uh that github.io it's also available. It's like if you want it.

B

um So if we dive inside the SDK right now, um the crate is composed of a few modules that are available. So there's the main entry point for the SDK, which is the SDK module crate. Sorry, um this crate will contain all exposed utilities functions and different in the procedural macros that will be useful, Inside, the Actors when you develop an actor and it will also expose some of the ciscals I mean all the Cisco that are available in the low level SDK.

B

If you want to um create your own, like invoke function, your own functions calling low level Cisco where it's available there. Also, the ID for the SDK was that it should be your only import when you develop an actor like only import for the fvm to avoid having multiple dependencies and then having to version everything, and the idea was that we could iterate on this SDK having proper versioning and having like always the SDK working for uh for Tool building.

B

Then we have the macro crate, which contains all of the procedural macros that we've created, and then we have two like kind of back-end logic crates, which are Macross reports and, like n democracy board, will like make the bridge between the macro that we have it, that we declare that we can use and the back end, which contains the logic for generating the code and like parsing the rest code that we have inside the actor Etc.

B

um So if we, if we go through here so as I said in the SDK we have kind of here, or um we have our our lib.rs, which contains a few trades, that I think are useful. When you're looking actors, we have the CID create.

B

Here we have um the testing here: module which exposes assert a certain assert non-equal which helps developers to like do tests, Inside the Actors and, having kind of then Cisco they get Cisco that can throw back messages with the dedicated exist code exit code, sorry, which is useful, and we find also the encoding create, which is a VM rpld, encoding, The, Cisco crate, as I say previously in the shot rate, which all contain types and methods which which are useful, When developing actors.

B

Otherwise it exposes all our macros, which we can find here in the macro crate and so for all the all the micros we can. We can see that we have the fvm state, a VM actor, a vmpa, payload and fvm Export, so we have four macros in our um SDK, and so, if I just show an example quite quickly, a simple one.

B

So the edit is that what we wanted to do is have one macro: dedicating for like dedicated for one specific usage inside of the SDK and having all the other ones. That would not be mandatory for it to exist like the idea is. Every macro is responsible for one functionality and all the others can actually be done by hand by the developers, and it would still work so in that IDE.

B

We have here the fvm state, which will help to generate all the 30 code around the structures which will help to like serialize this array, State and also generate the save and the load function, which will help to save and load the states around that. We also have the fvm actors, which is implemented on an implementation which is uh of the same type as of now for of the a VM state, and so this implementation, like this sorry, this processional macro this implementation.

B

What it will do is generate an invoke function and while it's doing so, it's also using and parsing the fvm export procedural macro, and with that actually looking at what value we should use for the uh entry point for each method, and so with that, what he's doing is generating the whole invoke function and the internal dispatch code, which would be needed for you to be able to call the right macro and get a return value after that.

B

Along with that, we've also developed a um sorry, a fvm payload, which I can find here sorry an example macro which is used for parameters and return types for your methods, because you also need to have like serization on it and you might want some custom authorization Etc. But as of now, it's only handling Civil War. But the idea was that we wanted for people to not have to like add survey on this side and having another macro to help them handle parameters and return types for functions.

B

um So that's the main idea around the SDK. We also have two examples which are uh first, one like which is a simple Contour. The first example that I said that I showed, and then we have this example, which is made of based off Helix code. Actually, there's not actually right now, A mentioned to what they did, but that will be added at one of the iteration that we were faced with and the idea was just to show off.

B

How can could like erc20 like token be implemented inside the VM and not really like to implement the standard which is currently being discussed. I think it would be better to wait for the standouts to be final and then to have a proper example and even I think use the Helix library to to do so um about iterations and what we are needing to to do in the in the I think in the following days and and what were given us as feedbacks.

B

So we'll take my notes here, sorry, so that is that first one was like to mention Helix for the rc20 example um and try to uh and add them on the readme. It would also be ideal to follow the standard, but that that can be done once the um uh the the standard is fully implemented.

B

um Then we will uh add some documentation on the Future Works limitations, maybe a bit more precise and say Okay. So this need to be done and that's what would be ideal in the next iteration I think this will also need to be constructed with the community and the fvm team to make sure that we are aligned on that, and so we can move forward.

B

um We also need to uh revamp the way we declare bindings um obvious as you've, maybe seen it. In my examples we declare binding.

B

uh The idea is that we declare the method for binding in the fvm actor procedural macro and we're giving the value here on the FGM export and revel made a great command which, because it's redundant, and so what we could do is declare the method for The Binding like what type of binding it is here instead of binding and so declaring the method here and here the value and so only having like no parameters or small other parameters for the FGM actor.

B

And then the ID would also be and I think right. I will need to take that offline with you, because I couldn't really understand what you meant, but for transactional, Block. Sorry, uh there's a use case there and I think I need to chat with you, because I read back the Grant and I couldn't really understand what you meant. So that would be great, um so yeah. So that's what we did I'm sorry I, don't have like a live demo to show, because my computer right now is like um moving options Etc.

B

So it's not there and there's actually on the documentation that we produced. There's. Actually, like usage, how to use it how to test it, um so please feel free to go and try it out. I mean I know. As of now, the SDK is hard to use. It's not published on crate.io plus we have some dependencies that are still not published from the fvm.

B

We are using a personalized branch on the refvm repo and some codes are not pushed, so please feel free to try it out still and or at least like take a look and see, if could be useful to you or your project um and yeah, and that will be all on the SDK bot per se on my site.