Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starc007/web3-wallet-connect
A simple package to connect wallet to your dapp
https://github.com/starc007/web3-wallet-connect
blockchain metamask walletconnect web3
Last synced: about 2 months ago
JSON representation
A simple package to connect wallet to your dapp
- Host: GitHub
- URL: https://github.com/starc007/web3-wallet-connect
- Owner: starc007
- License: mit
- Created: 2022-09-21T10:10:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T20:33:10.000Z (10 months ago)
- Last Synced: 2024-10-17T11:01:45.903Z (2 months ago)
- Topics: blockchain, metamask, walletconnect, web3
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@saura3h/web3-connect
- Size: 582 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
Web3 Wallet Connect v1.1.7
Easily Integrate web3 wallets in your Dapp
NPM Package
·
Report Bug
·
Request Feature
·
Example
## Installation
Install web3-wallet connect with npm
```jsx
npm i @saura3h/web3-connect
```
## Example Usage
### Import Wallet
```jsx
import {
useMetamask,
useWalletConnect,
useOkxWallet,
} from "@saura3h/web3-connect";
```
### Create wallet Object
```jsx
// for Metamask object
const connect = new useMetamask();
// for WalletConnect Object
// pass rpc url object.
const connect = new useWalletConnect({ rpc: rpcUrlObject });
//// for OkxWallet object
const connect = new useOkxWallet();
```
### Connect to Wallet
```jsx
//for Metamask
const wallet = await connect._connectMM();
//for WalletConnect
const wallet = await connect._connectWC();
// for OkxWallet
const wallet = await connect._connectOkx();
```
### Network Change
```jsx
// This fn accepts a callback function
connect.onNetworkChange(cb);
const cb = (chainId) => {
console.log(parseInt(chainId));
};
```
### Account Change
```jsx
// This fn accepts a callback function
connect.onAccountChange(cb);
const cb = (walletAddress) => {
console.log(walletAddress);
};
```
### Switch Network
```jsx
//chainId should be integer eg 1,137,56,etc
const _result = await connect._switchNetwork(chainId);
```
### Disconnect
```jsx
//FOR WALLETCONNECT
await connect._disconnectWC();
```
### Remove Listeners
```jsx
//FOR Metmask and OkxWallet
await connect.removeListeners();
```
### Provider
```jsx
// for metamask
const provider = connect.getProviderMM();
//for WalletConnect
const provider = connect.getProviderWC();
//for OkxWallet
const provider = connect.getProviderOkx();
```
### Sign Message
```jsx
// For signing the message]
const result = await connect._signMessage(message);
```
### Conncet Smart Contract
```jsx
import { useContract } from "@saura3h/web3-connect";
const contract = useContract(CONTRACT_ADDRESS, ABI, PROVIDER);
```
### import ethers
```jsx
import { ethers } from "@saura3h/web3-connect";
```
### Supported Wallets
- Metamask
- WalletConnect
- OkxWallet
- More coming soon
## 🍰 Contributing
Before Contributing please read [Contribute](Contribute.md)
## 💻 Built with
- Typescript
- Ether.js
## ❤️ Supporting the project
A simple star to this project repo is enough to keep me motivated on this project for days. If you find your self very much excited with this project let me know with a tweet.
Thanks!
or
## ➤ License
Distributed under the [MIT](LICENSE.txt) License. See [LICENSE](LICENSE.txt) for more information.
This readme was created with [readmi.xyz](https://readmi.xyz) ❤️