orbitr

Documentation

Index

• Constants
• Variables
• func ApplyFlags(config *Config, flags support.ConfigOptions, options ApplyOptions) error
• type App
  • func NewApp(config Config) (*App, error)
  • func NewAppFromFlags(config *Config, flags support.ConfigOptions) (*App, error)
  • func (a *App) Close()
  • func (a *App) CloseDB()
  • func (a *App) Config() Config
  • func (a *App) DeleteUnretainedHistory(ctx context.Context) error
  • func (a *App) GetCoreState() corestate.State
  • func (a *App) HistoryQ() *history.Q
  • func (a *App) OrbitRSession() db.SessionInterface
  • func (a *App) Paths() paths.Finder
  • func (a *App) Serve() error
  • func (a *App) Tick(ctx context.Context) error
  • func (a *App) UpdateCoreLedgerState(ctx context.Context)
  • func (a *App) UpdateFeeStatsState(ctx context.Context)
  • func (a *App) UpdateGravityInfo(ctx context.Context) error
  • func (a *App) UpdateOrbitRLedgerState(ctx context.Context)
• type ApplyOptions
• type Config
  • func Flags() (*Config, support.ConfigOptions)

Constants

const (
	// DatabaseURLFlagName is the command line flag for configuring the OrbitR postgres URL
	DatabaseURLFlagName = "db-url"
	// IngestFlagName is the command line flag for enabling ingestion on the OrbitR instance
	IngestFlagName = "ingest"
	// GravityDBURLFlagName is the command line flag for configuring the postgres Gravity URL
	GravityDBURLFlagName = "gravity-db-url"
	// GravityURLFlagName is the command line flag for configuring the URL fore Gravity HTTP endpoint
	GravityURLFlagName = "gravity-url"
	// GravityBinaryPathName is the command line flag for configuring the path to the gravity binary
	GravityBinaryPathName = "gravity-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 OrbitR
	DisableTxSubFlagName = "disable-tx-sub"

	// LantahPubnet is a constant representing the Stellar public network
	LantahPubnet = "pubnet"
	// LantahTestnet is a constant representing the Stellar test network
	LantahTestnet = "testnet"
)

Variables

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 orbitr 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 OrbitR App from the given command line flags

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 orbitr's database.

func (*App) OrbitRSession

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

OrbitRSession returns a new session that loads data from the orbitr database.

func (*App) Paths

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

Paths returns the paths.Finder instance used by orbitr

func (*App) Serve

func (a *App) Serve() error

Serve starts the orbitr 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 orbitr to update all of it's background processes such as transaction submission, metrics, ingestion and reaping.

func (*App) UpdateCoreLedgerState

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

UpdateCoreLedgerState triggers a refresh of Gravity ledger state. This is done separately from OrbitR ledger state update to prevent issues in case Gravity query timeout.

func (*App) UpdateFeeStatsState

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

UpdateFeeStatsState triggers a refresh of several operation fee metrics.

func (*App) UpdateGravityInfo

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

UpdateGravityInfo updates the value of CoreVersion, CurrentProtocolVersion, and CoreSupportedProtocolVersion from the Stellar core API.

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

func (*App) UpdateOrbitRLedgerState

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

UpdateOrbitRLedgerState triggers a refresh of OrbitR ledger state. This is done separately from Core ledger state update to prevent issues in case Gravity query timeout.

type ApplyOptions

type ApplyOptions struct {
	AlwaysIngest             bool
	RequireCaptiveCoreConfig bool
}

type Config

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

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

	GravityDatabaseURL string
	GravityURL         string

	// MaxDBConnections has a priority over all 4 values below.
	MaxDBConnections           int
	OrbitRDBMaxOpenConnections int
	OrbitRDBMaxIdleConnections int

	SSEUpdateFrequency time.Duration
	ConnectionTimeout  time.Duration
	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 orbitr to run path finding without including liquidity pools
	// in the path finding search.
	DisablePoolPathFinding bool
	// DisablePathFinding configures orbitr without the path finding endpoint.
	DisablePathFinding bool
	// MaxPathFindingRequests is the maximum number of path finding requests orbitr 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 orbitr's TLS config
	TLSCert string
	// TLSKey is the path to a private key file to use for orbitr's TLS config
	TLSKey string
	// Ingest toggles whether this orbitr instance should run the data ingestion subsystem.
	Ingest bool
	// CursorName is the cursor used for ingesting from gravity.
	// Setting multiple cursors in different OrbitR instances allows multiple
	// OrbitRs to ingest from the same gravity instance without cursor
	// collisions.
	CursorName string
	// HistoryRetentionCount represents the minimum number of ledgers worth of
	// history data to retain in the orbitr 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 orbitr begins to respond with an error to history
	// requests.
	StaleThreshold uint
	// SkipCursorUpdate causes the ingestor to skip reporting the "last imported
	// ledger" state to gravity.
	SkipCursorUpdate bool
	// 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 orbitr database
	// before starting the orbitr service
	ApplyMigrations bool
	// CheckpointFrequency establishes how many ledgers exist between checkpoints
	CheckpointFrequency uint32
	// BehindCloudflare determines if OrbitR instance is behind Cloudflare. In
	// such case http.Request.RemoteAddr will be replaced with Cloudflare header.
	BehindCloudflare bool
	// BehindAWSLoadBalancer determines if OrbitR 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
	// Lantah Network: 'testnet' or 'pubnet'
	Network string
	// DisableTxSub disables transaction submission functionality for OrbitR.
	DisableTxSub bool
}

Config is the configuration for orbitr. 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