ts0yu/folio

📖 folio is a blazing-fast compiler for the FVM stack

folio 📖

overview

folio provides a fast, simple abstraction and work-in-progress compiler for the FVM (Financial Virtual Machine).

features

• lexical analysis
• parsing
• basic code generation and bytecode output
• finalize code generation, and ensure parity with FVM.ts

compiler

example usage of the folio compiler can be found within the /examples folder.

structure

• crates
  • cli -> command line interface
  • compiler
    • assembler.rs -> defines the parser
    • codegen.rs -> code generation module
    • opcode/rs -> defines a set of FVM primitive types
    • token.rs -> lexical analysis and token definition

contact

• email
• discord

folio's Issues

simplify parsing

we need a more robust way of parsing macros than currently - reference huffc

compilation context

similar to rustc, we need some sort of Context struct that lets us pass around details of the current compilation run.

this will be used for:

• errors
• benchmarking
• more verbose compiler information

add parameters to opcodes

allow the compiler to properly parse opcodes - not just opcodes in text

allow macros to be invoked from within macros

Currently, a macro can only be called from within the main macro. We should allow macros to be called from any macro, not just main.

this could be done by passing over the main macro body until there are no more identifiers.

this is low priority

add span to token

this links with error issue, if we include spans in the token structure we can create better user errors

error handling

user should be able to see nice cli errors when something goes wrong.

consider using similar format to rustc

verify hex literal

hex literals currently can be any length so we need to ensure they are the correct length of an address

Differential Testing

I think post deployment of portfolio we should try to differentially test this with fmv.ts

I think it would be sweet to work on this with @clemlak

benchmarking

add benchmarking with criterion

encode assembled program

encode the assembled opcodes. reference FVMLib.sol. this depends on the opcodes parameter issue

`get_n` method

Make a method in assembler.rs that abstracts getting the nth token - code is repetitive currently. See https://github.com/ts0yu/folio/blob/main/crates/compiler/src/assembler.rs#L77