core

README

API

Idempotency

Most of the API endpoints are idempotent. Some endpoints require a client_token parameter that is used for ensuring idempotency. These client tokens are only used as an idempotency key, and cannot be used to lookup entities later.

Documentation

Overview

Package core implements Chain Core and its API.

Index

• func CleanupSubmittedTxs(ctx context.Context, db pg.DB)
• func Configure(ctx context.Context, db pg.DB, c *Config) error
• func WriteHTTPError(ctx context.Context, w http.ResponseWriter, err error)
• type Config
  • func LoadConfig(ctx context.Context, db pg.DB) (*Config, error)
• type ConfigSigner
• type Handler
  • func (h *Handler) HealthSetter(name string) func(error)
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type RequestLimit

Functions

func CleanupSubmittedTxs

func CleanupSubmittedTxs(ctx context.Context, db pg.DB)

CleanupSubmittedTxs will periodically delete records of submitted txs older than a day. This function blocks and only exits when its context is cancelled.

TODO(jackson): unexport this and start it in a goroutine in a core.New() function?

func Configure

func Configure(ctx context.Context, db pg.DB, c *Config) error

Configure configures the core by writing to the database. If running in a cored process, the caller must ensure that the new configuration is properly reloaded, for example by restarting the process.

If c.IsSigner is true, Configure generates a new mockhsm keypair for signing blocks, and assigns it to c.BlockPub.

If c.IsGenerator is true, Configure creates an initial block, saves it, and assigns its hash to c.BlockchainID. Otherwise, c.IsGenerator is false, and Configure makes a test request to GeneratorURL to detect simple configuration mistakes.

func WriteHTTPError

func WriteHTTPError(ctx context.Context, w http.ResponseWriter, err error)

WriteHTTPError writes a json encoded detailedError to the ResponseWriter. It uses the status code associated with the error.

Types

type Config

type Config struct {
	ID                   string  `json:"id"`
	IsSigner             bool    `json:"is_signer"`
	IsGenerator          bool    `json:"is_generator"`
	BlockchainID         bc.Hash `json:"blockchain_id"`
	GeneratorURL         string  `json:"generator_url"`
	GeneratorAccessToken string  `json:"generator_access_token"`
	ConfiguredAt         time.Time
	BlockPub             string         `json:"block_pub"`
	Signers              []ConfigSigner `json:"block_signer_urls"`
	Quorum               int
	MaxIssuanceWindow    time.Duration
}

Config encapsulates Core-level, persistent configuration options.

func LoadConfig

func LoadConfig(ctx context.Context, db pg.DB) (*Config, error)

LoadConfig loads the stored configuration, if any, from the database.

type ConfigSigner

type ConfigSigner struct {
	AccessToken string        `json:"access_token"`
	Pubkey      json.HexBytes `json:"pubkey"`
	URL         string        `json:"url"`
}

type Handler

type Handler struct {
	Chain         *protocol.Chain
	Store         *txdb.Store
	Assets        *asset.Registry
	Accounts      *account.Manager
	HSM           *mockhsm.HSM
	Indexer       *query.Indexer
	Config        *Config
	DB            pg.DB
	Addr          string
	AltAuth       func(*http.Request) bool
	Signer        func(context.Context, *bc.Block) ([]byte, error)
	RequestLimits []RequestLimit
	// contains filtered or unexported fields
}

Handler serves the Chain HTTP API

func (*Handler) HealthSetter

func (h *Handler) HealthSetter(name string) func(error)

HealthSetter returns a function that, when called, sets the named health status in the map returned by "/health". The returned function is safe to call concurrently with ServeHTTP.

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type RequestLimit

type RequestLimit struct {
	Key       func(*http.Request) string
	Burst     int
	PerSecond int
}