ipcs

Documentation

Index

• func NewService(log logging.Logger, chainManager chains.Manager, ipcs *ipcs.ChainIPCs) (http.Handler, error)
• type Client
  • func NewClient(uri string) Client
• type GetPublishedBlockchainsReply
• type PublishBlockchainArgs
• type PublishBlockchainReply
• type Service
  • func (s *Service) GetPublishedBlockchains(_ *http.Request, _ *struct{}, reply *GetPublishedBlockchainsReply) error
  • func (s *Service) PublishBlockchain(_ *http.Request, args *PublishBlockchainArgs, reply *PublishBlockchainReply) error
  • func (s *Service) UnpublishBlockchain(_ *http.Request, args *UnpublishBlockchainArgs, _ *api.EmptyReply) error
• type UnpublishBlockchainArgs

Functions

func NewService

func NewService(log logging.Logger, chainManager chains.Manager, ipcs *ipcs.ChainIPCs) (http.Handler, error)

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

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

func NewClient

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

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

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

func (*Service) GetPublishedBlockchains

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

GetPublishedBlockchains returns blockchains being published

func (*Service) PublishBlockchain

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

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"`
}