Add Ethers.blob_base_fee/1 and fix minor encoding bugs (#180)

* Add `Ethres.blob_fee_per_gas/1`

* Fix transaction encoding

* Update ethereumex version requirement

* Add margin to max_fee_per_blob_gas

* Enhance fee margin configuration and docs

* Fix CHANGELOG

* Fix credo warnings

Author: alisinabh

CHANGELOG.md

@@ -7,6 +7,13 @@
 - Support [EIP-1191](https://eips.ethereum.org/EIPS/eip-1191): Add chain id to mixed-case checksum address encoding
 - Add [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844) transaction support
 - Add [EIP-2930](https://eips.ethereum.org/EIPS/eip-2930) transaction support
+- Add `Ethers.blob_base_fee/1` to calculate blob fee per gas
+- Make default gas and fee margin configurable
+
+### Bug Fixes
+
+- Fix encoding of transactions without any input data
+- Encode `access_list` and `blob_versioned_hashed` correctly in RPC transaction requests
 
 ## v0.6.1 (2025-01-02)
 

README.md

@@ -75,7 +75,9 @@ config :ethers,
   json_module: Jason, # Defaults to: Jason
   secp256k1_module: ExSecp256k1, # Defaults to: ExSecp256k1
   default_signer: nil, # Defaults to: nil, see Ethers.Signer for more info
-  default_signer_opts: [] # Defaults to: []
+  default_signer_opts: [], # Defaults to: []
+  default_gas_margin: 11000, # Precision is 0.01% (11000 = 110%)
+  default_mdefault_max_fee_per_gas_margin: 12000 #Precision is 0.01% (12000 = 120%)
 
 # If using Ethereumex, you can specify a default JSON-RPC server url here for all requests.
 config :ethereumex, url: "[URL_HERE]"

lib/ethers.ex

@@ -77,6 +77,7 @@ defmodule Ethers do
     :get_balance,
     :get_transaction_count,
     :max_priority_fee_per_gas,
+    :blob_base_fee,
     :gas_price
   ]
   @rpc_actions_map %{
@@ -91,6 +92,7 @@ defmodule Ethers do
     get_transaction: :eth_get_transaction_by_hash,
     max_priority_fee_per_gas: :eth_max_priority_fee_per_gas,
     send_transaction: :eth_send_transaction,
+    blob_base_fee: :eth_blob_base_fee,
     # Deprecated, kept for backward compatibility
     send: :eth_send_transaction
   }
@@ -525,6 +527,29 @@ defmodule Ethers do
     end
   end
 
+  @doc """
+  Returns the current blob base fee from the RPC API
+  """
+  @spec blob_base_fee(Keyword.t()) ::
+          {:ok, non_neg_integer()} | {:error, reason :: term()}
+  def blob_base_fee(opts \\ []) do
+    {rpc_client, rpc_opts} = get_rpc_client(opts)
+
+    rpc_client.eth_blob_base_fee(rpc_opts)
+    |> post_process(nil, :blob_base_fee)
+  end
+
+  @doc """
+  Same as `Ethers.blob_base_fee/1` but raises on error.
+  """
+  @spec blob_base_fee!(Keyword.t()) :: non_neg_integer() | no_return()
+  def blob_base_fee!(opts \\ []) do
+    case blob_base_fee(opts) do
+      {:ok, fee} -> fee
+      {:error, reason} -> raise ExecutionError, reason
+    end
+  end
+
   @doc """
   Fetches the event logs with the given filter.
 

lib/ethers/rpc_client/adapter.ex

@@ -29,6 +29,8 @@ defmodule Ethers.RpcClient.Adapter do
 
   @callback eth_max_priority_fee_per_gas(keyword()) :: {:ok, binary()} | error()
 
+  @callback eth_blob_base_fee(keyword()) :: {:ok, binary()} | error()
+
   @callback eth_get_logs(map(), keyword()) :: {:ok, [binary()] | [map()]} | error()
 
   @callback eth_send_transaction(map(), keyword()) :: {:ok, binary()} | error()

lib/ethers/transaction.ex

@@ -36,6 +36,9 @@ defmodule Ethers.Transaction do
     max_priority_fee_per_gas: :maxPriorityFeePerGas
   }
 
+  # Margin precision is 0.01% (12345 = 123.45%)
+  @margin_precision 10_000
+
   @typedoc """
   EVM Transaction type
   """
@@ -82,9 +85,9 @@ defmodule Ethers.Transaction do
     case Map.fetch(params, :type) do
       {:ok, type} when type in @transaction_types ->
         input =
-          params
-          |> Map.get(:input, Map.get(params, :data))
-          |> Utils.hex_decode!()
+          if input_hex = Map.get(params, :input, Map.get(params, :data)) do
+            Utils.hex_decode!(input_hex)
+          end
 
         params
         |> Map.put(:input, input)
@@ -318,7 +321,10 @@ defmodule Ethers.Transaction do
         {field, Utils.integer_to_hex(value)}
 
       {:access_list, al} when is_list(al) ->
-        {:access_list, al}
+        {:access_list, encode_access_list(al)}
+
+      {:blob_versioned_hashes, hashes} when is_list(hashes) ->
+        {:blob_versioned_hashes, Enum.map(hashes, &Utils.hex_encode/1)}
 
       {:type, type} when is_atom(type) ->
         # Type will get replaced with hex value
@@ -339,6 +345,15 @@ defmodule Ethers.Transaction do
     )
   end
 
+  defp encode_access_list(access_list) do
+    Enum.map(access_list, fn [address, storage_keys] ->
+      [
+        Utils.encode_address!(address),
+        Enum.map(storage_keys, &Utils.hex_encode/1)
+      ]
+    end)
+  end
+
   @doc false
   @deprecated "Use Transaction.Signed.calculate_y_parity_or_v/2 instead"
   defdelegate calculate_y_parity_or_v(tx, recovery_id), to: Signed
@@ -351,6 +366,7 @@ defmodule Ethers.Transaction do
   defp fill_action(:nonce, tx), do: {:get_transaction_count, tx.from, block: "latest"}
   defp fill_action(:max_fee_per_gas, _tx), do: :gas_price
   defp fill_action(:max_priority_fee_per_gas, _tx), do: :max_priority_fee_per_gas
+  defp fill_action(:max_fee_per_blob_gas, _tx), do: :blob_base_fee
   defp fill_action(:gas_price, _tx), do: :gas_price
   defp fill_action(:gas, tx), do: {:estimate_gas, tx}
 
@@ -362,17 +378,16 @@ defmodule Ethers.Transaction do
     end
   end
 
-  defp do_post_process(:max_fee_per_gas, {:ok, max_fee_per_gas}) do
-    # Setting a higher value for max_fee_per gas since the actual base fee is
-    # determined by the last block. This way we minimize the chance to get stuck in
-    # queue when base fee increases
-    mex_fee_per_gas = div(max_fee_per_gas * 120, 100)
-    {:ok, {:max_fee_per_gas, mex_fee_per_gas}}
+  defp do_post_process(field, {:ok, value})
+       when field in [:max_fee_per_gas, :max_fee_per_blob_gas] do
+    # Setting a higher value for max_fee_per and max_fee_per_blob_gas gas since the actual base
+    # fee is determined by the last block. This way we minimize the chance to get stuck in
+    # queue when base fee increases.
+    {:ok, {field, max_fee_per_gas_with_margin(value)}}
   end
 
   defp do_post_process(:gas, {:ok, gas}) do
-    gas = div(gas * 110, 100)
-    {:ok, {:gas, gas}}
+    {:ok, {:gas, gas_with_margin(gas)}}
   end
 
   defp do_post_process(key, {:ok, v_int}) when is_integer(v_int) do
@@ -412,4 +427,18 @@ defmodule Ethers.Transaction do
 
   @doc false
   def default_transaction_type, do: @default_transaction_type
+
+  defp gas_with_margin(value) do
+    margin = Application.get_env(:ethers, :default_gas_margin, 11_000)
+    with_margin(value, margin)
+  end
+
+  defp max_fee_per_gas_with_margin(value) do
+    margin = Application.get_env(:ethers, :default_max_fee_per_gas_margin, 12_000)
+    with_margin(value, margin)
+  end
+
+  defp with_margin(value, margin) do
+    div(value * margin, @margin_precision)
+  end
 end

mix.exs

@@ -104,7 +104,7 @@ defmodule Ethers.MixProject do
     [
       {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
       {:dialyxir, "~> 1.3", only: [:dev, :test], runtime: false},
-      {:ethereumex, "~> 0.10.6"},
+      {:ethereumex, "~> 0.10 and >= 0.10.7"},
       {:ex_abi, "~> 0.8.0", optional: System.get_env("SKIP_EX_KECCAK") == "true"},
       {:ex_doc, "~> 0.32", only: :dev, runtime: false},
       {:ex_keccak, "~> 0.7.5"},

mix.lock

@@ -5,7 +5,7 @@
   "dialyxir": {:hex, :dialyxir, "1.4.5", "ca1571ac18e0f88d4ab245f0b60fa31ff1b12cbae2b11bd25d207f865e8ae78a", [:mix], [{:erlex, ">= 0.2.7", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b0fb08bb8107c750db5c0b324fa2df5ceaa0f9307690ee3c1f6ba5b9eb5d35c3"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.42", "f23d856f41919f17cd06a493923a722d87a2d684f143a1e663c04a2b93100682", [:mix], [], "hexpm", "6915b6ca369b5f7346636a2f41c6a6d78b5af419d61a611079189233358b8b8b"},
   "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
-  "ethereumex": {:hex, :ethereumex, "0.10.6", "6d75cac39b5b7a720b064fe48563f205d3d9784e5bde25f983dd07cf306c2a6d", [:make, :mix], [{:finch, "~> 0.16", [hex: :finch, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:poolboy, "~> 1.5", [hex: :poolboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "58cf926239dabf8bd1fc6cf50a37b926274240b7f58ba5b235a20b5500a9a7e1"},
+  "ethereumex": {:hex, :ethereumex, "0.10.7", "b52c09f078a94f21aad13263ca1c031ce8505163762bd9e2c07167ab0c31e9be", [:make, :mix], [{:finch, "~> 0.16", [hex: :finch, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:poolboy, "~> 1.5", [hex: :poolboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "f033fa1a619202904977b0399151977ed94649a44b9b8ac704ba8084c8647c54"},
   "ex_abi": {:hex, :ex_abi, "0.8.1", "451fa960ddc4dfbb350e13509f3dd64ca586b8484a77aad9f7d778161b5eab79", [:mix], [{:ex_keccak, "~> 0.7.5", [hex: :ex_keccak, repo: "hexpm", optional: true]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "abcf53d556c2948e5c1241340afd4a72cdf93ab6daef16fc200c16ca1183cdca"},
   "ex_doc": {:hex, :ex_doc, "0.36.1", "4197d034f93e0b89ec79fac56e226107824adcce8d2dd0a26f5ed3a95efc36b1", [:mix], [{:earmark_parser, "~> 1.4.42", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "d7d26a7cf965dacadcd48f9fa7b5953d7d0cfa3b44fa7a65514427da44eafd89"},
   "ex_keccak": {:hex, :ex_keccak, "0.7.6", "110c3ed76b55265975d9ae6628205b8a026f11fe081f3073e00c29aab2e91473", [:mix], [{:rustler, ">= 0.0.0", [hex: :rustler, repo: "hexpm", optional: true]}, {:rustler_precompiled, "~> 0.8", [hex: :rustler_precompiled, repo: "hexpm", optional: false]}], "hexpm", "9d1568424eb7b995e480d1b7f0c1e914226ee625496600abb922bba6f5cdc5e4"},
@@ -14,7 +14,7 @@
   "excoveralls": {:hex, :excoveralls, "0.18.3", "bca47a24d69a3179951f51f1db6d3ed63bca9017f476fe520eb78602d45f7756", [:mix], [{:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "746f404fcd09d5029f1b211739afb8fb8575d775b21f6a3908e7ce3e640724c6"},
   "file_system": {:hex, :file_system, "1.0.1", "79e8ceaddb0416f8b8cd02a0127bdbababe7bf4a23d2a395b983c1f8b3f73edd", [:mix], [], "hexpm", "4414d1f38863ddf9120720cd976fce5bdde8e91d8283353f0e31850fa89feb9e"},
   "finch": {:hex, :finch, "0.19.0", "c644641491ea854fc5c1bbaef36bfc764e3f08e7185e1f084e35e0672241b76d", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.6.2 or ~> 1.7", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 1.1", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "fc5324ce209125d1e2fa0fcd2634601c52a787aff1cd33ee833664a5af4ea2b6"},
-  "hpax": {:hex, :hpax, "1.0.1", "c857057f89e8bd71d97d9042e009df2a42705d6d690d54eca84c8b29af0787b0", [:mix], [], "hexpm", "4e2d5a4f76ae1e3048f35ae7adb1641c36265510a2d4638157fbcb53dda38445"},
+  "hpax": {:hex, :hpax, "1.0.2", "762df951b0c399ff67cc57c3995ec3cf46d696e41f0bba17da0518d94acd4aac", [:mix], [], "hexpm", "2f09b4c1074e0abd846747329eaa26d535be0eb3d189fa69d812bfb8bfefd32f"},
   "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~> 0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},

test/ethers_test.exs

@@ -43,6 +43,17 @@ defmodule EthersTest do
     end
   end
 
+  describe "blob_base_fee" do
+    test "returns the correct blob base fee" do
+      assert {:ok, blob_base_fee} = Ethers.blob_base_fee()
+      assert is_integer(blob_base_fee)
+    end
+
+    test "bang version returns unwrapped value" do
+      assert is_integer(Ethers.blob_base_fee!())
+    end
+  end
+
   describe "current_block_number" do
     test "returns the current block number" do
       assert {:ok, n} = Ethers.current_block_number()
@@ -570,6 +581,73 @@ defmodule EthersTest do
         type: "0x2"
       }
     end
+
+    test "works with all transaction types" do
+      types = [
+        Ethers.Transaction.Legacy,
+        Ethers.Transaction.Eip1559,
+        Ethers.Transaction.Eip2930,
+        Ethers.Transaction.Eip4844
+      ]
+
+      for type <- types do
+        assert {:ok, _tx_hash} =
+                 Ethers.send_transaction(
+                   %{value: 1000},
+                   rpc_client: Ethers.TestRPCModule,
+                   from: @from,
+                   type: type,
+                   to: "0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc",
+                   rpc_opts: [send_params_to_pid: self()]
+                 )
+
+        type_id = Ethers.Utils.integer_to_hex(type.type_id())
+
+        assert_receive %{
+          from: @from,
+          to: "0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc",
+          value: "0x3E8",
+          type: ^type_id
+        }
+      end
+    end
+
+    test "works with all transaction types and local signer" do
+      types = [
+        Ethers.Transaction.Legacy,
+        Ethers.Transaction.Eip1559,
+        Ethers.Transaction.Eip2930
+        # Does not work with Anvil without sidecar
+        # Ethers.Transaction.Eip4844
+      ]
+
+      for type <- types do
+        assert {:ok, tx_hash} =
+                 Ethers.send_transaction(
+                   %{value: 1000},
+                   from: @from,
+                   type: type,
+                   to: "0x9965507D1a55bcC2695C58ba16FB37d819B0A4da",
+                   signer: Ethers.Signer.Local,
+                   blob_versioned_hashes: [
+                     Ethers.Utils.hex_decode!(
+                       "0x01bb9dc6ee48ae6a6f7ffd69a75196a4d49723beedf35981106e8da0efd8f796"
+                     )
+                   ],
+                   access_list: access_list_fixture(),
+                   signer_opts: [
+                     private_key: @from_private_key
+                   ]
+                 )
+
+        wait_for_transaction!(tx_hash)
+
+        type_id = Ethers.Utils.integer_to_hex(type.type_id())
+
+        assert %Ethers.Transaction.Signed{payload: %^type{}} = Ethers.get_transaction!(tx_hash)
+        assert Ethers.get_transaction_receipt!(tx_hash)["type"] == type_id
+      end
+    end
   end
 
   describe "sign_transaction/2" do
@@ -740,4 +818,43 @@ defmodule EthersTest do
       assert Ethers.chain_id!() == 31_337
     end
   end
+
+  defp access_list_fixture do
+    [
+      [
+        <<7, 166, 233, 85, 186, 67, 69, 186, 232, 58, 194, 166, 250, 167, 113, 253, 221, 138, 32,
+          17>>,
+        [
+          <<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+            0, 0, 0>>,
+          <<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+            0, 0, 1>>,
+          <<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+            0, 0, 8>>
+        ]
+      ],
+      [
+        <<125, 26, 250, 123, 113, 143, 184, 147, 219, 48, 163, 171, 192, 207, 198, 8, 170, 207,
+          235, 176>>,
+        [
+          <<20, 213, 49, 41, 66, 36, 14, 86, 92, 86, 174, 193, 24, 6, 206, 88, 227, 192, 227, 140,
+            150, 38, 157, 117, 156, 93, 53, 162, 162, 228, 164, 73>>,
+          <<39, 1, 253, 11, 38, 56, 243, 61, 178, 37, 217, 28, 106, 219, 218, 212, 101, 144, 168,
+            106, 9, 162, 178, 195, 134, 64, 92, 47, 116, 42, 248, 66>>,
+          <<55, 176, 184, 46, 229, 216, 168, 134, 114, 223, 56, 149, 164, 106, 244, 139, 188, 211,
+            13, 110, 252, 201, 8, 19, 110, 41, 69, 111, 163, 6, 4, 187>>
+        ]
+      ],
+      [
+        <<160, 184, 105, 145, 198, 33, 139, 54, 193, 209, 157, 74, 46, 158, 176, 206, 54, 6, 235,
+          72>>,
+        [
+          <<55, 87, 12, 241, 140, 109, 149, 116, 74, 21, 79, 162, 177, 155, 126, 149, 140, 120,
+            239, 104, 184, 198, 10, 128, 220, 82, 127, 193, 94, 44, 235, 143>>,
+          <<110, 137, 211, 30, 63, 216, 210, 191, 11, 65, 28, 69, 142, 152, 199, 70, 59, 247, 35,
+            135, 140, 60, 232, 168, 69, 188, 249, 220, 59, 46, 57, 23>>
+        ]
+      ]
+    ]
+  end
 end

test/support/test_rpc_module.ex

@@ -15,6 +15,14 @@ defmodule Ethers.TestRPCModule do
     {:ok, opts[:tx_hash] || "tx_hash"}
   end
 
+  def eth_send_raw_transaction(params, opts) do
+    if pid = opts[:send_params_to_pid] do
+      send(pid, params)
+    end
+
+    {:ok, opts[:tx_hash] || "tx_hash"}
+  end
+
   def eth_call(params, block, opts) do
     if pid = opts[:send_back_to_pid] do
       send(pid, :eth_call)