api

package
v1.9.2 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2025 License: BSD-3-Clause Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIClient

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

APIClient gives access to most node apis (or suitable wrappers)

func (APIClient) AdminAPI

func (c APIClient) AdminAPI() *admin.Client

func (APIClient) CChainAPI

func (c APIClient) CChainAPI() interface{}

func (APIClient) CChainEthAPI

func (c APIClient) CChainEthAPI() EthClient

func (APIClient) CChainIndexAPI

func (c APIClient) CChainIndexAPI() *indexer.Client

func (APIClient) HealthAPI

func (c APIClient) HealthAPI() *health.Client

func (APIClient) InfoAPI

func (c APIClient) InfoAPI() *info.Client

func (APIClient) PChainAPI

func (c APIClient) PChainAPI() *platformvm.Client

func (APIClient) PChainIndexAPI

func (c APIClient) PChainIndexAPI() *indexer.Client

func (APIClient) XChainAPI

func (c APIClient) XChainAPI() *xvm.Client

func (APIClient) XChainWalletAPI

func (c APIClient) XChainWalletAPI() *xvm.WalletClient

type Client

type Client interface {
	PChainAPI() *platformvm.Client
	XChainAPI() *xvm.Client
	XChainWalletAPI() *xvm.WalletClient
	CChainAPI() interface{}  // evmclient.Client
	CChainEthAPI() EthClient // ethclient websocket wrapper that adds mutexed calls, and lazy conn init (on first call)
	InfoAPI() *info.Client
	HealthAPI() *health.Client
	AdminAPI() *admin.Client
	PChainIndexAPI() *indexer.Client
	CChainIndexAPI() *indexer.Client
}

Issues API calls to a node TODO: byzantine api. check if appropriate. improve implementation.

func NewAPIClient

func NewAPIClient(ipAddr string, port uint16) Client

NewAPIClient initialize most of node apis

type EthClient

type EthClient interface{}

EthClient is a placeholder interface for ethereum client

type NewAPIClientF

type NewAPIClientF func(ipAddr string, port uint16) Client

Returns a new API client for a node at [ipAddr]:[port].

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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