Struct Config

pub struct Config {
    pub json_rpc_url: String,
    pub websocket_url: String,
    pub keypair_path: String,
    pub address_labels: HashMap<String, String>,
    pub commitment: String,
}

The Solana CLI configuration.

Fields

json_rpc_url: String

The RPC address of a Solana validator node.

Typical values for mainnet, devnet, and testnet are described in the Solana documentation.

For local testing, the typical value is http://localhost:8899.

websocket_url: String

The address to connect to for receiving event notifications.

If it is an empty string then the correct value will be derived from json_rpc_url.

The default value is the empty string.

keypair_path: String

The default signing source, which may be a keypair file, but may also represent several other types of signers, as described in the documentation for solana_clap_utils::keypair::signer_from_path. Because it represents sources other than a simple path, the name keypair_path is misleading, and exists for backwards compatibility reasons.

The signing source can be loaded with either the signer_from_path function, or with solana_clap_utils::keypair::DefaultSigner.

address_labels: HashMap<String, String>

A mapping from Solana addresses to human-readable names.

By default the only value in this map is the system program.

commitment: String

The default commitment level.

By default the value is “confirmed”, as defined by solana_sdk::commitment_config::CommitmentLevel::Confirmed.

Implementations

impl Config

pub fn load(config_file: &str) -> Result<Self, Error>

Load a configuration from file.

Errors

This function may return typical file I/O errors.

pub fn save(&self, config_file: &str) -> Result<(), Error>

Save a configuration to file.

If the file’s directory does not exist, it will be created. If the file already exists, it will be overwritten.

Errors

This function may return typical file I/O errors.

pub fn compute_websocket_url(json_rpc_url: &str) -> String

Compute the websocket URL from the RPC URL.

The address is created from the RPC URL by:

• adding 1 to the port number,
• using the “wss” scheme if the RPC URL has an “https” scheme, or the “ws” scheme if the RPC URL has an “http” scheme.

If json_rpc_url cannot be parsed as a URL then this function returns the empty string.

pub fn import_address_labels<P>(&mut self, filename: P) -> Result<(), Error>

where P: AsRef<Path>,

Load a map of address/name pairs from a YAML file at the given path and insert them into the configuration.

pub fn export_address_labels<P>(&self, filename: P) -> Result<(), Error>

where P: AsRef<Path>,

Save the map of address/name pairs contained in the configuration to a YAML file at the given path.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config