1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
use crate::{ContractError, ContractInstance};
use ethers_core::{
abi::{Abi, Token, Tokenize},
types::{
transaction::eip2718::TypedTransaction, Address, BlockNumber, Bytes, NameOrAddress,
TransactionReceipt, TransactionRequest, U256, U64,
},
};
use ethers_providers::{
call_raw::{CallBuilder, RawCall},
Middleware,
};
#[cfg(not(feature = "legacy"))]
use ethers_core::types::Eip1559TransactionRequest;
use std::{borrow::Borrow, marker::PhantomData, sync::Arc};
/// `ContractDeployer` is a [`ContractDeploymentTx`] object with an
/// [`Arc`] middleware. This type alias exists to preserve backwards
/// compatibility with less-abstract Contracts.
///
/// For full usage docs, see [`ContractDeploymentTx`].
pub type ContractDeployer<M, C> = ContractDeploymentTx<Arc<M>, M, C>;
/// `ContractFactory` is a [`DeploymentTxFactory`] object with an
/// [`Arc`] middleware. This type alias exists to preserve backwards
/// compatibility with less-abstract Contracts.
///
/// For full usage docs, see [`DeploymentTxFactory`].
pub type ContractFactory<M> = DeploymentTxFactory<Arc<M>, M>;
/// Helper which manages the deployment transaction of a smart contract. It
/// wraps a deployment transaction, and retrieves the contract address output
/// by it.
///
/// Currently, we recommend using the [`ContractDeployer`] type alias.
#[derive(Debug)]
#[must_use = "DeploymentTx does nothing unless you `send` it"]
pub struct ContractDeploymentTx<B, M, C> {
/// the actual deployer, exposed for overriding the defaults
pub deployer: Deployer<B, M>,
/// marker for the `Contract` type to create afterwards
///
/// this type will be used to construct it via `From::from(Contract)`
_contract: PhantomData<C>,
}
impl<B, M, C> Clone for ContractDeploymentTx<B, M, C>
where
B: Clone,
{
fn clone(&self) -> Self {
ContractDeploymentTx { deployer: self.deployer.clone(), _contract: self._contract }
}
}
impl<B, M, C> From<Deployer<B, M>> for ContractDeploymentTx<B, M, C> {
fn from(deployer: Deployer<B, M>) -> Self {
Self { deployer, _contract: PhantomData }
}
}
impl<B, M, C> ContractDeploymentTx<B, M, C>
where
B: Borrow<M> + Clone,
M: Middleware,
C: From<ContractInstance<B, M>>,
{
/// Create a new instance of this from a deployer.
pub fn new(deployer: Deployer<B, M>) -> Self {
Self { deployer, _contract: PhantomData }
}
/// Sets the number of confirmations to wait for the contract deployment transaction
pub fn confirmations<T: Into<usize>>(mut self, confirmations: T) -> Self {
self.deployer.confs = confirmations.into();
self
}
/// Sets the block at which RPC requests are made
pub fn block<T: Into<BlockNumber>>(mut self, block: T) -> Self {
self.deployer.block = block.into();
self
}
/// Uses a Legacy transaction instead of an EIP-1559 one to do the deployment
pub fn legacy(mut self) -> Self {
self.deployer = self.deployer.legacy();
self
}
/// Sets the `from` field in the deploy transaction to the provided value
pub fn from<T: Into<Address>>(mut self, from: T) -> Self {
self.deployer.tx.set_from(from.into());
self
}
/// Sets the `to` field in the deploy transaction to the provided value
pub fn to<T: Into<NameOrAddress>>(mut self, to: T) -> Self {
self.deployer.tx.set_to(to.into());
self
}
/// Sets the `gas` field in the deploy transaction to the provided value
pub fn gas<T: Into<U256>>(mut self, gas: T) -> Self {
self.deployer.tx.set_gas(gas.into());
self
}
/// Sets the `gas_price` field in the deploy transaction to the provided value
pub fn gas_price<T: Into<U256>>(mut self, gas_price: T) -> Self {
self.deployer.tx.set_gas_price(gas_price.into());
self
}
/// Sets the `value` field in the deploy transaction to the provided value
pub fn value<T: Into<U256>>(mut self, value: T) -> Self {
self.deployer.tx.set_value(value.into());
self
}
/// Sets the `data` field in the deploy transaction to the provided value
pub fn data<T: Into<Bytes>>(mut self, data: T) -> Self {
self.deployer.tx.set_data(data.into());
self
}
/// Sets the `nonce` field in the deploy transaction to the provided value
pub fn nonce<T: Into<U256>>(mut self, nonce: T) -> Self {
self.deployer.tx.set_nonce(nonce.into());
self
}
/// Sets the `chain_id` field in the deploy transaction to the provided value
pub fn chain_id<T: Into<U64>>(mut self, chain_id: T) -> Self {
self.deployer.tx.set_chain_id(chain_id.into());
self
}
/// Dry runs the deployment of the contract
///
/// Note: this function _does not_ send a transaction from your account
pub async fn call(&self) -> Result<(), ContractError<M>> {
self.deployer.call().await
}
/// Returns a CallBuilder, which when awaited executes the deployment of this contract via
/// `eth_call`. This call resolves to the returned data which would have been stored at the
/// destination address had the deploy transaction been executed via `send()`.
///
/// Note: this function _does not_ send a transaction from your account
pub fn call_raw(&self) -> CallBuilder<'_, M::Provider> {
self.deployer.call_raw()
}
/// Broadcasts the contract deployment transaction and after waiting for it to
/// be sufficiently confirmed (default: 1), it returns a new instance of the contract type at
/// the deployed contract's address.
pub async fn send(self) -> Result<C, ContractError<M>> {
let contract = self.deployer.send().await?;
Ok(C::from(contract))
}
/// Broadcasts the contract deployment transaction and after waiting for it to
/// be sufficiently confirmed (default: 1), it returns a new instance of the contract type at
/// the deployed contract's address and the corresponding
/// [`TransactionReceipt`].
pub async fn send_with_receipt(self) -> Result<(C, TransactionReceipt), ContractError<M>> {
let (contract, receipt) = self.deployer.send_with_receipt().await?;
Ok((C::from(contract), receipt))
}
/// Returns a reference to the deployer's ABI
pub fn abi(&self) -> &Abi {
self.deployer.abi()
}
/// Returns a pointer to the deployer's client
pub fn client(&self) -> &M {
self.deployer.client()
}
}
/// Helper which manages the deployment transaction of a smart contract
#[derive(Debug)]
#[must_use = "Deployer does nothing unless you `send` it"]
pub struct Deployer<B, M> {
/// The deployer's transaction, exposed for overriding the defaults
pub tx: TypedTransaction,
abi: Abi,
client: B,
confs: usize,
block: BlockNumber,
_m: PhantomData<M>,
}
impl<B, M> Clone for Deployer<B, M>
where
B: Clone,
{
fn clone(&self) -> Self {
Deployer {
tx: self.tx.clone(),
abi: self.abi.clone(),
client: self.client.clone(),
confs: self.confs,
block: self.block,
_m: PhantomData,
}
}
}
impl<B, M> Deployer<B, M>
where
B: Borrow<M> + Clone,
M: Middleware,
{
/// Sets the number of confirmations to wait for the contract deployment transaction
pub fn confirmations<T: Into<usize>>(mut self, confirmations: T) -> Self {
self.confs = confirmations.into();
self
}
/// Set the block at which requests are made
pub fn block<T: Into<BlockNumber>>(mut self, block: T) -> Self {
self.block = block.into();
self
}
/// Uses a Legacy transaction instead of an EIP-1559 one to do the deployment
pub fn legacy(mut self) -> Self {
self.tx = match self.tx {
TypedTransaction::Eip1559(inner) => {
let tx: TransactionRequest = inner.into();
TypedTransaction::Legacy(tx)
}
other => other,
};
self
}
/// Dry runs the deployment of the contract
///
/// Note: this function _does not_ send a transaction from your account
pub async fn call(&self) -> Result<(), ContractError<M>> {
self.client
.borrow()
.call(&self.tx, Some(self.block.into()))
.await
.map_err(ContractError::from_middleware_error)?;
// TODO: It would be nice to handle reverts in a structured way.
Ok(())
}
/// Returns a CallBuilder, which when awaited executes the deployment of this contract via
/// `eth_call`. This call resolves to the returned data which would have been stored at the
/// destination address had the deploy transaction been executed via `send()`.
///
/// Note: this function _does not_ send a transaction from your account
pub fn call_raw(&self) -> CallBuilder<'_, M::Provider> {
self.client.borrow().provider().call_raw(&self.tx).block(self.block.into())
}
/// Broadcasts the contract deployment transaction and after waiting for it to
/// be sufficiently confirmed (default: 1), it returns a [`Contract`](crate::Contract)
/// struct at the deployed contract's address.
pub async fn send(self) -> Result<ContractInstance<B, M>, ContractError<M>> {
let (contract, _) = self.send_with_receipt().await?;
Ok(contract)
}
/// Broadcasts the contract deployment transaction and after waiting for it to
/// be sufficiently confirmed (default: 1), it returns a tuple with
/// the [`Contract`](crate::Contract) struct at the deployed contract's address
/// and the corresponding [`TransactionReceipt`].
pub async fn send_with_receipt(
self,
) -> Result<(ContractInstance<B, M>, TransactionReceipt), ContractError<M>> {
let pending_tx = self
.client
.borrow()
.send_transaction(self.tx, Some(self.block.into()))
.await
.map_err(ContractError::from_middleware_error)?;
// TODO: Should this be calculated "optimistically" by address/nonce?
let receipt = pending_tx
.confirmations(self.confs)
.await
.ok()
.flatten()
.ok_or(ContractError::ContractNotDeployed)?;
let address = receipt.contract_address.ok_or(ContractError::ContractNotDeployed)?;
let contract = ContractInstance::new(address, self.abi, self.client);
Ok((contract, receipt))
}
/// Returns a reference to the deployer's ABI
pub fn abi(&self) -> &Abi {
&self.abi
}
/// Returns a pointer to the deployer's client
pub fn client(&self) -> &M {
self.client.borrow()
}
}
/// To deploy a contract to the Ethereum network, a `ContractFactory` can be
/// created which manages the Contract bytecode and Application Binary Interface
/// (ABI), usually generated from the Solidity compiler.
///
/// Once the factory's deployment transaction is mined with sufficient confirmations,
/// the [`Contract`](crate::Contract) object is returned.
///
/// # Example
///
/// ```no_run
/// use ethers_contract::ContractFactory;
/// use ethers_core::types::Bytes;
/// use ethers_providers::{Provider, Http};
///
/// # async fn foo() -> Result<(), Box<dyn std::error::Error>> {
/// // get the contract ABI and bytecode
/// let abi = Default::default();
/// let bytecode = Bytes::from_static(b"...");
///
/// // connect to the network
/// let client = Provider::<Http>::try_from("http://localhost:8545").unwrap();
/// let client = std::sync::Arc::new(client);
///
/// // create a factory which will be used to deploy instances of the contract
/// let factory = ContractFactory::new(abi, bytecode, client);
///
/// // The deployer created by the `deploy` call exposes a builder which gets consumed
/// // by the async `send` call
/// let contract = factory
/// .deploy("initial value".to_string())?
/// .confirmations(0usize)
/// .send()
/// .await?;
/// println!("{}", contract.address());
/// # Ok(())
/// # }
#[derive(Debug)]
pub struct DeploymentTxFactory<B, M> {
client: B,
abi: Abi,
bytecode: Bytes,
_m: PhantomData<M>,
}
impl<B, M> Clone for DeploymentTxFactory<B, M>
where
B: Clone,
{
fn clone(&self) -> Self {
DeploymentTxFactory {
client: self.client.clone(),
abi: self.abi.clone(),
bytecode: self.bytecode.clone(),
_m: PhantomData,
}
}
}
impl<B, M> DeploymentTxFactory<B, M>
where
B: Borrow<M> + Clone,
M: Middleware,
{
/// Creates a factory for deployment of the Contract with bytecode, and the
/// constructor defined in the abi. The client will be used to send any deployment
/// transaction.
pub fn new(abi: Abi, bytecode: Bytes, client: B) -> Self {
Self { client, abi, bytecode, _m: PhantomData }
}
/// Create a deployment tx using the provided tokens as constructor
/// arguments
pub fn deploy_tokens(self, params: Vec<Token>) -> Result<Deployer<B, M>, ContractError<M>>
where
B: Clone,
{
// Encode the constructor args & concatenate with the bytecode if necessary
let data: Bytes = match (self.abi.constructor(), params.is_empty()) {
(None, false) => return Err(ContractError::ConstructorError),
(None, true) => self.bytecode.clone(),
(Some(constructor), _) => {
constructor.encode_input(self.bytecode.to_vec(), ¶ms)?.into()
}
};
// create the tx object. Since we're deploying a contract, `to` is `None`
// We default to EIP-1559 transactions, but the sender can convert it back
// to a legacy one
#[cfg(feature = "legacy")]
let tx = TransactionRequest { to: None, data: Some(data), ..Default::default() };
#[cfg(not(feature = "legacy"))]
let tx = Eip1559TransactionRequest { to: None, data: Some(data), ..Default::default() };
let tx = tx.into();
Ok(Deployer {
client: self.client.clone(),
abi: self.abi,
tx,
confs: 1,
block: BlockNumber::Latest,
_m: PhantomData,
})
}
/// Constructs the deployment transaction based on the provided constructor
/// arguments and returns a `Deployer` instance. You must call `send()` in order
/// to actually deploy the contract.
///
/// Notes:
/// 1. If there are no constructor arguments, you should pass `()` as the argument.
/// 1. The default poll duration is 7 seconds.
/// 1. The default number of confirmations is 1 block.
pub fn deploy<T: Tokenize>(
self,
constructor_args: T,
) -> Result<Deployer<B, M>, ContractError<M>> {
self.deploy_tokens(constructor_args.into_tokens())
}
}