add fetchBalance

Author: kolirt

README.md

@@ -14,6 +14,7 @@ Simple WalletConnect v2 integration package for Vue3 apps.
 - [Usage](#usage)
     - [Connect wallet button](#connect-wallet-button)
     - [Multicall](#multicall)
+    - [FetchBalance](#fetchbalance)
     - [ReadContract](#readcontract)
     - [WriteContract](#writecontract)
     - [EstimateWriteContractGas](#estimatewritecontractgas)
@@ -106,6 +107,42 @@ let data = await multicall({
  */
 ```
 
+## FetchBalance
+```js
+import {fetchBalance} from '@kolirt/vue-web3-auth'
+
+let bnbBalance = await fetchBalance({
+  address: '0x2D4C407BBe49438ED859fe965b140dcF1aaB71a9'
+})
+
+/**
+ * Result in bnbBalance
+ *
+ * {
+ *  decimals: 18,
+ *  formatted: '1.908669631824871303',
+ *  symbol: 'BNB',
+ *  value: 1908669631824871303n
+ * }
+ */
+
+let tokenBalance = await fetchBalance({
+  address: '0x2D4C407BBe49438ED859fe965b140dcF1aaB71a9',
+  token: '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c'
+})
+
+/**
+ * Result in tokenBalance
+ *
+ * {
+ *  decimals: 18,
+ *  formatted: '0',
+ *  symbol: 'WBNB',
+ *  value: 0n
+ * }
+ */
+```
+
 ## ReadContract
 
 ```ts

lib/balance.ts

@@ -0,0 +1,12 @@
+import type {FetchBalance} from './types'
+import {fetchBalance as masterFetchBalance} from '@wagmi/core'
+import {chain} from './chain'
+
+export function fetchBalance(data: FetchBalance) {
+    return masterFetchBalance({
+        chainId: data.chainId || chain.value.id,
+        address: data.address,
+        token: data.token,
+        formatUnits: data.formatUnits
+    })
+}

lib/index.ts

@@ -24,6 +24,10 @@ export {
     chain
 } from './chain'
 
+export {
+    fetchBalance
+} from './balance'
+
 export {
     readContract,
     writeContract,

lib/types.ts

@@ -1,4 +1,4 @@
-import type {Chain} from '@wagmi/core'
+import type {Chain, Unit} from '@wagmi/core'
 import type {ThemeCtrlState} from '@web3modal/core'
 import type {EthereumClient} from '@web3modal/ethereum'
 import type {BlockTag} from 'viem/src/types/block'
@@ -83,4 +83,12 @@ export type WriteContract = {
     nonce?: number
     value?: bigint
     confirmations?: number
+}
+
+export type FetchBalance = {
+    chainId?: number
+    address: `0x${string}`
+    formatUnits?: Unit
+    token?: `0x${string}`
+
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kolirt/vue-web3-auth",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Web3 authentication for Vue3 apps based on WalletConnect v2",
   "author": "kolirt",
   "license": "MIT",