Struct Vyper

pub struct Vyper<'a> {
    pub path_to_code: &'a Path,
    pub bytecode: Option<String>,
    pub abi: PathBuf,
    pub venv: Option<&'a Path>,
}

Represents important information about a Vyper contract. ABI doesn’t need to point to an existing file since it can just be generated using gen_abi(). If the ABI already exists at the given path, you can use serde_json to retrieve it from a file.

Fields

path_to_code: &'a Path

bytecode: Option<String>

abi: PathBuf

venv: Option<&'a Path>

Implementations

impl<'a> Vyper<'a>

pub fn new(path: &'a Path) -> Self

Constructor function that takes in the path to your vyper contract

pub fn with_abi(root: &'a Path, abi_path: PathBuf) -> Self

pub fn with_venv(path: &'a Path, venv: &'a Path) -> Vyper<'a>

pub fn with_venv_and_abi( path: &'a Path, venv: &'a Path, abi: PathBuf, ) -> Vyper<'a>

pub fn abi_mut(&mut self) -> &mut PathBuf

pub fn abi_exists(&self) -> bool

pub fn contract_exists(&self) -> bool

pub fn get_vyper(&self) -> String

pub fn get_pip(&self) -> String

pub fn exists(&self) -> bool

pub fn get_version(&self) -> Result<String, VyperErrors>

check the version of the vyper compiler

pub fn compile(&mut self) -> Result<(), VyperErrors>

Compiles a vyper contract by invoking the vyper compiler, updates the ABI field in the Vyper struct

pub fn compile_blueprint(&mut self) -> Result<(), VyperErrors>

pub fn compile_ver(&mut self, ver: &Evm) -> Result<(), VyperErrors>

Compiles a vyper contract by invoking the vyper compiler, arg for specifying the EVM version to compile to

pub fn gen_abi(&self) -> Result<(), VyperErrors>

Generates the ABI and creates a file @ the abi path specified in the Vyper struct

pub fn get_abi(&self) -> Result<Value, VyperErrors>

Generates the ABI and creates a file @ the abi path specified in the Vyper struct

pub fn storage_layout(&self) -> Result<(), VyperErrors>

Storage layout as JSON, saves it to a file

pub fn ast(&self) -> Result<(), VyperErrors>

AST of your contract as JSON, saves it to a file

pub fn interface(&self) -> Result<(), VyperErrors>

Generates an external interface for your vyper contract to be called with

pub fn opcodes(&self) -> Result<(), VyperErrors>

Generates the opcodes produced by your vyper contract, saves it as a text file

pub fn opcodes_runtime(&self) -> Result<(), VyperErrors>

Generates the opcodes produced by your vyper contract at runtime, saves it as a text file

pub fn userdoc(&self) -> Result<(), VyperErrors>

Natspec user documentation for vyper contract

pub fn devdoc(&self) -> Result<(), VyperErrors>

Natspec dev documentation for vyper contract

Trait Implementations

impl<'a> Debug for Vyper<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Vyper<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Vyper<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Vyper<'a>

fn cmp(&self, other: &Vyper<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Vyper<'a>

fn eq(&self, other: &Vyper<'a>) -> 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<'a> PartialOrd for Vyper<'a>

fn partial_cmp(&self, other: &Vyper<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for Vyper<'a>

impl<'a> StructuralPartialEq for Vyper<'a>