aurora

package
v0.0.0-...-a8bb791 Latest Latest
Warning

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

Go to latest
Published: Feb 13, 2024 License: Apache-2.0, Apache-2.0 Imports: 45 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DatabaseURLFlagName is the command line flag for configuring the Aurora postgres URL
	DatabaseURLFlagName = "db-url"
	// IngestFlagName is the command line flag for enabling ingestion on the Aurora instance
	IngestFlagName = "ingest"
	// HcnetCoreDBURLFlagName is the command line flag for configuring the postgres Hcnet Core URL
	HcnetCoreDBURLFlagName = "hcnet-core-db-url"
	// HcnetCoreURLFlagName is the command line flag for configuring the URL fore Hcnet Core HTTP endpoint
	HcnetCoreURLFlagName = "hcnet-core-url"
	// HcnetCoreBinaryPathName is the command line flag for configuring the path to the hcnet core binary
	HcnetCoreBinaryPathName = "hcnet-core-binary-path"

	// CaptiveCoreConfigPathName is the command line flag for configuring the path to the captive core configuration file
	CaptiveCoreConfigPathName = "captive-core-config-path"
	// CaptiveCoreConfigUseDB is the command line flag for enabling captive core runtime to use an external db url
	// connection rather than RAM for ledger states
	CaptiveCoreConfigUseDB = "captive-core-use-db"
	// CaptiveCoreHTTPPortFlagName is the commandline flag for specifying captive core HTTP port
	CaptiveCoreHTTPPortFlagName = "captive-core-http-port"
	// EnableCaptiveCoreIngestionFlagName is the commandline flag for enabling captive core ingestion
	EnableCaptiveCoreIngestionFlagName = "enable-captive-core-ingestion"
	// NetworkPassphraseFlagName is the command line flag for specifying the network passphrase
	NetworkPassphraseFlagName = "network-passphrase"
	// HistoryArchiveURLsFlagName is the command line flag for specifying the history archive URLs
	HistoryArchiveURLsFlagName = "history-archive-urls"
	// NetworkFlagName is the command line flag for specifying the "network"
	NetworkFlagName = "network"
	// EnableIngestionFilteringFlagName is the command line flag for enabling the experimental ingestion filtering feature (now enabled by default)
	EnableIngestionFilteringFlagName = "exp-enable-ingestion-filtering"
	// DisableTxSubFlagName is the command line flag for disabling transaction submission feature of Aurora
	DisableTxSubFlagName = "disable-tx-sub"
	// SkipSorobanIngestionFlagName is the command line flag for disabling Soroban related ingestion processing
	SkipSorobanIngestionFlagName = "disable-soroban-ingest"

	// HcnetPubnet is a constant representing the Hcnet public network
	HcnetPubnet = "pubnet"
	// HcnetTestnet is a constant representing the Hcnet test network
	HcnetTestnet = "testnet"
)

Variables

View Source
var (
	IngestCmd        = "ingest"
	RecordMetricsCmd = "record-metrics"
	DbCmd            = "db"
	ServeCmd         = "serve"
	AuroraCmd        = "aurora"

	DbFillGapsCmd             = "fill-gaps"
	DbReingestCmd             = "reingest"
	IngestTriggerStateRebuild = "trigger-state-rebuild"
	IngestInitGenesisStateCmd = "init-genesis-state"
	IngestBuildStateCmd       = "build-state"
	IngestStressTestCmd       = "stress-test"
	IngestVerifyRangeCmd      = "verify-range"

	ApiServerCommands = []string{AuroraCmd, ServeCmd}
	IngestionCommands = append(ApiServerCommands,
		IngestInitGenesisStateCmd,
		IngestBuildStateCmd,
		IngestStressTestCmd,
		IngestVerifyRangeCmd,
		DbFillGapsCmd,
		DbReingestCmd)
	DatabaseBoundCommands = append(ApiServerCommands, DbCmd, IngestCmd)
)
View Source
var (
	//go:embed configs/captive-core-pubnet.cfg
	PubnetDefaultConfig []byte

	//go:embed configs/captive-core-testnet.cfg
	TestnetDefaultConfig []byte

	PubnetConf = networkConfig{

		HistoryArchiveURLs: network.PublicNetworkhistoryArchiveURLs,
		NetworkPassphrase:  network.PublicNetworkPassphrase,
		// contains filtered or unexported fields
	}

	TestnetConf = networkConfig{

		HistoryArchiveURLs: network.TestNetworkhistoryArchiveURLs,
		NetworkPassphrase:  network.TestNetworkPassphrase,
		// contains filtered or unexported fields
	}
)

Functions

func ApplyFlags

func ApplyFlags(config *Config, flags support.ConfigOptions, options ApplyOptions) error

ApplyFlags applies the command line flags on the given Config instance

Types

type App

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

App represents the root of the state of a aurora instance.

func NewApp

func NewApp(config Config) (*App, error)

NewApp constructs an new App instance from the provided config.

func NewAppFromFlags

func NewAppFromFlags(config *Config, flags support.ConfigOptions) (*App, error)

NewAppFromFlags constructs a new Aurora App from the given command line flags

