apiserver

Documentation

Index

• Variables
• type APIServer
  • func NewAPIServer() *APIServer
  • func (s *APIServer) AddGETPath(path string, con echo.HandlerFunc) error
  • func (s *APIServer) HandleJRPC(req *JRPCRequest) interface{}
  • func (s *APIServer) JRPC(SubName string) (*JRPCSub, error)
  • func (s *APIServer) Name() string
  • func (s *APIServer) OnBlockConnected(b *types.Block, loader types.Loader)
  • func (s *APIServer) OnLoadChain(loader types.Loader) error
  • func (s *APIServer) OnTransactionFail(height uint32, txs []*types.Transaction, err []error)
  • func (s *APIServer) OnTransactionInPoolExpired(txs []*types.Transaction)
  • func (s *APIServer) Run(BindAddress string) error
• type Argument
  • func NewArgument(args []interface{}) *Argument
  • func (arg *Argument) Array(index int) ([]interface{}, error)
  • func (arg *Argument) Float32(index int) (float32, error)
  • func (arg *Argument) Float64(index int) (float64, error)
  • func (arg *Argument) Int(index int) (int, error)
  • func (arg *Argument) Len() int
  • func (arg *Argument) Map(index int) (map[string]interface{}, error)
  • func (arg *Argument) String(index int) (string, error)
  • func (arg *Argument) Uint16(index int) (uint16, error)
  • func (arg *Argument) Uint32(index int) (uint32, error)
  • func (arg *Argument) Uint64(index int) (uint64, error)
  • func (arg *Argument) Uint8(index int) (uint8, error)
• type Handler
• type INode
• type JRPCRequest
• type JRPCResponse
• type JRPCResponseWithError
• type JRPCSub
  • func NewJRPCSub() *JRPCSub
  • func (s *JRPCSub) Set(Method string, h Handler)
• type ReqData
• type RevertError
  • func NewRevertError(result *core.ExecutionResult) *RevertError
  • func (e *RevertError) ErrorCode() int
  • func (e *RevertError) ErrorData() interface{}

Variables

var (
	ErrInvalidArgument      = errors.New("invalid argument")
	ErrInvalidArgumentIndex = errors.New("invalid argument index")
	ErrInvalidArgumentType  = errors.New("invalid argument type")
	ErrInvalidMethod        = errors.New("invalid method")
	ErrExistSubName         = errors.New("exist sub name")
)

errors

Types

type APIServer

type APIServer struct {
	types.ServiceBase
	sync.Mutex
	// contains filtered or unexported fields
}

APIServer provides json rpc and web service for the chain

func NewAPIServer

func NewAPIServer() *APIServer

NewAPIServer returns a APIServer

func (*APIServer) AddGETPath

func (s *APIServer) AddGETPath(path string, con echo.HandlerFunc) error

add link to apiserver

func (*APIServer) HandleJRPC

func (s *APIServer) HandleJRPC(req *JRPCRequest) interface{}

func (*APIServer) JRPC

func (s *APIServer) JRPC(SubName string) (*JRPCSub, error)

JRPC provides the json rpc feature as a SubName.FunctionName methods

func (*APIServer) Name

func (s *APIServer) Name() string

Name returns the name of the service

func (*APIServer) OnBlockConnected

func (s *APIServer) OnBlockConnected(b *types.Block, loader types.Loader)

OnBlockConnected called when a block is connected to the chain

func (*APIServer) OnLoadChain

func (s *APIServer) OnLoadChain(loader types.Loader) error

OnLoadChain called when the chain loaded

func (*APIServer) OnTransactionFail

func (s *APIServer) OnTransactionFail(height uint32, txs []*types.Transaction, err []error)

OnTransactionFail called when the tx fail

func (*APIServer) OnTransactionInPoolExpired

func (s *APIServer) OnTransactionInPoolExpired(txs []*types.Transaction)

OnTransactionInPoolExpired called when the tx expired

func (*APIServer) Run

func (s *APIServer) Run(BindAddress string) error

Run starts web service of the apiserver

type Argument

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

Argument parses rpc arguments

func NewArgument

func NewArgument(args []interface{}) *Argument

NewArgument returns a Argument

func (*Argument) Array

func (arg *Argument) Array(index int) ([]interface{}, error)

Strings returns a string value of the index

func (*Argument) Float32

func (arg *Argument) Float32(index int) (float32, error)

Float32 returns a float32 value of the index

func (*Argument) Float64

func (arg *Argument) Float64(index int) (float64, error)

Float64 returns a float64 value of the index

func (*Argument) Int

func (arg *Argument) Int(index int) (int, error)

Int returns a int value of the index

func (*Argument) Len

func (arg *Argument) Len() int

Len returns length of arguments

func (*Argument) Map

func (arg *Argument) Map(index int) (map[string]interface{}, error)

Strings returns a string value of the index

func (*Argument) String

func (arg *Argument) String(index int) (string, error)

Strings returns a string value of the index

func (*Argument) Uint16

func (arg *Argument) Uint16(index int) (uint16, error)

Uint16 returns a uint16 value of the index

func (*Argument) Uint32

func (arg *Argument) Uint32(index int) (uint32, error)

Uint32 returns a uint32 value of the index

func (*Argument) Uint64

func (arg *Argument) Uint64(index int) (uint64, error)

Uint64 returns a uint64 value of the index

func (*Argument) Uint8

func (arg *Argument) Uint8(index int) (uint8, error)

Uint8 returns a uint8 value of the index

type Handler

type Handler func(ID interface{}, arg *Argument) (interface{}, error)

Handler handles a rpc method

type INode

type INode interface {
	AddTx(tx *types.Transaction, sig common.Signature) error
}

type JRPCRequest

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

JRPCRequest is a jrpc request

type JRPCResponse

type JRPCResponse struct {
	ID      interface{} `json:"id"`
	JSONRPC string      `json:"jsonrpc"`
	Result  interface{} `json:"result"`
}

JRPCResponse is a jrpc response

type JRPCResponseWithError

type JRPCResponseWithError struct {
	JSONRPC string      `json:"jsonrpc"`
	ID      interface{} `json:"id"`
	Result  interface{} `json:"result,omitempty"`
	Error   interface{} `json:"error,omitempty"`
}

JRPCResponse is a jrpc response

type JRPCSub

type JRPCSub struct {
	sync.Mutex
	// contains filtered or unexported fields
}

JRPCSub provides the json rpc feature of the sub name

func NewJRPCSub

func NewJRPCSub() *JRPCSub

NewJRPCSub returns a JRPCSub

func (*JRPCSub) Set

func (s *JRPCSub) Set(Method string, h Handler)

Set sets a handler of the method

type ReqData

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

type RevertError

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

revertError is an API error that encompassas an EVM revertal with JSON error code and a binary data blob.

func NewRevertError

func NewRevertError(result *core.ExecutionResult) *RevertError

func (*RevertError) ErrorCode

func (e *RevertError) ErrorCode() int

ErrorCode returns the JSON error code for a revertal. See: https://github.com/ethereum/wiki/wiki/JSON-RPC-Error-Codes-Improvement-Proposal

func (*RevertError) ErrorData

func (e *RevertError) ErrorData() interface{}

ErrorData returns the hex encoded revert reason.