1use crate::{CallDecoder, Error, EthCall, Result};
2use alloy_consensus::SignableTransaction;
3use alloy_dyn_abi::{DynSolValue, JsonAbiExt};
4use alloy_json_abi::Function;
5use alloy_network::{
6 eip2718::Encodable2718, Ethereum, IntoWallet, Network, TransactionBuilder,
7 TransactionBuilder4844, TransactionBuilderError, TxSigner,
8};
9use alloy_network_primitives::ReceiptResponse;
10use alloy_primitives::{Address, Bytes, ChainId, PrimitiveSignature as Signature, TxKind, U256};
11use alloy_provider::{PendingTransactionBuilder, Provider};
12use alloy_rpc_types_eth::{state::StateOverride, AccessList, BlobTransactionSidecar, BlockId};
13use alloy_sol_types::SolCall;
14use std::{self, marker::PhantomData};
15
16pub type SolCallBuilder<T, P, C, N = Ethereum> = CallBuilder<T, P, PhantomData<C>, N>;
22
23pub type DynCallBuilder<T, P, N = Ethereum> = CallBuilder<T, P, Function, N>;
25
26pub type RawCallBuilder<T, P, N = Ethereum> = CallBuilder<T, P, (), N>;
28
29#[derive(Clone)]
125#[must_use = "call builders do nothing unless you `.call`, `.send`, or `.await` them"]
126pub struct CallBuilder<T, P, D, N: Network = Ethereum> {
127 pub(crate) request: N::TransactionRequest,
128 block: BlockId,
129 state: Option<StateOverride>,
130 pub provider: P,
133 decoder: D,
134 fake_transport: PhantomData<T>,
135}
136
137impl<T, P, D, N: Network> CallBuilder<T, P, D, N> {
138 pub fn into_transaction_request(self) -> N::TransactionRequest {
140 self.request
141 }
142
143 pub fn build_unsigned_raw_transaction(self) -> Result<Vec<u8>, TransactionBuilderError<N>>
176 where
177 N::UnsignedTx: SignableTransaction<Signature>,
178 {
179 let tx = self.request.build_unsigned().map_err(|e| e.error)?;
180 Ok(tx.encoded_for_signing())
181 }
182
183 pub async fn build_raw_transaction<S>(
219 self,
220 signer: S,
221 ) -> Result<Vec<u8>, TransactionBuilderError<N>>
222 where
223 S: TxSigner<Signature> + IntoWallet<N>,
224 {
225 let tx = self.request.build(&signer.into_wallet()).await?;
226 Ok(tx.encoded_2718())
227 }
228}
229
230impl<T, P, D, N: Network> AsRef<N::TransactionRequest> for CallBuilder<T, P, D, N> {
231 fn as_ref(&self) -> &N::TransactionRequest {
232 &self.request
233 }
234}
235
236impl<T, P: Provider<N>, N: Network> DynCallBuilder<T, P, N> {
238 pub(crate) fn new_dyn(
239 provider: P,
240 address: &Address,
241 function: &Function,
242 args: &[DynSolValue],
243 ) -> Result<Self> {
244 Ok(Self::new_inner_call(
245 provider,
246 function.abi_encode_input(args)?.into(),
247 function.clone(),
248 )
249 .to(*address))
250 }
251
252 #[inline]
254 pub fn clear_decoder(self) -> RawCallBuilder<T, P, N> {
255 RawCallBuilder {
256 request: self.request,
257 block: self.block,
258 state: self.state,
259 provider: self.provider,
260 decoder: (),
261 fake_transport: PhantomData,
262 }
263 }
264}
265
266#[doc(hidden)]
267impl<'a, T, P: Provider<N>, C: SolCall, N: Network> SolCallBuilder<T, &'a P, C, N> {
268 pub fn new_sol(provider: &'a P, address: &Address, call: &C) -> Self {
271 Self::new_inner_call(provider, call.abi_encode().into(), PhantomData::<C>).to(*address)
272 }
273}
274
275impl<T, P: Provider<N>, C: SolCall, N: Network> SolCallBuilder<T, P, C, N> {
276 #[inline]
278 pub fn clear_decoder(self) -> RawCallBuilder<T, P, N> {
279 RawCallBuilder {
280 request: self.request,
281 block: self.block,
282 state: self.state,
283 provider: self.provider,
284 decoder: (),
285 fake_transport: PhantomData,
286 }
287 }
288}
289
290impl<T, P: Provider<N>, N: Network> RawCallBuilder<T, P, N> {
291 #[inline]
343 pub fn with_sol_decoder<C: SolCall>(self) -> SolCallBuilder<T, P, C, N> {
344 SolCallBuilder {
345 request: self.request,
346 block: self.block,
347 state: self.state,
348 provider: self.provider,
349 decoder: PhantomData::<C>,
350 fake_transport: PhantomData,
351 }
352 }
353}
354
355impl<T, P: Provider<N>, N: Network> RawCallBuilder<T, P, N> {
356 #[inline]
361 pub fn new_raw(provider: P, input: Bytes) -> Self {
362 Self::new_inner_call(provider, input, ())
363 }
364
365 pub fn new_raw_deploy(provider: P, input: Bytes) -> Self {
371 Self::new_inner_deploy(provider, input, ())
372 }
373}
374
375impl<T, P: Provider<N>, D: CallDecoder, N: Network> CallBuilder<T, P, D, N> {
376 fn new_inner_deploy(provider: P, input: Bytes, decoder: D) -> Self {
377 Self {
378 request: <N::TransactionRequest>::default().with_deploy_code(input),
379 decoder,
380 provider,
381 block: BlockId::default(),
382 state: None,
383 fake_transport: PhantomData,
384 }
385 }
386
387 fn new_inner_call(provider: P, input: Bytes, decoder: D) -> Self {
388 Self {
389 request: <N::TransactionRequest>::default().with_input(input),
390 decoder,
391 provider,
392 block: BlockId::default(),
393 state: None,
394 fake_transport: PhantomData,
395 }
396 }
397
398 pub fn chain_id(mut self, chain_id: ChainId) -> Self {
400 self.request.set_chain_id(chain_id);
401 self
402 }
403
404 pub fn from(mut self, from: Address) -> Self {
406 self.request.set_from(from);
407 self
408 }
409
410 pub fn kind(mut self, to: TxKind) -> Self {
412 self.request.set_kind(to);
413 self
414 }
415
416 pub fn to(mut self, to: Address) -> Self {
418 self.request.set_to(to);
419 self
420 }
421
422 pub fn sidecar(mut self, blob_sidecar: BlobTransactionSidecar) -> Self
424 where
425 N::TransactionRequest: TransactionBuilder4844,
426 {
427 self.request.set_blob_sidecar(blob_sidecar);
428 self
429 }
430
431 pub fn legacy(self) -> Self {
433 todo!()
434 }
435
436 pub fn gas(mut self, gas: u64) -> Self {
438 self.request.set_gas_limit(gas);
439 self
440 }
441
442 pub fn gas_price(mut self, gas_price: u128) -> Self {
446 self.request.set_gas_price(gas_price);
447 self
448 }
449
450 pub fn max_fee_per_gas(mut self, max_fee_per_gas: u128) -> Self {
452 self.request.set_max_fee_per_gas(max_fee_per_gas);
453 self
454 }
455
456 pub fn max_priority_fee_per_gas(mut self, max_priority_fee_per_gas: u128) -> Self {
458 self.request.set_max_priority_fee_per_gas(max_priority_fee_per_gas);
459 self
460 }
461
462 pub fn max_fee_per_blob_gas(mut self, max_fee_per_blob_gas: u128) -> Self
464 where
465 N::TransactionRequest: TransactionBuilder4844,
466 {
467 self.request.set_max_fee_per_blob_gas(max_fee_per_blob_gas);
468 self
469 }
470
471 pub fn access_list(mut self, access_list: AccessList) -> Self {
473 self.request.set_access_list(access_list);
474 self
475 }
476
477 pub fn value(mut self, value: U256) -> Self {
479 self.request.set_value(value);
480 self
481 }
482
483 pub fn nonce(mut self, nonce: u64) -> Self {
485 self.request.set_nonce(nonce);
486 self
487 }
488
489 pub fn map<F>(mut self, f: F) -> Self
491 where
492 F: FnOnce(N::TransactionRequest) -> N::TransactionRequest,
493 {
494 self.request = f(self.request);
495 self
496 }
497
498 pub const fn block(mut self, block: BlockId) -> Self {
500 self.block = block;
501 self
502 }
503
504 pub fn state(mut self, state: impl Into<StateOverride>) -> Self {
510 self.state = Some(state.into());
511 self
512 }
513
514 pub fn calldata(&self) -> &Bytes {
516 self.request.input().expect("set in the constructor")
517 }
518
519 pub async fn estimate_gas(&self) -> Result<u64> {
522 let mut estimate = self.provider.estimate_gas(self.request.clone());
523 if let Some(state) = self.state.clone() {
524 estimate = estimate.overrides(state);
525 }
526 estimate.block(self.block).await.map_err(Into::into)
527 }
528
529 #[doc(alias = "eth_call")]
535 #[doc(alias = "call_with_overrides")]
536 pub fn call(&self) -> EthCall<'_, D, N> {
537 self.call_raw().with_decoder(&self.decoder)
538 }
539
540 pub fn call_raw(&self) -> EthCall<'_, (), N> {
547 let call = self.provider.call(self.request.clone()).block(self.block);
548 let call = match self.state.clone() {
549 Some(state) => call.overrides(state),
550 None => call,
551 };
552 call.into()
553 }
554
555 #[inline]
557 pub fn decode_output(&self, data: Bytes, validate: bool) -> Result<D::CallOutput> {
558 self.decoder.abi_decode_output(data, validate)
559 }
560
561 pub async fn deploy(&self) -> Result<Address> {
572 if !self.request.kind().is_some_and(|to| to.is_create()) {
573 return Err(Error::NotADeploymentTransaction);
574 }
575 let pending_tx = self.send().await?;
576 let receipt = pending_tx.get_receipt().await?;
577 receipt.contract_address().ok_or(Error::ContractNotDeployed)
578 }
579
580 pub async fn send(&self) -> Result<PendingTransactionBuilder<N>> {
585 Ok(self.provider.send_transaction(self.request.clone()).await?)
586 }
587
588 pub fn calculate_create_address(&self) -> Option<Address> {
593 self.request.calculate_create_address()
594 }
595}
596
597impl<T, P: Clone, D, N: Network> CallBuilder<T, &P, D, N> {
598 pub fn with_cloned_provider(self) -> CallBuilder<T, P, D, N> {
600 CallBuilder {
601 request: self.request,
602 block: self.block,
603 state: self.state,
604 provider: self.provider.clone(),
605 decoder: self.decoder,
606 fake_transport: PhantomData,
607 }
608 }
609}
610
611impl<T, P, D: CallDecoder, N: Network> std::fmt::Debug for CallBuilder<T, P, D, N> {
612 #[inline]
613 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
614 f.debug_struct("CallBuilder")
615 .field("request", &self.request)
616 .field("block", &self.block)
617 .field("state", &self.state)
618 .field("decoder", &self.decoder.as_debug_field())
619 .finish()
620 }
621}
622
623#[cfg(test)]
624mod tests {
625 use super::*;
626 use alloy_consensus::Transaction;
627 use alloy_network::EthereumWallet;
628 use alloy_node_bindings::Anvil;
629 use alloy_primitives::{address, b256, bytes, hex, utils::parse_units, B256};
630 use alloy_provider::{Provider, ProviderBuilder, WalletProvider};
631 use alloy_rpc_types_eth::AccessListItem;
632 use alloy_signer_local::PrivateKeySigner;
633 use alloy_sol_types::sol;
634 use futures::Future;
635
636 #[test]
637 fn empty_constructor() {
638 sol! {
639 #[sol(rpc, bytecode = "6942")]
640 contract EmptyConstructor {
641 constructor();
642 }
643 }
644
645 let provider = ProviderBuilder::new().on_anvil();
646 let call_builder = EmptyConstructor::deploy_builder(&provider);
647 assert_eq!(*call_builder.calldata(), bytes!("6942"));
648 }
649
650 sol! {
651 #[sol(rpc, bytecode = "60803461006357601f61014838819003918201601f19168301916001600160401b038311848410176100675780849260209460405283398101031261006357518015158091036100635760ff80195f54169116175f5560405160cc908161007c8239f35b5f80fd5b634e487b7160e01b5f52604160045260245ffdfe60808060405260043610156011575f80fd5b5f3560e01c9081638bf1799f14607a575063b09a261614602f575f80fd5b346076576040366003190112607657602435801515810360765715606f57604060015b81516004356001600160a01b0316815260ff919091166020820152f35b60405f6052565b5f80fd5b346076575f36600319011260765760209060ff5f541615158152f3fea264697066735822122043709781c9bdc30c530978abf5db25a4b4ccfebf989baafd2ba404519a7f7e8264736f6c63430008180033")]
654 contract MyContract {
655 bool public myState;
656
657 constructor(bool myState_) {
658 myState = myState_;
659 }
660
661 function doStuff(uint a, bool b) external pure returns(address c, bytes32 d) {
662 return (address(uint160(a)), bytes32(uint256(b ? 1 : 0)));
663 }
664 }
665 }
666
667 sol! {
668 #[sol(rpc, bytecode = "608080604052346100155760d4908161001a8239f35b5f80fdfe60808060405260043610156011575f80fd5b5f3560e01c90816361bc221a14607e575063d09de08a14602f575f80fd5b34607a575f366003190112607a575f546001600160801b038082166001018181116066576001600160801b03199092169116175f55005b634e487b7160e01b5f52601160045260245ffd5b5f80fd5b34607a575f366003190112607a575f546001600160801b03168152602090f3fea26469706673582212208b360e442c4bb2a4bbdec007ee24588c7a88e0aa52ac39efac748e5e23eff69064736f6c63430008180033")]
671 contract Counter {
672 uint128 public counter;
673
674 function increment() external {
675 counter += 1;
676 }
677 }
678 }
679
680 #[allow(clippy::type_complexity)]
682 fn build_call_builder() -> CallBuilder<(), impl Provider, PhantomData<MyContract::doStuffCall>>
683 {
684 let provider = ProviderBuilder::new().on_anvil();
685 let contract = MyContract::new(Address::ZERO, provider);
686 let call_builder = contract.doStuff(U256::ZERO, true).with_cloned_provider();
687 call_builder
688 }
689
690 #[test]
691 fn change_chain_id() {
692 let call_builder = build_call_builder().chain_id(1337);
693 assert_eq!(
694 call_builder.request.chain_id.expect("chain_id should be set"),
695 1337,
696 "chain_id of request should be '1337'"
697 );
698 }
699
700 #[test]
701 fn change_max_fee_per_gas() {
702 let call_builder = build_call_builder().max_fee_per_gas(42);
703 assert_eq!(
704 call_builder.request.max_fee_per_gas.expect("max_fee_per_gas should be set"),
705 42,
706 "max_fee_per_gas of request should be '42'"
707 );
708 }
709
710 #[test]
711 fn change_max_priority_fee_per_gas() {
712 let call_builder = build_call_builder().max_priority_fee_per_gas(45);
713 assert_eq!(
714 call_builder
715 .request
716 .max_priority_fee_per_gas
717 .expect("max_priority_fee_per_gas should be set"),
718 45,
719 "max_priority_fee_per_gas of request should be '45'"
720 );
721 }
722
723 #[test]
724 fn change_max_fee_per_blob_gas() {
725 let call_builder = build_call_builder().max_fee_per_blob_gas(50);
726 assert_eq!(
727 call_builder.request.max_fee_per_blob_gas.expect("max_fee_per_blob_gas should be set"),
728 50,
729 "max_fee_per_blob_gas of request should be '50'"
730 );
731 }
732
733 #[test]
734 fn change_access_list() {
735 let access_list = AccessList::from(vec![AccessListItem {
736 address: Address::ZERO,
737 storage_keys: vec![B256::ZERO],
738 }]);
739 let call_builder = build_call_builder().access_list(access_list.clone());
740 assert_eq!(
741 call_builder.request.access_list.expect("access_list should be set"),
742 access_list,
743 "Access list of the transaction should have been set to our access list"
744 )
745 }
746
747 #[test]
748 fn call_encoding() {
749 let provider = ProviderBuilder::new().on_anvil();
750 let contract = MyContract::new(Address::ZERO, &&provider).with_cloned_provider();
751 let call_builder = contract.doStuff(U256::ZERO, true).with_cloned_provider();
752 assert_eq!(
753 *call_builder.calldata(),
754 bytes!(
755 "b09a2616"
756 "0000000000000000000000000000000000000000000000000000000000000000"
757 "0000000000000000000000000000000000000000000000000000000000000001"
758 ),
759 );
760 let _future: Box<dyn Future<Output = Result<MyContract::doStuffReturn>> + Send> =
762 Box::new(async move { call_builder.call().await });
763 }
764
765 #[test]
766 fn deploy_encoding() {
767 let provider = ProviderBuilder::new().on_anvil();
768 let bytecode = &MyContract::BYTECODE[..];
769 let call_builder = MyContract::deploy_builder(&provider, false);
770 assert_eq!(
771 call_builder.calldata()[..],
772 [
773 bytecode,
774 &hex!("0000000000000000000000000000000000000000000000000000000000000000")[..]
775 ]
776 .concat(),
777 );
778 let call_builder = MyContract::deploy_builder(&provider, true);
779 assert_eq!(
780 call_builder.calldata()[..],
781 [
782 bytecode,
783 &hex!("0000000000000000000000000000000000000000000000000000000000000001")[..]
784 ]
785 .concat(),
786 );
787 }
788
789 #[tokio::test(flavor = "multi_thread")]
790 async fn deploy_and_call() {
791 let provider = ProviderBuilder::new().on_anvil_with_wallet();
792
793 let expected_address = provider.default_signer_address().create(0);
794 let my_contract = MyContract::deploy(provider, true).await.unwrap();
795 assert_eq!(*my_contract.address(), expected_address);
796
797 let my_state_builder = my_contract.myState();
798 assert_eq!(my_state_builder.calldata()[..], MyContract::myStateCall {}.abi_encode(),);
799 let result: MyContract::myStateReturn = my_state_builder.call().await.unwrap();
800 assert!(result.myState);
801
802 let do_stuff_builder = my_contract.doStuff(U256::from(0x69), true);
803 assert_eq!(
804 do_stuff_builder.calldata()[..],
805 MyContract::doStuffCall { a: U256::from(0x69), b: true }.abi_encode(),
806 );
807 let result: MyContract::doStuffReturn = do_stuff_builder.call().await.unwrap();
808 assert_eq!(result.c, address!("0000000000000000000000000000000000000069"));
809 assert_eq!(
810 result.d,
811 b256!("0000000000000000000000000000000000000000000000000000000000000001"),
812 );
813 }
814
815 #[tokio::test(flavor = "multi_thread")]
816 async fn deploy_and_call_with_priority() {
817 let provider = ProviderBuilder::new().on_anvil_with_wallet();
818 let counter_contract = Counter::deploy(provider.clone()).await.unwrap();
819 let max_fee_per_gas: U256 = parse_units("50", "gwei").unwrap().into();
820 let max_priority_fee_per_gas: U256 = parse_units("0.1", "gwei").unwrap().into();
821 let receipt = counter_contract
822 .increment()
823 .max_fee_per_gas(max_fee_per_gas.to())
824 .max_priority_fee_per_gas(max_priority_fee_per_gas.to())
825 .send()
826 .await
827 .expect("Could not send transaction")
828 .get_receipt()
829 .await
830 .expect("Could not get the receipt");
831 let transaction_hash = receipt.transaction_hash;
832 let transaction = provider
833 .get_transaction_by_hash(transaction_hash)
834 .await
835 .expect("failed to fetch tx")
836 .expect("tx not included");
837 assert_eq!(
838 transaction.max_fee_per_gas(),
839 max_fee_per_gas.to(),
840 "max_fee_per_gas of the transaction should be set to the right value"
841 );
842 assert_eq!(
843 transaction
844 .max_priority_fee_per_gas()
845 .expect("max_priority_fee_per_gas of the transaction should be set"),
846 max_priority_fee_per_gas.to(),
847 "max_priority_fee_per_gas of the transaction should be set to the right value"
848 )
849 }
850
851 sol! {
852 #[sol(rpc, bytecode = "6080604052348015600e575f80fd5b506101448061001c5f395ff3fe60806040526004361061001d575f3560e01c8063785d04f514610021575b5f80fd5b61003461002f3660046100d5565b610036565b005b5f816001600160a01b0316836040515f6040518083038185875af1925050503d805f811461007f576040519150601f19603f3d011682016040523d82523d5f602084013e610084565b606091505b50509050806100d05760405162461bcd60e51b81526020600482015260146024820152734661696c656420746f2073656e64206d6f6e657960601b604482015260640160405180910390fd5b505050565b5f80604083850312156100e6575f80fd5b8235915060208301356001600160a01b0381168114610103575f80fd5b80915050925092905056fea2646970667358221220188e65dcedbc4bd68fdebc795292d5a9bf643385f138383969a28f796ff8858664736f6c63430008190033")]
853 contract SendMoney {
854 function send(uint256 amount, address target) external payable {
855 (bool success, ) = target.call{value: amount}("");
856 require(success, "Failed to send money");
857 }
858 }
859 }
860
861 #[tokio::test]
863 async fn fill_eth_call() {
864 let anvil = Anvil::new().spawn();
865 let pk: PrivateKeySigner =
866 "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80".parse().unwrap();
867
868 let wallet = EthereumWallet::new(pk);
869
870 let wallet_provider = ProviderBuilder::new().wallet(wallet).on_http(anvil.endpoint_url());
871
872 let contract = SendMoney::deploy(wallet_provider.clone()).await.unwrap();
873
874 let tx = contract
875 .send(U256::from(1000000), Address::with_last_byte(1))
876 .into_transaction_request()
877 .value(U256::from(1000000));
878
879 assert!(tx.from.is_none());
880
881 let std_provider = ProviderBuilder::new().on_http(anvil.endpoint_url());
882 let should_fail = std_provider.estimate_gas(tx.clone()).await.is_err();
883
884 assert!(should_fail);
885
886 let gas = wallet_provider.estimate_gas(tx).await.unwrap();
887
888 assert_eq!(gas, 56555);
889 }
890
891 #[tokio::test]
892 async fn decode_eth_call_ret_bytes() {
893 sol! {
894 #[derive(Debug, PartialEq)]
895 #[sol(rpc, bytecode = "0x6080604052348015600e575f5ffd5b506101578061001c5f395ff3fe608060405234801561000f575f5ffd5b5060043610610029575f3560e01c80630d1d2c641461002d575b5f5ffd5b61003561004b565b6040516100429190610108565b60405180910390f35b61005361007b565b6040518060400160405280602a67ffffffffffffffff16815260200160011515815250905090565b60405180604001604052805f67ffffffffffffffff1681526020015f151581525090565b5f67ffffffffffffffff82169050919050565b6100bb8161009f565b82525050565b5f8115159050919050565b6100d5816100c1565b82525050565b604082015f8201516100ef5f8501826100b2565b50602082015161010260208501826100cc565b50505050565b5f60408201905061011b5f8301846100db565b9291505056fea264697066735822122039acc87c027f3bddf6806ff9914411d4245bdc708bca36a07138a37b1b98573464736f6c634300081c0033")]
896 contract RetStruct {
897 struct MyStruct {
898 uint64 a;
899 bool b;
900 }
901
902 function retStruct() external pure returns (MyStruct memory) {
903 return MyStruct(42, true);
904 }
905 }
906 }
907
908 let provider = ProviderBuilder::new().on_anvil_with_wallet();
909
910 let contract = RetStruct::deploy(provider.clone()).await.unwrap();
911
912 let tx = contract.retStruct().into_transaction_request();
913
914 let result =
915 provider.call(tx).decode_resp::<RetStruct::retStructCall>().await.unwrap().unwrap();
916
917 assert_eq!(result._0, RetStruct::MyStruct { a: 42, b: true });
918 }
919}