@saura3h/web3-connect
v1.1.7
Published
A simple package to connect your wallet to dapp
Downloads
31
Maintainers
Readme
Installation
Install web3-wallet connect with npm
npm i @saura3h/web3-connect
Example Usage
Import Wallet
import {
useMetamask,
useWalletConnect,
useOkxWallet,
} from "@saura3h/web3-connect";
Create wallet Object
// 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
//for Metamask
const wallet = await connect._connectMM();
//for WalletConnect
const wallet = await connect._connectWC();
// for OkxWallet
const wallet = await connect._connectOkx();
Network Change
// This fn accepts a callback function
connect.onNetworkChange(cb);
const cb = (chainId) => {
console.log(parseInt(chainId));
};
Account Change
// This fn accepts a callback function
connect.onAccountChange(cb);
const cb = (walletAddress) => {
console.log(walletAddress);
};
Switch Network
//chainId should be integer eg 1,137,56,etc
const _result = await connect._switchNetwork(chainId);
Disconnect
//FOR WALLETCONNECT
await connect._disconnectWC();
Remove Listeners
//FOR Metmask and OkxWallet
await connect.removeListeners();
Provider
// for metamask
const provider = connect.getProviderMM();
//for WalletConnect
const provider = connect.getProviderWC();
//for OkxWallet
const provider = connect.getProviderOkx();
Sign Message
// For signing the message]
const result = await connect._signMessage(message);
Conncet Smart Contract
import { useContract } from "@saura3h/web3-connect";
const contract = useContract(CONTRACT_ADDRESS, ABI, PROVIDER);
import ethers
import { ethers } from "@saura3h/web3-connect";
Supported Wallets
- Metamask
- WalletConnect
- OkxWallet
- More coming soon
🍰 Contributing
Before Contributing please read Contribute
💻 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. See LICENSE for more information.
This readme was created with readmi.xyz ❤️