func (*App) AuroraSession

func (a *App) AuroraSession() db.SessionInterface

AuroraSession returns a new session that loads data from the aurora database.

func (*App) Close

func (a *App) Close()

Close cancels the app. It does not close DB connections - use App.CloseDB().

func (*App) CloseDB

func (a *App) CloseDB()

CloseDB closes DB connections. When using during web server shut down make sure all requests are first properly finished to avoid "sql: database is closed" errors.

func (*App) Config

func (a *App) Config() Config

func (*App) DeleteUnretainedHistory

func (a *App) DeleteUnretainedHistory(ctx context.Context) error

DeleteUnretainedHistory forwards to the app's reaper. See `reap.DeleteUnretainedHistory` for details

func (*App) GetCoreState

func (a *App) GetCoreState() corestate.State

func (*App) HistoryQ

func (a *App) HistoryQ() *history.Q

HistoryQ returns a helper object for performing sql queries against the history portion of aurora's database.

func (*App) Paths

func (a *App) Paths() paths.Finder

Paths returns the paths.Finder instance used by aurora

func (*App) Serve

func (a *App) Serve() error

Serve starts the aurora web server, binding it to a socket, setting up the shutdown signals.

func (*App) Tick

func (a *App) Tick(ctx context.Context) error

Tick triggers aurora to update all of it's background processes such as transaction submission, metrics, ingestion and reaping.

func (*App) UpdateAuroraLedgerState

func (a *App) UpdateAuroraLedgerState(ctx context.Context)

UpdateAuroraLedgerState triggers a refresh of Aurora ledger state. This is done separately from Core ledger state update to prevent issues in case Hcnet-Core query timeout.

func (*App) UpdateCoreLedgerState

func (a *App) UpdateCoreLedgerState(ctx context.Context)

UpdateCoreLedgerState triggers a refresh of Hcnet-Core ledger state. This is done separately from Aurora ledger state update to prevent issues in case Hcnet-Core query timeout.

func (*App) UpdateFeeStatsState

func (a *App) UpdateFeeStatsState(ctx context.Context)

UpdateFeeStatsState triggers a refresh of several operation fee metrics.

func (*App) UpdateHcnetCoreInfo

func (a *App) UpdateHcnetCoreInfo(ctx context.Context) error

UpdateHcnetCoreInfo updates the value of CoreVersion, CurrentProtocolVersion, and CoreSupportedProtocolVersion from the Hcnet core API.

Warning: This method should only return an error if it is fatal. See usage in `App.Tick`

type ApplyOptions

type ApplyOptions struct {
	AlwaysIngest                 bool
	RequireCaptiveCoreFullConfig bool
}

type Config

type Config struct {
	DatabaseURL        string
	RoDatabaseURL      string
	HistoryArchiveURLs []string
	Port               uint
	AdminPort          uint

	EnableIngestionFiltering    bool
	CaptiveCoreBinaryPath       string
	CaptiveCoreConfigPath       string
	CaptiveCoreTomlParams       ledgerbackend.CaptiveCoreTomlParams
	CaptiveCoreToml             *ledgerbackend.CaptiveCoreToml
	CaptiveCoreStoragePath      string
	CaptiveCoreReuseStoragePath bool
	CaptiveCoreConfigUseDB      bool

	HcnetCoreURL string

	// MaxDBConnections has a priority over all 4 values below.
	MaxDBConnections           int
	AuroraDBMaxOpenConnections int
	AuroraDBMaxIdleConnections int

	SSEUpdateFrequency time.Duration
	ConnectionTimeout  time.Duration
	// MaxHTTPRequestSize is the maximum allowed request payload size
	MaxHTTPRequestSize uint
	RateQuota          *throttled.RateQuota
	FriendbotURL       *url.URL
	LogLevel           logrus.Level
	LogFile            string

	// MaxPathLength is the maximum length of the path returned by `/paths` endpoint.
	MaxPathLength uint
	// MaxAssetsPerPathRequest is the maximum number of assets considered for `/paths/strict-send` and `/paths/strict-receive`
	MaxAssetsPerPathRequest int
	// DisablePoolPathFinding configures aurora to run path finding without including liquidity pools
	// in the path finding search.
	DisablePoolPathFinding bool
	// DisablePathFinding configures aurora without the path finding endpoint.
	DisablePathFinding bool
	// MaxPathFindingRequests is the maximum number of path finding requests aurora will allow
	// in a 1-second period. A value of 0 disables the limit.
	MaxPathFindingRequests uint

	NetworkPassphrase string
	SentryDSN         string
	LogglyToken       string
	LogglyTag         string
	// TLSCert is a path to a certificate file to use for aurora's TLS config
	TLSCert string
	// TLSKey is the path to a private key file to use for aurora's TLS config
	TLSKey string
	// Ingest toggles whether this aurora instance should run the data ingestion subsystem.
	Ingest bool
	// HistoryRetentionCount represents the minimum number of ledgers worth of
	// history data to retain in the aurora database. For the purposes of
	// determining a "retention duration", each ledger roughly corresponds to 10
	// seconds of real time.
	HistoryRetentionCount uint
	// StaleThreshold represents the number of ledgers a history database may be
	// out-of-date by before aurora begins to respond with an error to history
	// requests.
	StaleThreshold uint
	// IngestDisableStateVerification disables state verification
	// `System.verifyState()` when set to `true`.
	IngestDisableStateVerification bool
	// IngestStateVerificationCheckpointFrequency configures how often state verification is performed.
	// If IngestStateVerificationCheckpointFrequency is set to 1 state verification is run on every checkpoint,
	// If IngestStateVerificationCheckpointFrequency is set to 2 state verification is run on every second checkpoint,
	// etc...
	IngestStateVerificationCheckpointFrequency uint
	// IngestStateVerificationTimeout configures a timeout on the state verification routine.
	// If IngestStateVerificationTimeout is set to 0 the timeout is disabled.
	IngestStateVerificationTimeout time.Duration
	// IngestEnableExtendedLogLedgerStats enables extended ledger stats in
	// logging.
	IngestEnableExtendedLogLedgerStats bool
	// ApplyMigrations will apply pending migrations to the aurora database
	// before starting the aurora service
	ApplyMigrations bool
	// CheckpointFrequency establishes how many ledgers exist between checkpoints
	CheckpointFrequency uint32
	// BehindCloudflare determines if Aurora instance is behind Cloudflare. In
	// such case http.Request.RemoteAddr will be replaced with Cloudflare header.
	BehindCloudflare bool
	// BehindAWSLoadBalancer determines if Aurora instance is behind AWS load
	// balances like ELB or ALB. In such case http.Request.RemoteAddr will be
	// replaced with the last IP in X-Forwarded-For header.
	BehindAWSLoadBalancer bool
	// RoundingSlippageFilter excludes trades from /trade_aggregations with rounding slippage >x bps
	RoundingSlippageFilter int
	// Hcnet network: 'testnet' or 'pubnet'
	Network string
	// DisableTxSub disables transaction submission functionality for Aurora.
	DisableTxSub bool
	// SkipSorobanIngestion skips Soroban related ingestion processing.
	SkipSorobanIngestion bool
}

