erigon-pulse/cmd/rpcdaemon/commands/net_api.go
Thomas Jay Rush 1af3e09d75
1209 automate documentation (#1290)
* Automate documentation

* Updating

* Updating

* Fixing lint

* Updating readthedocs documentation

* Updating testing

* Updating testing
2020-10-24 18:03:52 +01:00

58 lines
1.5 KiB
Go

package commands
import (
"context"
"fmt"
"strconv"
"github.com/ledgerwatch/turbo-geth/common/hexutil"
"github.com/ledgerwatch/turbo-geth/ethdb"
)
// NetAPI the interface for the net_ RPC commands
type NetAPI interface {
Listening(_ context.Context) (bool, error)
Version(_ context.Context) (string, error)
PeerCount(_ context.Context) (hexutil.Uint, error)
}
// NetAPIImpl data structure to store things needed for net_ commands
type NetAPIImpl struct {
ethBackend ethdb.Backend
}
// NewNetAPIImpl returns NetAPIImplImpl instance
func NewNetAPIImpl(eth ethdb.Backend) *NetAPIImpl {
return &NetAPIImpl{
ethBackend: eth,
}
}
// Listening implements net_listening. Returns true if client is actively listening for network connections.
// TODO: Remove hard coded value
func (api *NetAPIImpl) Listening(_ context.Context) (bool, error) {
return true, nil
}
// Version implements net_version. Returns the current network id.
func (api *NetAPIImpl) Version(_ context.Context) (string, error) {
if api.ethBackend == nil {
// We're running in --chaindata mode or otherwise cannot get the backend
return "", fmt.Errorf(NotAvailableChainData, "net_version")
}
res, err := api.ethBackend.NetVersion()
if err != nil {
return "", err
}
return strconv.FormatUint(res, 10), nil
}
// PeerCount implements net_peerCount. Returns number of peers currently connected to the client.
// TODO: This routine currently returns a hard coded value of '25'
func (api *NetAPIImpl) PeerCount(_ context.Context) (hexutil.Uint, error) {
return hexutil.Uint(25), nil
}