Merge branch 'main' of github.com:wchenNL/elixir_ethers into add_kms_signer

Author: Wen Chen

CHANGELOG.md

@@ -1,6 +1,30 @@
 # Changelog
 
-## v0.2.2 (2023-01-08)
+## v0.3.0 (2024-02-05)
+
+### Breaking Changes
+
+- Removed `signature_v`, `signature_recovery_id` and `signature_y_parity` from `Ethers.Transaction`
+  struct and introduce new `signature_v_or_y_parity` value
+- Update `ex_abi` to 0.7.0 with new `method_id` logic for event selectors and use its value
+
+### Enhancements
+
+- Cleanup implementation of Transaction encoders and value decoder
+
+## v0.2.3 (2024-01-29)
+
+### New features
+
+- Add `Ethers.get_transaction_receipt/2` function to query native chain transaction receipt by transaction hash.
+
+### Enhancements
+
+- Add more metadata to `Ethers.Transaction` struct.
+- Return `Ethers.Transaction` struct in `Ethers.get_transaction/2` function.
+- Support `get_transaction` in batch requests.
+
+## v0.2.2 (2024-01-08)
 
 ### New features
 

README.md

@@ -23,7 +23,7 @@ dependencies in your `mix.exs` file:
 ```elixir
 def deps do
   [
-    {:ethers, "~> 0.2.2"},
+    {:ethers, "~> 0.3.0"},
     # Uncomment next line if you want to use local signers
     # {:ex_secp256k1, "~> 0.7.2"}
   ]
@@ -261,7 +261,7 @@ To sign transactions on Ethers, You can specify a `signer` module when sending/s
 
 Ethers has these built-in signers to use:
 
-- `Ethers.Signer.Local`\*: A local signer which loads a private key from `signer_opts` and signs the transactions.
+- `Ethers.Signer.Local`: A local signer which loads a private key from `signer_opts` and signs the transactions.
 - `Ethers.Signer.JsonRPC`: Uses `eth_signTransaction` Json RPC function to sign transactions. (Using services like [Consensys/web3signer](https://github.com/Consensys/web3signer) or [geth](https://geth.ethereum.org/))
 - `Ethers.Signer.KMS`: A KMS-based signer that expects a valid `kms_key_id` from `signer_opts`. Transactions are sent to KMS to sign with the specified [Customer Managed Key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). Notice that the keys need to pre-exist as `ECC_SECG_P256K1` asymmetric pairs as described on [AWS](https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-ecc). Also, please refer to [AWS Key configuration](https://github.com/ex-aws/ex_aws?tab=readme-ov-file#aws-key-configuration) for configuring your app to connect to AWS in order to use the signer.
 

lib/ethers.ex

@@ -84,6 +84,7 @@ defmodule Ethers do
     gas_price: :eth_gas_price,
     get_logs: :eth_get_logs,
     get_transaction_count: :eth_get_transaction_count,
+    get_transaction: :eth_get_transaction_by_hash,
     send: :eth_send_transaction
   }
 
@@ -142,17 +143,36 @@ defmodule Ethers do
   ## Parameters
   - tx_hash: Transaction hash which the transaction is queried for.
   - overrides:
+    - rpc_client: The RPC module to use for this request (overrides default).
     - rpc_opts: Specific RPC options to specify for this request.
   """
   @spec get_transaction(Types.t_hash(), Keyword.t()) ::
-          {:ok, map()} | {:error, term()}
+          {:ok, Transaction.t()} | {:error, term()}
   def get_transaction(tx_hash, opts \\ []) when is_binary(tx_hash) do
     {rpc_client, rpc_opts} = get_rpc_client(opts)
 
     rpc_client.eth_get_transaction_by_hash(tx_hash, rpc_opts)
     |> post_process(nil, :get_transaction)
   end
 
+  @doc """
+  Returns the receipt of a transaction by it's hash.
+
+  ## Parameters
+  - tx_hash: Transaction hash which the transaction receipt is queried for.
+  - overrides:
+    - rpc_client: The RPC module to use for this request (overrides default).
+    - rpc_opts: Specific RPC options to specify for this request.
+  """
+  @spec get_transaction_receipt(Types.t_hash(), Keyword.t()) ::
+          {:ok, map()} | {:error, term()}
+  def get_transaction_receipt(tx_hash, opts \\ []) when is_binary(tx_hash) do
+    {rpc_client, rpc_opts} = get_rpc_client(opts)
+
+    rpc_client.eth_get_transaction_receipt(tx_hash, rpc_opts)
+    |> post_process(nil, :get_transaction_receipt)
+  end
+
   @doc """
   Deploys a contract to the blockchain.
 
@@ -645,6 +665,13 @@ defmodule Ethers do
   defp post_process({:ok, nil}, _tx_hash, :get_transaction),
     do: {:error, :transaction_not_found}
 
+  defp post_process({:ok, tx_data}, _tx_hash, :get_transaction) do
+    Transaction.from_map(tx_data)
+  end
+
+  defp post_process({:ok, nil}, _tx_hash, :get_transaction_receipt),
+    do: {:error, :transaction_receipt_not_found}
+
   defp post_process({:ok, result}, _tx_data, _action),
     do: {:ok, result}
 

lib/ethers/contract_helpers.ex

@@ -315,6 +315,10 @@ defmodule Ethers.ContractHelpers do
     [event_topic_0(selector) | encode_event_sub_topics(selector, args)]
   end
 
+  defp event_topic_0(%{method_id: method_id}) when byte_size(method_id) == 32 do
+    Ethers.Utils.hex_encode(method_id)
+  end
+
   defp event_topic_0(selector) do
     selector
     |> ABI.FunctionSelector.encode()

lib/ethers/signer/local.ex

@@ -36,8 +36,15 @@ defmodule Ethers.Signer.Local do
            Transaction.encode(tx)
            |> keccak_module().hash_256()
            |> secp256k1_module().sign(private_key) do
+      y_parity_or_v = Transaction.calculate_y_parity_or_v(tx, recovery_id)
+
       signed =
-        %{tx | signature_r: r, signature_s: s, signature_recovery_id: recovery_id}
+        %Ethers.Transaction{
+          tx
+          | signature_r: r,
+            signature_s: s,
+            signature_y_parity_or_v: y_parity_or_v
+        }
         |> Transaction.encode()
         |> Utils.hex_encode()