Skip to content

Commit

Permalink
chore: add CLI to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
petscheit committed Apr 8, 2024
1 parent 1230738 commit 3c4e052
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# eth-trie-proofs

A comprehensive proofs handler for Ethereum trie. Tested with various EIPs including Legacy, EIP-2930, EIP-1559, and EIP-4844.
A comprehensive proofs handler for Ethereum trie. Tested with various EIPs including Legacy, EIP-2930, EIP-1559, and EIP-4844. This repository exposes the proof building functionalities, and a CLI version.

## Features

Expand All @@ -19,6 +19,22 @@ A comprehensive proofs handler for Ethereum trie. Tested with various EIPs inclu
- [x] Retrieve proof by transaction index
- [x] Verify proof

## CLI Tool

The CLI tool supports generating proofs for transactions and receipts. Use the following commands based on your requirements:

**Generate a Proof via CLI**
To generate a proof for a transaction, use the following command:

`cargo run --bin eth-trie-proofs tx <TRANSACTION_HASH> [RPC_URL]`

To generate a receipt proof:

`cargo run --bin eth-trie-proofs receipt <TRANSACTION_HASH> [RPC_URL]`

As a default, `https://ethereum-rpc.publicnode.com` is used as an RPC provider. This will probably work for recent transactions, but it is advised to use a dedicated RPC.


## Installation

Use the following command to add `eth-trie-proofs` to your project:
Expand Down

0 comments on commit 3c4e052

Please sign in to comment.