From 08a90ad171432ce4af1810088478b509a148c8be Mon Sep 17 00:00:00 2001
From: EdisonSR <61781882@qq.com>
Date: Thu, 9 Jan 2025 09:25:29 +0800
Subject: [PATCH] Detail how to use the BlockByNumber method when special
 labels are used

---
 ethclient/ethclient.go | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/ethclient/ethclient.go b/ethclient/ethclient.go
index 0a08d1e326..eeb67f9bb4 100644
--- a/ethclient/ethclient.go
+++ b/ethclient/ethclient.go
@@ -90,6 +90,12 @@ func (ec *Client) BlockByHash(ctx context.Context, hash common.Hash) (*types.Blo
 //
 // Note that loading full blocks requires two requests. Use HeaderByNumber
 // if you don't need all transactions or uncle headers.
+// if you want to use tag like earliest, latest, finalized, safe, or finalized, you can use the
+// UnmarshalJSON fuction to get the corresponding number
+// eg:
+// var bn rpc.BlockNumber
+// err := json.Unmarshal([]byte(`"finalized"`), &bn)
+// you will get -3  and you can use for the number param
 func (ec *Client) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
 	return ec.getBlock(ctx, "eth_getBlockByNumber", toBlockNumArg(number), true)
 }