handlers

Documentation

Index

• type FormattedAmount
• type Handlers
  • func NewHandlers(handleFunc func(string, func(*http.Request) (interface{}, error)) *mux.Route, ...) *Handlers
  • func (handlers *Handlers) Init(account accounts.Interface)
  • func (handlers *Handlers) Uninit()
• type Transaction

Types

type FormattedAmount

type FormattedAmount struct {
	Amount      string            `json:"amount"`
	Unit        string            `json:"unit"`
	Conversions map[string]string `json:"conversions"`
}

FormattedAmount with unit and conversions.

type Handlers

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

Handlers provides a web api to the account.

func NewHandlers

func NewHandlers(
	handleFunc func(string, func(*http.Request) (interface{}, error)) *mux.Route, log *logrus.Entry) *Handlers

NewHandlers creates a new Handlers instance.

func (*Handlers) Init

func (handlers *Handlers) Init(account accounts.Interface)

Init installs a account as a base for the web api. This needs to be called before any requests are made.

func (*Handlers) Uninit

func (handlers *Handlers) Uninit()

Uninit removes the account. After this, no requests should be made.

type Transaction

type Transaction struct {
	ID               string            `json:"id"`
	NumConfirmations int               `json:"numConfirmations"`
	Type             string            `json:"type"`
	Status           accounts.TxStatus `json:"status"`
	Amount           FormattedAmount   `json:"amount"`
	Fee              FormattedAmount   `json:"fee"`
	Time             *string           `json:"time"`
	Addresses        []string          `json:"addresses"`

	// BTC specific fields.
	VSize        int64           `json:"vsize"`
	Size         int64           `json:"size"`
	Weight       int64           `json:"weight"`
	FeeRatePerKb FormattedAmount `json:"feeRatePerKb"`

	// ETH specific fields
	Gas uint64 `json:"gas"`
}

Transaction is the info returned per transaction by the /transactions endpoint.