Ether-SWR

Ether-SWR is a React hook that fetches Ethereum data, streamlines the chores to keep the internal state of Decentralized App (DApp) and optimize the RPC calls to an Ethereum node.
It does so with a declarative approach via an opinionated wrapper of SWR.

Ether-SWR follows the stale-while-revalidate (HTTP RFC 5861) concept: first it returns the data from cache (stale), then send the fetch request on chain, and finally come with the up-to-date data.

In case the same request is defined multiple times on the same rendered component tree only one request is made because SWR deduping process.


Installation

yarn add ether-swr

or

npm install --save ether-swr

API

$3

``typescript
const { data: balance } = useEtherSWR(['getBalance', 'latest'])
`

You can use all the methods provided by a Web3Provider from [Ether.js]()

$3

`typescript
const { data: balance } = useEtherSWR([
'0x6b175474e89094c44da98b954eedeac495271d0f', // DAI contract
'balanceOf', // Method
'0x5d3a536e4d6dbd6114cc1ead35777bab948e3643' // holder
])
`

$3

`typescript
const { data: balances } = useEtherSWR([
[
'0x6b175474e89094c44da98b954eedeac495271d0f', // DAI contract
'balanceOf', // Method
'0x5d3a536e4d6dbd6114cc1ead35777bab948e3643' // holder 1
],
[
'0x6b175474e89094c44da98b954eedeac495271d0f', // DAI contract
'balanceOf', // Method
'0x5d3a536e4d6dbd6114cc1ead35777bab948e3643' // holder 2
]
])
`

You can use all the methods provided by a contract as long as you have provided the ABI associated to the smart contract

$3

Subscribe to a topic refresh automatically the underline data once it's dispatched

`typescript
const { data: balance, mutate } = useEtherSWR([address, 'balanceOf', account], {
subscribe: [
// A filter from anyone to me
{
name: 'Transfer',
topics: [null, account]
},
// A filter from me to anyone
{
name: 'Transfer',
topics: [account, null]
}
]
})

return (


`typescript
const { data: balance, mutate } = useEtherSWR([address, 'balanceOf', account], {
subscribe: [
// A filter from anyone to me
{
name: 'Transfer',
topics: [null, account],
on: (
data: BigNumber,
fromAddress: string,
toAddress: string,
amount: BigNumber,
event: any
) => {
console.log('receive', { event })
const update = data.add(amount)
mutate(update, false) // optimistic update skip re-fetch
}
},
// A filter from me to anyone
{
name: 'Transfer',
topics: [account, null],
on: (
data: BigNumber,
fromAddress: string,
toAddress: string,
amount: BigNumber,
event: any
) => {
console.log('send', { event })
const update = data.sub(amount)
mutate(update, false) // optimistic update skip re-fetch
}
}
]
})

return (


You can use EthSWRConfig to have a global fetcher capable of retrieving basic Ethereum information (e.g. block, getBalance)
or directly interact with a smart contract mapped to its ABI.
To keep the state fresh you can pass refreshInterval: 30000 to the value object so that behind the scene Ether-SWR will refresh every 30 seconds the data of all the keys mounted in the tree components.

`js
import React from 'react'
import { Web3ReactProvider, useWeb3React } from '@web3-react/core'
import { Web3Provider } from '@ethersproject/providers'
import { InjectedConnector } from '@web3-react/injected-connector'
import { BigNumber } from 'ethers'
import { formatEther, formatUnits } from '@ethersproject/units'
import useEtherSWR, { EthSWRConfig } from 'ether-swr'
import ERC20ABI from './ERC20.abi.json'

const ABIs = [
['0x6b175474e89094c44da98b954eedeac495271d0f', ERC20ABI]
]

const EthBalance = () => {
const { account } = useWeb3React()
const { data: balance } = useEtherSWR(['getBalance', account, 'latest'])

if (!balance) {
return

`typescript
import { useBalanceOf } from 'ether-swr'

const { account } = useWeb3React()
const { data: balances } = useBalanceOf(
[
'0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
'0x6B175474E89094C44Da98b954EedeAC495271d0F'
],
account
)
`

$3

It retrieves Ether balance.
You can either pass one or multiple owners

`typescript
import { useBalance } from 'ether-swr'

const { account } = useWeb3React()
const { data: balances } = useBalance(
[
'0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
'0x6B175474E89094C44Da98b954EedeAC495271d0F'
],
account
)
``

Related projects

- SWR
- Ether.js
- web3-react
- Ethereum JSON-RPC Spec

Licence

Licensed under MIT.