Feat: Add a basic cairo zero runner

cmd/cli/main.go

@@ -2,20 +2,106 @@ package main
 
 import (
 	"fmt"
+	runnerzero "github.com/NethermindEth/cairo-vm-go/pkg/runners/zero"
+	"github.com/urfave/cli/v2"
 	"os"
 )
 
 func main() {
-	if len(os.Args) < 2 {
-		fmt.Println("Usage: cairo-vm <path_to_file>")
-		os.Exit(1)
-	}
+	var proofmode bool
+	var entrypoint string
+	var traceLocation string
+	var arguments cli.StringSlice
 
-	path := os.Args[1]
+	app := &cli.App{
+		Name:                 "cairo-vm",
+		Usage:                "A cairo virtual machine",
+		EnableBashCompletion: true,
+		Suggest:              true,
+		DefaultCommand:       "help",
+		Commands: []*cli.Command{
+			{
+				Name:  "run",
+				Usage: "runs a cairo file",
+				Flags: []cli.Flag{
+					&cli.BoolFlag{
+						Name:        "proofmode",
+						Aliases:     []string{"p"},
+						Value:       false,
+						Usage:       "outputs the proof of execution",
+						Required:    false,
+						Destination: &proofmode,
+					},
+					&cli.StringFlag{
+						Name:        "entrypoint",
+						Aliases:     []string{"e"},
+						Value:       "main",
+						Usage:       "name of the function to run",
+						Required:    true,
+						Destination: &entrypoint,
+					},
+					&cli.StringFlag{
+						Name:        "output",
+						Aliases:     []string{"o"},
+						Usage:       "path to file to store the trace",
+						Required:    false,
+						Destination: &traceLocation,
+					},
+					&cli.StringSliceFlag{
+						Name:        "args",
+						Usage:       "path to file to store the trace",
+						Required:    false,
+						Destination: &arguments,
+					},
+				},
+				Action: func(ctx *cli.Context) error {
+					pathToFile := ctx.Args().Get(0)
+					if pathToFile == "" {
+						return fmt.Errorf("path to cairo file not set")
+					}
 
-	runCairoFile(path)
-}
+					fmt.Printf("Loading program at %s\n", pathToFile)
+					content, err := os.ReadFile(pathToFile)
+					if err != nil {
+						return fmt.Errorf("cannot load program: %w", err)
+					}
+					program, err := runnerzero.LoadCairoZeroProgram(content)
+					if err != nil {
+						return fmt.Errorf("cannot load program: %w", err)
+					}
+
+					fmt.Printf("Running....")
+					runner, err := runnerzero.NewRunner(program, proofmode)
+					if err != nil {
+						return fmt.Errorf("cannot create runner: %w", err)
+					}
+
+					end, err := runner.InitializeMainEntrypoint()
+					if err != nil {
+						return fmt.Errorf("cannot create runner: %w", err)
+					}
+
+					err = runner.RunUntilPc(end)
+					if err != nil {
+						return fmt.Errorf("cannot create runner: %w", err)
+					}
 
-func runCairoFile(path string) {
-	fmt.Printf("Running Cairo file at path: %s\n", path)
+					if proofmode {
+						err = runner.BuildProof()
+						if err != nil {
+							return err
+						}
+					}
+
+					fmt.Printf("Success!")
+					return nil
+				},
+			},
+		},
+	}
+
+	if err := app.Run(os.Args); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
 }

go.mod