Config is the configuration for aurora. It gets populated by the app's main function and is provided to NewApp.

func Flags

func Flags() (*Config, support.ConfigOptions)

Flags returns a Config instance and a list of commandline flags which modify the Config instance

Directories

Path Synopsis
Package actions provides the infrastructure for defining and executing actions (code that is triggered in response to an client request) on aurora.
Package actions provides the infrastructure for defining and executing actions (code that is triggered in response to an client request) on aurora.
Package assets is a simple helper package to help convert to/from xdr.AssetType values
Package assets is a simple helper package to help convert to/from xdr.AssetType values
Package codes is a helper package to help convert to transaction and operation result codes to strings used in aurora.
Package codes is a helper package to help convert to transaction and operation result codes to strings used in aurora.
db2
Package db2 is the replacement for db.
Package db2 is the replacement for db.
history
Package history contains database record definitions useable for reading rows from a the history portion of aurora's database
Package history contains database record definitions useable for reading rows from a the history portion of aurora's database
Package hchi provides functions to support embedded and retrieving a request id from a go context tree
Package hchi provides functions to support embedded and retrieving a request id from a go context tree
Package ingest contains the new ingestion system for aurora.
Package ingest contains the new ingestion system for aurora.
Package ledger provides useful utilities concerning ledgers within hcnet, specifically as a central location to store a cached snapshot of the state of both aurora's and hcnet-core's views of the ledger.
Package ledger provides useful utilities concerning ledgers within hcnet, specifically as a central location to store a cached snapshot of the state of both aurora's and hcnet-core's views of the ledger.
Package operationfeestats provides useful utilities concerning operation fee stats within hcnet,specifically as a central location to store a cached snapshot of the state of network per operation fees and surge pricing.
Package operationfeestats provides useful utilities concerning operation fee stats within hcnet,specifically as a central location to store a cached snapshot of the state of network per operation fees and surge pricing.
Package paths provides utilities and facilities for payment paths as needed by aurora.
Package paths provides utilities and facilities for payment paths as needed by aurora.
Package reap contains the history reaping subsystem for aurora.
Package reap contains the history reaping subsystem for aurora.
sse
This package contains the Server Sent Events implementation used by aurora.
This package contains the Server Sent Events implementation used by aurora.
Package simplepath provides an implementation of paths.
Package simplepath provides an implementation of paths.
Package test contains simple test helpers that should not have any dependencies on aurora's packages.
Package test contains simple test helpers that should not have any dependencies on aurora's packages.
db
Package db provides helpers to connect to test databases.
Package db provides helpers to connect to test databases.
transactions
Package transactions offers common infrastructure for testing Transactions
Package transactions offers common infrastructure for testing Transactions
Package txsub provides the machinery that aurora uses to submit transactions to the hcnet network and track their progress.
Package txsub provides the machinery that aurora uses to submit transactions to the hcnet network and track their progress.
Package utf8 contains utilities for working with utf8 data.
Package utf8 contains utilities for working with utf8 data.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL