api

Documentation

Index

• Constants
• func RandTraceID() string
• type Params
  • func PreprocessRequest(ctx context.Context, req *http.Request) (*Params, error)
• type QueryType
  • func QTypeFromString(strQType string) QueryType
• type RequestHandler
  • func NewRequestHandler(params *Params, messageBus core.MessageBus, nc core.NetworkCoordinator, ...) *RequestHandler
  • func (rh *RequestHandler) ProcessGetSeed(ctx context.Context) (map[string]interface{}, error)
  • func (rh *RequestHandler) ProcessIsAuthorized(ctx context.Context) (map[string]interface{}, error)
  • func (rh *RequestHandler) ProcessRegisterNode(ctx context.Context) (map[string]interface{}, error)
• type Runner
  • func NewRunner(cfg *configuration.APIRunner) (*Runner, error)
  • func (ar *Runner) Start(ctx context.Context, c core.Components) error
  • func (ar *Runner) Stop(ctx context.Context) error

Constants

const (

	// HandlerError is error in handler
	HandlerError int = -1
	// BadRequest is bad formed request
	BadRequest int = -2
)

const (
	// REFERENCE is field for reference
	REFERENCE = "reference"
	// SEED is field to reference
	SEED = "seed"
)

const TraceIDQueryParam = "traceID"

Functions

func RandTraceID

func RandTraceID() string

RandTraceID returns random traceID in uuid format

Types

type Params

type Params struct {
	QueryType              string   `json:"query_type"`
	Name                   string   `json:"name"`
	Reference              string   `json:"reference"`
	From                   string   `json:"from"`
	To                     string   `json:"to"`
	Method                 string   `json:"method"`
	Requester              string   `json:"requester"`
	Target                 string   `json:"target"`
	Amount                 uint     `json:"amount"`
	PublicKey              string   `json:"public_key"`
	Roles                  []string `json:"roles"`
	NumberOfBootstrapNodes uint     `json:"bootstrap_nodes_num"`
	MajorityRule           uint     `json:"majority_rule"`
	Host                   string   `json:"host"`
}

Params contains supported query params

func PreprocessRequest

func PreprocessRequest(ctx context.Context, req *http.Request) (*Params, error)

PreprocessRequest extracts params from requests

type QueryType

type QueryType int

QueryType represents type of query

const (
	UNDEFINED QueryType = iota
	CreateMember
	DumpUserInfo
	GetBalance
	SendMoney
	DumpAllUsers
	RegisterNode
	IsAuth
	GetSeed
)

Supported query types

func QTypeFromString

func QTypeFromString(strQType string) QueryType

QTypeFromString converts string representation to enum

type RequestHandler

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

RequestHandler encapsulate processing of request

func NewRequestHandler

func NewRequestHandler(params *Params, messageBus core.MessageBus, nc core.NetworkCoordinator, rootDomainReference core.RecordRef, smanager *seedmanager.SeedManager) *RequestHandler

NewRequestHandler creates new query handler

func (*RequestHandler) ProcessGetSeed

func (rh *RequestHandler) ProcessGetSeed(ctx context.Context) (map[string]interface{}, error)

ProcessGetSeed processes get seed request

func (*RequestHandler) ProcessIsAuthorized

func (rh *RequestHandler) ProcessIsAuthorized(ctx context.Context) (map[string]interface{}, error)

ProcessIsAuthorized processes is_auth query type

func (*RequestHandler) ProcessRegisterNode

func (rh *RequestHandler) ProcessRegisterNode(ctx context.Context) (map[string]interface{}, error)

ProcessRegisterNode process register node response

type Runner

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

Runner implements Component for API

func NewRunner

func NewRunner(cfg *configuration.APIRunner) (*Runner, error)

NewRunner is C-tor for API Runner

func (*Runner) Start

func (ar *Runner) Start(ctx context.Context, c core.Components) error

Start runs api server

func (*Runner) Stop

func (ar *Runner) Stop(ctx context.Context) error

Stop stops api server