Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rpc

package

Go to main page

Versions in this module

v0

v0.27.0

Sep 6, 2024

v0.26.3

Aug 19, 2024

v0.26.2

Aug 15, 2024

v0.26.1

Aug 14, 2024

v0.26.0

Aug 8, 2024

v0.25.2

Jul 15, 2024

v0.25.0

Jul 8, 2024

v0.24.7

Jun 13, 2024

v0.24.6

Jun 7, 2024

v0.24.5

Jun 4, 2024

v0.24.4

May 31, 2024

v0.24.3

May 28, 2024

v0.24.2

May 24, 2024

v0.24.1

May 22, 2024

v0.24.0

Apr 12, 2024

Changes in this version

+ const EarliestBlockNumber

+ const EngineApi

+ const FinalizedBlockNumber

+ const LatestBlockNumber

+ const MetadataApi

+ const PendingBlockNumber

+ const SafeBlockNumber

+ var DefaultHTTPTimeouts = HTTPTimeouts

+ var ErrBadResult = errors.New("bad result in JSON-RPC response")

+ var ErrClientQuit = errors.New("client is closed")

+ var ErrMissingBatchResponse = errors.New("response batch did not contain a response to this call")

+ var ErrNoResult = errors.New("JSON-RPC response has no result")

+ var ErrNotificationsUnsupported = notificationsUnsupportedError

+ var ErrSubscriptionNotFound = errors.New("subscription not found")

+ var ErrSubscriptionQueueOverflow = errors.New("subscription queue overflow")

+ func ContextRequestTimeout(ctx context.Context) (time.Duration, bool)

+ func NewContextWithHeaders(ctx context.Context, h http.Header) context.Context

+ type API struct

+ Authenticated bool

+ Namespace string

+ Public bool

+ Service interface{}

+ Version string

+ type BatchElem struct

+ Args []interface{}

+ Error error

+ Method string

+ Result interface{}

+ type BlockNumber int64

+ func (bn *BlockNumber) UnmarshalJSON(data []byte) error

+ func (bn BlockNumber) Int64() int64

+ func (bn BlockNumber) MarshalText() ([]byte, error)

+ func (bn BlockNumber) String() string

+ type BlockNumberOrHash struct

+ BlockHash *common.Hash

+ BlockNumber *BlockNumber

+ RequireCanonical bool

+ func BlockNumberOrHashWithHash(hash common.Hash, canonical bool) BlockNumberOrHash

+ func BlockNumberOrHashWithNumber(blockNr BlockNumber) BlockNumberOrHash

+ func (bnh *BlockNumberOrHash) Hash() (common.Hash, bool)

+ func (bnh *BlockNumberOrHash) Number() (BlockNumber, bool)

+ func (bnh *BlockNumberOrHash) String() string

+ func (bnh *BlockNumberOrHash) UnmarshalJSON(data []byte) error

+ type Client struct

+ UserID []byte

+ func ClientFromContext(ctx context.Context) (*Client, bool)

+ func Dial(rawurl string) (*Client, error)

+ func DialContext(ctx context.Context, rawurl string) (*Client, error)

+ func DialHTTP(endpoint string) (*Client, error)

+ func DialHTTPWithClient(endpoint string, client *http.Client) (*Client, error)

+ func DialIO(ctx context.Context, in io.Reader, out io.Writer) (*Client, error)

+ func DialIPC(ctx context.Context, endpoint string) (*Client, error)

+ func DialInProc(handler *Server) *Client

+ func DialOptions(ctx context.Context, rawurl string, options ...ClientOption) (*Client, error)

+ func DialStdIO(ctx context.Context) (*Client, error)

+ func DialWebsocket(ctx context.Context, endpoint, origin string) (*Client, error)

+ func DialWebsocketWithDialer(ctx context.Context, endpoint, origin string, dialer websocket.Dialer) (*Client, error)

+ func (c *Client) BatchCall(b []BatchElem) error

+ func (c *Client) BatchCallContext(ctx context.Context, b []BatchElem) error

