admin

Documentation

Overview

package admin specifies the interface for the admin service client.

Index

• type AdminClient

Types

type AdminClient

type AdminClient interface {
	Approve(ctx context.Context, publicKey []byte) ([]byte, error)
	Join(ctx context.Context) ([]byte, error)
	JoinStatus(ctx context.Context, pubkey []byte) (*types.JoinRequest, error)
	Leave(ctx context.Context) ([]byte, error)
	ListValidators(ctx context.Context) ([]*types.Validator, error)
	Peers(ctx context.Context) ([]*adminTypes.PeerInfo, error)
	Remove(ctx context.Context, publicKey []byte) ([]byte, error)
	Status(ctx context.Context) (*adminTypes.Status, error)
	Version(ctx context.Context) (string, error)
	ListPendingJoins(ctx context.Context) ([]*types.JoinRequest, error)
	// GetConfig gets the current config from the node.
	// It returns the config serialized as JSON.
	GetConfig(ctx context.Context) ([]byte, error)
}