The highest tagged major version is v2.

ipcs

package

v1.1.11 Latest Latest Go to latest Published: Aug 12, 2025 License: BSD-3-Clause Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/luxfi/node

Links

Open Source Insights

Documentation ¶

Index ¶

func NewService(log log.Logger, chainManager chains.Manager, ipcs *ipcs.ChainIPCs) (http.Handler, error)
type Clientdeprecated
- func NewClient(uri string) Clientdeprecated
type GetPublishedBlockchainsReply
type PublishBlockchainArgs
type PublishBlockchainReply
type Service
type UnpublishBlockchainArgs

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewService ¶

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

Types ¶

type Client deprecated added in v1.1.11

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.1.11

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.11

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.1.11

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

func (*Service) GetPublishedBlockchains ¶ added in v1.1.11

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

GetPublishedBlockchains returns blockchains being published

func (*Service) PublishBlockchain ¶ added in v1.1.11

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.1.11

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

Source Files ¶

View all Source files

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