From adf54d7d83f0c6071859ee42b99e2c0c1629f6d1 Mon Sep 17 00:00:00 2001
From: Tom Meagher <tom@meagher.co>
Date: Wed, 9 Aug 2023 16:11:21 -0400
Subject: [PATCH] feat: useAccountEffect

---
 README.md                                                   | 2 +-
 .../{useAccountState.test.ts => useAccountEffect.test.ts}   | 6 +++---
 .../src/hooks/{useAccountState.ts => useAccountEffect.ts}   | 6 +++---
 packages/react/src/index.ts                                 | 6 +++---
 playgrounds/vite-react/src/App.tsx                          | 4 ++--
 5 files changed, 12 insertions(+), 12 deletions(-)
 rename packages/react/src/hooks/{useAccountState.test.ts => useAccountEffect.test.ts} (91%)
 rename packages/react/src/hooks/{useAccountState.ts => useAccountEffect.ts} (88%)

diff --git a/README.md b/README.md
index fa8d91cf8e..27251dda3c 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,7 @@ For documentation and examples, visit [wagmi.sh](https://wagmi.sh).
 
 ## Contributing
 
-Check out the [Contributing docs][contributing] to get started.
+Check out the [Contributing Guide][contributing] to get started.
 
 ## Sponsors
 
diff --git a/packages/react/src/hooks/useAccountState.test.ts b/packages/react/src/hooks/useAccountEffect.test.ts
similarity index 91%
rename from packages/react/src/hooks/useAccountState.test.ts
rename to packages/react/src/hooks/useAccountEffect.test.ts
index c38ce62837..9dee50dea6 100644
--- a/packages/react/src/hooks/useAccountState.test.ts
+++ b/packages/react/src/hooks/useAccountEffect.test.ts
@@ -4,7 +4,7 @@ import { createWrapper, renderHook, waitFor } from '@wagmi/test/react'
 import { expect, test, vi } from 'vitest'
 
 import { WagmiProvider } from '../context.js'
-import { useAccountState } from './useAccountState.js'
+import { useAccountEffect } from './useAccountEffect.js'
 import { useConnect } from './useConnect.js'
 import { useDisconnect } from './useDisconnect.js'
 
@@ -13,7 +13,7 @@ test('behavior: connect and disconnect called once', async () => {
   const onDisconnect = vi.fn()
 
   const { result } = renderHook(() => ({
-    useAccountState: useAccountState({ onConnect, onDisconnect }),
+    useAccountEffect: useAccountEffect({ onConnect, onDisconnect }),
     useConnect: useConnect(),
     useDisconnect: useDisconnect(),
   }))
@@ -59,7 +59,7 @@ test('behavior: connect called on reconnect', async () => {
     expect(data.isReconnected).toBeTruthy()
   })
 
-  renderHook(() => useAccountState({ onConnect }), {
+  renderHook(() => useAccountEffect({ onConnect }), {
     wrapper: createWrapper(WagmiProvider, { value: config }),
   })
 
diff --git a/packages/react/src/hooks/useAccountState.ts b/packages/react/src/hooks/useAccountEffect.ts
similarity index 88%
rename from packages/react/src/hooks/useAccountState.ts
rename to packages/react/src/hooks/useAccountEffect.ts
index 172e9678d9..cad6da51d6 100644
--- a/packages/react/src/hooks/useAccountState.ts
+++ b/packages/react/src/hooks/useAccountEffect.ts
@@ -4,7 +4,7 @@ import type { Evaluate } from '@wagmi/core/internal'
 import { useConfig } from './useConfig.js'
 import { useEffect } from 'react'
 
-export type UseAccountStateParameters = {
+export type UseAccountEffectParameters = {
   onConnect?(
     data: Evaluate<
       Pick<
@@ -18,8 +18,8 @@ export type UseAccountStateParameters = {
   onDisconnect?(): void
 }
 
-/** https://wagmi.sh/react/hooks/useAccountState */
-export function useAccountState(parameters: UseAccountStateParameters = {}) {
+/** https://wagmi.sh/react/hooks/useAccountEffect */
+export function useAccountEffect(parameters: UseAccountEffectParameters = {}) {
   const { onConnect, onDisconnect } = parameters
   const config = useConfig()
 
diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts
index fc2347f07a..5292f86c5f 100644
--- a/packages/react/src/index.ts
+++ b/packages/react/src/index.ts
@@ -35,9 +35,9 @@ export { WagmiProviderNotFoundError } from './errors/context.js'
 export { type UseAccountReturnType, useAccount } from './hooks/useAccount.js'
 
 export {
-  type UseAccountStateParameters,
-  useAccountState,
-} from './hooks/useAccountState.js'
+  type UseAccountEffectParameters,
+  useAccountEffect,
+} from './hooks/useAccountEffect.js'
 
 export {
   type UseBalanceParameters,
diff --git a/playgrounds/vite-react/src/App.tsx b/playgrounds/vite-react/src/App.tsx
index ba5f35573d..59aa29939d 100644
--- a/playgrounds/vite-react/src/App.tsx
+++ b/playgrounds/vite-react/src/App.tsx
@@ -1,6 +1,6 @@
 import {
   useAccount,
-  useAccountState,
+  useAccountEffect,
   useBalance,
   useBlockNumber,
   useChainId,
@@ -16,7 +16,7 @@ import {
 import { optimism } from 'wagmi/chains'
 
 function App() {
-  useAccountState({
+  useAccountEffect({
     onConnect(data) {
       console.log('onConnect', data)
     },