Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move ethers to peer dependencies #293

Merged
merged 2 commits into from
Feb 7, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Next Next commit
Move ethers to peer dependencies
  • Loading branch information
Dhaiwat10 committed Feb 6, 2022
commit a37b464c25663a2c73980eba4ada6a01f912f8d4
9 changes: 9 additions & 0 deletions .changeset/khaki-cobras-laugh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
'@web3-ui/components': minor
'@web3-ui/hooks': minor
---

!! BREAKING CHANGE !!
`ethers` has been moved to peer dependencies for both the `components` and `hooks` packages. (It was already a peer dependency for `core`)

This means that you will users will now have to install `ethers` along side our packages manually.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# web3-ui

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-29-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

_In Development 🏗️_
Expand All @@ -19,7 +21,7 @@ A library of UI components specifically crafted for web3 use cases.
1. Install the package

```bash
$ yarn add @web3-ui/core
$ yarn add @web3-ui/core ethers
```

2. Setup the Provider
Expand Down
2 changes: 1 addition & 1 deletion packages/components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A set of React components made for web3-specific use cases. Fully compatible with and built on top of ChakraUI.

```bash
yarn add @web3-ui/components
yarn add @web3-ui/components ethers
```

## Getting started
Expand Down
4 changes: 2 additions & 2 deletions packages/components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@
"@chakra-ui/react": "^1.7.2",
"@emotion/react": "^11",
"@emotion/styled": "^11",
"ethers": "^5.5.2",
"framer-motion": "^4"
},
"peerDependencies": {
"react": "*",
"react-dom": "*"
"react-dom": "*",
"ethers": "^5.5.2"
},
"devDependencies": {
"@web3-ui/hooks": "^0.10.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A set of React hooks developed for web3 use cases.

```bash
yarn add @web3-ui/hooks
yarn add @web3-ui/hooks ethers
```

## Getting started
Expand Down
4 changes: 2 additions & 2 deletions packages/hooks/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@
"dependencies": {
"@babel/runtime": "^7.16.7",
"@walletconnect/web3-provider": "^1.6.6",
"ethers": "^5.5.1",
"web3modal": "^1.9.4"
},
"peerDependencies": {
"react": ">=16.8.0",
"react-dom": ">=16.8.0"
"react-dom": ">=16.8.0",
"ethers": "^5.5.1"
},
"devDependencies": {
"@portis/web3": "^4.0.6",
Expand Down