feat: Integrate WeaveVM as a secondary backend in EigenDA proxy

.env.example.holesky

@@ -81,9 +81,36 @@ EIGENDA_PROXY_EIGENDA_SERVICE_MANAGER_ADDR=0xD4A7E1Bd8015057293f0D0A557088c28694
 
 # access key secret for S3 storage
 # EIGENDA_PROXY_S3_ACCESS_KEY_SECRET=
-          
+
 # bucket name for S3 storage
 # EIGENDA_PROXY_S3_BUCKET=
-          
+
 # endpoint for S3 storage
 # EIGENDA_PROXY_S3_ENDPOINT
+
+# WVM secondary storage related environment variables
+
+# Set to true to enable WVM chain as a secondary storage
+# EIGENDA_PROXY_WVM_ENABLED=
+
+# WVM rpc endpoint
+# EIGENDA_PROXY_WVM_ENDPOINT=https://testnet-rpc.wvm.dev/
+
+# WVM chain id
+# EIGENDA_PROXY_WVM_CHAIN_ID=9496
+
+# WVM operations timeout
+# EIGENDA_PROXY_WVM_TIMEOUT=5s
+
+# WVM web3signer endpoint
+# EIGENDA_PROXY_WVM_WEB3_SIGNER_ENDPOINT=
+
+# WVM private key in case you don't use web3signer, not recommended
+# WVM_PRIV_KEY=
+
+# WVM paths to TLS related files in case you use web3signer with TLS enabled
+# EIGENDA_PROXY_WVM_WEB3_SIGNER_TLS_CERT_FILE=
+
+# EIGENDA_PROXY_WVM_WEB3_SIGNER_TLS_KEY_FILE=
+
+# EIGENDA_PROXY_WVM_WEB3_SIGNER_TLS_CERT_FILE=

README.md

@@ -19,6 +19,7 @@ Features:
 * Performs DA certificate verification during retrieval to ensure that data represented by bad DA certificates do not become part of the canonical chain.
 * Compatibility with Optimism's alt-da commitment type with eigenda backend.
 * Compatibility with Optimism's keccak-256 commitment type with S3 storage.
+* Blobs permanent backup storage option via [WeaveVM](./store/precomputed_key/wvm). 
 
 In order to disperse to the EigenDA network in production, or at high throughput on testnet, please register your authentication ethereum address through [this form](https://forms.gle/3QRNTYhSMacVFNcU8). Your EigenDA authentication keypair address should not be associated with any funds anywhere.
 

common/store.go

@@ -16,12 +16,12 @@ const (
 	RedisBackendType
 
 	UnknownBackendType
-)
 
-var (
-	ErrProxyOversizedBlob = fmt.Errorf("encoded blob is larger than max blob size")
+	WVMBackendType
 )
 
+var ErrProxyOversizedBlob = fmt.Errorf("encoded blob is larger than max blob size")
+
 func (b BackendType) String() string {
 	switch b {
 	case EigenDABackendType:
@@ -32,6 +32,8 @@ func (b BackendType) String() string {
 		return "S3"
 	case RedisBackendType:
 		return "Redis"
+	case WVMBackendType:
+		return "WVM"
 	case UnknownBackendType:
 		fallthrough
 	default:
@@ -51,6 +53,8 @@ func StringToBackendType(s string) BackendType {
 		return S3BackendType
 	case "redis":
 		return RedisBackendType
+	case "wvm":
+		return WVMBackendType
 	case "unknown":
 		fallthrough
 	default:

e2e/server_test.go

@@ -1,6 +1,7 @@
 package e2e_test
 
 import (
+	"os"
 	"testing"
 	"time"
 
@@ -37,7 +38,6 @@ this test asserts that the data can be posted/read to EigenDA
 with a concurrent S3 backend configured
 */
 func TestOptimismClientWithGenericCommitment(t *testing.T) {
-
 	if !runIntegrationTests && !runTestnetIntegrationTests {
 		t.Skip("Skipping test as INTEGRATION or TESTNET env var not set")
 	}
@@ -124,11 +124,10 @@ func TestProxyCachingWithRedis(t *testing.T) {
 }
 
 /*
-	Ensure that fallback location is read from when EigenDA blob is not available.
-	This is done by setting the memstore expiration time to 1ms and waiting for the blob to expire
-	before attempting to read it.
+Ensure that fallback location is read from when EigenDA blob is not available.
+This is done by setting the memstore expiration time to 1ms and waiting for the blob to expire
+before attempting to read it.
 */
-
 func TestProxyReadFallback(t *testing.T) {
 	// test can't be ran against holesky since read failure case can't be manually triggered
 	if !runIntegrationTests || runTestnetIntegrationTests {
@@ -166,3 +165,50 @@ func TestProxyReadFallback(t *testing.T) {
 	requireWriteReadSecondary(t, ts.Metrics.SecondaryRequestsTotal, common.S3BackendType)
 	requireDispersalRetrievalEigenDA(t, ts.Metrics.HTTPServerRequestsTotal, commitments.SimpleCommitmentMode)
 }
+
+/*
+Tests fallback when wvm secondary backend is used.
+Works only when WVM_PRIV_KEY is set
+*/
+func TestProxyReadFallbackOnWvm(t *testing.T) {
+	privateKey := os.Getenv("WVM_PRIV_KEY")
+	if privateKey == "" {
+		t.Skip("Skipping test as WVM_PRIV_KEY has not been set")
+	}
+
+	// test can't be ran against holesky since read failure case can't be manually triggered
+	if !runIntegrationTests || runTestnetIntegrationTests {
+		t.Skip("Skipping test as INTEGRATION env var not set")
+	}
+
+	t.Parallel()
+
+	// setup server with S3 as a fallback option
+	testCfg := e2e.TestConfig(useMemory())
+	testCfg.UseWVMFallback = true
+	// ensure that blob memstore eviction times result in near immediate activation
+	testCfg.Expiration = time.Millisecond * 1
+
+	tsConfig := e2e.TestSuiteConfig(testCfg)
+	ts, kill := e2e.CreateTestSuite(tsConfig)
+	defer kill()
+
+	cfg := &client.Config{
+		URL: ts.Address(),
+	}
+	daClient := client.New(cfg)
+	expectedBlob := e2e.RandBytes(1_000_000)
+	t.Log("Setting input data on proxy server...")
+	blobInfo, err := daClient.SetData(ts.Ctx, expectedBlob)
+	require.NoError(t, err)
+
+	time.Sleep(1 * time.Second)
+	t.Log("Getting input data from proxy server...")
+	actualBlob, err := daClient.GetData(ts.Ctx, blobInfo)
+	require.NoError(t, err)
+	require.Equal(t, expectedBlob, actualBlob)
+
+	requireSimpleClientSetGet(t, ts, e2e.RandBytes(1_000_000))
+	requireWriteReadSecondary(t, ts.Metrics.SecondaryRequestsTotal, common.WVMBackendType)
+	requireDispersalRetrievalEigenDA(t, ts.Metrics.HTTPServerRequestsTotal, commitments.SimpleCommitmentMode)
+}

e2e/setup.go

@@ -15,6 +15,7 @@ import (
 	"github.com/Layr-Labs/eigenda-proxy/store/generated_key/memstore"
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/redis"
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/s3"
+	wvm "github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/wvm/types"
 	"github.com/Layr-Labs/eigenda-proxy/verify"
 	"github.com/Layr-Labs/eigenda/api/clients"
 	"github.com/Layr-Labs/eigenda/encoding/kzg"
@@ -113,6 +114,7 @@ type Cfg struct {
 	UseS3Caching       bool
 	UseRedisCaching    bool
 	UseS3Fallback      bool
+	UseWVMFallback     bool
 }
 
 func TestConfig(useMemory bool) *Cfg {
@@ -123,6 +125,7 @@ func TestConfig(useMemory bool) *Cfg {
 		UseS3Caching:       false,
 		UseRedisCaching:    false,
 		UseS3Fallback:      false,
+		UseWVMFallback:     false,
 		WriteThreadCount:   0,
 	}
 }
@@ -159,6 +162,19 @@ func createS3Config(eigendaCfg server.Config) server.CLIConfig {
 	}
 }
 
+func createWVMConfig(eigendaCfg server.Config) server.CLIConfig {
+	eigendaCfg.StorageConfig.WVMConfig = wvm.Config{
+		Enabled:  true,
+		Endpoint: "https://testnet-rpc.wvm.dev/",
+		ChainID:  9496,
+		// set higher than 5s in e2e tests
+		Timeout: 10 * time.Second,
+	}
+	return server.CLIConfig{
+		EigenDAConfig: eigendaCfg,
+	}
+}
+
 func TestSuiteConfig(testCfg *Cfg) server.CLIConfig {
 	// load signer key from environment
 	pk := os.Getenv(privateKey)
@@ -237,6 +253,10 @@ func TestSuiteConfig(testCfg *Cfg) server.CLIConfig {
 		eigendaCfg.StorageConfig.FallbackTargets = []string{"S3"}
 		cfg = createS3Config(eigendaCfg)
 
+	case testCfg.UseWVMFallback:
+		eigendaCfg.StorageConfig.FallbackTargets = []string{"wvm"}
+		cfg = createWVMConfig(eigendaCfg)
+
 	case testCfg.UseRedisCaching:
 		eigendaCfg.StorageConfig.CacheTargets = []string{"redis"}
 		cfg = createRedisConfig(eigendaCfg)
@@ -273,7 +293,6 @@ func CreateTestSuite(testSuiteCfg server.CLIConfig) (TestSuite, func()) {
 		log,
 		m,
 	)
-
 	if err != nil {
 		panic(err)
 	}
@@ -340,7 +359,7 @@ func createS3Bucket(bucketName string) {
 }
 
 func RandStr(n int) string {
-	var letterRunes = []rune("abcdefghijklmnopqrstuvwxyz")
+	letterRunes := []rune("abcdefghijklmnopqrstuvwxyz")
 	b := make([]rune, n)
 	for i := range b {
 		b[i] = letterRunes[rand.Intn(len(letterRunes))]

flags/flags.go

@@ -6,6 +6,7 @@ import (
 	"github.com/Layr-Labs/eigenda-proxy/store/generated_key/memstore"
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/redis"
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/s3"
+	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/wvm"
 	"github.com/Layr-Labs/eigenda-proxy/verify"
 	"github.com/urfave/cli/v2"
 
@@ -24,6 +25,7 @@ const (
 	S3Category                 = "S3 Cache/Fallback"
 	VerifierCategory           = "KZG and Cert Verifier"
 	VerifierDeprecatedCategory = "DEPRECATED VERIFIER FLAGS -- THESE WILL BE REMOVED IN V2.0.0"
+	WVMCategory                = "WVM Fallback/Perm Storage option"
 )
 
 const (
@@ -73,4 +75,5 @@ func init() {
 	Flags = append(Flags, memstore.CLIFlags(EnvVarPrefix, MemstoreFlagsCategory)...)
 	Flags = append(Flags, verify.CLIFlags(EnvVarPrefix, VerifierCategory)...)
 	Flags = append(Flags, verify.DeprecatedCLIFlags(EnvVarPrefix, VerifierDeprecatedCategory)...)
+	Flags = append(Flags, wvm.CLIFlags(EnvVarPrefix, WVMCategory)...)
 }

go.mod

@@ -210,6 +210,7 @@ require (
 	github.com/opencontainers/image-spec v1.1.0 // indirect
 	github.com/opencontainers/runtime-spec v1.2.0 // indirect
 	github.com/opentracing/opentracing-go v1.2.0 // indirect
+	github.com/patrickmn/go-cache v2.1.0+incompatible // indirect
 	github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 // indirect
 	github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7 // indirect
 	github.com/pingcap/errors v0.11.4 // indirect

go.sum

@@ -703,6 +703,8 @@ github.com/ory/dockertest/v3 v3.10.0 h1:4K3z2VMe8Woe++invjaTB7VRyQXQy5UY+loujO4a
 github.com/ory/dockertest/v3 v3.10.0/go.mod h1:nr57ZbRWMqfsdGdFNLHz5jjNdDb7VVFnzAeW1n5N1Lg=
 github.com/pascaldekloe/goe v0.1.0 h1:cBOtyMzM9HTpWjXfbbunk26uA6nG3a8n06Wieeh0MwY=
 github.com/pascaldekloe/goe v0.1.0/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc=
+github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
+github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
 github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 h1:onHthvaw9LFnH4t2DcNVpwGmV9E1BkGknEliJkfwQj0=
 github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58/go.mod h1:DXv8WO4yhMYhSNPKjeNKa5WY9YCIEBRbNzFFPJbWO6Y=
 github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7 h1:oYW+YCJ1pachXTQmzR3rNLYGGz4g/UgFcjb28p/viDM=

server/load_store.go

@@ -11,6 +11,7 @@ import (
 	"github.com/Layr-Labs/eigenda-proxy/store/generated_key/memstore"
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/redis"
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/s3"
+	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/wvm"
 	"github.com/Layr-Labs/eigenda-proxy/verify"
 	"github.com/Layr-Labs/eigenda/api/clients"
 	"github.com/ethereum/go-ethereum/log"
@@ -19,7 +20,7 @@ import (
 // TODO - create structured abstraction for dependency injection vs. overloading stateless functions
 
 // populateTargets ... creates a list of storage backends based on the provided target strings
-func populateTargets(targets []string, s3 common.PrecomputedKeyStore, redis *redis.Store) []common.PrecomputedKeyStore {
+func populateTargets(targets []string, s3 common.PrecomputedKeyStore, redis *redis.Store, wvm common.PrecomputedKeyStore) []common.PrecomputedKeyStore {
 	stores := make([]common.PrecomputedKeyStore, len(targets))
 
 	for i, f := range targets {
@@ -38,6 +39,12 @@ func populateTargets(targets []string, s3 common.PrecomputedKeyStore, redis *red
 			}
 			stores[i] = s3
 
+		case common.WVMBackendType:
+			if wvm == nil {
+				panic(fmt.Sprintf("WVM backend is not configured but specified in targets: %s", f))
+			}
+			stores[i] = wvm
+
 		case common.EigenDABackendType, common.MemoryBackendType:
 			panic(fmt.Sprintf("Invalid target for fallback: %s", f))
 
@@ -58,6 +65,7 @@ func LoadStoreManager(ctx context.Context, cfg CLIConfig, log log.Logger, m metr
 	var err error
 	var s3Store *s3.Store
 	var redisStore *redis.Store
+	var wvmStore *wvm.Store
 
 	if cfg.EigenDAConfig.StorageConfig.S3Config.Bucket != "" && cfg.EigenDAConfig.StorageConfig.S3Config.Endpoint != "" {
 		log.Info("Using S3 backend")
@@ -67,6 +75,16 @@ func LoadStoreManager(ctx context.Context, cfg CLIConfig, log log.Logger, m metr
 		}
 	}
 
+	if cfg.EigenDAConfig.StorageConfig.WVMConfig.Enabled {
+		if cfg.EigenDAConfig.StorageConfig.WVMConfig.Endpoint != "" {
+			log.Info("Using WVM backend")
+			wvmStore, err = wvm.NewStore(&cfg.EigenDAConfig.StorageConfig.WVMConfig, log)
+			if err != nil {
+				return nil, fmt.Errorf("failed to create WVM store: %w", err)
+			}
+		}
+	}
+
 	if cfg.EigenDAConfig.StorageConfig.RedisConfig.Endpoint != "" {
 		log.Info("Using Redis backend")
 		// create Redis backend store
@@ -122,8 +140,8 @@ func LoadStoreManager(ctx context.Context, cfg CLIConfig, log log.Logger, m metr
 	}
 
 	// create secondary storage router
-	fallbacks := populateTargets(cfg.EigenDAConfig.StorageConfig.FallbackTargets, s3Store, redisStore)
-	caches := populateTargets(cfg.EigenDAConfig.StorageConfig.CacheTargets, s3Store, redisStore)
+	fallbacks := populateTargets(cfg.EigenDAConfig.StorageConfig.FallbackTargets, s3Store, redisStore, wvmStore)
+	caches := populateTargets(cfg.EigenDAConfig.StorageConfig.CacheTargets, s3Store, redisStore, wvmStore)
 	secondary := store.NewSecondaryManager(log, m, caches, fallbacks)
 
 	if secondary.Enabled() { // only spin-up go routines if secondary storage is enabled
@@ -135,6 +153,6 @@ func LoadStoreManager(ctx context.Context, cfg CLIConfig, log log.Logger, m metr
 		}
 	}
 
-	log.Info("Creating storage router", "eigenda backend type", eigenDA != nil, "s3 backend type", s3Store != nil)
+	log.Info("Creating storage router", "eigenda backend type", eigenDA != nil, "s3 backend type", s3Store != nil, "wvm backend type", wvmStore != nil)
 	return store.NewManager(eigenDA, s3Store, log, secondary)
 }

store/cli.go

@@ -3,6 +3,7 @@ package store
 import (
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/redis"
 	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/s3"
+	"github.com/Layr-Labs/eigenda-proxy/store/precomputed_key/wvm"
 	"github.com/urfave/cli/v2"
 )
 
@@ -55,5 +56,6 @@ func ReadConfig(ctx *cli.Context) Config {
 		CacheTargets:    ctx.StringSlice(CacheTargetsFlagName),
 		RedisConfig:     redis.ReadConfig(ctx),
 		S3Config:        s3.ReadConfig(ctx),
+		WVMConfig:       wvm.ReadConfig(ctx),
 	}
 }

store/generated_key/memstore/memstore_test.go

@@ -93,7 +93,6 @@ func TestExpiration(t *testing.T) {
 
 	_, err = ms.Get(ctx, key)
 	require.Error(t, err)
-
 }
 
 func TestLatency(t *testing.T) {
@@ -125,5 +124,4 @@ func TestLatency(t *testing.T) {
 	_, err = ms.Get(ctx, key)
 	require.NoError(t, err)
 	require.GreaterOrEqual(t, time.Since(timeBeforeGet), getLatency)
-
 }