EXCCoin block explorer, with packages and apps for data collection and storage. Written in Go.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
blockdata
cmd
db
dev
exccdataapi
explorer
mempool
public
rpcutils
semver
stakedb
txhelpers
views
.appveyor.yml
.gitignore
.travis.yml
CODE_OF_CONDUCT
CONTRIBUTING.md
Gopkg.lock
Gopkg.toml
LICENSE
README.md
apimiddleware.go
apirouter.go
apiroutes.go
blockmemdb.go
config.go
err.go
log.go
main.go
ntfnchans.go
ntfnhandlers.go
run_tests.sh
sample-exccdata.conf
sample-nginx.conf
sample-rate_limiting.html
travis_osx_before_install.sh
version.go
websocket.go

README.md

exccdata

Build Status Build status GitHub release Latest tag Go Report Card ISC License

The exccdata repository is a collection of golang packages and apps for ExchangeCoin data collection, storage, and presentation.

Repository overview

../exccdata             The exccdata daemon.
├── blockdata           Package blockdata.
├── cmd
│   ├── rebuilddb       rebuilddb utility, for SQLite backend.
│   ├── rebuilddb2      rebuilddb2 utility, for PostgreSQL backend.
│   └── scanblocks      scanblocks utility.
├── exccdataapi         Package exccdataapi for golang API clients.
├── db
│   ├── dbtypes         Package dbtypes with common data types.
│   ├── exccpg          Package exccpg providing PostgreSQL backend.
│   └── exccsqlite      Package exccsqlite providing SQLite backend.
├── dev                 Shell scripts for maintenance and deployment.
├── public              Public resources for block explorer (css, js, etc.).
├── explorer            Package explorer, powering the block explorer.
├── mempool             Package mempool.
├── rpcutils            Package rpcutils.
├── semver              Package semver.
├── stakedb             Package stakedb, for tracking tickets.
├── txhelpers           Package txhelpers.
└── views               HTML templates for block explorer.

Requirements

  • Go 1.9.x or 1.10.x.
  • Running exccd (>=1.1.2) synchronized to the current best block on the network.

Installation

Build from Source

The following instructions assume a Unix-like shell (e.g. bash).

  • Install Go

  • Verify Go installation:

    go env GOROOT GOPATH
    
  • Ensure $GOPATH/bin is on your $PATH.

  • Install dep, the dependency management tool.

    go get -u -v github.com/golang/dep/cmd/dep
    
  • Clone the exccdata repository. It must be cloned into the following directory.

    git clone https://github.com/EXCCoin/exccdata $GOPATH/src/github.com/EXCCoin/exccdata
    
  • Fetch dependencies, and build the exccdata executable.

    cd $GOPATH/src/github.com/EXCCoin/exccdata
    dep ensure
    # build exccdata executable in workspace:
    go build
    

The sqlite driver uses cgo, which requires a C compiler (e.g. gcc) to compile the C sources. On Windows this is easily handled with MSYS2 (download and install MinGW-w64 gcc packages).

Tip: If you receive other build errors, it may be due to "vendor" directories left by dep builds of dependencies such as exccwallet. You may safely delete vendor folders and run dep ensure again.

Runtime resources

The config file, logs, and data files are stored in the application data folder, which may be specified via the -A/--appdata setting. However, the location of the config file may be set with -C/--configfile.

The "public" and "views" folders must be in the same folder as the exccdata executable.

Updating

First, update the repository (assuming you have master checked out):

cd $GOPATH/src/github.com/EXCCoin/exccdata
git pull origin master
dep ensure
go build

Look carefully for errors with git pull, and reset locally modified files if necessary.

Getting Started

Configure PostgreSQL (IMPORTANT)

If you intend to run exccdata in "full" mode (i.e. with the --pg switch), which uses a PostgreSQL database backend, it is crucial that you configure your PostgreSQL server for your hardware and the exccdata workload.

Read postgresql-tuning.conf carefully for details on how to make the necessary changes to your system.

Create configuration file

Begin with the sample configuration file:

cp sample-exccdata.conf exccdata.conf

Then edit exccdata.conf with your exccd RPC settings. See the output of exccdata --help for a list of all options and their default values.

Indexing the Blockchain

If exccdata has not previously been run with the PostgreSQL database backend, it is necessary to perform a bulk import of blockchain data and generate table indexes. This will be done automatically by exccdata on a fresh startup.

Alternatively, the PostgreSQL tables may also be generated with the rebuilddb2 command line tool:

  • Create the exccdata user and database in PostgreSQL (tables will be created automatically).
  • Set your PostgreSQL credentials and host in both ./cmd/rebuilddb2/rebuilddb2.conf, and exccdata.conf in the location specified by the appdata flag.
  • Run ./rebuilddb2 to bulk import data and index the tables.
  • In case of irrecoverable errors, such as detected schema changes without an upgrade path, the tables and their indexes may be dropped with rebuilddb2 -D.

Note that exccdata requires that exccd is running with optional indexes enabled. By default these indexes are not turned on when exccd is installed.

In exccd.conf set:

txindex=1
addrindex=1

Starting exccdata

Launch the exccdata daemon and allow the databases to process new blocks. Both SQLite and PostgreSQL synchronization require about an hour the first time exccdata is run, but they are done concurrently. On subsequent launches, only blocks new to exccdata are processed.

./exccdata    # don't forget to configure exccdata.conf in the appdata folder!

Unlike exccdata.conf, which must be placed in the appdata folder or explicitly set with -C, the "public" and "views" folders must be in the same folder as the exccdata executable.

exccdata daemon

The root of the repository is the main package for the exccdata app, which has several components including:

  1. Block explorer (web interface).
  2. Blockchain monitoring and data collection.
  3. Mempool monitoring and reporting.
  4. Data storage in durable database (sqlite presently).
  5. RESTful JSON API over HTTP(S).

Block Explorer

After exccdata syncs with the blockchain server via RPC, by default it will begin listening for HTTP connections on http://127.0.0.1:7777/. This means it starts a web server listening on IPv4 localhost, port 7777. Both the interface and port are configurable. The block explorer and the JSON API are both provided by the server on this port. See JSON REST API for details.

Note that while exccdata can be started with HTTPS support, it is recommended to employ a reverse proxy such as nginx. See sample-nginx.conf for an example nginx configuration.

A new auxillary database backend using PostgreSQL was introduced in v0.9.0 that provides expanded functionality. However, initial population of the database takes additional time and tens of gigabytes of disk storage space. Thus, exccdata runs by default in a reduced functionality mode that does not require PostgreSQL. To enable the PostgreSQL backend (and the expanded functionality), exccdata may be started with the --pg switch.

JSON REST API

