config

package
v1.0.0-beta.32 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 21, 2024 License: MIT Imports: 31 Imported by: 0

Documentation

Overview

Package config provides a configuration for the API

Index

Constants

View Source 
const (
	APIVersion             = "v1"
	HealthRequestPath      = "health"
	ConfigFilePathKey      = "config_file"
	DefaultConfigFilePath  = "config.yaml"
	BroadcastCallbackRoute = "/transaction/broadcast/callback"
)

Config constants used for spv-wallet

View Source 
const (
	// AuthenticationSchemeXpub is the xpub auth scheme (using xPubs as tokens)
	AuthenticationSchemeXpub = "xpub"
)
View Source 
const DefaultAdminXpub = "xpub661MyMwAqRbcFgfmdkPgE2m5UjHXu9dj124DbaGLSjaqVESTWfCD4VuNmEbVPkbYLCkykwVZvmA8Pbf8884TQr1FgdG2nPoHR8aB36YdDQh"

DefaultAdminXpub is the default admin xpub used for authenticate requests.

View Source 
const TaskManagerQueueName = "spv_wallet_queue"

TaskManagerQueueName is the default queue name for the task manager.

Variables

This section is empty.

Functions

This section is empty.

Types

type ARCConfig 

type ARCConfig struct {
	Callback     *CallbackConfig `json:"callback" mapstructure:"callback"`
	DeploymentID string          `json:"deployment_id" mapstructure:"deployment_id"`
	Token        string          `json:"token" mapstructure:"token"`
	URL          string          `json:"url" mapstructure:"url"`
}

ARCConfig consists of blockchain nodes (Arc) configuration

func (*ARCConfig) Validate 

func (n *ARCConfig) Validate() error

Validate checks the configuration for specific rules

type AppConfig 

type AppConfig struct {
	// Version is the version of the application.
	Version string `json:"version" mapstructure:"version"`
	// TaskManager is a configuration for Task Manager in SPV Wallet.
	TaskManager *TaskManagerConfig `json:"task_manager" mapstructure:"task_manager"`
	// Authentication is the configuration for keys authentication in SPV Wallet.
	Authentication *AuthenticationConfig `json:"auth" mapstructure:"auth"`
	// Server is a general configuration for spv-wallet.
	Server *ServerConfig `json:"server_config" mapstructure:"server_config"`
	// ARC is a config for Arc.
	ARC *ARCConfig `json:"arc" mapstructure:"arc"`
	// Metrics is a configuration for metrics in SPV Wallet.
	Metrics *MetricsConfig `json:"metrics" mapstructure:"metrics"`
	// ExperimentalFeatures is a configuration that allows to enable features that are considered experimental/non-production.
	ExperimentalFeatures *ExperimentalConfig `json:"experimental_features" mapstructure:"experimental_features"`
	// Notifications is a config for Notification service.
	Notifications *NotificationsConfig `json:"notifications" mapstructure:"notifications"`
	// Db is the configuration for database related settings.
	Db *DbConfig `json:"db" mapstructure:"db"`
	// Cache is the configuration for cache, memory or redis, and cluster cache settings.
	Cache *CacheConfig `json:"cache" mapstructure:"cache"`
	// Logging is the configuration for zerolog used in SPV Wallet.
	Logging *LoggingConfig `json:"logging" mapstructure:"logging"`
	// Paymail is a config for Paymail and BEEF.
	Paymail *PaymailConfig `json:"paymail" mapstructure:"paymail"`
	// BHSConfig is a config for BlockHeadersService
	BHS *BHSConfig `json:"block_headers_service" mapstructure:"block_headers_service"`
	// ImportBlockHeaders is a URL from where the headers can be downloaded.
	ImportBlockHeaders string `json:"import_block_headers" mapstructure:"import_block_headers"`
	// DebugProfiling is a flag for enabling additinal debug profiling.
	DebugProfiling bool `json:"debug_profiling" mapstructure:"debug_profiling"`
	// DisableITC is a flag for disabling Incoming Transaction Checking.
	DisableITC bool `json:"disable_itc" mapstructure:"disable_itc"`
	// RequestLogging is flag for enabling logging in go-api-router.
	RequestLogging bool `json:"request_logging" mapstructure:"request_logging"`
	// CustomFeeUnit
	CustomFeeUnit *FeeUnitConfig `json:"custom_fee_unit" mapstructure:"custom_fee_unit"`
}

