https://github.com/kaonone/web3-wallets-kit
Package for connecting with Ethereum wallets for dApp
https://github.com/kaonone/web3-wallets-kit
Last synced: about 1 month ago
JSON representation
Package for connecting with Ethereum wallets for dApp
- Host: GitHub
- URL: https://github.com/kaonone/web3-wallets-kit
- Owner: kaonone
- License: mit
- Created: 2019-11-11T07:51:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:05:55.000Z (over 2 years ago)
- Last Synced: 2025-04-12T21:05:45.929Z (about 2 months ago)
- Language: TypeScript
- Size: 2.42 MB
- Stars: 35
- Watchers: 4
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Web3 Wallets Kit [](http://commitizen.github.io/cz-cli/)
This kit will help connect you dApp to different Ethereum wallets, e.g. Metamask. With web3-wallets-kit, you can create Web3WalletsManager and connect your dApp to the wallet of your choice using one of the supported wallet integrations.
## Wallet integrations:
| Wallet | Integration Package |Size |
|----|----|----|
|Inpage (Extensions like [Metamask](https://metamask.io/) or Web3 browsers like [Cipher](https://www.cipherbrowser.com/))|[`@web3-wallets-kit/inpage-connector`](./packages/inpage-connector)|[](https://bundlephobia.com/result?p=@web3-wallets-kit/inpage-connector@latest)|
[WalletConnect](https://walletconnect.org/)|[`@web3-wallets-kit/connect-wallet-connector`](./packages/connect-wallet-connector)|[](https://bundlephobia.com/result?p=@web3-wallets-kit/connect-wallet-connector@latest)|
[Bitsky](https://www.bitski.com/)|[`@web3-wallets-kit/bitski-connector`](./packages/bitski-connector)|[](https://bundlephobia.com/result?p=@web3-wallets-kit/bitski-connector@latest)|
[Fortmatic](https://fortmatic.com/)|[`@web3-wallets-kit/fortmatic-connector`](./packages/fortmatic-connector)|[](https://bundlephobia.com/result?p=@web3-wallets-kit/fortmatic-connector@latest)|
[Portis](https://www.portis.io/)|[`@web3-wallets-kit/portis-connector`](./packages/portis-connector)|[](https://bundlephobia.com/result?p=@web3-wallets-kit/portis-connector@latest)|
[Squarelink](https://squarelink.com/)|[`@web3-wallets-kit/squarelink-connector`](./packages/squarelink-connector)|[](https://bundlephobia.com/result?p=@web3-wallets-kit/squarelink-connector@latest)|
[Torus](https://tor.us/)|[`@web3-wallets-kit/torus-connector`](./packages/torus-connector)|[](https://bundlephobia.com/result?p=@web3-wallets-kit/torus-connector@latest)|
[Ledger](https://www.ledger.com/)|Coming soon||
## Installation
`npm install --save @web3-wallets-kit/core`
`npm install --save @web3-wallets-kit/inpage-connector` or another integration
## Creating and managing wallets
```typescript
import Web3 from 'web3';
import { Web3WalletsManager } from '@web3-wallets-kit/core';
import { InpageConnector } from '@web3-wallets-kit/inpage-connector';
// Create Web3WalletsManager instance
const web3Manager = new Web3WalletsManager({
defaultProvider: {
network: 'kovan',
infuraAccessToken: 'INFURA_API_KEY',
},
makeWeb3: provider => new Web3(provider), // you can use web3.js, ethers.js or another suitable library
});
// Create connector
const connector = new InpageConnector();
// Connect to wallet
await web3Manager.connect(connector);
// Get address and Web3 for sending transaction
const myAddress = web3Manager.account.value;
const txWeb3 = web3Manager.txWeb3.value;
// Create contract
const daiContract = txWeb3.eth.Contract(DAI_ABI, '0x5592ec0cfb4dbc12d3ab100b257153436a1f0fea');
// Send transaction
await daiContract.methods
.transfer('0x0000000000000000000000000000000000000000', '1000000000000000000')
.send({ from: myAddress });
```
## Web3WalletsManager API
```typescript
class Web3WalletsManager {
/** default Web3 instance for reading. Uses a provider created based on defaultProvider options */
web3: W;
/** Web3 instance for sending transactions. An instance is created after connecting to the wallet and uses the wallet provider */
txWeb3: BehaviorSubject;
/** active account address */
account: BehaviorSubject;
/** active network ID */
chainId: BehaviorSubject;
/** status of the connection */
status: BehaviorSubject;
constructor(options: Options);
/** Connect to wallet; Returns account address and Web3 Instance for sending transactions */
connect(connector: Connector): Promise;
/** Disconnect wallet, close streams */
disconnect(): Promise;
}
interface Options {
defaultProvider: {
httpRpcUrl?: string;
wsRpcUrl?: string;
infuraAccessToken?: string;
/** default: 'mainnet' */
network?: InfuraNetwork;
};
makeWeb3(provider: Provider): W;
}
```