ipcs

Documentation

Index

• func NewService(log logging.Logger, chainManager chains.Manager, httpServer server.Server, ...) (*common.HTTPHandler, error)
• type Client
  • func NewClient(uri string) Client
• type GetPublishedBlockchainsReply
• type IPCServer
  • func (ipc *IPCServer) GetPublishedBlockchains(r *http.Request, args *struct{}, reply *GetPublishedBlockchainsReply) error
  • func (ipc *IPCServer) PublishBlockchain(r *http.Request, args *PublishBlockchainArgs, reply *PublishBlockchainReply) error
  • func (ipc *IPCServer) UnpublishBlockchain(r *http.Request, args *UnpublishBlockchainArgs, reply *api.SuccessResponse) error
• type PublishBlockchainArgs
• type PublishBlockchainReply
• type UnpublishBlockchainArgs

Functions

func NewService

func NewService(log logging.Logger, chainManager chains.Manager, httpServer server.Server, ipcs *ipcs.ChainIPCs) (*common.HTTPHandler, error)

NewService returns a new IPCs API service

Types

type Client

type Client interface {
	// PublishBlockchain requests the node to begin publishing consensus and decision events
	PublishBlockchain(ctx context.Context, chainID string) (*PublishBlockchainReply, error)
	// UnpublishBlockchain requests the node to stop publishing consensus and decision events
	UnpublishBlockchain(ctx context.Context, chainID string) (bool, error)
	// GetPublishedBlockchains requests the node to get blockchains being published
	GetPublishedBlockchains(ctx context.Context) ([]ids.ID, error)
}

Client interface for interacting with the IPCS endpoint

func NewClient

func NewClient(uri string) Client

NewClient returns a Client for interacting with the IPCS endpoint

type GetPublishedBlockchainsReply

type GetPublishedBlockchainsReply struct {
	Chains []ids.ID `json:"chains"`
}

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(r *http.Request, args *struct{}, reply *GetPublishedBlockchainsReply) error

GetPublishedBlockchains returns blockchains being published

func (*IPCServer) PublishBlockchain

func (ipc *IPCServer) PublishBlockchain(r *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(r *http.Request, args *UnpublishBlockchainArgs, reply *api.SuccessResponse) 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