README
¶
shinzo-host-client
A Host node for the Shinzo network. It pulls primitive blockchain data from Indexers, runs Lens WASM transforms, and serves the resulting Views to subscriber nodes via an embedded DefraDB instance.
Getting started
Make sure ~/config.yaml exists on the host machine, then:
docker compose up
Set your keyring secret before starting:
export DEFRA_KEYRING_SECRET=<your-secret>
Further instructions, as well as hardware recommendations, can be found at docs.shinzo.network.
[!TIP] See BUILD.md for full build-from-source instructions.
Configuration
The app reads from config/config.yaml. The only field you must set is defradb.keyring_secret (or the DEFRA_KEYRING_SECRET environment variable). Everything else has working defaults.
See docs.shinzo.network for the full configuration reference.
Deployment
See the Shinzo documentation site for production deployment instructions, hardware requirements, and network topology guidance.
Contributing
Open an issue before submitting a PR. See CONTRIBUTING.md for guidelines.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
accounting
Package accounting submits signed service records to the accounting service after a host serves a billed query.
|
Package accounting submits signed service records to the accounting service after a host serves a billed query. |
|
acp
Package acp implements the host-side query-billing middleware.
|
Package acp implements the host-side query-billing middleware. |
|
pool
Package pool derives a pool's deterministic CREATE2 address (its pool_id) from the view it serves.
|
Package pool derives a pool's deterministic CREATE2 address (its pool_id) from the view it serves. |