AppConfig is the configuration values and associated env vars

func GetDefaultAppConfig 

func GetDefaultAppConfig() *AppConfig

GetDefaultAppConfig returns the default configuration for the application.

func Load 

func Load(versionToSet string, logger zerolog.Logger) (appConfig *AppConfig, err error)

Load all AppConfig

func (*AppConfig) GetUserAgent 

func (c *AppConfig) GetUserAgent() string

GetUserAgent will return the outgoing user agent

func (*AppConfig) IsBeefEnabled 

func (c *AppConfig) IsBeefEnabled() bool

IsBeefEnabled returns true if the Beef capability will be used for paymail transactions

func (*AppConfig) ToEngineOptions 

func (c *AppConfig) ToEngineOptions(logger zerolog.Logger) (options []engine.ClientOps, err error)

ToEngineOptions converts the AppConfig to a slice of engine.ClientOps that can be used to create a new engine.Client.

func (*AppConfig) Validate 

func (c *AppConfig) Validate() error

Validate checks the configuration for specific rules

type AuthenticationConfig 

type AuthenticationConfig struct {
	// AdminKey is used for administrative requests
	AdminKey string `json:"admin_key" mapstructure:"admin_key"`
	// Scheme it the authentication scheme to use (default is: xpub)
	Scheme string `json:"scheme" mapstructure:"scheme"`
	// RequireSigning is the flag that decides if the signing is required
	RequireSigning bool `json:"require_signing" mapstructure:"require_signing"`
}

AuthenticationConfig is the configuration for Authentication

func (*AuthenticationConfig) IsAdmin 

func (a *AuthenticationConfig) IsAdmin(key string) bool

IsAdmin will check if the key is an admin key

func (*AuthenticationConfig) Validate 

func (a *AuthenticationConfig) Validate() error

Validate checks the configuration for specific rules

type BHSConfig 

type BHSConfig struct {
	// AuthToken is the token used for authenticating requests to Block Headers Service (BHS)
	AuthToken string `json:"auth_token" mapstructure:"auth_token"`
	// URL is the URL used to communicate with Block Headers Service (BHS)
	URL string `json:"url" mapstructure:"url"`
}

BHSConfig consists of AuthToken and URL used to communicate with BlockHeadersService

func (*BHSConfig) Validate 

func (b *BHSConfig) Validate() error

Validate checks the configuration for specific rules

type BeefConfig 

type BeefConfig struct {
	// BlockHeadersServiceHeaderValidationURL is the URL for merkle roots validation in Block Headers Service.
	BlockHeadersServiceHeaderValidationURL string `json:"block_headers_service_url" mapstructure:"block_headers_service_url"`
	// BlockHeadersServiceAuthToken is the authentication token for validating merkle roots in Block Headers Service.
	BlockHeadersServiceAuthToken string `json:"block_headers_service_auth_token" mapstructure:"block_headers_service_auth_token"`
	// UseBeef is a flag for enabling BEEF transactions format.
	UseBeef bool `json:"use_beef" mapstructure:"use_beef"`
}

BeefConfig consists of components required to use beef, e.g. Block Headers Service for merkle roots validation

type CacheConfig 

type CacheConfig struct {
	// Cluster is the cluster-specific configuration for SPV Wallet.
	Cluster *ClusterConfig `json:"cluster" mapstructure:"cluster"`
	// Redis is a general config for redis if the engine is set to it.
	Redis *RedisConfig `json:"redis" mapstructure:"redis"`
	// Engine is the cache engine to use (redis, freecache).
	Engine cachestore.Engine `json:"engine" mapstructure:"engine"`
}