The API serves JSON data over HTTP(S). All API endpoints are currently prefixed with /api (e.g. http://localhost:7777/api/stake).

Endpoint List

Best block Path Type
Summary /block/best types.BlockDataBasic
Stake info /block/best/pos types.StakeInfoExtended
Header /block/best/header exccjson.GetBlockHeaderVerboseResult
Hash /block/best/hash string
Height /block/best/height int
Size /block/best/size int32
Transactions /block/best/tx types.BlockTransactions
Transactions Count /block/best/tx/count types.BlockTransactionCounts
Verbose block result /block/best/verbose exccjson.GetBlockVerboseResult
Block X (block index) Path Type
Summary /block/X types.BlockDataBasic
Stake info /block/X/pos types.StakeInfoExtended
Header /block/X/header exccjson.GetBlockHeaderVerboseResult
Hash /block/X/hash string
Size /block/X/size int32
Transactions /block/X/tx types.BlockTransactions
Transactions Count /block/X/tx/count types.BlockTransactionCounts
Verbose block result /block/X/verbose exccjson.GetBlockVerboseResult
Block H (block hash) Path Type
Summary /block/hash/H types.BlockDataBasic
Stake info /block/hash/H/pos types.StakeInfoExtended
Header /block/hash/H/header exccjson.GetBlockHeaderVerboseResult
Height /block/hash/H/height int
Size /block/hash/H/size int32
Transactions /block/hash/H/tx types.BlockTransactions
Transactions Count /block/hash/H/tx/count types.BlockTransactionCounts
Verbose block result /block/hash/H/verbose exccjson.GetBlockVerboseResult
Block range (X < Y) Path Type
Summary array for blocks on [X,Y] /block/range/X/Y []types.BlockDataBasic
Summary array with block index step S /block/range/X/Y/S []types.BlockDataBasic
Size (bytes) array /block/range/X/Y/size []int32
Size array with step S /block/range/X/Y/S/size []int32
Transaction T (transaction id) Path Type
Transaction Details /tx/T types.Tx
Inputs /tx/T/in []types.TxIn
Details for input at index X /tx/T/in/X types.TxIn
Outputs /tx/T/out []types.TxOut
Details for output at index X /tx/T/out/X types.TxOut
Address A Path Type
Summary of last 10 transactions /address/A types.Address
Verbose transaction result for last
10 transactions
/address/A/raw types.AddressTxRaw
Summary of last N transactions /address/A/count/N types.Address
Verbose transaction result for last
N transactions
/address/A/count/N/raw types.AddressTxRaw
Summary of last N transactions, skipping M /address/A/count/N/skip/M types.Address
Verbose transaction result for last
N transactions, skipping M
/address/A/count/N/skip/Mraw types.AddressTxRaw
Stake Difficulty (Ticket Price) Path Type
Current sdiff and estimates /stake/diff types.StakeDiff
Sdiff for block X /stake/diff/b/X []float64
Sdiff for block range [X,Y] (X <= Y) /stake/diff/r/X/Y []float64
Current sdiff separately /stake/diff/current exccjson.GetStakeDifficultyResult
Estimates separately /stake/diff/estimates exccjson.EstimateStakeDiffResult
Ticket Pool Path Type
Current pool info (size, total value, and average price) /stake/pool types.TicketPoolInfo
Current ticket pool, in a JSON object with a "tickets" key holding an array of ticket hashes /stake/pool/full []string
Pool info for block X /stake/pool/b/X types.TicketPoolInfo
Full ticket pool at block height or hash H /stake/pool/b/H/full []string
Pool info for block range [X,Y] (X <= Y) /stake/pool/r/X/Y?arrays=[true|false]* []apitypes.TicketPoolInfo

The full ticket pool endpoints accept the URL query ?sort=[true\|false] for requesting the tickets array in lexicographical order. If a sorted list or list with deterministic order is not required, using sort=false will reduce server load and latency. However, be aware that the ticket order will be random, and will change each time the tickets are requested.

*For the pool info block range endpoint that accepts the arrays url query, a value of true will put all pool values and pool sizes into separate arrays, rather than having a single array of pool info JSON objects. This may make parsing more efficient for the client.

Vote and Agenda Info Path Type
The current agenda and its status /stake/vote/info exccjson.GetVoteInfoResult
Mempool Path Type
Ticket fee rate summary /mempool/sstx apitypes.MempoolTicketFeeInfo
Ticket fee rate list (all) /mempool/sstx/fees apitypes.MempoolTicketFees
Ticket fee rate list (N highest) /mempool/sstx/fees/N apitypes.MempoolTicketFees
Detailed ticket list (fee, hash, size, age, etc.) /mempool/sstx/details apitypes.MempoolTicketDetails
Detailed ticket list (N highest fee rates) /mempool/sstx/details/N apitypes.MempoolTicketDetails
Other Path Type
Status /status types.Status
Coin Supply /supply types.CoinSupply
Endpoint list (always indented) /list []string
Directory /directory string

All JSON endpoints accept the URL query indent=[true|false]. For example, /stake/diff?indent=true. By default, indentation is off. The characters to use for indentation may be specified with the indentjson string configuration option.

Important Note About Mempool

Although there is mempool data collection and serving, it is very important to keep in mind that the mempool in your node (exccd) is not likely to be exactly the same as other nodes' mempool. Also, your mempool is cleared out when you shutdown exccd. So, if you have recently (e.g. after the start of the current ticket price window) started exccd, your mempool will be missing transactions that other nodes have.

Command Line Utilities

rebuilddb

rebuilddb is a CLI app that performs a full blockchain scan that fills past block data into a SQLite database. This functionality is included in the startup of the exccdata daemon, but may be called alone with rebuilddb.

rebuilddb2

rebuilddb2 is a CLI app used for maintenance of exccdata's exccpg database (a.k.a. DB v2) that uses PostgreSQL to store a nearly complete record of the ExchangeCoin blockchain data. See the README.md for rebuilddb2 for important usage information.

scanblocks

scanblocks is a CLI app to scan the blockchain and save data into a JSON file. More details are in its own README. The repository also includes a shell script, jsonarray2csv.sh, to convert the result into a comma-separated value (CSV) file.

Helper packages

package exccdataapi defines the data types, with json tags, used by the JSON API. This facilitates authoring of robust golang clients of the API.

package dbtypes defines the data types used by the DB backends to model the block, transaction, and related blockchain data structures. Functions for converting from standard ExchangeCoin data types (e.g. wire.MsgBlock) are also provided.

package rpcutils includes helper functions for interacting with a rpcclient.Client.

package stakedb defines the StakeDatabase and ChainMonitor types for efficiently tracking live tickets, with the primary purpose of computing ticket pool value quickly. It uses the database.DB type from github.com/EXCCoin/exccd/database with an ffldb storage backend from github.com/EXCCoin/exccd/database/ffldb. It also makes use of the stake.Node type from github.com/EXCCoin/exccd/blockchain/stake. The ChainMonitor type handles connecting new blocks and chain reorganization in response to notifications from exccd.

package txhelpers includes helper functions for working with the common types exccutil.Tx, exccutil.Block, chainhash.Hash, and others.

Internal-use packages

Packages blockdata and exccsqlite are currently designed only for internal use internal use by other exccdata packages, but they may be of general value in the future.

blockdata defines:

  • The chainMonitor type and its BlockConnectedHandler() method that handles block-connected notifications and triggers data collection and storage.
  • The BlockData type and methods for converting to API types.
  • The blockDataCollector type and its Collect() and CollectHash() methods that are called by the chain monitor when a new block is detected.
  • The BlockDataSaver interface required by chainMonitor for storage of collected data.

exccpg defines:

  • The ChainDB type, which is the primary exported type from exccpg, providing an interface for a PostgreSQL database.
  • A large set of lower-level functions to perform a range of queries given a *sql.DB instance and various parameters.
  • The internal package contains the raw SQL statements.

exccsqlite defines:

  • A sql.DB wrapper type (DB) with the necessary SQLite queries for storage and retrieval of block and stake data.
  • The wiredDB type, intended to satisfy the APIDataSource interface used by the exccdata app's API. The block header is not stored in the DB, so a RPC client is used by wiredDB to get it on demand. wiredDB also includes methods to resync the database file.

package mempool defines a mempoolMonitor type that can monitor a node's mempool using the OnTxAccepted notification handler to send newly received transaction hashes via a designated channel. Ticket purchases (SSTx) are triggers for mempool data collection, which is handled by the mempoolDataCollector class, and data storage, which is handled by any number of objects implementing the MempoolDataSaver interface.

Plans

See the GitHub issue tracker and the project milestones.

Contributing

Yes, please! See the CONTRIBUTING.md file for details, but here's the gist of it:

  1. Fork the repo.
  2. Create a branch for your work (git branch -b cool-stuff).
  3. Code something great.
  4. Commit and push to your repo.
  5. Create a pull request.

Before committing any changes to the Gopkg.lock file, you must update dep to the latest version via:

go get -u github.com/golang/dep/cmd/dep

To update dep from the network, it is important to use the -u flag as shown above.

Note that all explorer.excc.co community and team members are expected to adhere to the code of conduct, described in the CODE_OF_CONDUCT file.

Also, come chat with us on Slack!

License

This project is licensed under the ISC License. See the LICENSE file for details.