generated from web3/web3.js-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* chore: update links after repo rename * chore: release 0.1.0-rc.1 * chore: after release improvements
- Loading branch information
Showing
8 changed files
with
143 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
<!-- EXAMPLE | ||
## [1.0.0] | ||
### Added | ||
- I've added feature XY (#1000) | ||
### Changed | ||
- I've cleaned up XY (#1000) | ||
### Deprecated | ||
- I've deprecated XY (#1000) | ||
### Removed | ||
- I've removed XY (#1000) | ||
### Fixed | ||
- I've fixed XY (#1000) | ||
### Security | ||
- I've improved the security in XY (#1000) | ||
--> | ||
|
||
## [0.1.0-rc.1] | ||
|
||
### Added | ||
|
||
- **Initial Release**: This version includes support for the following wallet RPC methods: | ||
- `wallet_addEthereumChain` | ||
- `wallet_switchEthereumChain` | ||
- `wallet_watchAsset` | ||
- `wallet_requestPermissions` | ||
- `wallet_getPermissions` | ||
- `wallet_revokePermissions` | ||
|
||
## [Unreleased] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Release Process for Web3js Plugin | ||
|
||
### 1. Create a Release Branch | ||
|
||
```bash | ||
git checkout -b release/bumped-version | ||
``` | ||
|
||
### 2. Install Dependencies | ||
|
||
Ensure all dependencies are installed: | ||
|
||
```bash | ||
yarn | ||
``` | ||
|
||
### 3. Bump Version Number | ||
|
||
- **Note**: Skip this step for the first version. | ||
- For subsequent releases, update the version number in `package.json`. | ||
|
||
### 4. Build the Project | ||
|
||
```bash | ||
yarn build | ||
``` | ||
|
||
### 5. Update the Changelog | ||
|
||
- Move items from under `## [Unreleased]` to the new release version (e.g., `## [0.1.0]`). | ||
- Add a new `## [Unreleased]` section at the end of the file. | ||
|
||
### 6. Create a Tag | ||
|
||
```bash | ||
git tag bumped-version | ||
``` | ||
|
||
### 7. Push Branch and Tag to Repository | ||
|
||
```bash | ||
git push origin release/bumped-version | ||
git push origin --tags | ||
``` | ||
|
||
### 8. Create a Pull Request | ||
|
||
- Create a PR to merge `release/bumped-version` into the `main` branch. | ||
- Wait for all tests to pass. | ||
|
||
### 9. Publish on GitHub | ||
|
||
- Navigate to [GitHub Releases](https://github.com/web3/web3-plugin-wallet-rpc/releases/new). | ||
- Select the recently pushed tag. | ||
- Add a release title and notes. | ||
- Check "pre-release" if it’s an alpha, beta, RC, or dev release. | ||
- Check “Create discussion for this release”. | ||
- Click the **Publish** button. | ||
|
||
### 10. Publish on npm | ||
|
||
```bash | ||
cd packages/web3-plugin-wallet-rpc | ||
|
||
npm login | ||
npm publish --dry-run # check what will be published | ||
npm publish | ||
npm logout | ||
``` | ||
|
||
### 11. Merge Back the PR | ||
|
||
- Merge the PR created in step 8 back into the `main` branch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,19 @@ | ||
{ | ||
"name": "web3-plugin-wallet-rpc", | ||
"name": "web3-plugin-wallet-workspace", | ||
"private": true, | ||
"version": "1.0.0", | ||
"version": "0.1.0", | ||
"description": "Web3.js plugin to add support for wallet-related RPC methods", | ||
"homepage": "https://github.com/web3/web3-wallet-rpc-utils#readme", | ||
"homepage": "https://github.com/web3/web3-plugin-wallet-rpc#readme", | ||
"bugs": { | ||
"url": "https://github.com/web3/web3-wallet-rpc-utils/issues" | ||
"url": "https://github.com/web3/web3-plugin-wallet-rpc/issues" | ||
}, | ||
"contributors": [ | ||
"ChainSafe <[email protected]>" | ||
], | ||
"license": "MIT", | ||
"repository": { | ||
"type": "git", | ||
"url": "[email protected]:web3/web3-wallet-rpc-utils.git" | ||
"url": "git+ssh://git@github.com/web3/web3-plugin-wallet-rpc.git" | ||
}, | ||
"workspaces": [ | ||
"packages/example-react-app", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,8 @@ | |
.prettierignore | ||
*.log | ||
|
||
node_modules/ | ||
docs/ | ||
coverage/ | ||
benchmark/ | ||
.coverage/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Web3.js Plugin for Wallet RPC methods | ||
|
||
Refer to the [README](../../README.md) file located in the root of this repository. | ||
Refer to the [README](https://github.com/web3/web3-plugin-wallet-rpc/blob/main/README.md) file located in the root of this repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
{ | ||
"name": "web3-plugin-wallet-rpc", | ||
"version": "1.0.0", | ||
"version": "0.1.0-rc.1", | ||
"description": "Web3.js plugin to add support for wallet-related RPC methods", | ||
"main": "lib/index.js", | ||
"types": "lib/index.d.ts", | ||
"homepage": "https://github.com/web3/web3-wallet-rpc-utils#readme", | ||
"homepage": "https://github.com/web3/web3-plugin-wallet-rpc#readme", | ||
"bugs": { | ||
"url": "https://github.com/web3/web3-wallet-rpc-utils/issues" | ||
"url": "https://github.com/web3/web3-plugin-wallet-rpc/issues" | ||
}, | ||
"scripts": { | ||
"lint": "eslint '{src,test}/**/*.ts'", | ||
|
@@ -20,7 +20,7 @@ | |
"license": "MIT", | ||
"repository": { | ||
"type": "git", | ||
"url": "[email protected]:web3/web3-wallet-rpc-utils.git" | ||
"url": "git+ssh://git@github.com/web3/web3-plugin-wallet-rpc.git" | ||
}, | ||
"devDependencies": { | ||
"@chainsafe/eslint-config": "^2.0.0", | ||
|