node

type API struct {
	Internal struct {
		Info              func(context.Context) (Info, error)                                                   `perm:"admin"`
		Ready             func(context.Context) (bool, error)                                                   `perm:"read"`
		LogLevelSet       func(ctx context.Context, name, level string) error                                   `perm:"admin"`
		AuthVerify        func(ctx context.Context, token string) ([]auth.Permission, error)                    `perm:"admin"`
		AuthNew           func(ctx context.Context, perms []auth.Permission) (string, error)                    `perm:"admin"`
		AuthNewWithExpiry func(ctx context.Context, perms []auth.Permission, ttl time.Duration) (string, error) `perm:"admin"`
	}
}

type BuildInfo struct {
	BuildTime       string
	LastCommit      string
	SemanticVersion string
	SystemVersion   string
	GolangVersion   string
}

type Config struct {
	StartupTimeout  time.Duration
	ShutdownTimeout time.Duration
}

type Info struct {
	Type       Type   `json:"type"`
	APIVersion string `json:"api_version"`
}

type Module interface {
	// Info returns administrative information about the node.
	Info(context.Context) (Info, error)

	// Ready returns true once the node's RPC is ready to accept requests.
	Ready(context.Context) (bool, error)

	// LogLevelSet sets the given component log level to the given level.
	LogLevelSet(ctx context.Context, name, level string) error

	// AuthVerify returns the permissions assigned to the given token.
	AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)
	// AuthNew signs and returns a new token with the given permissions.
	AuthNew(ctx context.Context, perms []auth.Permission) (string, error)
	// AuthNewWithExpiry signs and returns a new token with the given permissions and TTL.
	AuthNewWithExpiry(ctx context.Context, perms []auth.Permission, ttl time.Duration) (string, error)
}

type StorePath string

type Type uint8