CacheConfig is a configuration for cachestore

func (*CacheConfig) Validate 

func (c *CacheConfig) Validate() error

Validate checks the configuration for specific rules

type CallbackConfig 

type CallbackConfig struct {
	// Host is the URL for broadcast callback registration.
	Host string `json:"host" mapstructure:"host"`
	// Token is the token for broadcast callback registration.
	Token string `json:"token" mapstructure:"token"`
	// Enabled is the flag that enables callbacks.
	Enabled bool `json:"enabled" mapstructure:"enabled"`
}

CallbackConfig is the configuration for callbacks

type ClusterConfig 

type ClusterConfig struct {
	// Redis is cluster-specific redis config, will use cache config if this is unset.
	Redis *RedisConfig `json:"redis" mapstrcuture:"redis"`
	// Coordinator is a cluster coordinator (redis or memory).
	Coordinator cluster.Coordinator `json:"coordinator" mapstructure:"coordinator"`
	// Prefix is the string to use for all cluster keys.
	Prefix string `json:"prefix" mapstructure:"prefix"`
}

ClusterConfig is a configuration for the SPV Wallet cluster

type DatastoreConfig 

type DatastoreConfig struct {
	// TablePrefix is the prefix for all table names in the database.
	TablePrefix string `json:"table_prefix" mapstructure:"table_prefix"`
	// Engine is the database to be used, sqlite, postgresql.
	Engine datastore.Engine `json:"engine" mapstructure:"engine"`
	// Debug is a flag that decides whether additional output (such as sql statements) should be produced from datastore.
	Debug bool `json:"debug" mapstructure:"debug"`
}

DatastoreConfig is a configuration for the datastore

type DbConfig 

type DbConfig struct {
	// Datastore general config.
	Datastore *DatastoreConfig `json:"datastore" mapstructure:"datastore"`
	// SQL is a config for PostgreSQL. Works only if datastore engine is set to postgresql.
	SQL *datastore.SQLConfig `json:"sql" mapstructure:"sql"`
	// SQLite is a config for SQLite. Works only if datastore engine is set to sqlite.
	SQLite *datastore.SQLiteConfig `json:"sqlite" mapstructure:"sqlite"`
}

DbConfig consists of datastore config and specific dbs configs

func (*DbConfig) Validate 

func (d *DbConfig) Validate() error

Validate checks the configuration for specific rules

type ExperimentalConfig added in v0.19.0 

type ExperimentalConfig struct {
	// PikeContactsEnabled is a flag for enabling Pike contacts invite capability and contact endpoints.
	PikeContactsEnabled bool `json:"pike_contacts_enabled" mapstructure:"pike_contacts_enabled"`
	// PikePaymentEnabled is a flag for enabling Pike payment capability.
	PikePaymentEnabled bool `json:"pike_payment_enabled" mapstructure:"pike_payment_enabled"`
	// Use junglebus external service to fetch missing source transactions for inputs
	UseJunglebus bool `json:"use_junglebus" mapstructure:"use_junglebus"`
}

ExperimentalConfig represents a feature flag config.

type FeeUnitConfig 

type FeeUnitConfig struct {
	Satoshis int `json:"satoshis" mapstructure:"satoshis"`
	Bytes    int `json:"bytes" mapstructure:"bytes"`
}

FeeUnitConfig reflects the utils.FeeUnit struct with proper annotations for json and mapstructure

func (*FeeUnitConfig) Validate 

func (cf *FeeUnitConfig) Validate() error

Validate validates the custom fee unit configuration

type LoggingConfig 

type LoggingConfig struct {
	// Level is the importance and amount of information printed: debug, info, warn, error, fatal, panic, etc.
	Level string `json:"level" mapstructure:"level"`
	// Format is the format of logs, json (for gathering eg. into elastic) or console (for stdout).
	Format string `json:"format" mapstructure:"format"`
	// InstanceName is the name of the zerolog instance.
	InstanceName string `json:"instance_name" mapstructure:"instance_name"`
	// LogOrigin is the flag for whether the origin of logs should be printed.
	LogOrigin bool `json:"log_origin" mapstructure:"log_origin"`
}

