Skip to main content

DeployerArgs

espresso_contract_deployer::builder

Struct DeployerArgs 

Source 
pub struct DeployerArgs<P: Provider + WalletProvider> {
Show 42 fields
    deployer: P,
    rpc_url: Url,
    token_recipient: Option<Address>,
    mock_light_client: bool,
    use_multisig: bool,
    genesis_lc_state: Option<LightClientStateSol>,
    genesis_st_state: Option<StakeTableStateSol>,
    permissioned_prover: Option<Address>,
    blocks_per_epoch: Option<u64>,
    epoch_start_block: Option<u64>,
    exit_escrow_period: Option<U256>,
    multisig: Option<Address>,
    multisig_pauser: Option<Address>,
    initial_token_supply: Option<U256>,
    token_name: Option<String>,
    token_symbol: Option<String>,
    ops_timelock_admin: Option<Address>,
    ops_timelock_delay: Option<U256>,
    ops_timelock_executors: Option<Vec<Address>>,
    ops_timelock_proposers: Option<Vec<Address>>,
    safe_exit_timelock_admin: Option<Address>,
    safe_exit_timelock_delay: Option<U256>,
    safe_exit_timelock_executors: Option<Vec<Address>>,
    safe_exit_timelock_proposers: Option<Vec<Address>>,
    timelock_operation_type: Option<TimelockOperationType>,
    target_contract: Option<OwnableContract>,
    timelock_operation_value: Option<U256>,
    timelock_operation_delay: Option<U256>,
    timelock_operation_function_signature: Option<String>,
    timelock_operation_function_values: Option<Vec<String>>,
    timelock_operation_salt: Option<String>,
    use_timelock_owner: Option<bool>,
    transfer_ownership_from_eoa: Option<bool>,
    transfer_ownership_new_owner: Option<Address>,
    timelock_operation_id: Option<String>,
    multisig_transaction_target: Option<Address>,
    multisig_transaction_function_signature: Option<String>,
    multisig_transaction_function_args: Option<Vec<String>>,
    multisig_transaction_value: Option<String>,
    output_path: Option<PathBuf>,
    output_dir: Option<PathBuf>,
    chain_id: u64,

}
Expand description

Convenient handler that builds all the input arguments ready to be deployed.

  • deployer: deployer’s wallet provider
  • rpc_url: RPC URL for the L1 network
  • token_recipient: initial token holder, same as deployer if None.
  • mock_light_client: flag to indicate whether deploying mocked contract
  • use_multisig: flag to indicate whether to use multisig for upgrades
  • genesis_lc_state: Genesis light client state
  • genesis_st_state: Genesis stake table state
  • permissioned_prover: permissioned light client prover address
  • blocks_per_epoch: epoch length in block height
  • epoch_start_block: block height for the first activated epoch
  • exit_escrow_period: exit escrow period for stake table (in seconds)
  • multisig: new owner/multisig that owns all the proxy contracts
  • multisig_pauser: multisig address that has the pauser role
  • initial_token_supply: initial token supply for the token contract
  • token_name: name of the token
  • token_symbol: symbol of the token
  • ops_timelock_admin: admin address for the ops timelock
  • ops_timelock_delay: delay for the ops timelock
  • ops_timelock_executors: executors for the ops timelock
  • ops_timelock_proposers: proposers for the ops timelock
  • safe_exit_timelock_admin: admin address for the safe exit timelock
  • safe_exit_timelock_delay: delay for the safe exit timelock
  • safe_exit_timelock_executors: executors for the safe exit timelock
  • safe_exit_timelock_proposers: proposers for the safe exit timelock
  • timelock_operation_type: type of the timelock operation
  • target_contract: target contract for the contract operations
  • timelock_operation_value: value for the timelock operation
  • timelock_operation_delay: delay for the timelock operation
  • timelock_operation_function_signature: function signature for the timelock operation
  • timelock_operation_function_values: function values for the timelock operation
  • timelock_operation_salt: salt for the timelock operation
  • use_timelock_owner: flag to indicate whether to transfer ownership to the timelock owner
  • timelock_address: address of the timelock contract

