info

Documentation

Index

• func NewService(log logging.Logger, version version.Version, nodeID ids.ShortID, ...) (*common.HTTPHandler, error)
• type Client
  • func NewClient(uri string, requestTimeout time.Duration) *Client
  • func (c *Client) GetBlockchainID(alias string) (string, error)
  • func (c *Client) GetNetworkID() (uint32, error)
  • func (c *Client) GetNetworkName() (string, error)
  • func (c *Client) GetNodeID() (string, error)
  • func (c *Client) GetNodeIP() (string, error)
  • func (c *Client) GetTxFee() (*GetTxFeeResponse, error)
  • func (c *Client) IsBootstrapped(chain string) (bool, error)
  • func (c *Client) Peers() ([]network.PeerID, error)
• type GetBlockchainIDArgs
• type GetBlockchainIDReply
• type GetNetworkIDReply
• type GetNetworkNameReply
• type GetNodeIDReply
• type GetNodeIPReply
• type GetNodeVersionReply
• type GetTxFeeResponse
• type Info
  • func (service *Info) GetBlockchainID(_ *http.Request, args *GetBlockchainIDArgs, reply *GetBlockchainIDReply) error
  • func (service *Info) GetNetworkID(_ *http.Request, _ *struct{}, reply *GetNetworkIDReply) error
  • func (service *Info) GetNetworkName(_ *http.Request, _ *struct{}, reply *GetNetworkNameReply) error
  • func (service *Info) GetNodeID(_ *http.Request, _ *struct{}, reply *GetNodeIDReply) error
  • func (service *Info) GetNodeIP(_ *http.Request, _ *struct{}, reply *GetNodeIPReply) error
  • func (service *Info) GetNodeVersion(_ *http.Request, _ *struct{}, reply *GetNodeVersionReply) error
  • func (service *Info) GetTxFee(_ *http.Request, args *struct{}, reply *GetTxFeeResponse) error
  • func (service *Info) IsBootstrapped(_ *http.Request, args *IsBootstrappedArgs, reply *IsBootstrappedResponse) error
  • func (service *Info) Peers(_ *http.Request, _ *struct{}, reply *PeersReply) error
• type IsBootstrappedArgs
• type IsBootstrappedResponse
• type PeersReply

Functions

func NewService

func NewService(
	log logging.Logger,
	version version.Version,
	nodeID ids.ShortID,
	networkID uint32,
	chainManager chains.Manager,
	peers network.Network,
	creationTxFee uint64,
	txFee uint64,
) (*common.HTTPHandler, error)

NewService returns a new admin API service

Types

type Client

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

Client is an Info API Client

func NewClient

func NewClient(uri string, requestTimeout time.Duration) *Client

NewClient returns a new Info API Client

func (*Client) GetBlockchainID

func (c *Client) GetBlockchainID(alias string) (string, error)

GetBlockchainID ...

func (*Client) GetNetworkID

func (c *Client) GetNetworkID() (uint32, error)

GetNetworkID ...

func (*Client) GetNetworkName

func (c *Client) GetNetworkName() (string, error)

GetNetworkName ...

func (*Client) GetNodeID

func (c *Client) GetNodeID() (string, error)

GetNodeID ...

func (*Client) GetNodeIP

func (c *Client) GetNodeIP() (string, error)

GetNodeIP ...

func (*Client) GetTxFee

func (c *Client) GetTxFee() (*GetTxFeeResponse, error)

GetTxFee ...

func (*Client) IsBootstrapped

func (c *Client) IsBootstrapped(chain string) (bool, error)

IsBootstrapped ...

func (*Client) Peers

func (c *Client) Peers() ([]network.PeerID, error)

Peers ...

type GetBlockchainIDArgs

type GetBlockchainIDArgs struct {
	Alias string `json:"alias"`
}

GetBlockchainIDArgs are the arguments for calling GetBlockchainID

type GetBlockchainIDReply

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

GetBlockchainIDReply are the results from calling GetBlockchainID

type GetNetworkIDReply

type GetNetworkIDReply struct {
	NetworkID json.Uint32 `json:"networkID"`
}

GetNetworkIDReply are the results from calling GetNetworkID

type GetNetworkNameReply

type GetNetworkNameReply struct {
	NetworkName string `json:"networkName"`
}

GetNetworkNameReply is the result from calling GetNetworkName

type GetNodeIDReply

type GetNodeIDReply struct {
	NodeID string `json:"nodeID"`
}

GetNodeIDReply are the results from calling GetNodeID

type GetNodeIPReply

type GetNodeIPReply struct {
	IP string `json:"ip"`
}

GetNodeIPReply are the results from calling GetNodeVersion

type GetNodeVersionReply

type GetNodeVersionReply struct {
	Version string `json:"version"`
}

GetNodeVersionReply are the results from calling GetNodeVersion

type GetTxFeeResponse

type GetTxFeeResponse struct {
	CreationTxFee json.Uint64 `json:"creationTxFee"`
	TxFee         json.Uint64 `json:"txFee"`
}

GetTxFeeResponse ...

type Info

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

Info is the API service for unprivileged info on a node

func (*Info) GetBlockchainID

func (service *Info) GetBlockchainID(_ *http.Request, args *GetBlockchainIDArgs, reply *GetBlockchainIDReply) error

GetBlockchainID returns the blockchain ID that resolves the alias that was supplied

func (*Info) GetNetworkID

func (service *Info) GetNetworkID(_ *http.Request, _ *struct{}, reply *GetNetworkIDReply) error

GetNetworkID returns the network ID this node is running on

func (*Info) GetNetworkName

func (service *Info) GetNetworkName(_ *http.Request, _ *struct{}, reply *GetNetworkNameReply) error

GetNetworkName returns the network name this node is running on

func (*Info) GetNodeID

func (service *Info) GetNodeID(_ *http.Request, _ *struct{}, reply *GetNodeIDReply) error

GetNodeID returns the node ID of this node

func (*Info) GetNodeIP

func (service *Info) GetNodeIP(_ *http.Request, _ *struct{}, reply *GetNodeIPReply) error

GetNodeIP returns the IP of this node

func (*Info) GetNodeVersion

func (service *Info) GetNodeVersion(_ *http.Request, _ *struct{}, reply *GetNodeVersionReply) error

GetNodeVersion returns the version this node is running

func (*Info) GetTxFee

func (service *Info) GetTxFee(_ *http.Request, args *struct{}, reply *GetTxFeeResponse) error

GetTxFee returns the transaction fee in nAVAX.

func (*Info) IsBootstrapped

func (service *Info) IsBootstrapped(_ *http.Request, args *IsBootstrappedArgs, reply *IsBootstrappedResponse) error

IsBootstrapped returns nil and sets [reply.IsBootstrapped] == true iff [args.Chain] exists and is done bootstrapping Returns an error if the chain doesn't exist

func (*Info) Peers

func (service *Info) Peers(_ *http.Request, _ *struct{}, reply *PeersReply) error

Peers returns the list of current validators

type IsBootstrappedArgs

type IsBootstrappedArgs struct {
	// Alias of the chain
	// Can also be the string representation of the chain's ID
	Chain string `json:"chain"`
}

IsBootstrappedArgs are the arguments for calling IsBootstrapped

type IsBootstrappedResponse

type IsBootstrappedResponse struct {
	// True iff the chain exists and is done bootstrapping
	IsBootstrapped bool `json:"isBootstrapped"`
}

IsBootstrappedResponse are the results from calling IsBootstrapped

type PeersReply

type PeersReply struct {
	// Number of elements in [Peers]
	NumPeers json.Uint64 `json:"numPeers"`
	// Each element is a peer
	Peers []network.PeerID `json:"peers"`
}

PeersReply are the results from calling Peers