@xchainjs/xchain-wallet 2.0.16 → 2.0.18

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.
Files changed (2) hide show
  1. package/README.md +47 -7
  2. package/package.json +12 -12
package/README.md CHANGED
@@ -1,17 +1,57 @@
1
- # `@xchainjs/xchain-wallet`
1
+ <div align="center">
2
+ <h1 align="center">XChain Wallet</h1>
2
3
 
3
- XChainJS client wrapper to work with several XChainJS client at a time
4
+ <p align="center">
5
+ <a href='https://www.npmjs.com/package/@xchainjs/xchain-wallet' target='_blank'>
6
+ <img alt="NPM Version" src="https://img.shields.io/npm/v/%40xchainjs%2Fxchain-wallet" />
7
+ </a>
8
+ <a href='https://www.npmjs.com/package/@xchainjs/xchain-wallet' target='_blank'>
9
+ <img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/%40xchainjs%2Fxchain-wallet" />
10
+ </a>
11
+ </p>
12
+ </div>
4
13
 
5
- ## Install
14
+ <br />
6
15
 
7
- ```bash
16
+ Multi-chain wallet wrapper that allows you to work with multiple XChainJS clients simultaneously. Provides a unified interface for managing assets across different blockchain networks.
17
+
18
+ ## Modules
19
+
20
+ - `wallet` - Main wallet class for multi-chain asset management
21
+ - `types` - TypeScript type definitions for wallet operations
22
+
23
+ ## Installation
24
+
25
+ ```sh
8
26
  yarn add @xchainjs/xchain-wallet
9
27
  ```
10
28
 
11
- ## Examples
29
+ or
30
+
31
+ ```sh
32
+ npm install @xchainjs/xchain-wallet
33
+ ```
12
34
 
13
- To see an example, go to the wallet example of the examples folder of the repository
35
+ Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-wallet`.
36
+
37
+ ```sh
38
+ yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util
39
+ ```
14
40
 
15
41
  ## Documentation
16
42
 
17
- To be done
43
+ ### [`xchain wallet`](http://docs.xchainjs.org/xchain-wallet/)
44
+
45
+ [`How xchain-wallet works`](http://docs.xchainjs.org/xchain-wallet/how-it-works.html)\
46
+ [`How to use xchain-wallet`](http://docs.xchainjs.org/xchain-wallet/how-to-use.html)
47
+
48
+ ## Features
49
+
50
+ - **Multi-Chain Support**: Manage assets across all supported blockchains
51
+ - **Unified Interface**: Single wallet instance for multiple clients
52
+ - **Balance Aggregation**: View balances across all connected chains
53
+ - **Transaction Management**: Send and receive across different networks
54
+
55
+ ## Examples
56
+
57
+ You can find examples using the Wallet package in the [wallet](https://github.com/xchainjs/xchainjs-lib/tree/master/examples/wallet) examples folder.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@xchainjs/xchain-wallet",
3
3
  "description": "XChainjs clients wrapper to work with several chains at the same time",
4
- "version": "2.0.16",
4
+ "version": "2.0.18",
5
5
  "license": "MIT",
6
6
  "main": "lib/index.js",
7
7
  "module": "lib/index.esm.js",
@@ -29,19 +29,19 @@
29
29
  "directory": "release/package"
30
30
  },
31
31
  "dependencies": {
32
- "@xchainjs/xchain-client": "2.0.8",
33
- "@xchainjs/xchain-evm": "2.0.11",
34
- "@xchainjs/xchain-mayachain": "4.0.0",
35
- "@xchainjs/xchain-radix": "2.0.8",
36
- "@xchainjs/xchain-thorchain": "3.0.12",
37
- "@xchainjs/xchain-util": "2.0.4",
38
- "@xchainjs/xchain-utxo": "2.0.8",
39
- "bignumber.js": "^9.0.0",
32
+ "@xchainjs/xchain-client": "2.0.9",
33
+ "@xchainjs/xchain-evm": "2.0.12",
34
+ "@xchainjs/xchain-mayachain": "4.1.0",
35
+ "@xchainjs/xchain-radix": "2.0.9",
36
+ "@xchainjs/xchain-thorchain": "3.0.13",
37
+ "@xchainjs/xchain-util": "2.0.5",
38
+ "@xchainjs/xchain-utxo": "2.0.9",
39
+ "bignumber.js": "^9.1.2",
40
40
  "ethers": "^6.14.3"
41
41
  },
42
42
  "devDependencies": {
43
- "@xchainjs/xchain-bitcoin": "2.0.8",
44
- "@xchainjs/xchain-bitcoincash": "2.0.9",
45
- "@xchainjs/xchain-ethereum": "2.0.12"
43
+ "@xchainjs/xchain-bitcoin": "2.0.9",
44
+ "@xchainjs/xchain-bitcoincash": "2.0.10",
45
+ "@xchainjs/xchain-ethereum": "2.0.13"
46
46
  }
47
47
  }