Skip to content

Commit 60bf49a

Browse files
NoahZinsmeisterNoahZinsmeister
committed
prep for beta
1 parent b50caf8 commit 60bf49a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+3023
-5260
lines changed

Diff for: ‎README.md

+21-30
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,27 @@
1-
# `web3-react` 🧰 (alpha)
1+
# web3-react (beta)
22

33
[![CI](https://github.com/NoahZinsmeister/web3-react/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/NoahZinsmeister/web3-react/actions/workflows/CI.yml)
44

5-
[Example](https://web3-react-mu.vercel.app/)
6-
7-
Tasks:
8-
- Write other connectors
9-
- WalletConnect V2
10-
- Gnosis Safe
11-
- Other injected connectors?
12-
- Tighten up experimental connectors
13-
- Address remaining TODOs in the code
14-
- More tests
15-
- Docs
16-
- Test Node 12 support
17-
- Add Node 16 support once LTS
5+
## [Example](https://web3-react-mu.vercel.app/)
186

197
## Packages
208

21-
| Package | `@alpha` Version | Size | Description |
22-
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
23-
| [`@web3-react/store`](packages/store) | [![npm](https://img.shields.io/npm/v/@web3-react/store/alpha.svg)](https://www.npmjs.com/package/@web3-react/store/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/store/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/store@alpha) | |
24-
| [`@web3-react/types`](packages/types) | [![npm](https://img.shields.io/npm/v/@web3-react/types/alpha.svg)](https://www.npmjs.com/package/@web3-react/types/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/types/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/types@alpha) | |
25-
| [`@web3-react/core`](packages/core) | [![npm](https://img.shields.io/npm/v/@web3-react/core/alpha.svg)](https://www.npmjs.com/package/@web3-react/core/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/core/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/core@alpha) | |
9+
| Package | Version | Size | Description |
10+
|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
11+
| [`@web3-react/types`](packages/types) | [![npm](https://img.shields.io/npm/v/@web3-react/types/beta.svg)](https://www.npmjs.com/package/@web3-react/types/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/types/beta.svg)](https://bundlephobia.com/result?p=@web3-react/types@beta) | |
12+
| [`@web3-react/store`](packages/store) | [![npm](https://img.shields.io/npm/v/@web3-react/store/beta.svg)](https://www.npmjs.com/package/@web3-react/store/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/store/beta.svg)](https://bundlephobia.com/result?p=@web3-react/store@beta) | |
13+
| [`@web3-react/core`](packages/core) | [![npm](https://img.shields.io/npm/v/@web3-react/core/beta.svg)](https://www.npmjs.com/package/@web3-react/core/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/core/beta.svg)](https://bundlephobia.com/result?p=@web3-react/core@beta) | |
2614
| **Connectors** | | | |
27-
| [`@web3-react/metamask`](packages/metamask) | [![npm](https://img.shields.io/npm/v/@web3-react/metamask/alpha.svg)](https://www.npmjs.com/package/@web3-react/metamask/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/metamask/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/metamask@alpha) | [MetaMask](https://metamask.io/) |
28-
| [`@web3-react/network`](packages/network) | [![npm](https://img.shields.io/npm/v/@web3-react/network/alpha.svg)](https://www.npmjs.com/package/@web3-react/network/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/network/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/network@alpha) | |
29-
| [`@web3-react/walletconnect`](packages/walletconnect) | [![npm](https://img.shields.io/npm/v/@web3-react/walletconnect/alpha.svg)](https://www.npmjs.com/package/@web3-react/walletconnect/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/walletconnect/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/walletconnect@alpha) | [WalletConnect](https://walletconnect.org/) |
30-
| [`@web3-react/walletlink`](packages/walletlink) | [![npm](https://img.shields.io/npm/v/@web3-react/walletlink/alpha.svg)](https://www.npmjs.com/package/@web3-react/walletlink/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/walletlink/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/walletlink@alpha) | [WalletLink](https://walletlink.org/#/) |
31-
| **Experimental Connectors** | | | ⚠️ Not stable |
32-
| [`@web3-react/frame`](packages/frame) | [![npm](https://img.shields.io/npm/v/@web3-react/frame/alpha.svg)](https://www.npmjs.com/package/@web3-react/frame/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/frame/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/frame@alpha) | [Frame](https://frame.sh/) |
33-
| [`@web3-react/magic`](packages/magic) | [![npm](https://img.shields.io/npm/v/@web3-react/magic/alpha.svg)](https://www.npmjs.com/package/@web3-react/magic/v/alpha) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/magic/alpha.svg)](https://bundlephobia.com/result?p=@web3-react/magic@alpha) | [Magic](https://magic.link/) |
15+
| [`@web3-react/eip1193`](packages/eip1193) | [![npm](https://img.shields.io/npm/v/@web3-react/eip1193/beta.svg)](https://www.npmjs.com/package/@web3-react/eip1193/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/eip1193/beta.svg)](https://bundlephobia.com/result?p=@web3-react/eip1193@beta) | |
16+
| [`@web3-react/empty`](packages/empty) | [![npm](https://img.shields.io/npm/v/@web3-react/empty/beta.svg)](https://www.npmjs.com/package/@web3-react/empty/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/empty/beta.svg)](https://bundlephobia.com/result?p=@web3-react/empty@beta) | |
17+
| [`@web3-react/metamask`](packages/metamask) | [![npm](https://img.shields.io/npm/v/@web3-react/metamask/beta.svg)](https://www.npmjs.com/package/@web3-react/metamask/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/metamask/beta.svg)](https://bundlephobia.com/result?p=@web3-react/metamask@beta) | [MetaMask](https://metamask.io/) |
18+
| [`@web3-react/network`](packages/network) | [![npm](https://img.shields.io/npm/v/@web3-react/network/beta.svg)](https://www.npmjs.com/package/@web3-react/network/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/network/beta.svg)](https://bundlephobia.com/result?p=@web3-react/network@beta) | |
19+
| [`@web3-react/url`](packages/url) | [![npm](https://img.shields.io/npm/v/@web3-react/url/beta.svg)](https://www.npmjs.com/package/@web3-react/url/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/url/beta.svg)](https://bundlephobia.com/result?p=@web3-react/url@beta) | |
20+
| [`@web3-react/walletconnect`](packages/walletconnect) | [![npm](https://img.shields.io/npm/v/@web3-react/walletconnect/beta.svg)](https://www.npmjs.com/package/@web3-react/walletconnect/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/walletconnect/beta.svg)](https://bundlephobia.com/result?p=@web3-react/walletconnect@beta) | [WalletConnect](https://walletconnect.org/) |
21+
| [`@web3-react/walletlink`](packages/walletlink) | [![npm](https://img.shields.io/npm/v/@web3-react/walletlink/beta.svg)](https://www.npmjs.com/package/@web3-react/walletlink/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/walletlink/beta.svg)](https://bundlephobia.com/result?p=@web3-react/walletlink@beta) | [WalletLink](https://walletlink.org/#/) |
22+
| **Experimental Connectors** | | | Not stable |
23+
| [`@web3-react/frame`](packages/frame) | [![npm](https://img.shields.io/npm/v/@web3-react/frame/beta.svg)](https://www.npmjs.com/package/@web3-react/frame/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/frame/beta.svg)](https://bundlephobia.com/result?p=@web3-react/frame@beta) | [Frame](https://frame.sh/) |
24+
| [`@web3-react/magic`](packages/magic) | [![npm](https://img.shields.io/npm/v/@web3-react/magic/beta.svg)](https://www.npmjs.com/package/@web3-react/magic/v/beta) | [![minzip](https://img.shields.io/bundlephobia/minzip/@web3-react/magic/beta.svg)](https://bundlephobia.com/result?p=@web3-react/magic@beta) | [Magic](https://magic.link/) |
3425

3526

3627
## Getting Started
@@ -39,7 +30,7 @@ Tasks:
3930
- `yarn bootstrap`
4031
- `yarn start`
4132

42-
In addition to compiling each package in watch mode, this will also spin up an example app on [http://localhost:3000/](http://localhost:3000/).
33+
In addition to compiling each package in watch mode, this will also spin up the example app on [http://localhost:3000/](http://localhost:3000/).
4334

4435
## Running Tests
4536

@@ -49,14 +40,14 @@ In addition to compiling each package in watch mode, this will also spin up an e
4940

5041
### Add a dependency
5142

52-
- `yarn lerna add <DEPENDENCY> --scope <SUBPACKAGE>`
43+
- `yarn lerna add <DEPENDENCY> --scope <PACKAGE>`
5344

5445
### Remove a dependency
5546

5647
- Delete the relevant `package.json` entry
5748

5849
Because of a [lerna bug](https://github.com/lerna/lerna/issues/1883), it's not possible to prune `yarn.lock` programmatically, so regenerate it manually:
5950

60-
- `yarn lerna exec 'rm -f yarn.lock' --scope SUBPACKAGE`
61-
- `yarn clean --scope SUBPACKAGE`
51+
- `yarn lerna exec "rm -f yarn.lock" --scope <SUBPACKAGE>`
52+
- `yarn clean --scope <SUBPACKAGE>`
6253
- `yarn bootstrap`

Diff for: ‎package.json

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
{
22
"private": true,
33
"name": "web3-react",
4-
"description": "A simple, maximally extensible, dependency minimized framework for building modern Ethereum dApps",
5-
"author": "Noah Zinsmeister <[email protected]>",
6-
"license": "GPL-3.0-or-later",
74
"engines": {
85
"node": "^14 || ^16"
96
},
@@ -25,14 +22,18 @@
2522
"@types/react": "^17.0.21",
2623
"@typescript-eslint/eslint-plugin": "^5.7.0",
2724
"@typescript-eslint/parser": "^5.7.0",
25+
"@walletconnect/ethereum-provider": "^1.7.0",
2826
"eslint": "^8.4.1",
2927
"eslint-plugin-react-hooks": "^4.3.0",
28+
"eth-provider": "^0.9.4",
3029
"jest": "^27.2.4",
3130
"lerna": "^4.0.0",
31+
"magic-sdk": "^6.1.0",
3232
"prettier": "2.3.2",
3333
"react": "^17.0.2",
3434
"react-test-renderer": "^17.0.2",
3535
"ts-jest": "^27.0.5",
36-
"typescript": "^4.5.4"
36+
"typescript": "^4.5.4",
37+
"walletlink": "^2.4.0"
3738
}
3839
}

Diff for: ‎packages/core/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# @web3-react/core

Diff for: ‎packages/core/package.json

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
{
22
"name": "@web3-react/core",
3+
"keywords": [
4+
"web3-react"
5+
],
6+
"author": "Noah Zinsmeister <[email protected]>",
7+
"license": "GPL-3.0-or-later",
8+
"repository": "github:NoahZinsmeister/web3-react",
39
"publishConfig": {
410
"access": "public"
511
},
@@ -22,16 +28,12 @@
2228
"start": "tsc --watch"
2329
},
2430
"dependencies": {
31+
"@ethersproject/providers": "^5.5.1",
2532
"@web3-react/store": "^8.0.16-alpha.0",
2633
"@web3-react/types": "^8.0.16-alpha.0",
2734
"zustand": "^4.0.0-beta.0"
2835
},
2936
"peerDependencies": {
30-
"@ethersproject/providers": "^5.4.5",
3137
"react": ">=16.8"
32-
},
33-
"devDependencies": {
34-
"@ethersproject/providers": "^5.4.5"
35-
},
36-
"gitHead": "9461726911d45849d76642bc60fec57e84234cd7"
38+
}
3739
}

Diff for: ‎packages/core/yarn.lock

+13-13
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@
103103
integrity sha512-rIY/6WPm7T8n3qS2vuHTUBPdXHl+rGxWxW5okDfo9J4Z0+gRRZT0msvUdIJkE4/HS29GUMziwGaaKO2bWONBrg==
104104

105105
"@ethersproject/networks@^5.5.0":
106-
version "5.5.0"
107-
resolved "https://registry.yarnpkg.com/@ethersproject/networks/-/networks-5.5.0.tgz#babec47cab892c51f8dd652ce7f2e3e14283981a"
108-
integrity sha512-KWfP3xOnJeF89Uf/FCJdV1a2aDJe5XTN2N52p4fcQ34QhDqQFkgQKZ39VGtiqUgHcLI8DfT0l9azC3KFTunqtA==
106+
version "5.5.2"
107+
resolved "https://registry.yarnpkg.com/@ethersproject/networks/-/networks-5.5.2.tgz#784c8b1283cd2a931114ab428dae1bd00c07630b"
108+
integrity sha512-NEqPxbGBfy6O3x4ZTISb90SjEDkWYDUbEeIFhJly0F7sZjoQMnj5KYzMSkMkLKZ+1fGpx00EDpHQCy6PrDupkQ==
109109
dependencies:
110110
"@ethersproject/logger" "^5.5.0"
111111

@@ -116,10 +116,10 @@
116116
dependencies:
117117
"@ethersproject/logger" "^5.5.0"
118118

119-
"@ethersproject/providers@^5.4.5":
120-
version "5.5.0"
121-
resolved "https://registry.yarnpkg.com/@ethersproject/providers/-/providers-5.5.0.tgz#bc2876a8fe5e0053ed9828b1f3767ae46e43758b"
122-
integrity sha512-xqMbDnS/FPy+J/9mBLKddzyLLAQFjrVff5g00efqxPzcAwXiR+SiCGVy6eJ5iAIirBOATjx7QLhDNPGV+AEQsw==
119+
"@ethersproject/providers@^5.5.1":
120+
version "5.5.2"
121+
resolved "https://registry.yarnpkg.com/@ethersproject/providers/-/providers-5.5.2.tgz#131ccf52dc17afd0ab69ed444b8c0e3a27297d99"
122+
integrity sha512-hkbx7x/MKcRjyrO4StKXCzCpWer6s97xnm34xkfPiarhtEUVAN4TBBpamM+z66WcTt7H5B53YwbRj1n7i8pZoQ==
123123
dependencies:
124124
"@ethersproject/abstract-provider" "^5.5.0"
125125
"@ethersproject/abstract-signer" "^5.5.0"
@@ -142,9 +142,9 @@
142142
ws "7.4.6"
143143

144144
"@ethersproject/random@^5.5.0":
145-
version "5.5.0"
146-
resolved "https://registry.yarnpkg.com/@ethersproject/random/-/random-5.5.0.tgz#305ed9e033ca537735365ac12eed88580b0f81f9"
147-
integrity sha512-egGYZwZ/YIFKMHcoBUo8t3a8Hb/TKYX8BCBoLjudVCZh892welR3jOxgOmb48xznc9bTcMm7Tpwc1gHC1PFNFQ==
145+
version "5.5.1"
146+
resolved "https://registry.yarnpkg.com/@ethersproject/random/-/random-5.5.1.tgz#7cdf38ea93dc0b1ed1d8e480ccdaf3535c555415"
147+
integrity sha512-YaU2dQ7DuhL5Au7KbcQLHxcRHfgyNgvFV4sQOo0HrtW3Zkrc9ctWNz8wXQ4uCSfSDsqX2vcjhroxU5RQRV0nqA==
148148
dependencies:
149149
"@ethersproject/bytes" "^5.5.0"
150150
"@ethersproject/logger" "^5.5.0"
@@ -203,9 +203,9 @@
203203
"@ethersproject/signing-key" "^5.5.0"
204204

205205
"@ethersproject/web@^5.5.0":
206-
version "5.5.0"
207-
resolved "https://registry.yarnpkg.com/@ethersproject/web/-/web-5.5.0.tgz#0e5bb21a2b58fb4960a705bfc6522a6acf461e28"
208-
integrity sha512-BEgY0eL5oH4mAo37TNYVrFeHsIXLRxggCRG/ksRIxI2X5uj5IsjGmcNiRN/VirQOlBxcUhCgHhaDLG4m6XAVoA==
206+
version "5.5.1"
207+
resolved "https://registry.yarnpkg.com/@ethersproject/web/-/web-5.5.1.tgz#cfcc4a074a6936c657878ac58917a61341681316"
208+
integrity sha512-olvLvc1CB12sREc1ROPSHTdFCdvMh0J5GSJYiQg2D0hdD4QmJDy8QYDb1CvoqD/bF1c++aeKv2sR5uduuG9dQg==
209209
dependencies:
210210
"@ethersproject/base64" "^5.5.0"
211211
"@ethersproject/bytes" "^5.5.0"

Diff for: ‎packages/eip1193/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# @web3-react/eip1193

Diff for: ‎packages/eip1193/package.json

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
{
22
"name": "@web3-react/eip1193",
3+
"keywords": [
4+
"web3-react",
5+
"eip1193"
6+
],
7+
"author": "Noah Zinsmeister <[email protected]>",
8+
"license": "GPL-3.0-or-later",
9+
"repository": "github:NoahZinsmeister/web3-react",
310
"publishConfig": {
411
"access": "public"
512
},

0 commit comments

Comments
 (0)