README
¶
Horizon
Horizon is the client facing API server for the Paydex ecosystem. It acts as the interface between Paydex Core and applications that want to access the Paydex network. It allows you to submit transactions to the network, check the status of accounts, subscribe to event streams and more.
Try it out
See Horizon in action by running your own Paydex node as part of the Paydex testnet. With our Docker quick-start image, you can be running your own fully functional node in around 20 minutes. See the Quickstart Guide to get up and running.
Run a production server
If you're an administrator planning to run a production instance of Horizon as part of the public Paydex network, check out the detailed Administration Guide. It covers installation, monitoring, error scenarios and more.
Contributing
As an open source project, development of Horizon is public, and you can help! We welcome new issue reports, documentation and bug fixes, and contributions that further the project roadmap. The Development Guide will show you how to build Horizon, see what's going on behind the scenes, and set up an effective develop-test-push cycle so that you can get your work incorporated quickly.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
actions
Package actions provides the infrastructure for defining and executing actions (code that is triggered in response to an client request) on horizon.
|
Package actions provides the infrastructure for defining and executing actions (code that is triggered in response to an client request) on horizon. |
|
assets
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 |
|
codes
Package codes is a helper package to help convert to transaction and operation result codes to strings used in horizon.
|
Package codes is a helper package to help convert to transaction and operation result codes to strings used in horizon. |
|
db2
Package db2 is the replacement for db.
|
Package db2 is the replacement for db. |
|
db2/core
Package core contains database record definitions useable for reading rows from a Paydex Core db
|
Package core contains database record definitions useable for reading rows from a Paydex Core db |
|
db2/history
Package history contains database record definitions useable for reading rows from a the history portion of horizon's database
|
Package history contains database record definitions useable for reading rows from a the history portion of horizon's database |
|
db2/sqx
Package sqx contains utilities and extensions for the squirrel package which is used by horizon to generate sql statements.
|
Package sqx contains utilities and extensions for the squirrel package which is used by horizon to generate sql statements. |
|
expingest
Package expingest contains the new ingestion system for horizon.
|
Package expingest contains the new ingestion system for horizon. |
|
hchi
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 |
|
ingest
Package ingest contains the ingestion system for horizon.
|
Package ingest contains the ingestion system for horizon. |
|
ingest/participants
Package participants contains functions to derive a set of "participant" addresses for various data structures in the Paydex network's ledger.
|
Package participants contains functions to derive a set of "participant" addresses for various data structures in the Paydex network's ledger. |
|
ledger
Package ledger provides useful utilities concerning ledgers within paydex, specifically as a central location to store a cached snapshot of the state of both horizon's and paydex-core's views of the ledger.
|
Package ledger provides useful utilities concerning ledgers within paydex, specifically as a central location to store a cached snapshot of the state of both horizon's and paydex-core's views of the ledger. |
|
operationfeestats
Package operationfeestats provides useful utilities concerning operation fee stats within paydex,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 paydex,specifically as a central location to store a cached snapshot of the state of network per operation fees and surge pricing. |
|
paths
Package paths provides utilities and facilities for payment paths as needed by horizon.
|
Package paths provides utilities and facilities for payment paths as needed by horizon. |
|
reap
Package reap contains the history reaping subsystem for horizon.
|
Package reap contains the history reaping subsystem for horizon. |
|
render/sse
This package contains the Server Sent Events implementation used by horizon.
|
This package contains the Server Sent Events implementation used by horizon. |
|
simplepath
Package simplepath provides an implementation of paths.
|
Package simplepath provides an implementation of paths. |
|
test
Package test contains simple test helpers that should not have any dependencies on horizon's packages.
|
Package test contains simple test helpers that should not have any dependencies on horizon's packages. |
|
test/db
Package db provides helpers to connect to test databases.
|
Package db provides helpers to connect to test databases. |
|
test/trades
Common infrastructure for testing Trades
|
Common infrastructure for testing Trades |
|
txsub
Package txsub provides the machinery that horizon uses to submit transactions to the paydex network and track their progress.
|
Package txsub provides the machinery that horizon uses to submit transactions to the paydex network and track their progress. |
|
txsub/results/db
Package results provides an implementation of the txsub.ResultProvider interface backed using the SQL databases used by both paydex core and horizon
|
Package results provides an implementation of the txsub.ResultProvider interface backed using the SQL databases used by both paydex core and horizon |
|
txsub/sequence
Package sequence providers helpers to manage sequence numbers on behalf of horizon clients.
|
Package sequence providers helpers to manage sequence numbers on behalf of horizon clients. |
|
utf8
Package utf8 contains utilities for working with utf8 data.
|
Package utf8 contains utilities for working with utf8 data. |
Click to show internal directories.
Click to hide internal directories.