Struct cubist_config::pre_compile_manifest::PreCompileManifest

pub struct PreCompileManifest {
    pub files: Vec<FileArtifact>,
}

Manifest generated by cubist pre-compile. Contains info about the original as well as generated (shim/interface) contracts. These files are, by default, stored within the contracts directory of each target build (see Path below).

Path: {build_dir}/{target}/contracts/cubist-manifest.json

Example JSON file produced by cubist pre-compile:

  {
     "files": [
         {
             "is_shim": false,
             "rel_path": "poly.sol",
             "contract_dependencies": {
                "PolyCounter": [ "EthCounter" ]
             }
         },
         {
            "is_shim": true,
            "rel_path": "EthCounter.sol",
            "contract_dependencies": {
               "EthCounter": []
            }
         }
     ]
  }

This manifest tells other cubist commands where to find contract files (poly.sol) for the target chain and which source files have generated shim contracts (EthCounter.sol).

Manifests are consumed by all SDKs.

Fields

files: Vec<FileArtifact>

Produced files.

Implementations

impl PreCompileManifest

pub fn from_file(file: &Path) -> Result<Self>

Create manifest from JSON file.

pub fn is_dependency(&self, cc: &ContractFQN, dep: &ContractFQN) -> bool

Whether contract cc is allowed to call contract dep (i.e., whether dep is a dependency of cc)

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

Return relative paths to all (non-shim) contract files.

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

Return relative paths to all shim contract files.

pub fn to_file(&self, destination: &Path) -> Result<()>

Save manifest to JSON file.

Trait Implementations

impl Debug for PreCompileManifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PreCompileManifest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PreCompileManifest

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 PreCompileManifest

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

Serialize this value into the given Serde serializer.