README
¶
Note this code is beta.
It is not ready yet for production.
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.
Dependencies
Horizon requires go 1.5 or higher to build. See (https://golang.org/doc/install) for installation instructions.
Building
gb is used for building horizon.
Given you have a running golang installation, you can install this with:
go get -u github.com/constabulary/gb/...
From within the project directory, simply run gb build. After successful
completion, you should find bin/horizon is present in the project directory.
Developing Horizon
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
github.com/stellar/horizon/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. |
|
github.com/stellar/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 |
|
github.com/stellar/horizon/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. |
|
github.com/stellar/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 |
|
github.com/stellar/horizon/db
Package db provides machinery for the database subsystem of horizon.
|
Package db provides machinery for the database subsystem of horizon. |
|
github.com/stellar/horizon/log
Package log provides the logging facilities used for horizon.
|
Package log provides the logging facilities used for horizon. |
|
github.com/stellar/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. |
|
github.com/stellar/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. |
|
github.com/stellar/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. |
|
github.com/stellar/horizon/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 |
|
github.com/stellar/horizon/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. |
|
github.com/stellar/horizon/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. |
|
github.com/stellar/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. |
Click to show internal directories.
Click to hide internal directories.