Skip to content

Provider

Cshell uses UtxoRPC as its on-chain data provider. It connects to a UtxoRPC server to collect blockchain data and follow the tip. Any service that implements the UtxoRPC interface can act as a data provider for Cshell, for example, Dolos.

UtxoRPC is used only for supplying on-chain data. For transaction resolution and submission, Cshell uses a TRP (Transaction Resolution Protocol) server. TRP, used with Tx3, exposes a JSON-RPC interface to resolve and submit transactions. Any application that implements that JSON-RPC interface can serve as Cshell’s TRP provider, for example Hydra TRP.

Provider storage

All cshell provider configurations are stored in a single file on your local machine:

  • File: cshell.toml
  • Location: In your user home directory (examples: ~/cshell.toml)

This file contains the definitions for every provider you create.

Usage

When providers are available, create and configure a provider in Cshell using the interactive command below:

Terminal window
cshell provider create

You can manage providers using Cshell’s provider commands. To see which provider commands are available, run the following:

Terminal window
cshell provider --help

And the --help flag can be used anywhere in Cshell. For example, after choosing the create command, you can check the options available for that command as well:

Terminal window
cshell provider create --help