README
¶
Ostracon
Ostracon is forked from Tendermint Core v0.34.8 on 2021-03-15. And we synced up with Tendermint-v0.34.24 on 2023-07-24.
Node: Requires Go 1.20+
Warnings: Initial development is in progress, but there has not yet been a stable.
Quick Start
git clone
git clone https://github.com/Finschia/ostracon.git
# or
git clone git@github.com:Finschia/ostracon.git
Local Standalone
Build
make build # go help build
make install # go help install
Run
ostracon init
ostracon node --proxy_app=kvstore # Run a node
Before running it, don't forget to cleanup the old files:
# Clear the build folder
rm -rf ~/.ostracon
Visit with your browser
- Node: http://localhost:26657/
Localnet(4 nodes) with Docker
Build Docker Image
(optionally) Build the linux binary for localnode in ./build
make build-localnode
(optionally) Build ostracon/localnode image
make build-localnode-docker
Run localnet
To start 4 nodes
make localnet-start
Before running it, don't forget to cleanup the old files
rm -rf ./build/node*
Visit with your browser
- Node: http://localhost:26657/
Linux Docker
Build Docker Image
Build the linux binary
make build-linux-docker
Run a linux docker node
To start a linux node
make standalone-linux-docker
Visit with your browser
- Node: http://localhost:26657/
Directories
¶
| Path | Synopsis |
|---|---|
|
abci
|
|
|
server
Package server is used to start a new ABCI server.
|
Package server is used to start a new ABCI server. |
|
Package Behaviour provides a mechanism for reactors to report behaviour of peers.
|
Package Behaviour provides a mechanism for reactors to report behaviour of peers. |
|
cmd
|
|
|
merkle
Package merkle computes a deterministic minimal height Merkle tree hash.
|
Package merkle computes a deterministic minimal height Merkle tree hash. |
|
xchacha20poly1305
Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha.
|
Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha. |
|
Package evidence handles all evidence storage and gossiping from detection to block proposal.
|
Package evidence handles all evidence storage and gossiping from detection to block proposal. |
|
libs
|
|
|
events
Package events - Pub-Sub in go with event caching
|
Package events - Pub-Sub in go with event caching |
|
flowrate
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.
|
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream. |
|
json
Package json provides functions for marshaling and unmarshaling JSON in a format that is backwards-compatible with Amino JSON encoding.
|
Package json provides functions for marshaling and unmarshaling JSON in a format that is backwards-compatible with Amino JSON encoding. |
|
pubsub
Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).
|
Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients). |
|
pubsub/query
Package query provides a parser for a custom query format:
|
Package query provides a parser for a custom query format: |
|
package light provides a light client implementation.
|
package light provides a light client implementation. |
|
v0
TODO: Better handle abci client errors.
|
TODO: Better handle abci client errors. |
|
Package node is the main entry point, where the Node struct, which represents a full node, is defined.
|
Package node is the main entry point, where the Node struct, which represents a full node, is defined. |
|
upnp
Taken from taipei-torrent.
|
Taken from taipei-torrent. |
|
Package privval provides different implementations of the types.PrivValidator.
|
Package privval provides different implementations of the types.PrivValidator. |
|
proto
|
|
|
rpc
|
|
|
core
Package core defines the Ostracon RPC endpoints.
|
Package core defines the Ostracon RPC endpoints. |
|
jsonrpc
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets
|
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets |
|
jsonrpc/server
Commons for HTTP handling
|
Commons for HTTP handling |
|
scripts
|
|
|
indexer/sink/psql
Package psql implements an event sink backed by a PostgreSQL database.
|
Package psql implements an event sink backed by a PostgreSQL database. |
|
test
|
|
|
tools
|
|
Click to show internal directories.
Click to hide internal directories.