Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
Cross-provider verification, stale-head detection, silent-failure detection, and cost accounting for
Ethereum JSON-RPC traffic. Self-hosted, MIT licensed.

[![npm](https://img.shields.io/npm/v/@heightproof/web3)](https://www.npmjs.com/package/@heightproof/web3)

![Heightproof RPC activity](assets/screenshots/rpc-activity.png)

## The problem
Expand Down Expand Up @@ -84,8 +86,11 @@ This README describes where Heightproof is going and marks clearly what already

## Use it

`@heightproof/web3` is not on npm yet ([Phase 4](docs/roadmap.md#phase-4--adoption)) — build it from
this repo with `npm install && npm run build`.
```bash
npm install @heightproof/web3
```

The SDK reports to a Heightproof server you run yourself (see [Run it](#run-it)).

Wrap any EIP-1193 provider:

Expand Down
2 changes: 1 addition & 1 deletion docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Credibility here is the entire point, and it is spent instantly by overclaiming.

## Phase 4 — Adoption

- [ ] Publish `@heightproof/web3` to npm with real semver and a changelog
- [x] Publish `@heightproof/web3` to npm with real semver and a changelog (0.1.0)
- [ ] Hosted docs with a five-minute quickstart
- [ ] Framework adapters: ethers.js, web3.js, plain `fetch`
- [ ] Standalone mode — run the detectors without the full self-hosted stack
Expand Down
Loading