Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(taiko-client): integrate SocialScan blob storage service #17297

Merged
merged 6 commits into from
May 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/taiko-client/cmd/flags/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ var (
Category: driverCategory,
EnvVars: []string{"BLOB_SERVER"},
}
SocialScanEndpoint = &cli.StringFlag{
Name: "blob.socialScanEndpoint",
Usage: "Social Scan's blob storage server",
Category: driverCategory,
EnvVars: []string{"BLOB_SOCIAL_SCAN_ENDPOINT"},
}
)

// DriverFlags All driver flags.
Expand All @@ -59,4 +65,5 @@ var DriverFlags = MergeFlags(CommonFlags, []cli.Flag{
CheckPointSyncURL,
MaxExponent,
BlobServerEndpoint,
SocialScanEndpoint,
})
2 changes: 2 additions & 0 deletions packages/taiko-client/driver/chain_syncer/blob/syncer.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ func NewSyncer(
progressTracker *beaconsync.SyncProgressTracker,
maxRetrieveExponent uint64,
blobServerEndpoint *url.URL,
socialScanEndpoint *url.URL,
) (*Syncer, error) {
configs, err := client.TaikoL1.GetConfig(&bind.CallOpts{Context: ctx})
if err != nil {
Expand Down Expand Up @@ -83,6 +84,7 @@ func NewSyncer(
ctx,
client,
blobServerEndpoint,
socialScanEndpoint,
),
}, nil
}
Expand Down
2 changes: 2 additions & 0 deletions packages/taiko-client/driver/chain_syncer/blob/syncer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ func (s *BlobSyncerTestSuite) SetupTest() {
beaconsync.NewSyncProgressTracker(s.RPCClient.L2, 1*time.Hour),
0,
nil,
nil,
)
s.Nil(err)
s.s = syncer
Expand All @@ -58,6 +59,7 @@ func (s *BlobSyncerTestSuite) TestCancelNewSyncer() {
s.s.progressTracker,
0,
nil,
nil,
)
s.Nil(syncer)
s.NotNil(err)
Expand Down
12 changes: 10 additions & 2 deletions packages/taiko-client/driver/chain_syncer/chain_syncer.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func New(
p2pSyncTimeout time.Duration,
maxRetrieveExponent uint64,
blobServerEndpoint *url.URL,

socialScanEndpoint *url.URL,
) (*L2ChainSyncer, error) {
tracker := beaconsync.NewSyncProgressTracker(rpc.L2, p2pSyncTimeout)
go tracker.Track(ctx)
Expand All @@ -57,7 +57,15 @@ func New(
return nil, err
}
beaconSyncer := beaconsync.NewSyncer(ctx, rpc, state, syncMode, tracker)
blobSyncer, err := blob.NewSyncer(ctx, rpc, state, tracker, maxRetrieveExponent, blobServerEndpoint)
blobSyncer, err := blob.NewSyncer(
ctx,
rpc,
state,
tracker,
maxRetrieveExponent,
blobServerEndpoint,
socialScanEndpoint,
)
if err != nil {
return nil, err
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ func (s *ChainSyncerTestSuite) SetupTest() {
1*time.Hour,
0,
nil,
nil,
)
s.Nil(err)
s.s = syncer
Expand Down
11 changes: 11 additions & 0 deletions packages/taiko-client/driver/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ type Config struct {
RetryInterval time.Duration
MaxExponent uint64
BlobServerEndpoint *url.URL
SocialScanEndpoint *url.URL
}

// NewConfigFromCliContext creates a new config instance from
Expand Down Expand Up @@ -54,6 +55,15 @@ func NewConfigFromCliContext(c *cli.Context) (*Config, error) {
}
}

var socialScanEndpoint *url.URL
if c.IsSet(flags.SocialScanEndpoint.Name) {
if socialScanEndpoint, err = url.Parse(
c.String(flags.SocialScanEndpoint.Name),
); err != nil {
return nil, err
}
}

var timeout = c.Duration(flags.RPCTimeout.Name)
return &Config{
ClientConfig: &rpc.ClientConfig{
Expand All @@ -72,5 +82,6 @@ func NewConfigFromCliContext(c *cli.Context) (*Config, error) {
P2PSyncTimeout: c.Duration(flags.P2PSyncTimeout.Name),
MaxExponent: c.Uint64(flags.MaxExponent.Name),
BlobServerEndpoint: blobServerEndpoint,
SocialScanEndpoint: socialScanEndpoint,
}, nil
}
1 change: 1 addition & 0 deletions packages/taiko-client/driver/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ func (d *Driver) InitFromConfig(ctx context.Context, cfg *Config) (err error) {
cfg.P2PSyncTimeout,
cfg.MaxExponent,
cfg.BlobServerEndpoint,
cfg.SocialScanEndpoint,
); err != nil {
return err
}
Expand Down
40 changes: 37 additions & 3 deletions packages/taiko-client/pkg/rpc/blob_datasource.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package rpc

import (
"context"
"encoding/json"
"fmt"
"net/url"

Expand All @@ -18,6 +19,7 @@ type BlobDataSource struct {
ctx context.Context
client *Client
blobServerEndpoint *url.URL
socialScanEndpoint *url.URL
}

type BlobData struct {
Expand All @@ -40,14 +42,36 @@ func NewBlobDataSource(
ctx context.Context,
client *Client,
blobServerEndpoint *url.URL,
socialScanEndpoint *url.URL,
) *BlobDataSource {
return &BlobDataSource{
ctx: ctx,
client: client,
blobServerEndpoint: blobServerEndpoint,
socialScanEndpoint: socialScanEndpoint,
}
}

// UnmarshalJSON overwrites to parse data based on different json keys
func (p *BlobServerResponse) UnmarshalJSON(data []byte) error {
var tempMap map[string]interface{}
if err := json.Unmarshal(data, &tempMap); err != nil {
return err
}

// Parsing data based on different keys
if versionedHash, ok := tempMap["versionedHash"]; ok {
p.VersionedHash = versionedHash.(string)
} else if versionedHash, ok := tempMap["versioned_hash"]; ok {
p.VersionedHash = versionedHash.(string)
}

p.Commitment = tempMap["commitment"].(string)
p.Data = tempMap["data"].(string)

return nil
}

// GetBlobs get blob sidecar by meta
func (ds *BlobDataSource) GetBlobs(
ctx context.Context,
Expand All @@ -68,7 +92,7 @@ func (ds *BlobDataSource) GetBlobs(
}
if err != nil {
log.Info("Failed to get blobs from beacon, try to use blob server.", "error", err.Error())
if ds.blobServerEndpoint == nil {
if ds.blobServerEndpoint == nil && ds.socialScanEndpoint == nil {
log.Info("No blob server endpoint set")
return nil, err
}
Expand All @@ -89,8 +113,18 @@ func (ds *BlobDataSource) GetBlobs(

// getBlobFromServer get blob data from server path `/getBlob`.
func (ds *BlobDataSource) getBlobFromServer(ctx context.Context, blobHash common.Hash) (*BlobDataSeq, error) {
route := "/blobs/" + blobHash.String()
requestURL, err := url.JoinPath(ds.blobServerEndpoint.String(), route)
var (
route string
requestURL string
err error
)
if ds.socialScanEndpoint != nil {
route = "/blob/" + blobHash.String()
requestURL, err = url.JoinPath(ds.socialScanEndpoint.String(), route)
} else {
route = "/blobs/" + blobHash.String()
requestURL, err = url.JoinPath(ds.blobServerEndpoint.String(), route)
}
if err != nil {
return nil, err
}
Expand Down
56 changes: 56 additions & 0 deletions packages/taiko-client/pkg/rpc/blob_datasource_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
package rpc

import (
"context"
"net/url"
"testing"

"github.com/ethereum/go-ethereum/common"
"github.com/stretchr/testify/require"

"github.com/taikoxyz/taiko-mono/packages/taiko-client/bindings"
)

func TestGetBlobsFromSocialScan(t *testing.T) {
socialScanEndpoint, err := url.Parse("https://api.socialscan.io/blob-archive/v1/holesky-testnet")
require.Nil(t, err)
require.NotNil(t, socialScanEndpoint)
ds := NewBlobDataSource(
context.Background(),
&Client{},
nil,
socialScanEndpoint,
)
sidecars, err := ds.GetBlobs(
context.Background(),
&bindings.TaikoDataBlockMetadata{
BlobHash: common.HexToHash("0x0145185449c57dee4e6c921b702e5d572fbeb026f96c220a6a17b79d157d921b"),
BlobUsed: true,
},
)
require.Nil(t, err)
require.NotNil(t, sidecars)
require.NotNil(t, sidecars[0].Blob)
}

func TestGetBlobsFromBlobScan(t *testing.T) {
blobScanEndpoint, err := url.Parse("https://api.holesky.blobscan.com")
require.Nil(t, err)
require.NotNil(t, blobScanEndpoint)
ds := NewBlobDataSource(
context.Background(),
&Client{},
blobScanEndpoint,
nil,
)
sidecars, err := ds.GetBlobs(
context.Background(),
&bindings.TaikoDataBlockMetadata{
BlobHash: common.HexToHash("0x0145185449c57dee4e6c921b702e5d572fbeb026f96c220a6a17b79d157d921b"),
BlobUsed: true,
},
)
require.Nil(t, err)
require.NotNil(t, sidecars)
require.NotNil(t, sidecars[0].Blob)
}
1 change: 1 addition & 0 deletions packages/taiko-client/proposer/proposer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ func (s *ProposerTestSuite) SetupTest() {
beaconsync.NewSyncProgressTracker(s.RPCClient.L2, 1*time.Hour),
0,
nil,
nil,
)
s.Nil(err)
s.s = syncer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ func (s *EventHandlerTestSuite) SetupTest() {
tracker,
0,
nil,
nil,
)
s.Nil(err)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ func (s *ProofSubmitterTestSuite) SetupTest() {
tracker,
0,
nil,
nil,
)
s.Nil(err)

Expand Down
Loading