+ func (c *Client) Call(result interface{}, method string, args ...interface{}) error

+ func (c *Client) CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error

+ func (c *Client) Close()

+ func (c *Client) EthSubscribe(ctx context.Context, channel interface{}, args ...interface{}) (*ClientSubscription, error)

+ func (c *Client) Notify(ctx context.Context, method string, args ...interface{}) error

+ func (c *Client) RegisterName(name string, receiver interface{}) error

+ func (c *Client) SetHeader(key, value string)

+ func (c *Client) ShhSubscribe(ctx context.Context, channel interface{}, args ...interface{}) (*ClientSubscription, error)

+ func (c *Client) Stop()

+ func (c *Client) Subscribe(ctx context.Context, namespace string, channel interface{}, ...) (*ClientSubscription, error)

+ func (c *Client) SupportedModules() (map[string]string, error)

+ func (c *Client) SupportsSubscriptions() bool

+ type ClientOption interface

+ func WithBatchItemLimit(limit int) ClientOption

+ func WithBatchResponseSizeLimit(sizeLimit int) ClientOption

+ func WithHTTPAuth(a HTTPAuth) ClientOption

+ func WithHTTPClient(c *http.Client) ClientOption

+ func WithHeader(key, value string) ClientOption

+ func WithHeaders(headers http.Header) ClientOption

+ func WithWebsocketDialer(dialer websocket.Dialer) ClientOption

+ func WithWebsocketMessageSizeLimit(messageSizeLimit int64) ClientOption

+ type ClientSubscription struct

+ func (sub *ClientSubscription) Err() <-chan error

+ func (sub *ClientSubscription) Unsubscribe()

+ type CodecOption int

+ const OptionMethodInvocation

+ const OptionSubscriptions

+ type Conn interface

+ SetWriteDeadline func(time.Time) error

+ type ConnRemoteAddr interface

+ RemoteAddr func() string

+ type DataError interface

+ Error func() string

+ ErrorData func() interface{}

+ type Error interface

+ Error func() string

+ ErrorCode func() int

+ type GWTokenKey struct

+ type HTTPAuth func(h http.Header) error

+ type HTTPError struct

+ Body []byte

+ Status string

+ StatusCode int

+ func (err HTTPError) Error() string

+ type HTTPTimeouts struct

+ IdleTimeout time.Duration

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ type ID string

+ func NewID() ID

+ type Notifier struct

+ UserID []byte

+ func NotifierFromContext(ctx context.Context) (*Notifier, bool)

+ func (n *Notifier) Closed() <-chan interface{}

+ func (n *Notifier) CreateSubscription() *Subscription

+ func (n *Notifier) Notify(id ID, data interface{}) error

+ type PeerInfo struct

+ HTTP struct{ ... }

+ RemoteAddr string

+ Transport string

+ func PeerInfoFromContext(ctx context.Context) PeerInfo

+ type RPCService struct

+ func (s *RPCService) Modules() map[string]string

+ type Server struct

+ func NewServer() *Server

+ func StartIPCEndpoint(ipcEndpoint string, apis []API) (net.Listener, *Server, error)

+ func (s *Server) RegisterName(name string, receiver interface{}) error

+ func (s *Server) ServeCodec(codec ServerCodec, _ CodecOption, userID []byte)

+ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (s *Server) ServeListener(l net.Listener) error

+ func (s *Server) SetBatchLimits(itemLimit, maxResponseSize int)

+ func (s *Server) SetHTTPBodyLimit(limit int)

+ func (s *Server) Stop()

+ func (s *Server) WebsocketHandler(allowedOrigins []string) http.Handler

+ type ServerCodec interface

+ func NewCodec(conn Conn) ServerCodec

+ func NewFuncCodec(conn deadlineCloser, encode encodeFunc, decode decodeFunc) ServerCodec

+ type Subscription struct

+ ID ID

+ func (s *Subscription) Err() <-chan error

+ func (s *Subscription) MarshalJSON() ([]byte, error)