https://github.com/wevm/unver
Universal Signature Verification for ethers.js
https://github.com/wevm/unver
Last synced: 5 months ago
JSON representation
Universal Signature Verification for ethers.js
- Host: GitHub
- URL: https://github.com/wevm/unver
- Owner: wevm
- Created: 2025-09-04T10:21:37.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-04T10:43:03.000Z (10 months ago)
- Last Synced: 2025-09-04T12:26:51.103Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# unver
Universal Signature Verification for [ethers.js](https://github.com/ethers-io/ethers.js), with support for:
- Externally Owned Accounts
- Contract Accounts via [ERC-1271](https://eips.ethereum.org/EIPS/eip-1271)
- Predeployed Contract Accounts via [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492)
- Predelegated Contract Accounts via [ERC-8010](https://github.com/jxom/ERCs/blob/799f618e1f9b7ad1dcdf3ccc46b9b7a9309c086f/ERCS/erc-8010.md)
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API Reference](#api-reference)
- [`UnverProvider.wrap`](#unverproviderwrap)
- [`Signature.verifyHash`](#signatureverifyhash)
- [`Signature.verifyMessage`](#signatureverifymessage)
- [`Signature.verifyTypedData`](#signatureverifytypeddata)
- [Development](#development)
- [Community](#community)
- [Support](#support)
## Install
```bash
npm i unver
```
## Usage
```ts
import * as ethers from 'ethers'
import { UnverProvider } from 'unver'
const provider = UnverProvider.wrap(
new ethers.JsonRpcProvider('https://eth.merkle.io')
)
const address = '0x...'
const digest = '0x...'
const signature = '0x...'
const valid = await provider.verifyHash(address, digest, signature)
```
## API Reference
### `UnverProvider.wrap`
Wraps an `ethers.AbstractProvider` with the `UnverProvider` interface.
```ts
const provider = UnverProvider.wrap(
new ethers.JsonRpcProvider('https://eth.merkle.io')
)
```
#### Interface
```ts
declare function wrap(provider: ethers.AbstractProvider):
Provider
```
### `Signature.verifyHash`
Verifies a `signature` for a given `address` and `digest`.
```ts
const address = '0x...'
const digest = '0x...'
const signature = '0x...'
// Provider usage
const valid = await provider.verifyHash(address, digest, signature)
// Function usage
import { Signature } from 'unver'
const valid = await Signature.verifyHash(provider, address, digest, signature)
```
#### Interface
```ts
declare function verifyHash(
provider: ethers.AbstractProvider,
address: string,
digest: Uint8Array | string,
signature: ethers.SignatureLike,
): Promise
```
### `Signature.verifyMessage`
Verifies a `signature` for a given `address` and `message`.
```ts
const address = '0x...'
const message = 'hello world'
const signature = '0x...'
// Provider usage
const valid = await provider.verifyMessage(address, message, signature)
// Function usage
import { Signature } from 'unver'
const valid = await Signature.verifyMessage(provider, address, message, signature)
```
#### Interface
```ts
declare function verifyMessage(
provider: ethers.AbstractProvider,
address: string,
message: Uint8Array | string,
signature: ethers.SignatureLike,
): Promise
```
### `Signature.verifyTypedData`
Verifies a `signature` for a given `address` and `typedData`.
```ts
const address = '0x...'
const domain = {
name: 'My App',
version: '1.0.0',
chainId: 1,
verifyingContract: '0x...'
}
const types = {
Person: [
{ name: 'name', type: 'string' },
{ name: 'age', type: 'uint256' },
],
}
const value = {
name: 'John Doe',
age: 20,
}
const signature = '0x...'
// Provider usage
const valid = await provider.verifyTypedData(address, domain, types, value, signature)
// Function usage
import { Signature } from 'unver'
const valid = await Signature.verifyTypedData(provider, address, domain, types, value, signature)
```
#### Interface
```ts
declare function verifyTypedData(
provider: ethers.AbstractProvider,
address: string,
domain: ethers.TypedDataDomain,
types: Record>,
value: Record,
signature: ethers.SignatureLike,
): Promise
```
## Development
```bash
bun install # Install dependencies
bun test # Run tests
```
## Community
Check out the following places for more content:
- Follow [@wevm_dev](https://x.com/wevm_dev), [@jxom](https://x.com/_jxom), and [@awkweb](https://x.com/awkweb) on Twitter for project updates
## Support
- [GitHub Sponsors](https://github.com/sponsors/wevm?metadata_campaign=docs_support)
- [Gitcoin Grant](https://wagmi.sh/gitcoin)
- [wevm.eth](https://etherscan.io/enslookup-search?search=wevm.eth)