Documentation
¶
Index ¶
- func AwaitBootstrapped(ctx context.Context, c *Client, chainID string, freq time.Duration, ...) (bool, error)
- type Client
- func (c *Client) GetBlockchainID(ctx context.Context, alias string, options ...rpc.Option) (ids.ID, error)
- func (c *Client) GetNetworkID(ctx context.Context, options ...rpc.Option) (uint32, error)
- func (c *Client) GetNetworkName(ctx context.Context, options ...rpc.Option) (string, error)
- func (c *Client) GetNodeID(ctx context.Context, options ...rpc.Option) (ids.NodeID, *apiinfo.ProofOfPossession, error)
- func (c *Client) GetNodeIP(ctx context.Context, options ...rpc.Option) (netip.AddrPort, error)
- func (c *Client) GetNodeVersion(ctx context.Context, options ...rpc.Option) (*apiinfo.GetNodeVersionReply, error)
- func (c *Client) GetVMs(ctx context.Context, options ...rpc.Option) (apiinfo.VMAliases, error)
- func (c *Client) IsBootstrapped(ctx context.Context, chainID string, options ...rpc.Option) (bool, error)
- func (c *Client) Peers(ctx context.Context, nodeIDs []ids.NodeID, options ...rpc.Option) ([]apiinfo.Peer, error)
- func (c *Client) Upgrades(ctx context.Context, options ...rpc.Option) (*upgrade.Config, error)
- func (c *Client) Uptime(ctx context.Context, options ...rpc.Option) (*apiinfo.UptimeResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AwaitBootstrapped ¶
func AwaitBootstrapped(ctx context.Context, c *Client, chainID string, freq time.Duration, options ...rpc.Option) (bool, error)
AwaitBootstrapped polls the node every [freq] to check if [chainID] has finished bootstrapping. Returns true once [chainID] reports that it has finished bootstrapping. Only returns an error if [ctx] returns an error.
Types ¶
type Client ¶
type Client struct {
Requester rpc.EndpointRequester
}
func (*Client) GetBlockchainID ¶
func (*Client) GetNetworkID ¶
func (*Client) GetNetworkName ¶
func (*Client) GetNodeVersion ¶
func (*Client) GetVMs ¶
GetVMs are the VMs installed on the node, in id order. A list rather than a map because that is what the node answers with — a map has no layout on a wire whose fields are offsets, and no order for two reads to agree on.
func (*Client) IsBootstrapped ¶
Source Files
Click to show internal directories.
Click to hide internal directories.