server

Documentation

Index

• Constants
• type Algorithm
• type BearerToken
• type Config
  • func LoadConfig(configPathMaybe string) (*Config, error)
• type HttpPublicKey
• type Server
  • func New(ocConf *oc.Config, args ServerArgs) *Server
  • func (s *Server) Start() error
• type ServerArgs

Constants

const ENV_OFFCHAIN_CONFIG = "OFFCHAIN_CONFIG"

Types

type Algorithm

type Algorithm string

const (
	K256Sha256 Algorithm = "k256-sha2"
	Ed25519    Algorithm = "ed25519"
	Ed255      Algorithm = "ed255" // alias to ed25519
)

type BearerToken

type BearerToken struct {
	Token secret.Secret `yaml:"token"`
	Id    string        `yaml:"id"`
}

type Config

type Config struct {
	Listen    string   `yaml:"listen" env-default:"127.0.0.1:6333"`
	Origins   []string `yaml:"origins" env-default:""`
	AnyOrigin bool     `yaml:"any_origin" env-default:"false"`

	PublicReadEndpoints bool            `yaml:"public_read_endpoints"`
	BearerTokens        []BearerToken   `yaml:"bearer_tokens"`
	PublicKeys          []HttpPublicKey `yaml:"public_keys"`
}

func LoadConfig

func LoadConfig(configPathMaybe string) (*Config, error)

type HttpPublicKey

type HttpPublicKey struct {
	Algorithm Algorithm `yaml:"algorithm"`
	// Hex encoded
	Key hex.Hex `yaml:"key"`
	Id  string  `yaml:"id"`
}

type Server

type Server struct {
	ServerArgs
	// contains filtered or unexported fields
}

Server represents the HTTP server

func New

func New(ocConf *oc.Config, args ServerArgs) *Server

New creates a new server instance

func (*Server) Start

func (s *Server) Start() error

Start begins listening for requests

type ServerArgs

type ServerArgs struct {
	Listen    string
	AnyOrigin bool
	Origins   []string

	BearerTokens        []string
	PublicKeys          []verifier.VerifierI
	PublicReadEndpoints bool
}