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

v1

v1.0.0-rc1

Nov 29, 2024

v0

v0.5.0-rc1

Oct 15, 2024

v0.4.0

Mar 25, 2024

Changes in this version

+ type AdminAPI struct

+ func NewAdminAPI(node AdminNode, name string, self *network.Peer, log *slog.Logger) *AdminAPI

+ func (s *AdminAPI) GetNodeInfo() (*NodeInfoResponse, error)

+ type AdminNode interface

+ SystemIdentifier func() types.SystemID

+ type NodeInfoResponse struct

+ BootstrapNodes []PeerInfo

+ Name string

+ OpenConnections []PeerInfo

+ PartitionValidators []PeerInfo

+ RootValidators []PeerInfo

+ Self PeerInfo

+ SystemID types.SystemID

+ type PeerInfo struct

+ Addresses []multiaddr.Multiaddr

+ Identifier string

+ func (pi *PeerInfo) UnmarshalJSON(data []byte) error

type StateAPI

+ func (s *StateAPI) GetBlock(ctx context.Context, blockNumber types.Uint64) (types.Bytes, error)

+ type TransactionRecordAndProof struct

+ TxProof types.Bytes

+ TxRecord types.Bytes

+ type Unit struct

+ Data T

+ OwnerPredicate types.Bytes

+ StateProof *types.UnitStateProof

+ UnitID types.UnitID

v0.3.0

Feb 28, 2024

Changes in this version

+ const DefaultBatchItemLimit

+ const DefaultBatchResponseSizeLimit

+ const DefaultMaxBodyBytes

+ const MetricsScopeGRPCAPI

+ func InstrumentMetricsUnaryServerInterceptor(mtr metric.Meter, log *slog.Logger) grpc.UnaryServerInterceptor

+ func NewGRPCServer(node partitionNode, obs Observability, opts ...Option) (*grpcServer, error)

+ func NewHTTPServer(conf *ServerConfiguration, obs Observability, registrars ...Registrar) (*http.Server, error)

+ func NewRESTServer(addr string, maxBodySize int64, obs Observability, registrars ...Registrar) *http.Server

+ func WriteCBORError(w http.ResponseWriter, e error, code int, log *slog.Logger)

+ func WriteCBORResponse(w http.ResponseWriter, response any, statusCode int, log *slog.Logger)

+ type API struct

+ Namespace string

+ Service interface{}

+ type Observability interface

+ Logger func() *slog.Logger

+ Meter func(name string, opts ...metric.MeterOption) metric.Meter

+ PrometheusRegisterer func() prometheus.Registerer

+ type Option func(*Options)

+ func WithMaxGetBlocksBatchSize(maxGetBlocksBatchSize uint64) Option

+ type Options struct

+ type Registrar interface

+ Register func(r *mux.Router)

+ type RegistrarFunc func(r *mux.Router)

+ func InfoEndpoints(node partitionNode, name string, self *network.Peer, log *slog.Logger) RegistrarFunc

+ func MetricsEndpoints(pr prometheus.Registerer) RegistrarFunc

+ func NodeEndpoints(node partitionNode, unitProofDB keyvaluedb.KeyValueDB, obs Observability) RegistrarFunc

+ func (f RegistrarFunc) Register(r *mux.Router)

+ type ServerConfiguration struct

+ APIs []API

+ Address string

+ BatchItemLimit int

+ BatchResponseSizeLimit int

+ IdleTimeout time.Duration

+ MaxBodyBytes int64

+ MaxHeaderBytes int

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ Router Registrar

+ WriteTimeout time.Duration

+ func (c *ServerConfiguration) IsAddressEmpty() bool

+ type StateAPI struct

+ func NewStateAPI(node *partition.Node) *StateAPI

+ func (s *StateAPI) GetRoundNumber(ctx context.Context) (uint64, error)

+ func (s *StateAPI) GetTransactionProof(txHash string) ([]byte, error)

+ func (s *StateAPI) GetUnit(unitID string) (state.UnitData, error)

+ func (s *StateAPI) GetUnitsByOwnerID(ownerID string) ([]state.UnitData, error)

+ func (s *StateAPI) SendTransaction(tx []byte) error