ethereum, ethclient: add SyncProgress API endpoint

2 files changed, 34 insertions, 0 deletions

diff --git a/ethclient/ethclient.go b/ethclient/ethclient.go
index 575a7cb44..50346f6ae 100644
--- a/ethclient/ethclient.go
+++ b/ethclient/ethclient.go
@@ -191,6 +191,39 @@ func toBlockNumArg(number *big.Int) string {
 	return fmt.Sprintf("%#x", number)
 }
 
+type rpcProgress struct {
+	StartingBlock rpc.HexNumber
+	CurrentBlock  rpc.HexNumber
+	HighestBlock  rpc.HexNumber
+	PulledStates  rpc.HexNumber
+	KnownStates   rpc.HexNumber
+}
+
+// SyncProgress retrieves the current progress of the sync algorithm. If there's
+// no sync currently running, it returns nil.
+func (ec *Client) SyncProgress(ctx context.Context) (*ethereum.SyncProgress, error) {
+	var raw json.RawMessage
+	if err := ec.c.CallContext(ctx, &raw, "eth_syncing"); err != nil {
+		return nil, err
+	}
+	// Handle the possible response types
+	var syncing bool
+	if err := json.Unmarshal(raw, &syncing); err == nil {
+		return nil, nil // Not syncing (always false)
+	}
+	var progress *rpcProgress
+	if err := json.Unmarshal(raw, &progress); err != nil {
+		return nil, err
+	}
+	return &ethereum.SyncProgress{
+		StartingBlock: progress.StartingBlock.Uint64(),
+		CurrentBlock:  progress.CurrentBlock.Uint64(),
+		HighestBlock:  progress.HighestBlock.Uint64(),
+		PulledStates:  progress.PulledStates.Uint64(),
+		KnownStates:   progress.KnownStates.Uint64(),
+	}, nil
+}
+
 // SubscribeNewHead subscribes to notifications about the current blockchain head
 // on the given channel.
 func (ec *Client) SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (ethereum.Subscription, error) {
diff --git a/ethclient/ethclient_test.go b/ethclient/ethclient_test.go
index 47e37c0ce..0cc11eb5b 100644
--- a/ethclient/ethclient_test.go
+++ b/ethclient/ethclient_test.go
@@ -6,6 +6,7 @@ import "github.com/ethereum/go-ethereum"
 var (
 	_ = ethereum.ChainReader(&Client{})
 	_ = ethereum.ChainStateReader(&Client{})
+	_ = ethereum.ChainSyncReader(&Client{})
 	_ = ethereum.ChainHeadEventer(&Client{})
 	_ = ethereum.ContractCaller(&Client{})
 	_ = ethereum.GasEstimator(&Client{})