Creating an external application in Go
An external ABCI application runs separately from the Tenderdash node. The node connects to its socket or gRPC server and sends requests using the ABCI application interface. Use the application interface and protobuf definitions from your Tenderdash release.
Start with the example application
Build Tenderdash and the example ABCI CLI from the same checkout:
make install_abci
Start the supplied key-value application in one terminal:
abci-cli kvstore --address tcp://127.0.0.1:26658
Initialize a local validator and connect it to that application in another terminal. Use a new home directory for this experiment:
tenderdash init validator --home ./example-node
tenderdash start --home ./example-node --proxy-app=tcp://127.0.0.1:26658
Keep the ABCI server bound to loopback for local development. A publicly exposed ABCI endpoint lets callers bypass the node's consensus lifecycle.
Implement your application
Study the key-value application source and its tests. It provides working examples of transaction checking, proposal handling, block finalization, queries and snapshots.
Your Go implementation uses these package paths:
import (
"github.com/dashpay/tenderdash/abci/server"
abci "github.com/dashpay/tenderdash/abci/types"
)
The abci.Application interface includes:
InfoandInitChainfor startup and chain initialization.CheckTxfor mempool admission; this must not commit application state.PrepareProposalandProcessProposalfor block construction and validation.ExtendVoteandVerifyVoteExtensionfor application vote extensions.FinalizeBlockfor applying a decided block and persisting state.Queryfor application queries, plus the snapshot methods for state sync.
abci.BaseApplication supplies default implementations for scaffolding. Those
defaults are not a complete persistent application. Implement the state, height,
application hash, validation and recovery behavior your application requires.
Create the server with
server.NewServer(logger, address, transport, app), then start the returned
service with a context. Stop and wait for the service during shutdown. See the
server package
and ABCI CLI implementation
for lifecycle handling.
Submit and query transactions
With the example key-value application running, submit a transaction:
curl -s 'localhost:26657/broadcast_tx_commit?tx="example=rocks"'
Query the committed value:
curl -s 'localhost:26657/abci_query?data="example"'
Inspect the transaction result as well as transport-level success. Your own application defines the transaction encoding and query format.
Validate application behavior
Test invalid transactions, proposal rejection, repeated requests, crash recovery and snapshot restore. All correct replicas must derive the same application hash from the same committed input. Keep tentative proposal execution isolated from committed state, because proposals can be rejected or superseded.
For the complete lifecycle, read the ABCI specification. For embedding in the same process, follow the built-in application guide.