README
¶
Aurora
Aurora is the client facing API server for the Diamcircle ecosystem. It acts as the interface between Diamcircle Core and applications that want to access the Diamcircle 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 Aurora in action by running your own Diamcircle node as part of the Diamcircle 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 Aurora as part of the public Diamcircle network, check out the detailed Administration Guide. It covers installation, monitoring, error scenarios and more.
Contributing
As an open source project, development of Aurora 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 Aurora, 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 aurora.
|
Package actions provides the infrastructure for defining and executing actions (code that is triggered in response to an client request) on aurora. |
|
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 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. |
|
db2/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 |
|
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 new ingestion system for aurora.
|
Package ingest contains the new ingestion system for aurora. |
|
ingest/verify
Package verify provides helpers used for verifying if the ingested data is correct.
|
Package verify provides helpers used for verifying if the ingested data is correct. |
|
ledger
Package ledger provides useful utilities concerning ledgers within diamcircle, specifically as a central location to store a cached snapshot of the state of both aurora's and diamcircle-core's views of the ledger.
|
Package ledger provides useful utilities concerning ledgers within diamcircle, specifically as a central location to store a cached snapshot of the state of both aurora's and diamcircle-core's views of the ledger. |
|
operationfeestats
Package operationfeestats provides useful utilities concerning operation fee stats within diamcircle,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 diamcircle,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 aurora.
|
Package paths provides utilities and facilities for payment paths as needed by aurora. |
|
reap
Package reap contains the history reaping subsystem for aurora.
|
Package reap contains the history reaping subsystem for aurora. |
|
render/sse
This package contains the Server Sent Events implementation used by aurora.
|
This package contains the Server Sent Events implementation used by aurora. |
|
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 aurora's packages.
|
Package test contains simple test helpers that should not have any dependencies on aurora's packages. |
|
test/db
Package db provides helpers to connect to test databases.
|
Package db provides helpers to connect to test databases. |
|
test/transactions
Package transactions offers common infrastructure for testing Transactions
|
Package transactions offers common infrastructure for testing Transactions |
|
txsub
Package txsub provides the machinery that aurora uses to submit transactions to the diamcircle network and track their progress.
|
Package txsub provides the machinery that aurora uses to submit transactions to the diamcircle network and track their progress. |
|
txsub/sequence
Package sequence providers helpers to manage sequence numbers on behalf of aurora clients.
|
Package sequence providers helpers to manage sequence numbers on behalf of aurora clients. |
|
utf8
Package utf8 contains utilities for working with utf8 data.
|
Package utf8 contains utilities for working with utf8 data. |