feat: support multiple ethereum rpcs #215
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| package peggo | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "math/big" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/ethclient" | ||
| "github.com/ethereum/go-ethereum/rpc" | ||
| "github.com/knadh/koanf" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| type EthRPCManager struct { | ||
|
|
||
| currentEndpoint int // index (in the slice of configured RPC endpoints) of most recent endpoint used | ||
| client *rpc.Client | ||
| konfig *koanf.Koanf | ||
| } | ||
|
|
||
| // creates an instance of EthRPCManager with a given konfig. | ||
| func NewEthRPCManager(konfig *koanf.Koanf) *EthRPCManager { | ||
|
There was a problem hiding this comment. Would it be possible for there to be concurrent use of an There was a problem hiding this comment. Use of the embedded clients themselves should be concurrency-safe, but concurrent redialing / closing would need to be worked on - for example if one goroutine closed the client (perhaps as a result of an error in a grpc call) while another was doing something, the latter could geta very unexpected "connection was closed" type of error. Or if two concurrent redialing loops were active, a whole lot could happen. It should be possible to add a lock on DialNext() in particular before merging if we move forward with this. |
||
| ethManager := &EthRPCManager{ | ||
| konfig: konfig, | ||
| } | ||
| return ethManager | ||
| } | ||
|
|
||
| // closes and sets to nil the stored eth RPC client | ||
| func (em *EthRPCManager) CloseClient() { | ||
| if em.client != nil { | ||
| em.client.Close() | ||
| em.client = nil | ||
| } | ||
| } | ||
|
|
||
| // closes the current client and dials configured ethereum rpc endpoints in a roundrobin fashion until one | ||
| // is connected. returns an error if no endpoints ar configured or all dials failed | ||
| func (em *EthRPCManager) DialNext() error { | ||
| if em.konfig == nil { | ||
| return errors.New("ethRPCManager konfig is nil") | ||
| } | ||
|
|
||
| rpcs := strings.Split(strings.ReplaceAll(em.konfig.String(flagEthRPCs), " ", ""), ",") | ||
|
|
||
| em.CloseClient() | ||
|
|
||
| dialIndex := func(i int) bool { | ||
| if cli, err := rpc.Dial(rpcs[i]); err == nil { | ||
| em.currentEndpoint = i | ||
| em.client = cli | ||
| return true | ||
| } | ||
| fmt.Fprintf(os.Stderr, "Failed to dial to Ethereum RPC: %s\n", rpcs[i]) | ||
|
There was a problem hiding this comment. We should probably pass the core logger to |
||
| return false | ||
| } | ||
|
|
||
| // first tries all endpoints in the slice after the current index | ||
|
There was a problem hiding this comment. We could probably combine both these loops into one using the modulo operator. |
||
| for i := range rpcs { | ||
| if i > em.currentEndpoint && dialIndex(i) { | ||
| fmt.Fprintf(os.Stderr, "Connected to Ethereum RPC: %s\n", rpcs[i]) | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| // then tries remaining endpoints from the beginning of the slice | ||
| for i := range rpcs { | ||
| if i <= em.currentEndpoint && dialIndex(i) { | ||
| fmt.Fprintf(os.Stderr, "Connected to Ethereum RPC: %s\n", rpcs[i]) | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| return errors.New(fmt.Sprintf("failed to dial any of the %d Ethereum RPC endpoints configured", len(rpcs))) | ||
| } | ||
|
|
||
| // returns the current eth RPC client, dialing one first if nonexistent | ||
| func (em *EthRPCManager) GetClient() (*rpc.Client, error) { | ||
| if em.client == nil { | ||
| if err := em.DialNext(); err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| return em.client, nil | ||
| } | ||
|
|
||
| // returns the current eth RPC client, dialing one first if nonexistent | ||
| func (em *EthRPCManager) GetEthClient() (*ethclient.Client, error) { | ||
| cli, err := em.GetClient() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return ethclient.NewClient(cli), nil | ||
| } | ||
|
|
||
| // wraps ethclient.PendingNonceAt, also closing client if PendingNonceAt returns an error | ||
| func (em *EthRPCManager) PendingNonceAt(ctx context.Context, addr common.Address) (uint64, error) { | ||
| cli, err := em.GetEthClient() | ||
| if err != nil { | ||
| return 0, err | ||
| } | ||
| nonce, err := cli.PendingNonceAt(ctx, addr) | ||
| if err != nil { | ||
| em.CloseClient() | ||
| return 0, err | ||
| } | ||
| return nonce, nil | ||
| } | ||
|
|
||
| // wraps ethclient.ChainID, also closing client if ChainID returns an error | ||
| func (em *EthRPCManager) ChainID(ctx context.Context) (*big.Int, error) { | ||
| cli, err := em.GetEthClient() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| id, err := cli.ChainID(ctx) | ||
| if err != nil { | ||
| em.CloseClient() | ||
| return nil, err | ||
| } | ||
| return id, nil | ||
| } | ||
|
|
||
| // wraps ethclient.SuggestGasPrice, also closing client if SuggestGasPrice returns an error | ||
| func (em *EthRPCManager) SuggestGasPrice(ctx context.Context) (*big.Int, error) { | ||
| cli, err := em.GetEthClient() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| price, err := cli.SuggestGasPrice(ctx) | ||
| if err != nil { | ||
| em.CloseClient() | ||
| return nil, err | ||
| } | ||
| return price, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.