Struct ibc_test_framework::chain::driver::ChainDriver

pub struct ChainDriver {
    pub command_path: String,
    pub chain_id: ChainId,
    pub home_path: String,
    pub account_prefix: String,
    pub rpc_port: u16,
    pub grpc_port: u16,
    pub grpc_web_port: u16,
    pub p2p_port: u16,
    pub tx_config: TxConfig,
    pub runtime: Arc<Runtime>,
}

A driver for interacting with a chain full nodes through command line.

The name ChainDriver is inspired by WebDriver, which is the term used to describe programs that control spawning of the web browsers. In our case, the ChainDriver is used to spawn and manage chain full nodes.

Currently the ChainDriver is hardcoded to support only a single version of Gaia chain. In the future, we will want to turn this into one or more ChainDriver traits so that they can be used to spawn multiple chain implementations other than a single version of Gaia.

Fields

command_path: String

The filesystem path to the Gaia CLI. Defaults to gaiad.

chain_id: ChainId

The ID of the chain.

home_path: String

The home directory for the full node to store data files.

account_prefix: String

rpc_port: u16

The port used for RPC.

grpc_port: u16

The port used for GRPC.

grpc_web_port: u16

p2p_port: u16

The port used for P2P. (Currently unused other than for setup)

tx_config: TxConfig

runtime: Arc<Runtime>

Implementations

impl ChainDriver

pub fn create(
    command_path: String,
    chain_id: ChainId,
    home_path: String,
    account_prefix: String,
    rpc_port: u16,
    grpc_port: u16,
    grpc_web_port: u16,
    p2p_port: u16,
    runtime: Arc<Runtime>
) -> Result<Self, Error>

Create a new ChainDriver

pub fn rpc_address(&self) -> String

Returns the full URL for the RPC address.

pub fn websocket_address(&self) -> String

Returns the full URL for the WebSocket address.

pub fn grpc_address(&self) -> String

Returns the full URL for the GRPC address.

pub fn rpc_listen_address(&self) -> String

Returns the full URL for the RPC address to listen to when starting the full node.

This is somehow different from rpc_address as it requires the "tcp://" scheme.

pub fn grpc_listen_address(&self) -> String

Returns the full URL for the GRPC address to listen to when starting the full node.

This is somehow different from grpc_address as it requires no scheme to be specified.

pub fn exec(&self, args: &[&str]) -> Result<ExecOutput, Error>

Execute the gaiad command with the given command line arguments, and returns the STDOUT result as String.

This is not the most efficient way of interacting with the CLI, but is sufficient for testing purposes of interacting with the gaiad commmand.

The function also output debug logs that show what command is being executed, so that users can manually re-run the commands by copying from the logs.

pub fn initialize(&self) -> Result<(), Error>

Initialized the chain data stores.

This is used by bootstrap_single_node.

pub fn update_genesis_file(
    &self,
    file: &str,
    cont: impl FnOnce(&mut Value) -> Result<(), Error>
) -> Result<(), Error>

Modify the Gaia genesis file.

pub fn write_file(&self, file_path: &str, content: &str) -> Result<(), Error>

Write the string content to a file path relative to the chain home directory.

This is not efficient but is sufficient for testing purposes.

pub fn read_file(&self, file_path: &str) -> Result<String, Error>

Read the content at a file path relative to the chain home directory, and return the result as a string.

This is not efficient but is sufficient for testing purposes.

pub fn add_wallet(&self, wallet_id: &str) -> Result<Wallet, Error>

Add a wallet with the given ID to the full node’s keyring.

pub fn add_genesis_account(
    &self,
    wallet: &WalletAddress,
    amounts: &[(&Denom, u64)]
) -> Result<(), Error>

Add a wallet address to the genesis account list for an uninitialized full node.

pub fn add_genesis_validator(
    &self,
    wallet_id: &WalletId,
    denom: &Denom,
    amount: u64
) -> Result<(), Error>

Add a wallet ID with the given stake amount to be the genesis validator for an uninitialized chain.

pub fn collect_gen_txs(&self) -> Result<(), Error>

Call gaiad collect-gentxs to generate the genesis transactions.

pub fn update_chain_config(
    &self,
    file: &str,
    cont: impl FnOnce(&mut Value) -> Result<(), Error>
) -> Result<(), Error>

Modify the Gaia chain config which is saved in toml format.

pub fn start(&self) -> Result<ChildProcess, Error>

Start a full node by running in the background gaiad start.

Returns a ChildProcess that stops the full node process when the value is dropped.

pub fn query_balance(
    &self,
    wallet_id: &WalletAddress,
    denom: &Denom
) -> Result<u64, Error>

Query for the balances for a given wallet address and denomination

pub fn send_tx(&self, wallet: &Wallet, messages: Vec<Any>) -> Result<(), Error>

pub fn assert_eventual_wallet_amount(
    &self,
    wallet: &WalletAddress,
    target_amount: u64,
    denom: &Denom
) -> Result<(), Error>

Assert that a wallet should eventually have the expected amount in the given denomination.

Trait Implementations

impl Clone for ChainDriver

fn clone(&self) -> ChainDriver

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChainDriver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ExportEnv for ChainDriver

fn export_env(&self, writer: &mut impl EnvWriter)

Export the environment variables using the given EnvWriter.