Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Smith committed Jan 7, 2025
1 parent 2d215d8 commit 7ae8aa1
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This crate verifies any Ethereum signature including:
- Smart contract wallets with [ERC-1271](https://eips.ethereum.org/EIPS/eip-1271)
- Predeploy contract wallets with [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492)

This crate is implemented using a single `eth_call` RPC request, and is described in the [off-chain validation section](https://eips.ethereum.org/EIPS/eip-6492#off-chain-validation) of the ERC-6492 spec.

## Install

```bash
Expand All @@ -15,9 +17,13 @@ cargo add erc6492 --git https://github.com/reown-com/erc6492
or

```toml
erc6492 = { git = "https://github.com/reown-com/erc6492.git", version = "0.1.0" }
erc6492 = { git = "https://github.com/reown-com/erc6492.git" }
```

We recommend pinning to a commit ref to avoid unexpected breaking changes while in v0.

We will publish to crates.io soon.

## Usage

This crate uses [Alloy](https://github.com/alloy-rs) and requires an RPC provider in order to verify all signature types.
Expand Down

0 comments on commit 7ae8aa1

Please sign in to comment.