LoggingConfig is a configuration for logging

type MetricsConfig 

type MetricsConfig struct {
	// Enabled is a flag for enabling metrics.
	Enabled bool `json:"enabled" mapstructure:"enabled"`
}

MetricsConfig represents a metrics config.

type NotificationsConfig 

type NotificationsConfig struct {
	// Enabled is the flag that enables notifications service.
	Enabled bool `json:"enabled" mapstructure:"enabled"`
}

NotificationsConfig is the configuration for notifications

type PaymailConfig 

type PaymailConfig struct {
	// Beef is for Background Evaluation Extended Format (BEEF) config.
	Beef *BeefConfig `json:"beef" mapstructure:"beef"`
	// DefaultFromPaymail IE: from@domain.com.
	DefaultFromPaymail string `json:"default_from_paymail" mapstructure:"default_from_paymail"`
	// Domains is a list of allowed domains.
	Domains []string `json:"domains" mapstructure:"domains"`
	// DomainValidationEnabled should be turned off if hosted domain is not paymail related.
	DomainValidationEnabled bool `json:"domain_validation_enabled" mapstructure:"domain_validation_enabled"`
	// SenderValidationEnabled should be turned on for extra security.
	SenderValidationEnabled bool `json:"sender_validation_enabled" mapstructure:"sender_validation_enabled"`
}

PaymailConfig is the configuration for the built-in Paymail server

func (*PaymailConfig) Validate 

func (p *PaymailConfig) Validate() error

Validate checks the configuration for specific rules

type RedisConfig 

type RedisConfig struct {
	// URL is Redis url connection string.
	URL string `json:"url" mapstructure:"url"`
	// MaxActiveConnections is maximum number of active redis connections.
	MaxActiveConnections int `json:"max_active_connections" mapstructure:"max_active_connections"`
	// MaxIdleConnections is the maximum number of idle connections.
	MaxIdleConnections int `json:"max_idle_connections" mapstructure:"max_idle_connections"`
	// MaxConnectionLifetime is the maximum duration of the connection.
	MaxConnectionLifetime time.Duration `json:"max_connection_lifetime" mapstructure:"max_connection_lifetime"`
	// MaxIdleTimeout is the maximum duration of idle redis connection before timeout.
	MaxIdleTimeout time.Duration `json:"max_idle_timeout" mapstructure:"max_idle_timeout"`
	// DependencyMode works only in Redis with script enabled.
	DependencyMode bool `json:"dependency_mode" mapstructure:"dependency_mode"`
	// UseTLS is a flag which decides whether to use TLS
	UseTLS bool `json:"use_tls" mapstructure:"use_tls"`
}

RedisConfig is a configuration for Redis cachestore or taskmanager

type ServerConfig 

type ServerConfig struct {
	// IdleTimeout is the maximum duration before server timeout.
	IdleTimeout time.Duration `json:"idle_timeout" mapstructure:"idle_timeout"`
	// ReadTimeout is the maximum duration for server read timeout.
	ReadTimeout time.Duration `json:"read_timeout" mapstructure:"read_timeout"`
	// WriteTimeout is the maximum duration for server write timeout.
	WriteTimeout time.Duration `json:"write_timeout" mapstructure:"write_timeout"`
	// Port is the port that the server should use.
	Port int `json:"port" mapstructure:"port"`
}

ServerConfig is a configuration for the HTTP Server

func (*ServerConfig) Validate 

func (s *ServerConfig) Validate() error

Validate checks the configuration for specific rules

type TaskManagerConfig 

type TaskManagerConfig struct {
	// Factory is the Task Manager factory, memory or redis.
	Factory taskmanager.Factory `json:"factory" mapstructure:"factory"`
}

TaskManagerConfig is a configuration for the taskmanager

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.