csclient

Documentation

Index

• type ApiClient
  • func NewApiClient(apiUrl *url.URL, logger *slog.Logger, tracer *httptrace.ClientTrace, ...) *ApiClient
• type MinipoolRequester
  • func NewMinipoolRequester(context client.IRequesterContext) *MinipoolRequester
  • func (r *MinipoolRequester) Close(addresses []common.Address) (*types.ApiResponse[types.BatchTxInfoData], error)
  • func (r *MinipoolRequester) Create(salt *big.Int, skipLiquidityCheck bool, skipBalanceCheck bool) (*types.ApiResponse[csapi.MinipoolCreateData], error)
  • func (r *MinipoolRequester) Exit(infos []csapi.MinipoolValidatorInfo) (*types.ApiResponse[types.SuccessData], error)
  • func (r *MinipoolRequester) GetCloseDetails() (*types.ApiResponse[csapi.MinipoolCloseDetailsData], error)
  • func (r *MinipoolRequester) GetContext() client.IRequesterContext
  • func (r *MinipoolRequester) GetExitDetails(verbose bool) (*types.ApiResponse[csapi.MinipoolExitDetailsData], error)
  • func (r *MinipoolRequester) GetName() string
  • func (r *MinipoolRequester) GetPubkeys(includeExited bool) (*types.ApiResponse[csapi.MinipoolGetPubkeysData], error)
  • func (r *MinipoolRequester) GetRoute() string
  • func (r *MinipoolRequester) GetVanityArtifacts(nodeAddressStr string) (*types.ApiResponse[csapi.MinipoolVanityArtifactsData], error)
  • func (r *MinipoolRequester) Stake() (*types.ApiResponse[csapi.MinipoolStakeData], error)
  • func (r *MinipoolRequester) Status() (*types.ApiResponse[csapi.MinipoolStatusData], error)
  • func (r *MinipoolRequester) UploadSignedExits(infos []csapi.MinipoolValidatorInfo) (*types.ApiResponse[types.SuccessData], error)
• type NetworkRequester
  • func NewNetworkRequester(context client.IRequesterContext) *NetworkRequester
  • func (r *NetworkRequester) GetContext() client.IRequesterContext
  • func (r *NetworkRequester) GetName() string
  • func (r *NetworkRequester) GetRoute() string
  • func (r *NetworkRequester) Stats() (*types.ApiResponse[csapi.NetworkStatsData], error)
• type NodeRequester
  • func NewNodeRequester(context client.IRequesterContext) *NodeRequester
  • func (r *NodeRequester) GetContext() client.IRequesterContext
  • func (r *NodeRequester) GetName() string
  • func (r *NodeRequester) GetRegistrationStatus() (*types.ApiResponse[csapi.NodeGetRegistrationStatusData], error)
  • func (r *NodeRequester) GetRoute() string
  • func (r *NodeRequester) Register() (*types.ApiResponse[csapi.NodeRegisterData], error)
• type ServiceRequester
  • func NewServiceRequester(context client.IRequesterContext) *ServiceRequester
  • func (r *ServiceRequester) GetContext() client.IRequesterContext
  • func (r *ServiceRequester) GetName() string
  • func (r *ServiceRequester) GetNetworkSettings() (*types.ApiResponse[csapi.ServiceGetNetworkSettingsData], error)
  • func (r *ServiceRequester) GetResources() (*types.ApiResponse[csapi.ServiceGetResourcesData], error)
  • func (r *ServiceRequester) GetRoute() string
  • func (r *ServiceRequester) Version() (*types.ApiResponse[csapi.ServiceVersionData], error)
• type WalletRequester
  • func NewWalletRequester(context client.IRequesterContext) *WalletRequester
  • func (r *WalletRequester) CreateValidatorKey(pubkey beacon.ValidatorPubkey, index uint64, maxAttempts uint64) (*types.ApiResponse[csapi.WalletCreateValidatorKeyData], error)
  • func (r *WalletRequester) GetContext() client.IRequesterContext
  • func (r *WalletRequester) GetName() string
  • func (r *WalletRequester) GetRoute() string

Types

type ApiClient

type ApiClient struct {
	Minipool *MinipoolRequester
	Network  *NetworkRequester
	Node     *NodeRequester
	Service  *ServiceRequester
	Wallet   *WalletRequester
	// contains filtered or unexported fields
}

Binder for the Constellation API server

func NewApiClient

func NewApiClient(apiUrl *url.URL, logger *slog.Logger, tracer *httptrace.ClientTrace, authMgr *auth.AuthorizationManager) *ApiClient

Creates a new API client instance

type MinipoolRequester

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

func NewMinipoolRequester

func NewMinipoolRequester(context client.IRequesterContext) *MinipoolRequester

func (*MinipoolRequester) Close

func (r *MinipoolRequester) Close(addresses []common.Address) (*types.ApiResponse[types.BatchTxInfoData], error)

Close

func (*MinipoolRequester) Create

func (r *MinipoolRequester) Create(salt *big.Int, skipLiquidityCheck bool, skipBalanceCheck bool) (*types.ApiResponse[csapi.MinipoolCreateData], error)

Deposit to Constellation to create a new minipool

func (*MinipoolRequester) Exit

