@babylonlabs-io/wallet-connector 1.0.19 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -9
- package/package.json +8 -3
package/README.md
CHANGED
|
@@ -24,9 +24,9 @@
|
|
|
24
24
|
|
|
25
25
|
The Babylon Wallet Connector repository provides the wallet connection component
|
|
26
26
|
used in the Babylon Staking Dashboard. This component enables the connection of
|
|
27
|
-
both Bitcoin and Babylon chain wallets.
|
|
27
|
+
both Bitcoin and Babylon Genesis chain wallets.
|
|
28
28
|
|
|
29
|
-
## Key Features
|
|
29
|
+
## 🔑 Key Features
|
|
30
30
|
|
|
31
31
|
- Unified interfaces for Bitcoin and Babylon wallet connections
|
|
32
32
|
- Support for browser extension wallets
|
|
@@ -34,7 +34,7 @@ both Bitcoin and Babylon chain wallets.
|
|
|
34
34
|
- Mobile wallet compatibility through injectable interfaces
|
|
35
35
|
- Tomo Connect integration for broader wallet ecosystem
|
|
36
36
|
|
|
37
|
-
## Overview
|
|
37
|
+
## 🧐 Overview
|
|
38
38
|
|
|
39
39
|
The Babylon Wallet Connector provides a unified interface for integrating both
|
|
40
40
|
Bitcoin and Babylon wallets into Babylon dApp. It supports both native wallet
|
|
@@ -44,25 +44,53 @@ The main architectural difference is that native wallets are built into the
|
|
|
44
44
|
library, while injectable wallets can be dynamically added by injecting their
|
|
45
45
|
implementation into the webpage's `window` object before the dApp loads.
|
|
46
46
|
|
|
47
|
-
## Installation
|
|
47
|
+
## 👨🏻💻 Installation
|
|
48
48
|
|
|
49
49
|
```bash
|
|
50
50
|
npm i @babylonlabs-io/wallet-connect
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
##
|
|
53
|
+
## 📝 Commit Format & Automated Releases
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
This project uses [**Conventional Commits**](https://www.conventionalcommits.org/en/v1.0.0/)
|
|
56
|
+
and [**semantic-release**](https://semantic-release.gitbook.io/) to automate
|
|
57
|
+
versioning, changelog generation, and npm publishing.
|
|
56
58
|
|
|
57
|
-
|
|
59
|
+
### ✅ How It Works
|
|
58
60
|
|
|
59
|
-
|
|
61
|
+
1. All commits must follow the **Conventional Commits** format.
|
|
62
|
+
2. When changes are merged into the `main` branch:
|
|
63
|
+
- `semantic-release` analyzes commit messages
|
|
64
|
+
- Determines the appropriate semantic version bump (`major`, `minor`, `patch`)
|
|
65
|
+
- Tags the release in Git with release change log
|
|
66
|
+
- Publishes the new version to npm
|
|
67
|
+
|
|
68
|
+
### 🧱 Commit Message Examples
|
|
69
|
+
|
|
70
|
+
```console
|
|
71
|
+
feat: add support for slashing script
|
|
72
|
+
fix: handle invalid staking tx gracefully
|
|
73
|
+
docs: update README with commit conventions
|
|
74
|
+
refactor!: remove deprecated method and cleanup types
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
> **Note:** For breaking changes, add a `!` after the type (
|
|
78
|
+
> e.g. `feat!:` or `refactor!:`) and include a description of the breaking
|
|
79
|
+
> change in the commit body.
|
|
80
|
+
|
|
81
|
+
### 🚀 Releasing
|
|
82
|
+
|
|
83
|
+
Just commit your changes using the proper format and merge to `main`.
|
|
84
|
+
The CI pipeline will handle versioning and releasing automatically — no manual
|
|
85
|
+
tagging or version bumps needed.
|
|
86
|
+
|
|
87
|
+
## 📖 Storybook
|
|
60
88
|
|
|
61
89
|
```bash
|
|
62
90
|
npm run dev
|
|
63
91
|
```
|
|
64
92
|
|
|
65
|
-
## Wallet Integration
|
|
93
|
+
## 💳 Wallet Integration
|
|
66
94
|
|
|
67
95
|
> ⚠️ **IMPORTANT**: Breaking changes to the wallet methods used by the Babylon
|
|
68
96
|
> web application are likely to cause incompatibility with it or lead to
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@babylonlabs-io/wallet-connector",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"publishConfig": {
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
"dist"
|
|
60
60
|
],
|
|
61
61
|
"peerDependencies": {
|
|
62
|
-
"@babylonlabs-io/btc-staking-ts": "1.0.
|
|
62
|
+
"@babylonlabs-io/btc-staking-ts": "1.0.6",
|
|
63
63
|
"@babylonlabs-io/core-ui": "1.0.1",
|
|
64
64
|
"bitcoinjs-lib": "6.1.5",
|
|
65
65
|
"react": "^18.3.1",
|
|
@@ -69,8 +69,12 @@
|
|
|
69
69
|
"devDependencies": {
|
|
70
70
|
"@changesets/cli": "^2.27.9",
|
|
71
71
|
"@chromatic-com/storybook": "^3.2.2",
|
|
72
|
+
"@commitlint/cli": "^19.8.0",
|
|
73
|
+
"@commitlint/config-conventional": "^19.8.0",
|
|
72
74
|
"@eslint/js": "^9.13.0",
|
|
73
75
|
"@playwright/test": "^1.49.1",
|
|
76
|
+
"@semantic-release/github": "^11.0.2",
|
|
77
|
+
"@semantic-release/npm": "^12.0.1",
|
|
74
78
|
"@storybook/addon-essentials": "^8.4.2",
|
|
75
79
|
"@storybook/addon-interactions": "^8.4.2",
|
|
76
80
|
"@storybook/blocks": "^8.4.2",
|
|
@@ -97,6 +101,7 @@
|
|
|
97
101
|
"prettier": "^3.3.3",
|
|
98
102
|
"prettier-plugin-organize-imports": "^4.1.0",
|
|
99
103
|
"prettier-plugin-tailwindcss": "^0.6.8",
|
|
104
|
+
"semantic-release": "^24.2.3",
|
|
100
105
|
"storybook": "^8.4.2",
|
|
101
106
|
"storybook-dark-mode": "^4.0.2",
|
|
102
107
|
"tailwindcss": "^3.4.14",
|
|
@@ -118,4 +123,4 @@
|
|
|
118
123
|
"plugin:storybook/recommended"
|
|
119
124
|
]
|
|
120
125
|
}
|
|
121
|
-
}
|
|
126
|
+
}
|