README
¶
Horizon
Horizon is the client facing API server for the Stellar ecosystem. It acts as the interface between stellar-core and applications that want to access the Stellar network. It allows you to submit transactions to the network, check the status of accounts, subscribe to event streams, etc. See an overview of the Stellar ecosystem for more details.
Downloading the server
Prebuilt binaries of horizon are available on the releases page.
See the old releases page for prior releases
| Platform | Binary file name |
|---|---|
| Mac OSX 64 bit | horizon-darwin-amd64 |
| Linux 64 bit | horizon-linux-amd64 |
| Windows 64 bit | horizon-windows-amd64.exe |
Alternatively, you can build the binary yourself.
Dependencies
Horizon requires go 1.6 or higher to build. See (https://golang.org/doc/install) for installation instructions.
Building
glide is used for building horizon.
Given you have a running golang installation, you can install this with:
curl https://glide.sh/get | sh
Next, you must download the source for packages that horizon depends upon. From within the project directory, run:
glide install
Then, simply run go install github.com/stellar/go/services/horizon. After successful
completion, you should find horizon is present in your $GOPATH/bin directory.
More detailed intructions and admin guide.
Developing Horizon
Contributing
Please see the CONTRIBUTING.md for details on how to contribute to this project.
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. |
|
context/requestid
Package requestid provides functions to support embedded and retrieving a request id from a go context tree
|
Package requestid provides functions to support embedded and retrieving a request id from a go context tree |
|
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 Stellar Core db
|
Package core contains database record definitions useable for reading rows from a Stellar 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. |
|
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 Stellar network's ledger.
|
Package participants contains functions to derive a set of "participant" addresses for various data structures in the Stellar network's ledger. |
|
ledger
Package ledger provides useful utilities concerning ledgers within stellar, specifically a central location to store a cached snapshot of the state of both horizon's and stellar-core's view of the ledger.
|
Package ledger provides useful utilities concerning ledgers within stellar, specifically a central location to store a cached snapshot of the state of both horizon's and stellar-core's view of the ledger. |
|
log
Package log provides the logging facilities used for horizon.
|
Package log provides the logging facilities used for horizon. |
|
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. |
|
resource
Package resource contains the type definitions for all of horizons response resources.
|
Package resource contains the type definitions for all of horizons response resources. |
|
simplepath
Package simplepath provides an implementation of paths.Finder that performs a breadth first search for paths against a stellar-core's database
|
Package simplepath provides an implementation of paths.Finder that performs a breadth first search for paths against a stellar-core's database |
|
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. |
|
txsub
Package txsub provides the machinery that horizon uses to submit transactions to the stellar network and track their progress.
|
Package txsub provides the machinery that horizon uses to submit transactions to the stellar 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 stellar core and horizon
|
Package results provides an implementation of the txsub.ResultProvider interface backed using the SQL databases used by both stellar 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.