Documentation
¶
Index ¶
- func NewService(log logging.Logger, chainManager chains.Manager, httpServer server.Server, ...) (*common.HTTPHandler, error)
- type Client
- type GetPublishedBlockchainsReply
- type IPCServer
- func (ipc *IPCServer) GetPublishedBlockchains(_ *http.Request, _ *struct{}, reply *GetPublishedBlockchainsReply) error
- func (ipc *IPCServer) PublishBlockchain(_ *http.Request, args *PublishBlockchainArgs, reply *PublishBlockchainReply) error
- func (ipc *IPCServer) UnpublishBlockchain(_ *http.Request, args *UnpublishBlockchainArgs, _ *api.EmptyReply) error
- type PublishBlockchainArgs
- type PublishBlockchainReply
- type UnpublishBlockchainArgs
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client interface { // PublishBlockchain requests the node to begin publishing consensus and decision events PublishBlockchain(ctx context.Context, chainID string, options ...rpc.Option) (*PublishBlockchainReply, error) // UnpublishBlockchain requests the node to stop publishing consensus and decision events UnpublishBlockchain(ctx context.Context, chainID string, options ...rpc.Option) error // GetPublishedBlockchains requests the node to get blockchains being published GetPublishedBlockchains(ctx context.Context, options ...rpc.Option) ([]ids.ID, error) }
Client interface for interacting with the IPCS endpoint
type GetPublishedBlockchainsReply ¶
GetPublishedBlockchainsReply is the result from calling GetPublishedBlockchains
type IPCServer ¶
type IPCServer struct {
// contains filtered or unexported fields
}
IPCServer maintains the IPCs
func (*IPCServer) GetPublishedBlockchains ¶
func (ipc *IPCServer) GetPublishedBlockchains(_ *http.Request, _ *struct{}, reply *GetPublishedBlockchainsReply) error
GetPublishedBlockchains returns blockchains being published
func (*IPCServer) PublishBlockchain ¶
func (ipc *IPCServer) PublishBlockchain(_ *http.Request, args *PublishBlockchainArgs, reply *PublishBlockchainReply) error
PublishBlockchain publishes the finalized accepted transactions from the blockchainID over the IPC
func (*IPCServer) UnpublishBlockchain ¶
func (ipc *IPCServer) UnpublishBlockchain(_ *http.Request, args *UnpublishBlockchainArgs, _ *api.EmptyReply) error
UnpublishBlockchain closes publishing of a blockchainID
type PublishBlockchainArgs ¶
type PublishBlockchainArgs struct {
BlockchainID string `json:"blockchainID"`
}
PublishBlockchainArgs are the arguments for calling PublishBlockchain
type PublishBlockchainReply ¶
type PublishBlockchainReply struct { ConsensusURL string `json:"consensusURL"` DecisionsURL string `json:"decisionsURL"` }
PublishBlockchainReply are the results from calling PublishBlockchain
type UnpublishBlockchainArgs ¶
type UnpublishBlockchainArgs struct {
BlockchainID string `json:"blockchainID"`
}
UnpublishBlockchainArgs are the arguments for calling UnpublishBlockchain
Click to show internal directories.
Click to hide internal directories.