Skip to content

Repository files navigation

shinzo-host-client

Build Status License Docker

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

MIT

About

The Host Client will serve as the gateway between external applications and the Shinzo Network. It manages network coordination, request routing, and security functions for developers and indexers.

Resources

Contributing

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages