feat: migrate cbor lib and add Fuzzer for cbor serialization (#1110)

Co-authored-by: PatStiles <[email protected]>
Co-authored-by: Urix <[email protected]>

Author: 3 people

Makefile

@@ -121,6 +121,22 @@ update_operator:
 	@make build_operator
 	@./operator/build/aligned-operator --version
 
+operator_valid_marshall_fuzz_macos:
+	@cd operator/pkg && go test -fuzz=FuzzValidMarshall -ldflags=-extldflags=-Wl,-ld_classic
+
+operator_valid_marshall_fuzz_linux:
+	@cd operator/pkg && \
+	LD_LIBRARY_PATH=$(LD_LIBRARY_PATH):$(CURDIR)/operator/risc_zero/lib \
+	go test -fuzz=FuzzValidMarshall
+
+operator_marshall_unmarshall_fuzz_macos:
+	@cd operator/pkg && go test -fuzz=FuzzMarshalUnmarshal -ldflags=-extldflags=-Wl,-ld_classic
+
+operator_marshall_unmarshall_fuzz_linux:
+	@cd operator/pkg && \
+	LD_LIBRARY_PATH=$(LD_LIBRARY_PATH):$(CURDIR)/operator/risc_zero/lib \
+	go test -fuzz=FuzzMarshalUnmarshal
+
 bindings:
 	cd contracts && ./generate-go-bindings.sh
 

common/proving_systems.go

@@ -4,6 +4,8 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+
+	"github.com/fxamacker/cbor/v2"
 )
 
 type ProvingSystemId uint16
@@ -96,6 +98,32 @@ func (t *ProvingSystemId) UnmarshalBinary(data []byte) error {
 	return err
 }
 
+func (s *ProvingSystemId) UnmarshalCBOR(data []byte) error {
+	var statusStr string
+	if err := cbor.Unmarshal(data, &statusStr); err != nil {
+		return err
+	}
+
+	switch statusStr {
+	case "GnarkPlonkBls12_381":
+		*s = GnarkPlonkBls12_381
+	case "GnarkPlonkBn254":
+		*s = GnarkPlonkBn254
+	case "Groth16Bn254":
+		*s = Groth16Bn254
+	case "SP1":
+		*s = SP1
+	case "Halo2KZG":
+		*s = Halo2KZG
+	case "Halo2IPA":
+		*s = Halo2IPA
+	case "Risc0":
+		*s = Risc0
+	}
+
+	return nil
+}
+
 func (t ProvingSystemId) MarshalBinary() ([]byte, error) {
 	// needs to be defined but should never be called
 	return nil, fmt.Errorf("not implemented")

docs/3_guides/6_setup_aligned.md

@@ -50,11 +50,11 @@ Before starting, you need to set up an S3 bucket. More data storage will be test
 
 You need to fill the data in:
 
-```batcher/aligned-batcher/.env```
+`batcher/aligned-batcher/.env`
 
 And you can use this file as an example of how to fill it:
 
-```batcher/aligned-batcher/.env.example```
+`batcher/aligned-batcher/.env.example`
 
 After having the env setup, run in different terminals the following commands to boot Aligned locally:
 
@@ -108,15 +108,15 @@ Note that when upgrading the contracts, you must also:
 
 1. Re-generate the Go smart contract bindings:
 
-    ```bash
-    make bindings
-    ```
+   ```bash
+   make bindings
+   ```
 
 2. Rebuild Aggregator and Operator Go binaries:
 
-    ```bash
-    make build_binaries
-    ```
+   ```bash
+   make build_binaries
+   ```
 
 </details>
 
@@ -324,7 +324,7 @@ batcher (`batcher/aligned-batcher/`).
 The necessary environment variables are:
 
 | Variable Name         | Description                                                                                                                    |
-|-----------------------|--------------------------------------------------------------------------------------------------------------------------------|
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
 | AWS_SECRET_ACCESS_KEY | Secret key to authenticate and authorize API requests to the AWS S3 Bucket.                                                    |
 | AWS_REGION            | Geographical region where the AWS S3 Bucket will be accessed.                                                                  |
 | AWS_ACCESS_KEY_ID     | Access key used in combination with the AWS_SECRET_ACCESS_KEY to authenticate and authorize API requests to the AWS S3 Bucket. |
@@ -660,7 +660,7 @@ Create a `.env` file in the `/explorer` directory of the project.
 The `.env` file needs to contain the following variables:
 
 | Variable              | Description                                                                                     |
-|-----------------------|-------------------------------------------------------------------------------------------------|
+| --------------------- | ----------------------------------------------------------------------------------------------- |
 | `RPC_URL`             | The RPC URL of the network you want to connect to.                                              |
 | `ENVIRONMENT`         | The environment you want to run the application in. It can be `devnet`, `holesky` or `mainnet`. |
 | `ALIGNED_CONFIG_FILE` | The config file containing Aligned contracts' deployment information                            |
@@ -719,18 +719,34 @@ forge install Layr-Labs/eigenlayer-middleware@mainnet
 
 Then, to solve the issue<https://github.com/Layr-Labs/eigenlayer-middleware/issues/229>, we changed it to:
 
-```forge install yetanotherco/eigenlayer-middleware@yac-mainnet --no-commit```
+`forge install yetanotherco/eigenlayer-middleware@yac-mainnet --no-commit`
 
 As soon as it gets fixed in mainnet, we can revert it.
 
-Base version of middleware used is ```7229f2b```.
+Base version of middleware used is `7229f2b`.
 
-The script to initialize the devnet can be found on  ```contracts/scripts/anvil```.
+The script to initialize the devnet can be found on `contracts/scripts/anvil`.
 
 The addresses of the relevant contracts after running the anvil script are dumped
-on ```contracts/script/output/devnet```.
+on `contracts/script/output/devnet`.
 
-The state is backed up on ```contracts/scripts/anvil/state```.
+The state is backed up on `contracts/scripts/anvil/state`.
 
 EigenLayer contract deployment is almost the same as the EigenLayer contract deployment on mainnet.
 Changes are described in the file.
+
+## Running Fuzzers:
+
+Fuzzing for the operator can be done by executing the following make commands from the root directory of the project.
+
+macOS:
+
+```
+make operator_verification_data_fuzz_macos
+```
+
+Linux:
+
+```
+operator_verification_data_fuzz_linux
+```