Fields§

§deployer: P§rpc_url: Url§token_recipient: Option<Address>§mock_light_client: bool§use_multisig: bool§genesis_lc_state: Option<LightClientStateSol>§genesis_st_state: Option<StakeTableStateSol>§permissioned_prover: Option<Address>§blocks_per_epoch: Option<u64>§epoch_start_block: Option<u64>§exit_escrow_period: Option<U256>§multisig: Option<Address>§multisig_pauser: Option<Address>§initial_token_supply: Option<U256>§token_name: Option<String>§token_symbol: Option<String>§ops_timelock_admin: Option<Address>§ops_timelock_delay: Option<U256>§ops_timelock_executors: Option<Vec<Address>>§ops_timelock_proposers: Option<Vec<Address>>§safe_exit_timelock_admin: Option<Address>§safe_exit_timelock_delay: Option<U256>§safe_exit_timelock_executors: Option<Vec<Address>>§safe_exit_timelock_proposers: Option<Vec<Address>>§timelock_operation_type: Option<TimelockOperationType>§target_contract: Option<OwnableContract>§timelock_operation_value: Option<U256>§timelock_operation_delay: Option<U256>§timelock_operation_function_signature: Option<String>§timelock_operation_function_values: Option<Vec<String>>§timelock_operation_salt: Option<String>§use_timelock_owner: Option<bool>§transfer_ownership_from_eoa: Option<bool>§transfer_ownership_new_owner: Option<Address>§timelock_operation_id: Option<String>§multisig_transaction_target: Option<Address>§multisig_transaction_function_signature: Option<String>§multisig_transaction_function_args: Option<Vec<String>>§multisig_transaction_value: Option<String>§output_path: Option<PathBuf>§output_dir: Option<PathBuf>§chain_id: u64

Implementations§

Source§

impl<P: Provider + WalletProvider> DeployerArgs<P>

Source

pub async fn deploy( &self, contracts: &mut Contracts, target: Contract, ) -> Result<()>

deploy target contracts

Source

pub async fn deploy_to_stake_table_v1( &self, contracts: &mut Contracts, ) -> Result<()>

Deploy all contracts up to and including stake table v1

Source

pub async fn deploy_to_stake_table_v2( &self, contracts: &mut Contracts, ) -> Result<()>

Deploy all contracts up to and including stake table V2.

Source

pub async fn deploy_to_stake_table_v3( &self, contracts: &mut Contracts, ) -> Result<()>

Deploy all contracts up to and including stake table V3.

Source

pub async fn propose_timelock_operation_for_contract( &self, contracts: &mut Contracts, ) -> Result<()>

This function can perform timelock operations via two paths:

  • Multisig path: If multisig field from DeployerArgs is set, the operation will be proposed via Safe multisig
  • EOA path: If multisig field from DeployerArgs is not set, the operation will be executed directly via EOA (useful for tests/local development)

Parameters:

  • contracts: ref to deployed contracts
Source

pub async fn encode_transfer_ownership_to_timelock( &self, contracts: &mut Contracts, ) -> Result<()>

Encode ownership transfer from multisig to timelock as calldata

Source

pub async fn transfer_ownership_from_eoa( &self, contracts: &mut Contracts, ) -> Result<()>

Transfer ownership from EOA to new owner

Source

pub async fn encode_multisig_transaction(&self) -> Result<()>

Encode a multisig transaction as calldata and output it

Trait Implementations§

Source§

impl<P: Clone + Provider + WalletProvider> Clone for DeployerArgs<P>

Source§

fn clone(&self) -> DeployerArgs<P>

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

Auto Trait Implementations§

§

impl<P> Freeze for DeployerArgs<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for DeployerArgs<P>
where P: RefUnwindSafe,

§

impl<P> Send for DeployerArgs<P>

§

impl<P> Sync for DeployerArgs<P>

§

impl<P> Unpin for DeployerArgs<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for DeployerArgs<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for DeployerArgs<P>
where P: UnwindSafe,

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

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

§

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
§

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
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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
§

impl<T> JsonSchemaMaybe for T