Skip to content

Commit 51cca21

Browse files
authored
chore: release 0.1.0-rc.1 (#22)
* chore: update links after repo rename * chore: release 0.1.0-rc.1 * chore: after release improvements
1 parent 4ab50e5 commit 51cca21

File tree

8 files changed

+143
-18
lines changed

8 files changed

+143
-18
lines changed

CHANGELOG.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
<!-- EXAMPLE
9+
10+
## [1.0.0]
11+
12+
### Added
13+
14+
- I've added feature XY (#1000)
15+
16+
### Changed
17+
18+
- I've cleaned up XY (#1000)
19+
20+
### Deprecated
21+
22+
- I've deprecated XY (#1000)
23+
24+
### Removed
25+
26+
- I've removed XY (#1000)
27+
28+
### Fixed
29+
30+
- I've fixed XY (#1000)
31+
32+
### Security
33+
34+
- I've improved the security in XY (#1000)
35+
36+
-->
37+
38+
## [0.1.0-rc.1]
39+
40+
### Added
41+
42+
- **Initial Release**: This version includes support for the following wallet RPC methods:
43+
- `wallet_addEthereumChain`
44+
- `wallet_switchEthereumChain`
45+
- `wallet_watchAsset`
46+
- `wallet_requestPermissions`
47+
- `wallet_getPermissions`
48+
- `wallet_revokePermissions`
49+
50+
## [Unreleased]

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ web3.registerPlugin(new WalletRpcPlugin());
4343

4444
Click on the method name for detailed documentation.
4545

46-
#### [addEthereumChain](https://web3.github.io/web3-wallet-rpc-utils/classes/WalletRpcPlugin.html#addEthereumChain)
46+
#### [addEthereumChain](https://web3.github.io/web3-plugin-wallet-rpc/classes/WalletRpcPlugin.html#addEthereumChain)
4747

4848
Invokes the `wallet_addEthereumChain` method as defined in [EIP-3085](https://eips.ethereum.org/EIPS/eip-3085#wallet_addethereumchain).
4949

@@ -62,15 +62,15 @@ await web3.walletRpc.addEthereumChain({
6262
});
6363
```
6464

65-
#### [switchEthereumChain](https://web3.github.io/web3-wallet-rpc-utils/classes/WalletRpcPlugin.html#switchEthereumChain)
65+
#### [switchEthereumChain](https://web3.github.io/web3-plugin-wallet-rpc/classes/WalletRpcPlugin.html#switchEthereumChain)
6666

6767
Invokes the `wallet_switchEthereumChain` method as defined in [EIP-3326](https://eips.ethereum.org/EIPS/eip-3326#wallet_switchethereumchain).
6868

6969
```typescript
7070
await web3.walletRpc.switchEthereumChain(5000);
7171
```
7272

73-
#### [watchAsset](https://web3.github.io/web3-wallet-rpc-utils/classes/WalletRpcPlugin.html#watchAsset)
73+
#### [watchAsset](https://web3.github.io/web3-plugin-wallet-rpc/classes/WalletRpcPlugin.html#watchAsset)
7474

7575
Invokes the `wallet_watchAsset` method as defined in [EIP-747](https://eips.ethereum.org/EIPS/eip-747#specification).
7676

@@ -84,7 +84,7 @@ await web3.walletRpc.watchAsset({
8484
});
8585
```
8686

87-
#### [requestPermissions](https://web3.github.io/web3-wallet-rpc-utils/classes/WalletRpcPlugin.html#requestPermissions)
87+
#### [requestPermissions](https://web3.github.io/web3-plugin-wallet-rpc/classes/WalletRpcPlugin.html#requestPermissions)
8888

8989
Invokes the `wallet_requestPermissions` method as defined in [EIP-2255](https://eips.ethereum.org/EIPS/eip-2255#specification).
9090

@@ -94,15 +94,15 @@ const permissions = await web3.walletRpc.requestPermissions({
9494
});
9595
```
9696

97-
#### [getPermissions](https://web3.github.io/web3-wallet-rpc-utils/classes/WalletRpcPlugin.html#getPermissions)
97+
#### [getPermissions](https://web3.github.io/web3-plugin-wallet-rpc/classes/WalletRpcPlugin.html#getPermissions)
9898

9999
Invokes the `wallet_getPermissions` method as defined in [EIP-2255](https://eips.ethereum.org/EIPS/eip-2255#specification).
100100

101101
```typescript
102102
const permissions = await web3.walletRpc.getPermissions();
103103
```
104104

105-
#### [revokePermissions](https://web3.github.io/web3-wallet-rpc-utils/classes/WalletRpcPlugin.html#revokePermissions)
105+
#### [revokePermissions](https://web3.github.io/web3-plugin-wallet-rpc/classes/WalletRpcPlugin.html#revokePermissions)
106106

107107
Invokes the `wallet_revokePermissions` method as defined in [MetaMask docs](https://docs.metamask.io/wallet/reference/json-rpc-methods/wallet_revokepermissions/).
108108

@@ -114,7 +114,7 @@ const permissions = await web3.walletRpc.revokePermissions({
114114

115115
## Contributing
116116

117-
We welcome pull requests! For major changes, please [open an issue](https://github.com/web3/web3-wallet-rpc-utils) first to discuss the proposed modifications.
117+
We welcome pull requests! For major changes, please [open an issue](https://github.com/web3/web3-plugin-wallet-rpc) first to discuss the proposed modifications.
118118
Also, ensure that you update tests as needed to reflect the changes.
119119

120120
## License

RELEASE.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Release Process for Web3js Plugin
2+
3+
### 1. Create a Release Branch
4+
5+
```bash
6+
git checkout -b release/bumped-version
7+
```
8+
9+
### 2. Install Dependencies
10+
11+
Ensure all dependencies are installed:
12+
13+
```bash
14+
yarn
15+
```
16+
17+
### 3. Bump Version Number
18+
19+
- **Note**: Skip this step for the first version.
20+
- For subsequent releases, update the version number in `package.json`.
21+
22+
### 4. Build the Project
23+
24+
```bash
25+
yarn build
26+
```
27+
28+
### 5. Update the Changelog
29+
30+
- Move items from under `## [Unreleased]` to the new release version (e.g., `## [0.1.0]`).
31+
- Add a new `## [Unreleased]` section at the end of the file.
32+
33+
### 6. Create a Tag
34+
35+
```bash
36+
git tag bumped-version
37+
```
38+
39+
### 7. Push Branch and Tag to Repository
40+
41+
```bash
42+
git push origin release/bumped-version
43+
git push origin --tags
44+
```
45+
46+
### 8. Create a Pull Request
47+
48+
- Create a PR to merge `release/bumped-version` into the `main` branch.
49+
- Wait for all tests to pass.
50+
51+
### 9. Publish on GitHub
52+
53+
- Navigate to [GitHub Releases](https://github.com/web3/web3-plugin-wallet-rpc/releases/new).
54+
- Select the recently pushed tag.
55+
- Add a release title and notes.
56+
- Check "pre-release" if it’s an alpha, beta, RC, or dev release.
57+
- Check “Create discussion for this release”.
58+
- Click the **Publish** button.
59+
60+
### 10. Publish on npm
61+
62+
```bash
63+
cd packages/web3-plugin-wallet-rpc
64+
65+
npm login
66+
npm publish --dry-run # check what will be published
67+
npm publish
68+
npm logout
69+
```
70+
71+
### 11. Merge Back the PR
72+
73+
- Merge the PR created in step 8 back into the `main` branch.

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
{
2-
"name": "web3-plugin-wallet-rpc",
2+
"name": "web3-plugin-wallet-workspace",
33
"private": true,
4-
"version": "1.0.0",
4+
"version": "0.1.0",
55
"description": "Web3.js plugin to add support for wallet-related RPC methods",
6-
"homepage": "https://github.com/web3/web3-wallet-rpc-utils#readme",
6+
"homepage": "https://github.com/web3/web3-plugin-wallet-rpc#readme",
77
"bugs": {
8-
"url": "https://github.com/web3/web3-wallet-rpc-utils/issues"
8+
"url": "https://github.com/web3/web3-plugin-wallet-rpc/issues"
99
},
1010
"contributors": [
1111
"ChainSafe <info@chainsafe.io>"
1212
],
1313
"license": "MIT",
1414
"repository": {
1515
"type": "git",
16-
"url": "git@github.com:web3/web3-wallet-rpc-utils.git"
16+
"url": "git+ssh://git@github.com/web3/web3-plugin-wallet-rpc.git"
1717
},
1818
"workspaces": [
1919
"packages/example-react-app",

packages/example-react-app/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"react-dom": "^18.3.1",
1313
"uuid": "^10.0.0",
1414
"web3": "^4.14.0",
15-
"web3-plugin-wallet-rpc": "*"
15+
"web3-plugin-wallet-rpc": "0.1.0-rc.1"
1616
},
1717
"devDependencies": {
1818
"@chainsafe/eslint-config": "^2.0.0",

packages/web3-plugin-wallet-rpc/.npmignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
.prettierignore
1111
*.log
1212

13+
node_modules/
14+
docs/
1315
coverage/
1416
benchmark/
1517
.coverage/
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Web3.js Plugin for Wallet RPC methods
22

3-
Refer to the [README](../../README.md) file located in the root of this repository.
3+
Refer to the [README](https://github.com/web3/web3-plugin-wallet-rpc/blob/main/README.md) file located in the root of this repository.

packages/web3-plugin-wallet-rpc/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
22
"name": "web3-plugin-wallet-rpc",
3-
"version": "1.0.0",
3+
"version": "0.1.0-rc.1",
44
"description": "Web3.js plugin to add support for wallet-related RPC methods",
55
"main": "lib/index.js",
66
"types": "lib/index.d.ts",
7-
"homepage": "https://github.com/web3/web3-wallet-rpc-utils#readme",
7+
"homepage": "https://github.com/web3/web3-plugin-wallet-rpc#readme",
88
"bugs": {
9-
"url": "https://github.com/web3/web3-wallet-rpc-utils/issues"
9+
"url": "https://github.com/web3/web3-plugin-wallet-rpc/issues"
1010
},
1111
"scripts": {
1212
"lint": "eslint '{src,test}/**/*.ts'",
@@ -20,7 +20,7 @@
2020
"license": "MIT",
2121
"repository": {
2222
"type": "git",
23-
"url": "git@github.com:web3/web3-wallet-rpc-utils.git"
23+
"url": "git+ssh://git@github.com/web3/web3-plugin-wallet-rpc.git"
2424
},
2525
"devDependencies": {
2626
"@chainsafe/eslint-config": "^2.0.0",

0 commit comments

Comments
 (0)