Struct cubist_config::Config

pub struct Config {
    pub config_path: PathBuf,
    pub type_: ProjType,
    pub network_profiles: HashMap<NetworkProfileName, NetworkProfile>,
    pub current_network_profile: NetworkProfileName,
    pub bridge_provider: BridgeProvider,
    /* private fields */
}

Top-level cubist application configuration.

Configs are consumed by all SDKs.

Fields

config_path: PathBuf

Absolute path to the file corresponding to this configuration.

type_: ProjType

Project type

network_profiles: HashMap<NetworkProfileName, NetworkProfile>

A map of named network profiles for use in development, testing, etc.

current_network_profile: NetworkProfileName

Selected network profile. If omitted, defaults to “default”. A network profile with the same name must be defined in network_profiles.

bridge_provider: BridgeProvider

The bridge provider to use for cross-chain invocations.

Implementations

impl Config

pub fn new(type_: ProjType, dir: impl AsRef<Path>) -> Result<Self>

Create configuration given type and directory.

Arguments

• type_ - Project type
• dir - Project directory

Example

use cubist_config::{Config, ProjType};
use tempfile::tempdir;
use std::fs;

// Create temp dir
let dir = tempdir().unwrap();
fs::create_dir_all(&dir).unwrap();

// Create config (in temp dir)
let cfg: Config = Config::new(ProjType::JavaScript, &dir).unwrap();

assert_eq!(cfg.type_, ProjType::JavaScript);
assert_eq!(cfg.build_dir(), dir.path().join("build"));
assert_eq!(cfg.deploy_dir(), dir.path().join("deploy"));

// Save config file to disk
cfg.to_file(false).unwrap();

// Load config from disk
let cfg2 = Config::from_file(&cfg.config_path).unwrap();

pub fn paths(&self) -> Paths

Get well-known paths

pub fn nearest() -> Result<Self>

Create configuration from config file in the current directory or some parent directory.

Example

use cubist_config::{Config, ProjType};
use tempfile::tempdir;
use std::fs;
use std::env;

// Create temp directory and chdir
let dir = tempdir().unwrap();
fs::create_dir_all(&dir).unwrap();
assert!(env::set_current_dir(&dir).is_ok());

// Create config
let cfg: Config = Config::new(ProjType::JavaScript, ".").unwrap();
cfg.to_file(false).unwrap();

// Load config from disk
let cfg2 = Config::nearest().unwrap();

pub fn from_dir(dir: impl AsRef<Path>) -> Result<Self>

Create configuration from directory (really from DEFAULT_FILENAME file in the directory).

pub fn from_file(config_path: impl AsRef<Path>) -> Result<Self>

Create configuration from JSON file. Some paths can be overridden via environment variables:

• Set deploy_dir via CUBIST_DEPLOY_DIR
• Set build_dir via CUBIST_BUILD_DIR

This function serves as the deserializer to all the other loaders (namely Self::nearest and Self::from_dir).

pub fn to_file(&self, force: bool) -> Result<()>

Save configuration to new file.

Writing to an existing file is generally discouraged (but can be done with by passing true fo the force argument). When we read configs from file, we resolve some paths (e.g., we turn contract globs into paths) and don’t preserve the original. We also make the build, deploy, and contracts root dir relative to the project root. We do this largely because we use to_file when we create new projects. This does mean: to_file(from_file(_)) is not the identiy function!

pub fn project_dir(&self) -> PathBuf

Get the top-level project directory

pub fn deploy_dir(&self) -> PathBuf

Get the absolute deploy directory

pub fn build_dir(&self) -> PathBuf

Get the absolute build directory

pub fn relative_to_project_dir(&self, path: impl AsRef<Path>) -> Result<PathBuf>

Return relative path to the project root if the path is inside the project root.

pub fn contracts(&self) -> &ContractsConfig

Get contracts configurations.

pub fn targets(&self) -> impl Iterator<Item = Target> + '_

Return all targets.

pub fn network_for_target(&self, target: Target) -> Option<EndpointConfig>

Return configured network (if any) for a given target.

pub fn network_profile(&self) -> &NetworkProfile

Return the currently selected network profile.

pub fn allow_import_from_external(&self) -> bool

Returns true if imports from external sources are allowed.

pub fn get_compiler_config(&self) -> CompilerConfig

Returns the compiler configuration for this Cubist configuration.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

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 JsonSchema for Config

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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.