ipcs

package
v1.7.14-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 30, 2022 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 added in v1.0.6

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) (bool, 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

func NewClient added in v1.0.6

func NewClient(uri string) Client

NewClient returns a Client for interacting with the IPCS endpoint

type GetPublishedBlockchainsReply added in v1.1.4

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

GetPublishedBlockchainsReply is the result from calling GetPublishedBlockchains

type IPCServer added in v0.8.0

type IPCServer struct {
	// contains filtered or unexported fields
}

IPCServer maintains the IPCs

func (*IPCServer) GetPublishedBlockchains added in v1.1.4

func (ipc *IPCServer) GetPublishedBlockchains(r *http.Request, args *struct{}, reply *GetPublishedBlockchainsReply) error

GetPublishedBlockchains returns blockchains being published

func (*IPCServer) PublishBlockchain added in v0.8.0

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 added in v0.8.0

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL