api

Documentation

Index

• type Common
• type FullNode
• type Version
  • func (v Version) String() string

Types

type Common

type Common interface {
	AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)
	AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)

	// MethodGroup: Sys powerd by Star
	// 获取系统运行时间
	SysUptime(context.Context) (string, error)

	// Version provides information about API provider
	Version(context.Context) (Version, error)

	LogList(context.Context) ([]string, error)
	LogSetLevel(context.Context, string, string) error

	// trigger graceful shutdown
	Shutdown(context.Context) error

	Closing(context.Context) (<-chan struct{}, error)
}

type FullNode

type FullNode interface {
	Common
}

FullNode API is a low-level interface to the Star network full node

type Version

type Version struct {
	Version string

	// APIVersion is a binary encoded semver version of the remote implementing
	// this api
	//
	// See APIVersion in build/version.go
	APIVersion build.Version
}

Version provides various build-time information

func (Version) String

func (v Version) String() string