@@ -4,11 +4,14 @@ go 1.21
 
 require (
 	github.com/bits-and-blooms/bitset v1.8.0 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/go-playground/locales v0.13.0 // indirect
 	github.com/go-playground/universal-translator v0.17.0 // indirect
 	github.com/leodido/go-urn v1.2.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
 	golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa // indirect
 	golang.org/x/sys v0.11.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
@@ -19,5 +22,6 @@ require (
 	github.com/consensys/gnark-crypto v0.11.1
 	github.com/go-playground/validator/v10 v10.4.1
 	github.com/stretchr/testify v1.8.4
+	github.com/urfave/cli/v2 v2.25.7
 	golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb
 )

go.sum

@@ -8,6 +8,8 @@ github.com/bits-and-blooms/bitset v1.8.0 h1:FD+XqgOZDUxxZ8hzoBFuV9+cGWY9CslN6d5M
 github.com/bits-and-blooms/bitset v1.8.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8=
 github.com/consensys/gnark-crypto v0.11.1 h1:pt2nLbntYZA5IXnSw21vcQgoUCRPn6J/xylWQpK8gtM=
 github.com/consensys/gnark-crypto v0.11.1/go.mod h1:Iq/P3HHl0ElSjsg2E1gsMwhAyxnxoKK5nVyZKd+/KhU=
+github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
+github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -27,10 +29,16 @@ github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
 github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/urfave/cli/v2 v2.25.7 h1:VAzn5oq403l5pHjc4OhD54+XGO9cdKVL/7lDjF+iKUs=
+github.com/urfave/cli/v2 v2.25.7/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
+github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
+github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa h1:zuSxTR4o9y82ebqCUJYNGJbGPo6sKVl54f/TVDObg1c=

pkg/assembler/assembler_test.go

@@ -9,7 +9,7 @@ import (
 )
 
 func TestAssertEqRegister(t *testing.T) {
-	encode := parseSingleInstruction("[ap + 0] = [fp + 0], ap++;")
+	encode := parseSingleInstruction("[ap] = [fp + 0], ap++;")
 
 	// verify offsets
 	dstOffset := uint16(encode)

pkg/assembler/grammar.go

@@ -8,7 +8,7 @@ import (
 // Grammar and AST
 
 type CasmProgram struct {
-	Instructions []Instruction `@@`
+	Instructions []Instruction `@@*`
 }
 
 type Instruction struct {
@@ -150,14 +150,14 @@ func (deref *Deref) IsFp() bool {
 
 func (deref *Deref) BiasedOffset() (uint16, error) {
 	if deref.Offset == nil {
-		return 0, nil
+		return biasedZero, nil
 	}
 	return biasedOffset(deref.Offset.Sign == "-", *deref.Offset.Value)
 }
 
 func (dderef *DoubleDeref) BiasedOffset() (uint16, error) {
 	if dderef.Offset == nil {
-		return 0, nil
+		return biasedZero, nil
 	}
 	return biasedOffset(dderef.Offset.Sign == "-", *dderef.Offset.Value)
 }

pkg/hintrunner/hintrunner.go

@@ -12,7 +12,7 @@ type HintRunner struct {
 	hints map[uint64]Hinter
 }
 
-func CreateHintRunner(hints map[uint64]Hinter) HintRunner {
+func NewHintRunner(hints map[uint64]Hinter) HintRunner {
 	return HintRunner{hints}
 }
 

pkg/hintrunner/hintrunner_test.go

@@ -15,7 +15,7 @@ func TestExistingHint(t *testing.T) {
 	var ap ApCellRef = 5
 	allocHint := AllocSegment{ap}
 
-	hr := CreateHintRunner(map[uint64]Hinter{
+	hr := NewHintRunner(map[uint64]Hinter{
 		10: allocHint,
 	})
 
@@ -36,7 +36,7 @@ func TestNoHint(t *testing.T) {
 	var ap ApCellRef = 5
 	allocHint := AllocSegment{ap}
 
-	hr := CreateHintRunner(map[uint64]Hinter{
+	hr := NewHintRunner(map[uint64]Hinter{
 		10: allocHint,
 	})
 

pkg/parsers/zero/zero_test.go

@@ -176,6 +176,11 @@ func TestIdentifiers(t *testing.T) {
 	content := []byte(`
         {
             "identifiers": {
+                "__main__.fib": {
+                    "decorators": [],
+                    "pc": 9,
+                    "type": "function"
+                },
                 "__main__.BitwiseBuiltin": {
                     "destination": "starkware.cairo.common.cairo_builtins.BitwiseBuiltin",
                     "type": "alias"
@@ -216,6 +221,11 @@ func TestIdentifiers(t *testing.T) {
 		t,
 		&ZeroProgram{
 			Identifiers: map[string]any{
+				"__main__.fib": map[string]any{
+					"decorators": make([]any, 0),
+					"pc":         float64(9),
+					"type":       "function",
+				},
 				"__main__.BitwiseBuiltin": map[string]any{
 					"destination": "starkware.cairo.common.cairo_builtins.BitwiseBuiltin",
 					"type":        "alias",