admin

Documentation

Index

• Constants
• Variables
• func StartNKNServer(account *nkn.Account, identifier string, clientConfig *nkn.ClientConfig, ...) error
• func StartWebServer(listenAddr string, tun *tunnel.Tunnel, persistConf, mergedConf *config.Config) error
• type Client
  • func NewClient(account *nkn.Account, clientConfig *nkn.ClientConfig, identifier string) (*Client, error)
  • func (c *Client) GetInfo(addr string) (*GetInfoJSON, error)
  • func (c *Client) RPCCall(addr, method string, params interface{}, result interface{}) error
  • func (c *Client) SendMsg(address string, msg interface{}, waitResponse bool) (reply *nkn.Message, err error)
• type GetInfoJSON
• type RpcReq
• type RpcResp
• type Token
  • func NewToken(expiration time.Duration) *Token
  • func (t *Token) IsValid(token string) bool
• type TokenStore
  • func NewTokenStore(tokenExpiration, rotateInterval time.Duration) *TokenStore
  • func (tr *TokenStore) GetCurrentToken() *Token
  • func (tr *TokenStore) IsValid(token string) bool
  • func (tr *TokenStore) Start()
• type UnixTime
  • func (t UnixTime) MarshalJSON() ([]byte, error)

Constants

const (
	TokenSize           = 32
	TokenExpiration     = 10 * time.Minute
	TokenRotateInterval = 5 * time.Minute
)

Variables

var (
	ErrReplyTimeout = errors.New("wait for reply timeout")
)

Functions

func StartNKNServer

func StartNKNServer(account *nkn.Account, identifier string, clientConfig *nkn.ClientConfig, tun *tunnel.Tunnel, persistConf, mergedConf *config.Config) error

func StartWebServer

func StartWebServer(listenAddr string, tun *tunnel.Tunnel, persistConf, mergedConf *config.Config) error

Types

type Client

type Client struct {
	*nkn.MultiClient
	ReplyTimeout time.Duration
}

func NewClient

func NewClient(account *nkn.Account, clientConfig *nkn.ClientConfig, identifier string) (*Client, error)

func (*Client) GetInfo

func (c *Client) GetInfo(addr string) (*GetInfoJSON, error)

func (*Client) RPCCall

func (c *Client) RPCCall(addr, method string, params interface{}, result interface{}) error

func (*Client) SendMsg

func (c *Client) SendMsg(address string, msg interface{}, waitResponse bool) (reply *nkn.Message, err error)

type GetInfoJSON

type GetInfoJSON struct {
	Addr                 string       `json:"addr"`
	LocalIP              *localIPJSON `json:"localIP"`
	AdminHTTPAPIDisabled bool         `json:"adminHttpApiDisabled"`
	Version              string       `json:"version"`
	Tuna                 bool         `json:"tuna"`
	TunaServiceName      string       `json:"tunaServiceName,omitempty"`
	TunaCountry          []string     `json:"tunaCountry,omitempty"`
	InPrice              []string     `json:"inPrice,omitempty"`
	OutPrice             []string     `json:"outPrice,omitempty"`
	Tags                 []string     `json:"tags,omitempty"`
}

type RpcReq

type RpcReq struct {
	ID      string                 `json:"id"`
	JSONRPC string                 `json:"jsonrpc"`
	Method  string                 `json:"method"`
	Params  map[string]interface{} `json:"params"`
	Token   string                 `json:"token"`
}

type RpcResp

type RpcResp struct {
	Result interface{} `json:"result,omitempty"`
	Error  string      `json:"error,omitempty"`
}

type Token

type Token struct {
	Token     string   `json:"token"`
	ExpiresAt UnixTime `json:"expiresAt"`
}

func NewToken

func NewToken(expiration time.Duration) *Token

func (*Token) IsValid

func (t *Token) IsValid(token string) bool

type TokenStore

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

func NewTokenStore

func NewTokenStore(tokenExpiration, rotateInterval time.Duration) *TokenStore

func (*TokenStore) GetCurrentToken

func (tr *TokenStore) GetCurrentToken() *Token

func (*TokenStore) IsValid

func (tr *TokenStore) IsValid(token string) bool

func (*TokenStore) Start

func (tr *TokenStore) Start()

type UnixTime

type UnixTime time.Time

func (UnixTime) MarshalJSON

func (t UnixTime) MarshalJSON() ([]byte, error)