ipcs

package
v1.10.18-wip-p2p-bloom... Latest Latest
Warning

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

Go to latest
Published: Jan 16, 2024 License: BSD-3-Clause Imports: 12 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, ipcs *ipcs.ChainIPCs) (http.Handler, error)

Types

type Client deprecated 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) 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

Deprecated: The IPCs API is deprecated. The Index API should be used instead.

func NewClient deprecated added in v1.0.6

func NewClient(uri string) Client

NewClient returns a Client for interacting with the IPCS endpoint

Deprecated: The IPCs API is deprecated. The Index API should be used instead.

type GetPublishedBlockchainsReply added in v1.1.4

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

type PublishBlockchainArgs

type PublishBlockchainArgs struct {
	BlockchainID string `json:"blockchainID"`
}

type PublishBlockchainReply

type PublishBlockchainReply struct {
	ConsensusURL string `json:"consensusURL"`
	DecisionsURL string `json:"decisionsURL"`
}

type Service added in v1.10.13

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

func (*Service) GetPublishedBlockchains added in v1.10.13

func (s *Service) GetPublishedBlockchains(_ *http.Request, _ *struct{}, reply *GetPublishedBlockchainsReply) error

GetPublishedBlockchains returns blockchains being published

func (*Service) PublishBlockchain added in v1.10.13

func (s *Service) PublishBlockchain(_ *http.Request, args *PublishBlockchainArgs, reply *PublishBlockchainReply) error

PublishBlockchain publishes the finalized accepted transactions from the blockchainID over the IPC

func (*Service) UnpublishBlockchain added in v1.10.13

func (s *Service) UnpublishBlockchain(_ *http.Request, args *UnpublishBlockchainArgs, _ *api.EmptyReply) error

UnpublishBlockchain closes publishing of a blockchainID

type UnpublishBlockchainArgs

type UnpublishBlockchainArgs struct {
	BlockchainID string `json:"blockchainID"`
}

Jump to

Keyboard shortcuts

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