func (r *MinipoolRequester) Exit(infos []csapi.MinipoolValidatorInfo) (*types.ApiResponse[types.SuccessData], error)

Submit voluntary exits for minipool validators to the Beacon Chain

func (*MinipoolRequester) GetCloseDetails

func (r *MinipoolRequester) GetCloseDetails() (*types.ApiResponse[csapi.MinipoolCloseDetailsData], error)

Get close details

func (*MinipoolRequester) GetContext

func (r *MinipoolRequester) GetContext() client.IRequesterContext

func (*MinipoolRequester) GetExitDetails

func (r *MinipoolRequester) GetExitDetails(verbose bool) (*types.ApiResponse[csapi.MinipoolExitDetailsData], error)

Get details of minipools that are eligible for exiting, optionally listing all minipools instead (even ones that are not eligible)

func (*MinipoolRequester) GetName

func (r *MinipoolRequester) GetName() string

func (*MinipoolRequester) GetPubkeys

func (r *MinipoolRequester) GetPubkeys(includeExited bool) (*types.ApiResponse[csapi.MinipoolGetPubkeysData], error)

Get the minipool address, validator pubkey, and Beacon chain index for each of this node's minipools

func (*MinipoolRequester) GetRoute

func (r *MinipoolRequester) GetRoute() string

func (*MinipoolRequester) GetVanityArtifacts

func (r *MinipoolRequester) GetVanityArtifacts(nodeAddressStr string) (*types.ApiResponse[csapi.MinipoolVanityArtifactsData], error)

Get the artifacts necessary for vanity address searching

func (*MinipoolRequester) Stake

func (r *MinipoolRequester) Stake() (*types.ApiResponse[csapi.MinipoolStakeData], error)

Get details and transaction info of minipools that are eligible for staking

func (*MinipoolRequester) Status

func (r *MinipoolRequester) Status() (*types.ApiResponse[csapi.MinipoolStatusData], error)

Get all status details for minipools

func (*MinipoolRequester) UploadSignedExits

func (r *MinipoolRequester) UploadSignedExits(infos []csapi.MinipoolValidatorInfo) (*types.ApiResponse[types.SuccessData], error)

Upload signed voluntary exit messages for minipool validators to the NodeSet server

type NetworkRequester

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

func NewNetworkRequester

func NewNetworkRequester(context client.IRequesterContext) *NetworkRequester

func (*NetworkRequester) GetContext

func (r *NetworkRequester) GetContext() client.IRequesterContext

func (*NetworkRequester) GetName

func (r *NetworkRequester) GetName() string

func (*NetworkRequester) GetRoute

func (r *NetworkRequester) GetRoute() string

func (*NetworkRequester) Stats

func (r *NetworkRequester) Stats() (*types.ApiResponse[csapi.NetworkStatsData], error)

Get information about the Constellation network

type NodeRequester

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

func NewNodeRequester

func NewNodeRequester(context client.IRequesterContext) *NodeRequester

func (*NodeRequester) GetContext

func (r *NodeRequester) GetContext() client.IRequesterContext

func (*NodeRequester) GetName

func (r *NodeRequester) GetName() string

func (*NodeRequester) GetRegistrationStatus

func (r *NodeRequester) GetRegistrationStatus() (*types.ApiResponse[csapi.NodeGetRegistrationStatusData], error)

Get the registration status of the node with Constellation

func (*NodeRequester) GetRoute

func (r *NodeRequester) GetRoute() string

func (*NodeRequester) Register

func (r *NodeRequester) Register() (*types.ApiResponse[csapi.NodeRegisterData], error)

Gets a TX for registering the node with Constellation

type ServiceRequester

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

func NewServiceRequester

func NewServiceRequester(context client.IRequesterContext) *ServiceRequester

func (*ServiceRequester) GetContext

func (r *ServiceRequester) GetContext() client.IRequesterContext

func (*ServiceRequester) GetName

func (r *ServiceRequester) GetName() string

func (*ServiceRequester) GetNetworkSettings

func (r *ServiceRequester) GetNetworkSettings() (*types.ApiResponse[csapi.ServiceGetNetworkSettingsData], error)

Gets the network settings for the daemon's selected network

func (*ServiceRequester) GetResources

func (r *ServiceRequester) GetResources() (*types.ApiResponse[csapi.ServiceGetResourcesData], error)

Gets the resources for the daemon's selected network

func (*ServiceRequester) GetRoute

func (r *ServiceRequester) GetRoute() string

func (*ServiceRequester) Version

func (r *ServiceRequester) Version() (*types.ApiResponse[csapi.ServiceVersionData], error)

Gets the version of the daemon

type WalletRequester

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

func NewWalletRequester

func NewWalletRequester(context client.IRequesterContext) *WalletRequester

func (*WalletRequester) CreateValidatorKey

func (r *WalletRequester) CreateValidatorKey(pubkey beacon.ValidatorPubkey, index uint64, maxAttempts uint64) (*types.ApiResponse[csapi.WalletCreateValidatorKeyData], error)

Recover a validator key

func (*WalletRequester) GetContext

func (r *WalletRequester) GetContext() client.IRequesterContext

func (*WalletRequester) GetName

func (r *WalletRequester) GetName() string

func (*WalletRequester) GetRoute

func (r *WalletRequester) GetRoute() string