Struct Vyper

pub struct Vyper {
    pub path: PathBuf,
    pub version: Version,
}

Vyper compiler. Wrapper aound vyper binary.

Fields

path: PathBuf

version: Version

Implementations

impl Vyper

pub fn new(path: impl Into<PathBuf>) -> Result<Self>

Creates a new instance of the Vyper compiler. Uses the vyper binary in the system PATH.

pub fn compile_source(&self, path: &Path) -> Result<VyperOutput>

Convenience function for compiling all sources under the given path

pub fn compile_exact(&self, input: &VyperInput) -> Result<VyperOutput>

Same as Self::compile(), but only returns those files which are included in the CompilerInput.

In other words, this removes those files from the VyperOutput that are not included in the provided CompilerInput.

Examples

pub fn compile<T: Serialize>(&self, input: &T) -> Result<VyperOutput>

Compiles with --standard-json and deserializes the output as VyperOutput.

Examples

use foundry_compilers::{
    artifacts::{
        vyper::{VyperInput, VyperSettings},
        Source,
    },
    Vyper,
};
use std::path::Path;

let vyper = Vyper::new("vyper")?;
let path = Path::new("path/to/sources");
let sources = Source::read_all_from(path, &["vy", "vyi"])?;
let input = VyperInput::new(sources, VyperSettings::default(), &vyper.version);
let output = vyper.compile(&input)?;

pub fn compile_as<T: Serialize, D: DeserializeOwned>( &self, input: &T, ) -> Result<D>

Compiles with --standard-json and deserializes the output as the given D.

pub fn compile_output<T: Serialize>(&self, input: &T) -> Result<Vec<u8>>

Compiles with --standard-json and returns the raw stdout output.

pub fn version(vyper: impl Into<PathBuf>) -> Result<Version>

Invokes vyper --version and parses the output as a SemVer Version.

Trait Implementations

impl Clone for Vyper

fn clone(&self) -> Vyper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Compiler for Vyper

type Settings = VyperSettings

Compiler settings.

type CompilationError = VyperCompilationError

Error type returned by the compiler.

type Parser = VyperParser

Source parser used for resolving imports and version requirements.

type Input = VyperVersionedInput

Input type for the compiler. Contains settings and sources to be compiled.

type Language = VyperLanguage

Enum of languages supported by the compiler.

type CompilerContract = Contract

Output data for each contract

fn compile( &self, input: &Self::Input, ) -> Result<CompilerOutput<VyperCompilationError, Contract>>

Main entrypoint for the compiler. Compiles given input into CompilerOutput. Takes ownership over the input and returns back version with potential modifications made to it. Returned input is always the one which was seen by the binary.

fn available_versions(&self, _language: &Self::Language) -> Vec<CompilerVersion>

Returns all versions available locally and remotely. Should return versions with stripped metadata.

impl Debug for Vyper

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

Formats the value using the given formatter.