go-ethereum/ethdb/remotedb/remotedb.go
Ocenka ec6d104404
eth/remotedb: improve error handling (#31331)
This PR improves error handling in the remotedb package by fixing two
issues:

1. In the `Has` method, we now properly propagate errors instead of
silently returning false. This makes the behavior more predictable and
helps clients better understand when there are connection issues.

2. In the `New` constructor, we add a nil check for the client parameter
to prevent potential panics. This follows Go best practices for
constructor functions.

These changes make the code more robust and follow Go's error handling
idioms without requiring any changes to other parts of the codebase.

Changes:
- Modified `Has` method to return errors instead of silently returning
false
- Added nil check in `New` constructor
- Fixed field name in constructor to match struct definition
2025-04-08 14:44:13 +02:00

151 lines
3.8 KiB
Go

// Copyright 2022 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
// Package remotedb implements the key-value database layer based on a remote geth
// node. Under the hood, it utilises the `debug_dbGet` method to implement a
// read-only database.
// There really are no guarantees in this database, since the local geth does not
// exclusive access, but it can be used for basic diagnostics of a remote node.
package remotedb
import (
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/ethereum/go-ethereum/ethdb"
"github.com/ethereum/go-ethereum/rpc"
)
// Database is a key-value lookup for a remote database via debug_dbGet.
type Database struct {
remote *rpc.Client
}
func (db *Database) Has(key []byte) (bool, error) {
if _, err := db.Get(key); err != nil {
return false, err
}
return true, nil
}
func (db *Database) Get(key []byte) ([]byte, error) {
var resp hexutil.Bytes
err := db.remote.Call(&resp, "debug_dbGet", hexutil.Bytes(key))
if err != nil {
return nil, err
}
return resp, nil
}
func (db *Database) HasAncient(kind string, number uint64) (bool, error) {
if _, err := db.Ancient(kind, number); err != nil {
return false, err
}
return true, nil
}
func (db *Database) Ancient(kind string, number uint64) ([]byte, error) {
var resp hexutil.Bytes
err := db.remote.Call(&resp, "debug_dbAncient", kind, number)
if err != nil {
return nil, err
}
return resp, nil
}
func (db *Database) AncientRange(kind string, start, count, maxBytes uint64) ([][]byte, error) {
panic("not supported")
}
func (db *Database) Ancients() (uint64, error) {
var resp uint64
err := db.remote.Call(&resp, "debug_dbAncients")
return resp, err
}
func (db *Database) Tail() (uint64, error) {
panic("not supported")
}
func (db *Database) AncientSize(kind string) (uint64, error) {
panic("not supported")
}
func (db *Database) ReadAncients(fn func(op ethdb.AncientReaderOp) error) (err error) {
return fn(db)
}
func (db *Database) Put(key []byte, value []byte) error {
panic("not supported")
}
func (db *Database) Delete(key []byte) error {
panic("not supported")
}
func (db *Database) DeleteRange(start, end []byte) error {
panic("not supported")
}
func (db *Database) ModifyAncients(f func(ethdb.AncientWriteOp) error) (int64, error) {
panic("not supported")
}
func (db *Database) TruncateHead(n uint64) (uint64, error) {
panic("not supported")
}
func (db *Database) TruncateTail(n uint64) (uint64, error) {
panic("not supported")
}
func (db *Database) Sync() error {
return nil
}
func (db *Database) NewBatch() ethdb.Batch {
panic("not supported")
}
func (db *Database) NewBatchWithSize(size int) ethdb.Batch {
panic("not supported")
}
func (db *Database) NewIterator(prefix []byte, start []byte) ethdb.Iterator {
panic("not supported")
}
func (db *Database) Stat() (string, error) {
return "", nil
}
func (db *Database) AncientDatadir() (string, error) {
panic("not supported")
}
func (db *Database) Compact(start []byte, limit []byte) error {
return nil
}
func (db *Database) Close() error {
db.remote.Close()
return nil
}
func New(client *rpc.Client) ethdb.Database {
if client == nil {
return nil
}
return &Database{remote: client}
}