rpc, ethclient: cater 'finalized' and 'safe' blocks in ethclient (#517)

* rpc: add finalized and safe block types * ethclient: honour safe and finalized block requests * fix: remove BlockByNumberWithoutTx function
maticnetwork · Sep 22, 2022 · c91d4ca · c91d4ca
1 parent d73d6df
commit c91d4ca
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/ethclient/ethclient.go b/ethclient/ethclient.go
@@ -537,6 +537,14 @@ func toBlockNumArg(number *big.Int) string {
 	if number.Cmp(pending) == 0 {
 		return "pending"
 	}
+	finalized := big.NewInt(int64(rpc.FinalizedBlockNumber))
+	if number.Cmp(finalized) == 0 {
+		return "finalized"
+	}
+	safe := big.NewInt(int64(rpc.SafeBlockNumber))
+	if number.Cmp(safe) == 0 {
+		return "safe"
+	}
 	return hexutil.EncodeBig(number)
 }
 

diff --git a/ethclient/gethclient/gethclient.go b/ethclient/gethclient/gethclient.go
@@ -187,6 +187,14 @@ func toBlockNumArg(number *big.Int) string {
 	if number.Cmp(pending) == 0 {
 		return "pending"
 	}
+	finalized := big.NewInt(int64(rpc.FinalizedBlockNumber))
+	if number.Cmp(finalized) == 0 {
+		return "finalized"
+	}
+	safe := big.NewInt(int64(rpc.SafeBlockNumber))
+	if number.Cmp(safe) == 0 {
+		return "safe"
+	}
 	return hexutil.EncodeBig(number)
 }
 

diff --git a/rpc/types.go b/rpc/types.go
@@ -61,9 +61,11 @@ type jsonWriter interface {
 type BlockNumber int64
 
 const (
-	PendingBlockNumber  = BlockNumber(-2)
-	LatestBlockNumber   = BlockNumber(-1)
-	EarliestBlockNumber = BlockNumber(0)
+	SafeBlockNumber      = BlockNumber(-4)
+	FinalizedBlockNumber = BlockNumber(-3)
+	PendingBlockNumber   = BlockNumber(-2)
+	LatestBlockNumber    = BlockNumber(-1)
+	EarliestBlockNumber  = BlockNumber(0)
 )
 
 // UnmarshalJSON parses the given JSON fragment into a BlockNumber. It supports: