README
¶
Frontier
Frontier is the client facing API server for the DigitalBits ecosystem. It acts as the interface between DigitalBits Core and applications that want to access the DigitalBits 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 Frontier in action by running your own DigitalBits node as part of the DigitalBits 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.
Prebuild software
DigitalBits.io publishes frontier packages to the GitHub releases
Packages available as:
- .deb and .rpm packages
- prebuild binaries for windows, linux and macos
- docker image. See GitHub Packages
DEB-based
-
Download digitalbits-frontier package from GitHub Releases:
curl -Lo digitalbits-frontier.deb 'https://github.com/xdbfoundation/go/releases/download/${VERSION}/digitalbits-frontier_${VERSION}_amd64.deb' -
Install digitalbits-frontier package:
sudo dpkg -i digitalbits-frontier.deb
RPM-based
-
Download digitalbits-frontier package from GitHub Releases:
curl -Lo digitalbits-frontier.rpm 'https://github.com/xdbfoundation/go/releases/download/${VERSION}/digitalbits-frontier-${VERSION}.x86_64.rpm' -
Install digitalbits-frontier package:
sudo rpm -i digitalbits-frontier.rpm
Raw binaries
-
MacOS
curl -LO 'https://github.com/xdbfoundation/go/releases/download/${VERSION}/frontier-${VERSION}-darwin-amd64.tar.gz' -
Linux
curl -LO 'https://github.com/xdbfoundation/go/releases/download/${VERSION}/frontier-${VERSION}-linux-amd64.tar.gz' -
Windows
curl -LO 'https://github.com/xdbfoundation/go/releases/download/${VERSION}/frontier-${VERSION}-windows-amd64.zip' -
Linux (32-bit)
curl -LO 'https://github.com/xdbfoundation/go/releases/download/${VERSION}/frontier-${VERSION}-linux-386.tar.gz' -
Windows (32-bit)
curl -LO 'https://github.com/xdbfoundation/go/releases/download/${VERSION}/frontier-${VERSION}-windows-386.zip'
Docker image
docker pull ghcr.io/xdbfoundation/digitalbits-frontier:latest
Run a production server
If you're an administrator planning to run a production instance of Frontier as part of the public DigitalBits network, check out the detailed Administration Guide. It covers installation, monitoring, error scenarios and more.
Contributing
As an open source project, development of Frontier 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 Frontier, 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 frontier.
|
Package actions provides the infrastructure for defining and executing actions (code that is triggered in response to an client request) on frontier. |
|
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 frontier.
|
Package codes is a helper package to help convert to transaction and operation result codes to strings used in frontier. |
|
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 frontier's database
|
Package history contains database record definitions useable for reading rows from a the history portion of frontier'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 frontier.
|
Package ingest contains the new ingestion system for frontier. |
|
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 digitalbits, specifically as a central location to store a cached snapshot of the state of both frontier's and digitalbits-core's views of the ledger.
|
Package ledger provides useful utilities concerning ledgers within digitalbits, specifically as a central location to store a cached snapshot of the state of both frontier's and digitalbits-core's views of the ledger. |
|
operationfeestats
Package operationfeestats provides useful utilities concerning operation fee stats within digitalbits,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 digitalbits,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 frontier.
|
Package paths provides utilities and facilities for payment paths as needed by frontier. |
|
reap
Package reap contains the history reaping subsystem for frontier.
|
Package reap contains the history reaping subsystem for frontier. |
|
render/sse
This package contains the Server Sent Events implementation used by frontier.
|
This package contains the Server Sent Events implementation used by frontier. |
|
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 frontier's packages.
|
Package test contains simple test helpers that should not have any dependencies on frontier'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 frontier uses to submit transactions to the digitalbits network and track their progress.
|
Package txsub provides the machinery that frontier uses to submit transactions to the digitalbits network and track their progress. |
|
txsub/sequence
Package sequence providers helpers to manage sequence numbers on behalf of frontier clients.
|
Package sequence providers helpers to manage sequence numbers on behalf of frontier clients. |
|
utf8
Package utf8 contains utilities for working with utf8 data.
|
Package utf8 contains utilities for working with utf8 data. |