Skip to main content

ContractArtifact

Struct ContractArtifact 

Source
pub struct ContractArtifact {
    pub name: String,
    pub functions: Vec<FunctionArtifact>,
    pub outputs: Option<Value>,
    pub file_map: Option<Value>,
    pub context_inputs_sizes: Option<HashMap<String, usize>>,
}
Expand description

A deserialized contract artifact containing function metadata.

Fields§

§name: String

Contract name.

§functions: Vec<FunctionArtifact>

Functions defined in the contract.

§outputs: Option<Value>

Compiler output metadata (opaque JSON).

§file_map: Option<Value>

Source file map (opaque JSON).

§context_inputs_sizes: Option<HashMap<String, usize>>

Size of the PrivateContextInputs parameter for each private function. Computed during nargo parsing and persisted with the artifact so PXE can reconstruct private-function witnesses after store roundtrips.

Implementations§

Source§

impl ContractArtifact

Source

pub fn from_json(json: &str) -> Result<Self, Error>

Deserialize a contract artifact from a JSON string.

Source

pub fn find_function(&self, name: &str) -> Result<&FunctionArtifact, Error>

Find a function by name, returning an error if not found.

Source

pub fn find_function_by_type( &self, name: &str, function_type: &FunctionType, ) -> Result<&FunctionArtifact, Error>

Find a function by name and type, returning an error if not found.

Source

pub fn to_buffer(&self) -> Result<Vec<u8>, Error>

Serialize this artifact to a JSON byte buffer.

Source

pub fn from_buffer(buffer: &[u8]) -> Result<Self, Error>

Deserialize an artifact from a JSON byte buffer.

Source

pub fn to_json(&self) -> Result<String, Error>

Serialize to a pretty-printed JSON string.

Source

pub fn from_nargo_json(json: &str) -> Result<Self, Error>

Parse a contract artifact from raw nargo compiler output.

The nargo compiler output has a different structure than the Aztec-processed format. This method handles the conversion:

  • Strips __aztec_nr_internals__ prefix from function names
  • Maps custom_attributes to function_type (Private/Public/Utility)
  • Extracts parameters from abi.parameters
  • Computes function selectors from name + parameters
  • Filters out the inputs parameter (PrivateContextInputs) from private functions
Source

pub fn find_function_by_selector( &self, selector: &FunctionSelector, ) -> Option<&FunctionArtifact>

Find a function by selector.

Source

pub fn private_context_inputs_size(&self, function_name: &str) -> usize

Count the number of field elements the PrivateContextInputs parameter occupies for a given function. Returns 0 if the function has no such parameter (public/utility functions).

This is needed because compiled Noir bytecode expects the full PrivateContextInputs flattened into the initial witness before user args.

Source

pub fn count_abi_type_fields(typ: &AbiType) -> usize

Count the number of scalar fields an ABI type flattens to.

Trait Implementations§

Source§

impl Clone for ContractArtifact

Source§

fn clone(&self) -> ContractArtifact

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContractArtifact

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ContractArtifact

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ContractArtifact

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ContractArtifact

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ContractArtifact

Source§

impl StructuralPartialEq for ContractArtifact

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,