Update Espresso Go SDK to 0.2.1 (#176)

* init update to Go SDK 0.2.1

* can pass tests

* add go sdk version param

* solve multiClientCreation error and circleCI

* fix espressoClient creation for caff node and add safeguard log when streamer is nil

* adapt to new client to have at least two urls

* update docker as well (#178)

* add comments on at least 2 urls

* fix another single url

* fix docker compose single url

* fix docker compose caff single url

* allow a bit larger variance in the receipt to L1 time of integration test 1

* tweak docker compose file

* also tweak caff hotshot urls

* fix appendArg of BatcherMod in LaunchBatcherInEnclave()

* add sha256sum check to dockerfile

* check espresso go crypto helper sha256sum in a more elegant way

Author: dailinsubjam

.circleci/config.yml

@@ -991,12 +991,12 @@ jobs:
           at: "."
           if: ${{ uses_artifacts }}
       - run:
-          name: download espresso-network-go
+          name: download espresso-network go sdk
           command: |
-            ver=$(grep "github.com/EspressoSystems/espresso-network-go" go.mod | awk '{print $2}')
-            url="https://github.com/EspressoSystems/espresso-network-go/releases/download/${ver}/libespresso_crypto_helper-x86_64-unknown-linux-gnu.a"
+            ver=$(grep "github.com/EspressoSystems/espresso-network/sdks/go" go.mod | awk '{print $2}')
+            url="https://github.com/EspressoSystems/espresso-network/releases/download/sdks%2Fgo%2F${ver}/libespresso_crypto_helper-x86_64-unknown-linux-gnu.so"
             mkdir -p /home/circleci/local-lib
-            wget $url -O /home/circleci/local-lib/libespresso_crypto_helper-x86_64-unknown-linux-gnu.a
+            wget $url -O /home/circleci/local-lib/libespresso_crypto_helper-x86_64-unknown-linux-gnu.so
       - run:
           name: Fuzz
           command: |
@@ -1064,12 +1064,12 @@ jobs:
           name: do mise install (did not work otherwise for unknown reason)
           command: /home/circleci/.local/bin/mise install
       - run:
-          name: download espresso-network-go
+          name: download espresso-network go sdk
           command: |
-            ver=$(grep "github.com/EspressoSystems/espresso-network-go" go.mod | awk '{print $2}')
-            url="https://github.com/EspressoSystems/espresso-network-go/releases/download/${ver}/libespresso_crypto_helper-x86_64-unknown-linux-gnu.a"
+            ver=$(grep "github.com/EspressoSystems/espresso-network/sdks/go" go.mod | awk '{print $2}')
+            url="https://github.com/EspressoSystems/espresso-network/releases/download/sdks%2Fgo%2F${ver}/libespresso_crypto_helper-x86_64-unknown-linux-gnu.so"
             mkdir -p /home/circleci/local-lib
-            wget $url -O /home/circleci/local-lib/libespresso_crypto_helper-x86_64-unknown-linux-gnu.a
+            wget $url -O /home/circleci/local-lib/libespresso_crypto_helper-x86_64-unknown-linux-gnu.so
       - run:
           name: build op-program-client
           command: make op-program-client

espresso/docker-compose.yml

@@ -137,6 +137,7 @@ services:
       - --l1.trustrpc=true
       - --rpc.enable-admin=true
       - --caff.hotshot-urls=http://espresso-dev-node:24000
+      - --caff.hotshot-urls=http://espresso-dev-node:24000
       - --caff.next-hotshot-block-num=1
       - --caff.polling-hotshot-polling-interval=500ms
       - --log.level=debug
@@ -159,7 +160,8 @@ services:
       - --l1-eth-rpc=http://l1:8545
       - --l2-eth-rpc=http://op-geth:8551
       - --rollup-rpc=http://op-node-sequencer:8545
-      - --espresso-url=http://espresso-dev-node:24000
+      - --espresso-url=http://localhost:44889
+      - --espresso-url=http://localhost:44889
       - --espresso-light-client-addr=0x703848f4c85f18e3acd8196c8ec91eb0b7bd0797
 
   op-proposer:

espresso/environment/10_soft_confirmation_integrity_test.go

@@ -30,8 +30,8 @@ import (
 	"testing"
 	"time"
 
-	esp_client "github.com/EspressoSystems/espresso-network-go/client"
-	esp_common "github.com/EspressoSystems/espresso-network-go/types/common"
+	espressoClient "github.com/EspressoSystems/espresso-network/sdks/go/client"
+	espressoCommon "github.com/EspressoSystems/espresso-network/sdks/go/types/common"
 	env "github.com/ethereum-optimism/optimism/espresso/environment"
 	"github.com/ethereum-optimism/optimism/op-e2e/system/e2esys"
 	"github.com/ethereum-optimism/optimism/op-node/rollup"
@@ -289,7 +289,7 @@ const SUBMIT_RANDOM_DATA_INTERVAL = 500 * time.Millisecond
 
 // submitRandomDataToSequencerNamespace is a function that submits
 // random data to the sequencer namespace at a specified interval.
-func submitRandomDataToSequencerNamespace(ctx context.Context, espCli esp_client.EspressoClient, namespace uint64) {
+func submitRandomDataToSequencerNamespace(ctx context.Context, espCli espressoClient.EspressoClient, namespace uint64) {
 	// We only want to submit garbage data to the sequencer so quickly
 	ticker := time.NewTicker(SUBMIT_RANDOM_DATA_INTERVAL)
 	buffer := make([]byte, 1024*3)
@@ -304,9 +304,9 @@ func submitRandomDataToSequencerNamespace(ctx context.Context, espCli esp_client
 		n, _ := crypto_rand.Read(buffer)
 
 		// Submit garbage data to the sequencer namespace
-		_, err := espCli.SubmitTransaction(ctx, esp_common.Transaction{
+		_, err := espCli.SubmitTransaction(ctx, espressoCommon.Transaction{
 			Namespace: namespace,
-			Payload:   esp_common.Bytes(buffer[:n]),
+			Payload:   espressoCommon.Bytes(buffer[:n]),
 		})
 		if err != nil {
 			log.Error("Failed to submit random data to sequencer namespace", "namespace", namespace, "error", err)
@@ -395,7 +395,7 @@ const SUBMIT_VALID_DATA_WITH_WRONG_SIGNATURE_INTERVAlL = 500 * time.Millisecond
 
 // Attack Espresso Integrity by Submitting Valid Data with the wrong
 // Signature to the Sequencer's namespace.
-func submitValidDataWithWrongSignature(ctx context.Context, rollupCfg *rollup.Config, l2Seq *ethclient.Client, espCli esp_client.EspressoClient, namespace uint64) {
+func submitValidDataWithWrongSignature(ctx context.Context, rollupCfg *rollup.Config, l2Seq *ethclient.Client, espCli espressoClient.EspressoClient, namespace uint64) {
 	// We only want to submit garbage data to the sequencer so quickly
 	ticker := time.NewTicker(SUBMIT_VALID_DATA_WITH_WRONG_SIGNATURE_INTERVAlL)
 	stackTrie := trie.NewStackTrie(func(path []byte, hash geth_common.Hash, blob []byte) {})
@@ -474,7 +474,7 @@ func submitValidDataWithRandomSignature(
 	ctx context.Context,
 	rollupCfg *rollup.Config,
 	l2Seq *ethclient.Client,
-	espCli esp_client.EspressoClient,
+	espCli espressoClient.EspressoClient,
 	namespace uint64,
 ) {
 	// We only want to submit garbage data to the sequencer so quickly
@@ -614,7 +614,7 @@ func TestSequencerFeedConsistencyWithAttackOnEspresso(t *testing.T) {
 	}
 
 	l2Seq := system.NodeClient(e2esys.RoleSeq)
-	espCli := esp_client.NewClient(espressoSequencerURL.String())
+	espCli := espressoClient.NewClient(espressoSequencerURL.String())
 	namespace := system.RollupConfig.L2ChainID.Uint64()
 
 	// Attack Espresso Integrity by Submitting Garbage Data to the Same

espresso/environment/12_enforce_majority_rule_test.go

@@ -92,7 +92,8 @@ func runWithMultiClient(t *testing.T, numGoodUrls int, numBadUrls int, expectedE
 //	If M>N, the chain should make progress, otherwise it should not.
 func TestEnforceMajorityRule(t *testing.T) {
 
-	runWithMultiClient(t, 1, 0, NO_ERROR_EXPECTED)
+	// To create a valid multiple nodes client, we need to provide at least 2 URLs.
+	runWithMultiClient(t, 2, 0, NO_ERROR_EXPECTED)
 	runWithMultiClient(t, 2, 1, NO_ERROR_EXPECTED)
 	runWithMultiClient(t, 0, 2, ERROR_EXPECTED)
 	runWithMultiClient(t, 1, 1, ERROR_EXPECTED)

espresso/environment/1_espresso_benchmark_test.go

@@ -145,7 +145,7 @@ func TestE2eDevNetWithEspressoFastConfirmationStability(t *testing.T) {
 			t.Errorf("expected a small amount of variance in the receipt to caff time:\nhave:\n\t\"%v\"\nwant:\n\t\"%v\"\n", have, want)
 		}
 
-		if have, want := metrics.ReceiptToVerify.StdDev, 2*time.Second; have > want {
+		if have, want := metrics.ReceiptToVerify.StdDev, 3*time.Second; have > want {
 			t.Errorf("expected a small amount of variance in the receipt to L1 time:\nhave:\n\t\"%v\"\nwant:\n\t\"%v\"\n", have, want)
 		}
 	}

espresso/environment/2_espresso_liveness_test.go

@@ -9,8 +9,8 @@ import (
 	"testing"
 	"time"
 
-	espressoClient "github.com/EspressoSystems/espresso-network-go/client"
-	lightclient "github.com/EspressoSystems/espresso-network-go/light-client"
+	espressoClient "github.com/EspressoSystems/espresso-network/sdks/go/client"
+	espressoLightClient "github.com/EspressoSystems/espresso-network/sdks/go/light-client"
 	"github.com/ethereum-optimism/optimism/espresso"
 	env "github.com/ethereum-optimism/optimism/espresso/environment"
 	"github.com/ethereum-optimism/optimism/op-batcher/batcher"
@@ -258,7 +258,7 @@ func TestE2eDevNetWithEspressoEspressoDegradedLivenessViaCaffNode(t *testing.T)
 	{
 		// Streamer Setup and Configuration
 		l := log.NewLogger(slog.Default().Handler())
-		lightClient, err := lightclient.NewLightclientCaller(common.HexToAddress(env.ESPRESSO_LIGHT_CLIENT_ADDRESS), l1Client)
+		lightClient, err := espressoLightClient.NewLightclientCaller(common.HexToAddress(env.ESPRESSO_LIGHT_CLIENT_ADDRESS), l1Client)
 		require.NoError(t, err, "light client creation failed")
 		streamer := espresso.NewEspressoStreamer(
 			system.RollupConfig.L2ChainID.Uint64(),

espresso/environment/3_2_espresso_deterministic_state_test.go

@@ -13,8 +13,8 @@ import (
 	"github.com/ethereum/go-ethereum/rpc"
 	"github.com/stretchr/testify/require"
 
-	espressoClient "github.com/EspressoSystems/espresso-network-go/client"
-	espressoCommon "github.com/EspressoSystems/espresso-network-go/types"
+	espressoClient "github.com/EspressoSystems/espresso-network/sdks/go/client"
+	espressoCommon "github.com/EspressoSystems/espresso-network/sdks/go/types"
 	env "github.com/ethereum-optimism/optimism/espresso/environment"
 	"github.com/ethereum-optimism/optimism/op-e2e/e2eutils/wait"
 	"github.com/ethereum-optimism/optimism/op-e2e/system/e2esys"
@@ -73,7 +73,10 @@ func TestDeterministicDerivationExecutionStateWithInvalidTransaction(t *testing.
 
 	// We want to setup our test
 	addressAlice := system.Cfg.Secrets.Addresses().Alice
-	espressoClient := espressoClient.NewMultipleNodesClient(espressoDevNode.EspressoUrls())
+	espressoClient, err := espressoClient.NewMultipleNodesClient(espressoDevNode.EspressoUrls())
+	if have, want := err, error(nil); have != want {
+		t.Fatalf("failed to create Espresso client:\nhave:\n\t\"%v\"\nwant:\n\t\"%v\"\n", have, want)
+	}
 	l1Client := system.NodeClient(e2esys.RoleL1)
 	l2Verif := system.NodeClient(e2esys.RoleVerif)
 	l2Seq := system.NodeClient(e2esys.RoleSeq)
@@ -282,7 +285,10 @@ func TestValidEspressoTransactionCreation(t *testing.T) {
 	defer env.Stop(t, caffNode)
 
 	// We want to setup our test
-	espressoClient := espressoClient.NewMultipleNodesClient(espressoDevNode.EspressoUrls())
+	espressoClient, err := espressoClient.NewMultipleNodesClient(espressoDevNode.EspressoUrls())
+	if have, want := err, error(nil); have != want {
+		t.Fatalf("failed to create Espresso client:\nhave:\n\t\"%v\"\nwant:\n\t\"%v\"\n", have, want)
+	}
 	l2Verif := system.NodeClient(e2esys.RoleVerif)
 	caffVerif := system.NodeClient(env.RoleCaffNode)
 	// create a real Espresso transaction and make sure it can go through

espresso/environment/enclave_helpers.go

@@ -120,7 +120,9 @@ func LaunchBatcherInEnclave() DevNetLauncherOption {
 						appendArg(&args, flags.ThrottleThresholdFlag.Name, c.ThrottleThreshold)
 						appendArg(&args, flags.ThrottleTxSizeFlag.Name, c.ThrottleTxSize)
 						appendArg(&args, flags.WaitNodeSyncFlag.Name, c.WaitNodeSync)
-						appendArg(&args, flags.EspressoUrlsFlag.Name, c.EspressoUrls)
+						for _, url := range c.EspressoUrls {
+							appendArg(&args, flags.EspressoUrlsFlag.Name, url)
+						}
 						appendArg(&args, flags.EspressoLCAddrFlag.Name, c.EspressoLightClientAddr)
 						appendArg(&args, flags.TestingEspressoBatcherPrivateKeyFlag.Name, c.TestingEspressoBatcherPrivateKey)
 

espresso/environment/espresso_caff_node.go

@@ -114,9 +114,10 @@ func LaunchCaffNode(t *testing.T, system *e2esys.System, espressoDevNode Espress
 	caffNodeConfig.Rollup.CaffNodeConfig = rollup.CaffNodeConfig{
 		IsCaffNode:                    true,
 		PollingHotShotPollingInterval: 30 * time.Millisecond,
-		HotShotUrls:                   []string{u.String()},
-		L1EthRpc:                      system.L1.UserRPC().RPC(),
-		EspressoLightClientAddr:       ESPRESSO_LIGHT_CLIENT_ADDRESS,
+		// To create a valid multiple nodes client, we need to provide at least 2 URLs.
+		HotShotUrls:             []string{u.String(), u.String()},
+		L1EthRpc:                system.L1.UserRPC().RPC(),
+		EspressoLightClientAddr: ESPRESSO_LIGHT_CLIENT_ADDRESS,
 	}
 
 	// Configure

espresso/environment/optitmism_espresso_test_helpers.go

@@ -19,8 +19,8 @@ import (
 	"testing"
 	"time"
 
-	espressoClient "github.com/EspressoSystems/espresso-network-go/client"
-	espressoCommon "github.com/EspressoSystems/espresso-network-go/types"
+	espressoClient "github.com/EspressoSystems/espresso-network/sdks/go/client"
+	espressoCommon "github.com/EspressoSystems/espresso-network/sdks/go/types"
 	"github.com/ethereum-optimism/optimism/op-batcher/batcher"
 	"github.com/ethereum-optimism/optimism/op-batcher/flags"
 	"github.com/ethereum-optimism/optimism/op-e2e/config"
@@ -772,7 +772,8 @@ func launchEspressoDevNodeDocker() DevNetLauncherOption {
 
 							espressoDevNode := &EspressoDevNodeDockerContainerInfo{
 								DockerContainerInfo: espressoDevNodeContainerInfo,
-								espressoUrls:        []string{"http://" + hostPort},
+								// To create a valid multiple nodes client, we need to provide at least 2 URLs.
+								espressoUrls: []string{"http://" + hostPort, "http://" + hostPort},
 							}
 							ct.EspressoDevNode = espressoDevNode
 							c.EspressoUrls = espressoDevNode.espressoUrls