From b0f87d9da1fa7b1399f65d31ee93c537254b7e4a Mon Sep 17 00:00:00 2001 From: Tom Meagher Date: Fri, 8 Sep 2023 19:05:35 -0400 Subject: [PATCH] docs: reorder --- docs/.vitepress/sidebar.ts | 250 ++++++++++-------- docs/core/{ => api}/actions.md | 4 +- docs/core/{ => api}/actions/connect.md | 4 +- docs/core/{ => api}/actions/disconnect.md | 2 +- .../{ => api}/actions/estimateFeesPerGas.md | 0 docs/core/{ => api}/actions/getAccount.md | 0 docs/core/{ => api}/actions/getBalance.md | 0 docs/core/{ => api}/actions/getBlockNumber.md | 0 docs/core/{ => api}/actions/getChainId.md | 0 docs/core/{ => api}/actions/getConnections.md | 0 .../{ => api}/actions/getConnectorClient.md | 0 docs/core/{ => api}/actions/getEnsAddress.md | 0 docs/core/{ => api}/actions/getEnsAvatar.md | 0 docs/core/{ => api}/actions/getEnsName.md | 0 docs/core/{ => api}/actions/getEnsResolver.md | 0 docs/core/{ => api}/actions/getToken.md | 0 docs/core/{ => api}/actions/getTransaction.md | 0 docs/core/{ => api}/actions/multicall.md | 0 docs/core/{ => api}/actions/readContract.md | 0 docs/core/{ => api}/actions/readContracts.md | 0 docs/core/{ => api}/actions/reconnect.md | 4 +- .../core/{ => api}/actions/sendTransaction.md | 0 docs/core/{ => api}/actions/signMessage.md | 2 +- docs/core/{ => api}/actions/signTypedData.md | 2 +- .../{ => api}/actions/simulateContract.md | 0 docs/core/{ => api}/actions/switchAccount.md | 2 +- docs/core/{ => api}/actions/switchChain.md | 2 +- docs/core/{ => api}/actions/watchAccount.md | 0 docs/core/{ => api}/actions/watchChainId.md | 0 .../{ => api}/actions/watchConnections.md | 0 docs/core/{ => api}/chains.md | 0 docs/core/{ => api}/connectors.md | 0 .../{ => api}/connectors/coinbaseWallet.md | 0 docs/core/{ => api}/connectors/injected.md | 0 docs/core/{ => api}/createConfig.md | 0 docs/core/{ => api}/createConnector.md | 0 docs/core/{ => api}/createStorage.md | 0 docs/core/{ => api}/errors.md | 0 docs/core/{ => api}/utilities/deserialize.md | 0 .../{ => api}/utilities/normalizeChainId.md | 0 docs/core/{ => api}/utilities/serialize.md | 0 docs/core/getting-started.md | 2 +- docs/core/{ => guides}/faq.md | 0 docs/core/{ => guides}/testing.md | 0 docs/core/typescript.md | 2 +- docs/index.md | 4 +- docs/react/{ => api}/WagmiProvider.md | 0 docs/react/{ => api}/actions.md | 2 +- docs/react/{ => api}/chains.md | 0 docs/react/{ => api}/connectors.md | 4 +- .../{ => api}/connectors/coinbaseWallet.md | 0 docs/react/{ => api}/connectors/injected.md | 0 docs/react/{ => api}/createConfig.md | 0 docs/react/{ => api}/createStorage.md | 0 docs/react/{ => api}/errors.md | 0 docs/react/{ => api}/hooks.md | 4 +- docs/react/{ => api}/hooks/useAccount.md | 4 +- docs/react/{ => api}/hooks/useBalance.md | 2 +- docs/react/{ => api}/hooks/useBlockNumber.md | 6 +- docs/react/{ => api}/hooks/useChainId.md | 4 +- docs/react/{ => api}/hooks/useConfig.md | 0 docs/react/{ => api}/hooks/useConnect.md | 4 +- docs/react/{ => api}/hooks/useConnections.md | 4 +- docs/react/{ => api}/hooks/useDisconnect.md | 2 +- docs/react/{ => api}/hooks/useEnsAddress.md | 2 +- docs/react/{ => api}/hooks/useEnsAvatar.md | 2 +- docs/react/{ => api}/hooks/useEnsName.md | 2 +- docs/react/{ => api}/hooks/useEnsResolver.md | 2 +- .../{ => api}/hooks/useEstimateFeesPerGas.md | 2 +- docs/react/{ => api}/hooks/useReconnect.md | 4 +- .../react/{ => api}/hooks/useSwitchAccount.md | 2 +- docs/react/{ => api}/hooks/useToken.md | 2 +- docs/react/{ => api}/utilities/deserialize.md | 0 .../{ => api}/utilities/normalizeChainId.md | 0 docs/react/{ => api}/utilities/serialize.md | 0 docs/react/{ => guides}/faq.md | 0 docs/react/{ => guides}/tanstack-query.md | 0 docs/react/migration-guide.md | 85 ------ docs/react/typescript.md | 2 +- docs/shared/mutation-result.md | 2 +- packages/core/src/actions/connect.ts | 2 +- packages/core/src/actions/disconnect.ts | 2 +- packages/core/src/actions/estimateGas.ts | 2 +- packages/core/src/actions/getAccount.ts | 2 +- packages/core/src/actions/getBalance.ts | 2 +- packages/core/src/actions/getBlockNumber.ts | 2 +- packages/core/src/actions/getChainId.ts | 2 +- packages/core/src/actions/getConnections.ts | 2 +- .../core/src/actions/getConnectorClient.ts | 2 +- packages/core/src/actions/getEnsAddress.ts | 2 +- packages/core/src/actions/getEnsAvatar.ts | 2 +- packages/core/src/actions/getEnsName.ts | 2 +- packages/core/src/actions/getEnsResolver.ts | 2 +- packages/core/src/actions/getTransaction.ts | 2 +- packages/core/src/actions/readContract.ts | 2 +- packages/core/src/actions/reconnect.ts | 2 +- packages/core/src/actions/sendTransaction.ts | 2 +- packages/core/src/actions/signMessage.ts | 2 +- packages/core/src/actions/signTypedData.ts | 2 +- packages/core/src/actions/simulateContract.ts | 2 +- packages/core/src/actions/switchAccount.ts | 2 +- packages/core/src/actions/switchChain.ts | 2 +- packages/core/src/actions/watchAccount.ts | 2 +- packages/core/src/actions/watchBlockNumber.ts | 2 +- packages/core/src/actions/watchChainId.ts | 2 +- packages/core/src/actions/watchConnections.ts | 2 +- .../core/src/actions/watchContractEvent.ts | 2 +- .../src/actions/watchPendingTransactions.ts | 2 +- packages/core/src/actions/writeContract.ts | 2 +- packages/react/src/exports/actions.ts | 2 +- packages/react/src/hooks/useAccount.ts | 2 +- packages/react/src/hooks/useAccountEffect.ts | 2 +- packages/react/src/hooks/useBalance.ts | 2 +- packages/react/src/hooks/useBlockNumber.ts | 2 +- packages/react/src/hooks/useChainId.ts | 2 +- packages/react/src/hooks/useConfig.ts | 2 +- packages/react/src/hooks/useConnect.ts | 2 +- packages/react/src/hooks/useConnections.ts | 2 +- .../react/src/hooks/useConnectorClient.ts | 2 +- packages/react/src/hooks/useContractRead.ts | 2 +- packages/react/src/hooks/useContractReads.ts | 2 +- .../react/src/hooks/useContractSimulate.ts | 2 +- packages/react/src/hooks/useContractWrite.ts | 2 +- packages/react/src/hooks/useDisconnect.ts | 2 +- packages/react/src/hooks/useEnsAddress.ts | 2 +- packages/react/src/hooks/useEnsAvatar.ts | 2 +- packages/react/src/hooks/useEnsName.ts | 2 +- packages/react/src/hooks/useEnsResolver.ts | 2 +- .../react/src/hooks/useEstimateFeesPerGas.ts | 2 +- packages/react/src/hooks/useEstimateGas.ts | 2 +- packages/react/src/hooks/useReconnect.ts | 2 +- .../react/src/hooks/useSendTransaction.ts | 2 +- packages/react/src/hooks/useSignMessage.ts | 2 +- packages/react/src/hooks/useSignTypedData.ts | 2 +- packages/react/src/hooks/useSwitchAccount.ts | 2 +- packages/react/src/hooks/useSwitchChain.ts | 2 +- packages/react/src/hooks/useToken.ts | 2 +- packages/react/src/hooks/useTransaction.ts | 2 +- .../src/hooks/useWaitForTransactionReceipt.ts | 2 +- .../react/src/hooks/useWatchBlockNumber.ts | 2 +- .../react/src/hooks/useWatchContractEvent.ts | 2 +- .../src/hooks/useWatchPendingTransactions.ts | 2 +- 142 files changed, 240 insertions(+), 307 deletions(-) rename docs/core/{ => api}/actions.md (80%) rename docs/core/{ => api}/actions/connect.md (93%) rename docs/core/{ => api}/actions/disconnect.md (94%) rename docs/core/{ => api}/actions/estimateFeesPerGas.md (100%) rename docs/core/{ => api}/actions/getAccount.md (100%) rename docs/core/{ => api}/actions/getBalance.md (100%) rename docs/core/{ => api}/actions/getBlockNumber.md (100%) rename docs/core/{ => api}/actions/getChainId.md (100%) rename docs/core/{ => api}/actions/getConnections.md (100%) rename docs/core/{ => api}/actions/getConnectorClient.md (100%) rename docs/core/{ => api}/actions/getEnsAddress.md (100%) rename docs/core/{ => api}/actions/getEnsAvatar.md (100%) rename docs/core/{ => api}/actions/getEnsName.md (100%) rename docs/core/{ => api}/actions/getEnsResolver.md (100%) rename docs/core/{ => api}/actions/getToken.md (100%) rename docs/core/{ => api}/actions/getTransaction.md (100%) rename docs/core/{ => api}/actions/multicall.md (100%) rename docs/core/{ => api}/actions/readContract.md (100%) rename docs/core/{ => api}/actions/readContracts.md (100%) rename docs/core/{ => api}/actions/reconnect.md (91%) rename docs/core/{ => api}/actions/sendTransaction.md (100%) rename docs/core/{ => api}/actions/signMessage.md (97%) rename docs/core/{ => api}/actions/signTypedData.md (99%) rename docs/core/{ => api}/actions/simulateContract.md (100%) rename docs/core/{ => api}/actions/switchAccount.md (96%) rename docs/core/{ => api}/actions/switchChain.md (97%) rename docs/core/{ => api}/actions/watchAccount.md (100%) rename docs/core/{ => api}/actions/watchChainId.md (100%) rename docs/core/{ => api}/actions/watchConnections.md (100%) rename docs/core/{ => api}/chains.md (100%) rename docs/core/{ => api}/connectors.md (100%) rename docs/core/{ => api}/connectors/coinbaseWallet.md (100%) rename docs/core/{ => api}/connectors/injected.md (100%) rename docs/core/{ => api}/createConfig.md (100%) rename docs/core/{ => api}/createConnector.md (100%) rename docs/core/{ => api}/createStorage.md (100%) rename docs/core/{ => api}/errors.md (100%) rename docs/core/{ => api}/utilities/deserialize.md (100%) rename docs/core/{ => api}/utilities/normalizeChainId.md (100%) rename docs/core/{ => api}/utilities/serialize.md (100%) rename docs/core/{ => guides}/faq.md (100%) rename docs/core/{ => guides}/testing.md (100%) rename docs/react/{ => api}/WagmiProvider.md (100%) rename docs/react/{ => api}/actions.md (89%) rename docs/react/{ => api}/chains.md (100%) rename docs/react/{ => api}/connectors.md (81%) rename docs/react/{ => api}/connectors/coinbaseWallet.md (100%) rename docs/react/{ => api}/connectors/injected.md (100%) rename docs/react/{ => api}/createConfig.md (100%) rename docs/react/{ => api}/createStorage.md (100%) rename docs/react/{ => api}/errors.md (100%) rename docs/react/{ => api}/hooks.md (79%) rename docs/react/{ => api}/hooks/useAccount.md (91%) rename docs/react/{ => api}/hooks/useBalance.md (98%) rename docs/react/{ => api}/hooks/useBlockNumber.md (91%) rename docs/react/{ => api}/hooks/useChainId.md (90%) rename docs/react/{ => api}/hooks/useConfig.md (100%) rename docs/react/{ => api}/hooks/useConnect.md (95%) rename docs/react/{ => api}/hooks/useConnections.md (88%) rename docs/react/{ => api}/hooks/useDisconnect.md (97%) rename docs/react/{ => api}/hooks/useEnsAddress.md (98%) rename docs/react/{ => api}/hooks/useEnsAvatar.md (98%) rename docs/react/{ => api}/hooks/useEnsName.md (98%) rename docs/react/{ => api}/hooks/useEnsResolver.md (98%) rename docs/react/{ => api}/hooks/useEstimateFeesPerGas.md (97%) rename docs/react/{ => api}/hooks/useReconnect.md (95%) rename docs/react/{ => api}/hooks/useSwitchAccount.md (92%) rename docs/react/{ => api}/hooks/useToken.md (98%) rename docs/react/{ => api}/utilities/deserialize.md (100%) rename docs/react/{ => api}/utilities/normalizeChainId.md (100%) rename docs/react/{ => api}/utilities/serialize.md (100%) rename docs/react/{ => guides}/faq.md (100%) rename docs/react/{ => guides}/tanstack-query.md (100%) delete mode 100644 docs/react/migration-guide.md diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts index c9a16eaa40..a3163fac4e 100644 --- a/docs/.vitepress/sidebar.ts +++ b/docs/.vitepress/sidebar.ts @@ -18,192 +18,195 @@ export function getSidebar() { items: [ { text: 'Connect Wallet 🚧', - link: '/react/connect-wallet', + link: '/react/guides/connect-wallet', }, { text: 'TanStack Query 🚧', - link: '/react/tanstack-query', + link: '/react/guides/tanstack-query', }, { text: 'Ethers & Web3.js 🚧', - link: '/react/ethers-web3', + link: '/react/guides/ethers-web3', }, { text: 'Testing 🚧', - link: '/react/testing', + link: '/react/guides/testing', }, { text: 'Chain Properties 🚧', - link: '/react/chain-properties', + link: '/react/guides/chain-properties', }, { text: 'Viem Usage 🚧', - link: '/react/viem', + link: '/react/guides/viem', }, { text: 'FAQ / Troubleshooting', - link: '/react/faq', + link: '/react/guides/faq', + }, + { + text: 'Migrate from v1 to v2 🚧', + link: '/react/guides/migrate-from-v1-to-v2', }, - { text: 'Migrate from v1 to v2 🚧', link: '/react/migration-guide' }, ], }, { text: 'API', items: [ - { text: 'createConfig', link: '/react/createConfig' }, - { text: 'createStorage', link: '/react/createStorage' }, - { text: 'WagmiProvider', link: '/react/WagmiProvider' }, - { text: 'Actions', link: '/react/actions' }, - { text: 'Chains', link: '/react/chains' }, + { text: 'createConfig', link: '/react/api/createConfig' }, + { text: 'createStorage', link: '/react/api/createStorage' }, + { text: 'WagmiProvider', link: '/react/api/WagmiProvider' }, + { text: 'Actions', link: '/react/api/actions' }, + { text: 'Chains', link: '/react/api/chains' }, { text: 'Connectors 🚧', collapsed: true, - link: '/react/connectors', + link: '/react/api/connectors', items: [ { text: 'coinbaseWallet', - link: '/react/connectors/coinbaseWallet', + link: '/react/api/connectors/coinbaseWallet', }, - { text: 'injected', link: '/react/connectors/injected' }, + { text: 'injected', link: '/react/api/connectors/injected' }, { text: 'ledger 🚧', - link: '/react/connectors/ledger', + link: '/react/api/connectors/ledger', }, { text: 'safe 🚧', - link: '/react/connectors/safe', + link: '/react/api/connectors/safe', }, { text: 'walletConnect 🚧', - link: '/react/connectors/walletConnect', + link: '/react/api/connectors/walletConnect', }, ], }, - { text: 'Constants 🚧', link: '/react/constants' }, + { text: 'Constants 🚧', link: '/react/api/constants' }, { text: 'Hooks 🚧', collapsed: true, - link: '/react/hooks', + link: '/react/api/hooks', items: [ - { text: 'useAccount', link: '/react/hooks/useAccount' }, + { text: 'useAccount', link: '/react/api/hooks/useAccount' }, { text: 'useAccountEffect 🚧', - link: '/react/hooks/useAccountEffect', + link: '/react/api/hooks/useAccountEffect', }, - { text: 'useBalance', link: '/react/hooks/useBalance' }, + { text: 'useBalance', link: '/react/api/hooks/useBalance' }, { text: 'useBlockNumber', - link: '/react/hooks/useBlockNumber', + link: '/react/api/hooks/useBlockNumber', }, - { text: 'useChainId', link: '/react/hooks/useChainId' }, - { text: 'useConfig', link: '/react/hooks/useConfig' }, - { text: 'useConnect', link: '/react/hooks/useConnect' }, + { text: 'useChainId', link: '/react/api/hooks/useChainId' }, + { text: 'useConfig', link: '/react/api/hooks/useConfig' }, + { text: 'useConnect', link: '/react/api/hooks/useConnect' }, { text: 'useConnections', - link: '/react/hooks/useConnections', + link: '/react/api/hooks/useConnections', }, { text: 'useConnectorClient 🚧', - link: '/react/hooks/useConnectorClient', + link: '/react/api/hooks/useConnectorClient', }, { text: 'useContractInfiniteReads 🚧', - link: '/react/hooks/useContractInfiniteReads', + link: '/react/api/hooks/useContractInfiniteReads', }, { text: 'useContractRead 🚧', - link: '/react/hooks/useContractRead', + link: '/react/api/hooks/useContractRead', }, { text: 'useContractReads 🚧', - link: '/react/hooks/useContractReads', + link: '/react/api/hooks/useContractReads', }, { text: 'useContractSimulate 🚧', - link: '/react/hooks/useContractSimulate', + link: '/react/api/hooks/useContractSimulate', }, { text: 'useContractWrite 🚧', - link: '/react/hooks/useContractWrite', + link: '/react/api/hooks/useContractWrite', }, - { text: 'useDisconnect', link: '/react/hooks/useDisconnect' }, - { text: 'useEnsAddress', link: '/react/hooks/useEnsAddress' }, - { text: 'useEnsAvatar', link: '/react/hooks/useEnsAvatar' }, - { text: 'useEnsName', link: '/react/hooks/useEnsName' }, + { text: 'useDisconnect', link: '/react/api/hooks/useDisconnect' }, + { text: 'useEnsAddress', link: '/react/api/hooks/useEnsAddress' }, + { text: 'useEnsAvatar', link: '/react/api/hooks/useEnsAvatar' }, + { text: 'useEnsName', link: '/react/api/hooks/useEnsName' }, { text: 'useEnsResolver', - link: '/react/hooks/useEnsResolver', + link: '/react/api/hooks/useEnsResolver', }, { text: 'useEstimateFeesPerGas', - link: '/react/hooks/useEstimateFeesPerGas', + link: '/react/api/hooks/useEstimateFeesPerGas', }, { text: 'useEstimateGas 🚧', - link: '/react/hooks/useEstimateGas', + link: '/react/api/hooks/useEstimateGas', }, - { text: 'useReconnect', link: '/react/hooks/useReconnect' }, + { text: 'useReconnect', link: '/react/api/hooks/useReconnect' }, { text: 'useSendTransaction 🚧', - link: '/react/hooks/useSendTransaction', + link: '/react/api/hooks/useSendTransaction', }, { text: 'useSignMessage 🚧', - link: '/react/hooks/useSignMessage', + link: '/react/api/hooks/useSignMessage', }, { text: 'useSignTypedData 🚧', - link: '/react/hooks/useSignTypedData', + link: '/react/api/hooks/useSignTypedData', }, { text: 'useSwitchAccount 🚧', - link: '/react/hooks/useSwitchAccount', + link: '/react/api/hooks/useSwitchAccount', }, { text: 'useSwitchChain 🚧', - link: '/react/hooks/useSwitchChain', + link: '/react/api/hooks/useSwitchChain', }, { text: 'useTransaction 🚧', - link: '/react/hooks/useTransaction', + link: '/react/api/hooks/useTransaction', }, { text: 'useToken', - link: '/react/hooks/useToken', + link: '/react/api/hooks/useToken', }, { text: 'useWaitForTransaction 🚧', - link: '/react/hooks/useWaitForTransaction', + link: '/react/api/hooks/useWaitForTransaction', }, { text: 'useWalletClient 🚧', - link: '/react/hooks/useWalletClient', + link: '/react/api/hooks/useWalletClient', }, { text: 'useWatchBlockNumber 🚧', - link: '/react/hooks/useWatchBlockNumber', + link: '/react/api/hooks/useWatchBlockNumber', }, { text: 'useWatchContractEvent 🚧', - link: '/react/hooks/useWatchContractEvent', + link: '/react/api/hooks/useWatchContractEvent', }, { text: 'useWatchPendingTransactions 🚧', - link: '/react/hooks/useWatchPendingTransactions', + link: '/react/api/hooks/useWatchPendingTransactions', }, ], }, - { text: 'Errors', link: '/react/errors' }, + { text: 'Errors', link: '/react/api/errors' }, { text: 'Utilities', collapsed: true, items: [ - { text: 'deserialize', link: '/react/utilities/deserialize' }, + { text: 'deserialize', link: '/react/api/utilities/deserialize' }, { text: 'normalizeChainId', - link: '/react/utilities/normalizeChainId', + link: '/react/api/utilities/normalizeChainId', }, - { text: 'serialize', link: '/react/utilities/serialize' }, + { text: 'serialize', link: '/react/api/utilities/serialize' }, ], }, ], @@ -224,175 +227,190 @@ export function getSidebar() { items: [ { text: 'Framework Adapters 🚧', - link: '/core/framework-adapter', + link: '/core/guides/framework-adapter', }, { text: 'Ethers & Web3.js 🚧', - link: '/core/ethers-web3', + link: '/core/guides/ethers-web3', }, { text: 'Testing 🚧', - link: '/core/testing', + link: '/core/guides/testing', }, { text: 'Chain Properties 🚧', - link: '/core/chain-properties', + link: '/core/guides/chain-properties', }, { text: 'Viem Usage 🚧', - link: '/core/viem', + link: '/core/guides/viem', }, { text: 'FAQ / Troubleshooting', - link: '/core/faq', + link: '/core/guides/faq', + }, + { + text: 'Migrate from v1 to v2 🚧', + link: '/react/guides/migrate-from-v1-to-v2', }, - { text: 'Migrate from v1 to v2 🚧', link: '/core/migration-guide' }, ], }, { text: 'API', items: [ - { text: 'createConfig', link: '/core/createConfig' }, - { text: 'createConnector 🚧', link: '/core/createConnector' }, - { text: 'createStorage', link: '/core/createStorage' }, + { text: 'createConfig', link: '/core/api/createConfig' }, + { text: 'createConnector 🚧', link: '/core/api/createConnector' }, + { text: 'createStorage', link: '/core/api/createStorage' }, { text: 'Actions 🚧', collapsed: true, - link: '/core/actions', + link: '/core/api/actions', items: [ - { text: 'connect', link: '/core/actions/connect' }, - { text: 'disconnect', link: '/core/actions/disconnect' }, + { text: 'connect', link: '/core/api/actions/connect' }, + { text: 'disconnect', link: '/core/api/actions/disconnect' }, { text: 'estimateFeesPerGas', - link: '/core/actions/estimateFeesPerGas', + link: '/core/api/actions/estimateFeesPerGas', }, - { text: 'estimateGas 🚧', link: '/core/actions/estimateGas' }, - { text: 'getAccount', link: '/core/actions/getAccount' }, - { text: 'getBalance', link: '/core/actions/getBalance' }, + { text: 'estimateGas 🚧', link: '/core/api/actions/estimateGas' }, + { text: 'getAccount', link: '/core/api/actions/getAccount' }, + { text: 'getBalance', link: '/core/api/actions/getBalance' }, { text: 'getBlockNumber', - link: '/core/actions/getBlockNumber', + link: '/core/api/actions/getBlockNumber', }, - { text: 'getChainId', link: '/core/actions/getChainId' }, + { text: 'getChainId', link: '/core/api/actions/getChainId' }, { text: 'getConnections', - link: '/core/actions/getConnections', + link: '/core/api/actions/getConnections', }, { text: 'getConnectorClient', - link: '/core/actions/getConnectorClient', + link: '/core/api/actions/getConnectorClient', + }, + { + text: 'getEnsAddress', + link: '/core/api/actions/getEnsAddress', }, - { text: 'getEnsAddress', link: '/core/actions/getEnsAddress' }, - { text: 'getEnsAvatar', link: '/core/actions/getEnsAvatar' }, - { text: 'getEnsName', link: '/core/actions/getEnsName' }, + { text: 'getEnsAvatar', link: '/core/api/actions/getEnsAvatar' }, + { text: 'getEnsName', link: '/core/api/actions/getEnsName' }, { text: 'getEnsResolver', - link: '/core/actions/getEnsResolver', + link: '/core/api/actions/getEnsResolver', }, - { text: 'getToken', link: '/core/actions/getToken' }, + { text: 'getToken', link: '/core/api/actions/getToken' }, { text: 'getTransaction', - link: '/core/actions/getTransaction', + link: '/core/api/actions/getTransaction', }, { text: 'multicall 🚧', - link: '/core/actions/multicall', + link: '/core/api/actions/multicall', + }, + { text: 'reconnect', link: '/core/api/actions/reconnect' }, + { + text: 'readContract 🚧', + link: '/core/api/actions/readContract', + }, + { + text: 'readContracts 🚧', + link: '/core/api/actions/readContracts', }, - { text: 'reconnect', link: '/core/actions/reconnect' }, - { text: 'readContract 🚧', link: '/core/actions/readContract' }, - { text: 'readContracts 🚧', link: '/core/actions/readContracts' }, { text: 'sendTransaction', - link: '/core/actions/sendTransaction', + link: '/core/api/actions/sendTransaction', }, { text: 'signMessage', - link: '/core/actions/signMessage', + link: '/core/api/actions/signMessage', }, { text: 'signTypedData', - link: '/core/actions/signTypedData', + link: '/core/api/actions/signTypedData', }, { text: 'simulateContract 🚧', - link: '/core/actions/simulateContract', + link: '/core/api/actions/simulateContract', }, { text: 'switchAccount', - link: '/core/actions/switchAccount', + link: '/core/api/actions/switchAccount', }, { text: 'switchChain', - link: '/core/actions/switchChain', + link: '/core/api/actions/switchChain', }, { text: 'waitForTransactionReceipt 🚧', - link: '/core/actions/waitForTransactionReceipt', + link: '/core/api/actions/waitForTransactionReceipt', }, { text: 'watchAccount', - link: '/core/actions/watchAccount', + link: '/core/api/actions/watchAccount', }, { text: 'watchBlockNumber 🚧', - link: '/core/actions/watchBlockNumber', + link: '/core/api/actions/watchBlockNumber', }, { text: 'watchChainId', - link: '/core/actions/watchChainId', + link: '/core/api/actions/watchChainId', }, { text: 'watchConnections', - link: '/core/actions/watchConnections', + link: '/core/api/actions/watchConnections', }, { text: 'watchContractEvent 🚧', - link: '/core/actions/watchContractEvent', + link: '/core/api/actions/watchContractEvent', }, { text: 'watchPendingTransactions 🚧', - link: '/core/actions/watchPendingTransactions', + link: '/core/api/actions/watchPendingTransactions', + }, + { + text: 'writeContract 🚧', + link: '/core/api/actions/writeContract', }, - { text: 'writeContract 🚧', link: '/core/actions/writeContract' }, ], }, - { text: 'Chains', link: '/core/chains' }, + { text: 'Chains', link: '/core/api/chains' }, { text: 'Connectors 🚧', collapsed: true, - link: '/core/connectors', + link: '/core/api/connectors', items: [ { text: 'coinbaseWallet', - link: '/core/connectors/coinbaseWallet', + link: '/core/api/connectors/coinbaseWallet', }, - { text: 'injected', link: '/core/connectors/injected' }, + { text: 'injected', link: '/core/api/connectors/injected' }, { text: 'ledger 🚧', - link: '/core/connectors/ledger', + link: '/core/api/connectors/ledger', }, { text: 'safe 🚧', - link: '/core/connectors/safe', + link: '/core/api/connectors/safe', }, { text: 'walletConnect 🚧', - link: '/core/connectors/walletConnect', + link: '/core/api/connectors/walletConnect', }, ], }, - { text: 'Constants 🚧', link: '/react/constants' }, - { text: 'Errors', link: '/core/errors' }, + { text: 'Constants 🚧', link: '/react/api/constants' }, + { text: 'Errors', link: '/core/api/errors' }, { text: 'Utilities', collapsed: true, items: [ - { text: 'deserialize', link: '/core/utilities/deserialize' }, + { text: 'deserialize', link: '/core/api/utilities/deserialize' }, { text: 'normalizeChainId', - link: '/core/utilities/normalizeChainId', + link: '/core/api/utilities/normalizeChainId', }, - { text: 'serialize', link: '/core/utilities/serialize' }, + { text: 'serialize', link: '/core/api/utilities/serialize' }, ], }, ], diff --git a/docs/core/actions.md b/docs/core/api/actions.md similarity index 80% rename from docs/core/actions.md rename to docs/core/api/actions.md index e6fa717a23..6f0ad90ec2 100644 --- a/docs/core/actions.md +++ b/docs/core/api/actions.md @@ -1,9 +1,9 @@ diff --git a/docs/core/actions/connect.md b/docs/core/api/actions/connect.md similarity index 93% rename from docs/core/actions/connect.md rename to docs/core/api/actions/connect.md index eb686d91d2..5f32f4405c 100644 --- a/docs/core/actions/connect.md +++ b/docs/core/api/actions/connect.md @@ -6,7 +6,7 @@ const typeName = 'Connect' # connect -Action for connecting accounts with [connectors](/core/connectors). +Action for connecting accounts with [connectors](/core/api/connectors). ## Import @@ -60,7 +60,7 @@ const result = await connect(config, { `CreateConnectorFn | Connector` -[Connector](/core/connectors) to connect with. +[Connector](/core/api/connectors) to connect with. ::: code-group ```ts [index.ts] diff --git a/docs/core/actions/disconnect.md b/docs/core/api/actions/disconnect.md similarity index 94% rename from docs/core/actions/disconnect.md rename to docs/core/api/actions/disconnect.md index 8e83285058..88beefd1fa 100644 --- a/docs/core/actions/disconnect.md +++ b/docs/core/api/actions/disconnect.md @@ -36,7 +36,7 @@ import { type DisconnectParameters } from '@wagmi/core' `Connector | undefined` -[Connector](/core/connectors) to disconnect with. +[Connector](/core/api/connectors) to disconnect with. ::: code-group ```ts [index.ts] diff --git a/docs/core/actions/estimateFeesPerGas.md b/docs/core/api/actions/estimateFeesPerGas.md similarity index 100% rename from docs/core/actions/estimateFeesPerGas.md rename to docs/core/api/actions/estimateFeesPerGas.md diff --git a/docs/core/actions/getAccount.md b/docs/core/api/actions/getAccount.md similarity index 100% rename from docs/core/actions/getAccount.md rename to docs/core/api/actions/getAccount.md diff --git a/docs/core/actions/getBalance.md b/docs/core/api/actions/getBalance.md similarity index 100% rename from docs/core/actions/getBalance.md rename to docs/core/api/actions/getBalance.md diff --git a/docs/core/actions/getBlockNumber.md b/docs/core/api/actions/getBlockNumber.md similarity index 100% rename from docs/core/actions/getBlockNumber.md rename to docs/core/api/actions/getBlockNumber.md diff --git a/docs/core/actions/getChainId.md b/docs/core/api/actions/getChainId.md similarity index 100% rename from docs/core/actions/getChainId.md rename to docs/core/api/actions/getChainId.md diff --git a/docs/core/actions/getConnections.md b/docs/core/api/actions/getConnections.md similarity index 100% rename from docs/core/actions/getConnections.md rename to docs/core/api/actions/getConnections.md diff --git a/docs/core/actions/getConnectorClient.md b/docs/core/api/actions/getConnectorClient.md similarity index 100% rename from docs/core/actions/getConnectorClient.md rename to docs/core/api/actions/getConnectorClient.md diff --git a/docs/core/actions/getEnsAddress.md b/docs/core/api/actions/getEnsAddress.md similarity index 100% rename from docs/core/actions/getEnsAddress.md rename to docs/core/api/actions/getEnsAddress.md diff --git a/docs/core/actions/getEnsAvatar.md b/docs/core/api/actions/getEnsAvatar.md similarity index 100% rename from docs/core/actions/getEnsAvatar.md rename to docs/core/api/actions/getEnsAvatar.md diff --git a/docs/core/actions/getEnsName.md b/docs/core/api/actions/getEnsName.md similarity index 100% rename from docs/core/actions/getEnsName.md rename to docs/core/api/actions/getEnsName.md diff --git a/docs/core/actions/getEnsResolver.md b/docs/core/api/actions/getEnsResolver.md similarity index 100% rename from docs/core/actions/getEnsResolver.md rename to docs/core/api/actions/getEnsResolver.md diff --git a/docs/core/actions/getToken.md b/docs/core/api/actions/getToken.md similarity index 100% rename from docs/core/actions/getToken.md rename to docs/core/api/actions/getToken.md diff --git a/docs/core/actions/getTransaction.md b/docs/core/api/actions/getTransaction.md similarity index 100% rename from docs/core/actions/getTransaction.md rename to docs/core/api/actions/getTransaction.md diff --git a/docs/core/actions/multicall.md b/docs/core/api/actions/multicall.md similarity index 100% rename from docs/core/actions/multicall.md rename to docs/core/api/actions/multicall.md diff --git a/docs/core/actions/readContract.md b/docs/core/api/actions/readContract.md similarity index 100% rename from docs/core/actions/readContract.md rename to docs/core/api/actions/readContract.md diff --git a/docs/core/actions/readContracts.md b/docs/core/api/actions/readContracts.md similarity index 100% rename from docs/core/actions/readContracts.md rename to docs/core/api/actions/readContracts.md diff --git a/docs/core/actions/reconnect.md b/docs/core/api/actions/reconnect.md similarity index 91% rename from docs/core/actions/reconnect.md rename to docs/core/api/actions/reconnect.md index bb6b2a028b..7f6397a746 100644 --- a/docs/core/actions/reconnect.md +++ b/docs/core/api/actions/reconnect.md @@ -6,7 +6,7 @@ const typeName = 'Reconnect' # reconnect -Action for reconnecting [connectors](/core/connectors). +Action for reconnecting [connectors](/core/api/connectors). ## Import @@ -37,7 +37,7 @@ import { type ReconnectParameters } from '@wagmi/core' `(CreateConnectorFn | Connector)[] | undefined` -- [Connectors](/core/connectors) to reconnect to. +- [Connectors](/core/api/connectors) to reconnect to. - Defaults to [`Config['connectors']`](/core/createConfig#connectors). ::: code-group diff --git a/docs/core/actions/sendTransaction.md b/docs/core/api/actions/sendTransaction.md similarity index 100% rename from docs/core/actions/sendTransaction.md rename to docs/core/api/actions/sendTransaction.md diff --git a/docs/core/actions/signMessage.md b/docs/core/api/actions/signMessage.md similarity index 97% rename from docs/core/actions/signMessage.md rename to docs/core/api/actions/signMessage.md index bcb9ef7c6c..241fb587f5 100644 --- a/docs/core/actions/signMessage.md +++ b/docs/core/api/actions/signMessage.md @@ -55,7 +55,7 @@ const result = await signMessage(config, { `Connector | undefined` -[Connector](/core/connectors) to sign message with. +[Connector](/core/api/connectors) to sign message with. ::: code-group ```ts [index.ts] diff --git a/docs/core/actions/signTypedData.md b/docs/core/api/actions/signTypedData.md similarity index 99% rename from docs/core/actions/signTypedData.md rename to docs/core/api/actions/signTypedData.md index b78d5ed5eb..c5eb018c28 100644 --- a/docs/core/actions/signTypedData.md +++ b/docs/core/api/actions/signTypedData.md @@ -93,7 +93,7 @@ const result = await signTypedData(config, { `Connector | undefined` -[Connector](/core/connectors) to sign data with. +[Connector](/core/api/connectors) to sign data with. ::: code-group ```ts [index.ts] diff --git a/docs/core/actions/simulateContract.md b/docs/core/api/actions/simulateContract.md similarity index 100% rename from docs/core/actions/simulateContract.md rename to docs/core/api/actions/simulateContract.md diff --git a/docs/core/actions/switchAccount.md b/docs/core/api/actions/switchAccount.md similarity index 96% rename from docs/core/actions/switchAccount.md rename to docs/core/api/actions/switchAccount.md index d9acf70c19..5bb29c2778 100644 --- a/docs/core/actions/switchAccount.md +++ b/docs/core/api/actions/switchAccount.md @@ -39,7 +39,7 @@ import { type SwitchAccountParameters } from '@wagmi/core' `Connector` -[Connector](/core/connectors) to switch to. +[Connector](/core/api/connectors) to switch to. ::: code-group ```ts [index.ts] diff --git a/docs/core/actions/switchChain.md b/docs/core/api/actions/switchChain.md similarity index 97% rename from docs/core/actions/switchChain.md rename to docs/core/api/actions/switchChain.md index c3f14e1ad8..3fa8658a9e 100644 --- a/docs/core/actions/switchChain.md +++ b/docs/core/api/actions/switchChain.md @@ -60,7 +60,7 @@ const result = await switchChain(config, { `Connector` -[Connector](/core/connectors) to switch chain with. +[Connector](/core/api/connectors) to switch chain with. ::: code-group ```ts [index.ts] diff --git a/docs/core/actions/watchAccount.md b/docs/core/api/actions/watchAccount.md similarity index 100% rename from docs/core/actions/watchAccount.md rename to docs/core/api/actions/watchAccount.md diff --git a/docs/core/actions/watchChainId.md b/docs/core/api/actions/watchChainId.md similarity index 100% rename from docs/core/actions/watchChainId.md rename to docs/core/api/actions/watchChainId.md diff --git a/docs/core/actions/watchConnections.md b/docs/core/api/actions/watchConnections.md similarity index 100% rename from docs/core/actions/watchConnections.md rename to docs/core/api/actions/watchConnections.md diff --git a/docs/core/chains.md b/docs/core/api/chains.md similarity index 100% rename from docs/core/chains.md rename to docs/core/api/chains.md diff --git a/docs/core/connectors.md b/docs/core/api/connectors.md similarity index 100% rename from docs/core/connectors.md rename to docs/core/api/connectors.md diff --git a/docs/core/connectors/coinbaseWallet.md b/docs/core/api/connectors/coinbaseWallet.md similarity index 100% rename from docs/core/connectors/coinbaseWallet.md rename to docs/core/api/connectors/coinbaseWallet.md diff --git a/docs/core/connectors/injected.md b/docs/core/api/connectors/injected.md similarity index 100% rename from docs/core/connectors/injected.md rename to docs/core/api/connectors/injected.md diff --git a/docs/core/createConfig.md b/docs/core/api/createConfig.md similarity index 100% rename from docs/core/createConfig.md rename to docs/core/api/createConfig.md diff --git a/docs/core/createConnector.md b/docs/core/api/createConnector.md similarity index 100% rename from docs/core/createConnector.md rename to docs/core/api/createConnector.md diff --git a/docs/core/createStorage.md b/docs/core/api/createStorage.md similarity index 100% rename from docs/core/createStorage.md rename to docs/core/api/createStorage.md diff --git a/docs/core/errors.md b/docs/core/api/errors.md similarity index 100% rename from docs/core/errors.md rename to docs/core/api/errors.md diff --git a/docs/core/utilities/deserialize.md b/docs/core/api/utilities/deserialize.md similarity index 100% rename from docs/core/utilities/deserialize.md rename to docs/core/api/utilities/deserialize.md diff --git a/docs/core/utilities/normalizeChainId.md b/docs/core/api/utilities/normalizeChainId.md similarity index 100% rename from docs/core/utilities/normalizeChainId.md rename to docs/core/api/utilities/normalizeChainId.md diff --git a/docs/core/utilities/serialize.md b/docs/core/api/utilities/serialize.md similarity index 100% rename from docs/core/utilities/serialize.md rename to docs/core/api/utilities/serialize.md diff --git a/docs/core/getting-started.md b/docs/core/getting-started.md index 33f3b8e77a..afcf42b3fa 100644 --- a/docs/core/getting-started.md +++ b/docs/core/getting-started.md @@ -22,7 +22,7 @@ yarn add @wagmi/core @wagmi/connectors viem ``` ::: -- [Wagmi Connectors](/core/connectors) is a collection of interfaces for linking accounts/wallets to Wagmi. +- [Wagmi Connectors](/core/api/connectors) is a collection of interfaces for linking accounts/wallets to Wagmi. - [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations. - [TypeScript](/react/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/core/typescript). diff --git a/docs/core/faq.md b/docs/core/guides/faq.md similarity index 100% rename from docs/core/faq.md rename to docs/core/guides/faq.md diff --git a/docs/core/testing.md b/docs/core/guides/testing.md similarity index 100% rename from docs/core/testing.md rename to docs/core/guides/testing.md diff --git a/docs/core/typescript.md b/docs/core/typescript.md index 3945631d17..b3b84e1d31 100644 --- a/docs/core/typescript.md +++ b/docs/core/typescript.md @@ -53,7 +53,7 @@ Unfortunately [TypeScript doesn't support importing JSON `as const` yet](https:/ Anywhere you see the `abi` or `types` configuration property, you can likely use const-asserted or inline ABIs and Typed Data to get type-safety and inference. These properties are also called out in the docs. -Here's what [`readContract`](/core/actions/readContract) looks like with and without a const-asserted `abi` property. +Here's what [`readContract`](/core/api/actions/readContract) looks like with and without a const-asserted `abi` property. ::: code-group ```ts twoslash [Const-Asserted] diff --git a/docs/index.md b/docs/index.md index 6065ab494a..cf3947c3d4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,7 +24,7 @@ features: - icon: 🚀 title: 20+ React Hooks details: React Hooks for accounts, wallets, contracts, transactions, signing, ENS, and more. - link: /react/hooks + link: /react/api/hooks linkText: See all hooks - icon: 🦄 title: TypeScript Ready @@ -34,7 +34,7 @@ features: - icon: 💼 title: Connect Wallet details: Official wallet connectors for MetaMask, WalletConnect, Coinbase Wallet, and more. - link: /react/connectors + link: /react/api/connectors linkText: See all connectors - icon: 👟 title: Caching, Deduplication & Persistence diff --git a/docs/react/WagmiProvider.md b/docs/react/api/WagmiProvider.md similarity index 100% rename from docs/react/WagmiProvider.md rename to docs/react/api/WagmiProvider.md diff --git a/docs/react/actions.md b/docs/react/api/actions.md similarity index 89% rename from docs/react/actions.md rename to docs/react/api/actions.md index 8840028507..af367bb025 100644 --- a/docs/react/actions.md +++ b/docs/react/api/actions.md @@ -25,4 +25,4 @@ function App() { <<< @/snippets/react/config.ts[config.ts] ::: -See the [Wagmi Core docs](/core/actions) for more info on what actions are available. +See the [Wagmi Core docs](/core/api/actions) for more info on what actions are available. diff --git a/docs/react/chains.md b/docs/react/api/chains.md similarity index 100% rename from docs/react/chains.md rename to docs/react/api/chains.md diff --git a/docs/react/connectors.md b/docs/react/api/connectors.md similarity index 81% rename from docs/react/connectors.md rename to docs/react/api/connectors.md index 703192e8a9..fb3fbf436c 100644 --- a/docs/react/connectors.md +++ b/docs/react/api/connectors.md @@ -1,9 +1,9 @@ diff --git a/docs/react/connectors/coinbaseWallet.md b/docs/react/api/connectors/coinbaseWallet.md similarity index 100% rename from docs/react/connectors/coinbaseWallet.md rename to docs/react/api/connectors/coinbaseWallet.md diff --git a/docs/react/connectors/injected.md b/docs/react/api/connectors/injected.md similarity index 100% rename from docs/react/connectors/injected.md rename to docs/react/api/connectors/injected.md diff --git a/docs/react/createConfig.md b/docs/react/api/createConfig.md similarity index 100% rename from docs/react/createConfig.md rename to docs/react/api/createConfig.md diff --git a/docs/react/createStorage.md b/docs/react/api/createStorage.md similarity index 100% rename from docs/react/createStorage.md rename to docs/react/api/createStorage.md diff --git a/docs/react/errors.md b/docs/react/api/errors.md similarity index 100% rename from docs/react/errors.md rename to docs/react/api/errors.md diff --git a/docs/react/hooks.md b/docs/react/api/hooks.md similarity index 79% rename from docs/react/hooks.md rename to docs/react/api/hooks.md index ea5e38eac2..b5d09246b6 100644 --- a/docs/react/hooks.md +++ b/docs/react/api/hooks.md @@ -1,9 +1,9 @@ diff --git a/docs/react/hooks/useAccount.md b/docs/react/api/hooks/useAccount.md similarity index 91% rename from docs/react/hooks/useAccount.md rename to docs/react/api/hooks/useAccount.md index dd825a7c59..10ef35e2ac 100644 --- a/docs/react/hooks/useAccount.md +++ b/docs/react/api/hooks/useAccount.md @@ -65,5 +65,5 @@ import { type UseAccountReturnType } from 'wagmi' ## Action -- [`getAccount`](/core/actions/getAccount) -- [`watchAccount`](/core/actions/getAccount#watchaccount) \ No newline at end of file +- [`getAccount`](/core/api/actions/getAccount) +- [`watchAccount`](/core/api/actions/watchAccount) \ No newline at end of file diff --git a/docs/react/hooks/useBalance.md b/docs/react/api/hooks/useBalance.md similarity index 98% rename from docs/react/hooks/useBalance.md rename to docs/react/api/hooks/useBalance.md index d18d39d5ea..23851f41cb 100644 --- a/docs/react/hooks/useBalance.md +++ b/docs/react/api/hooks/useBalance.md @@ -199,4 +199,4 @@ import { type UseBalanceReturnType } from 'wagmi' ## Action -[getBalance](/core/actions/getBalance) \ No newline at end of file +[getBalance](/core/api/actions/getBalance) \ No newline at end of file diff --git a/docs/react/hooks/useBlockNumber.md b/docs/react/api/hooks/useBlockNumber.md similarity index 91% rename from docs/react/hooks/useBlockNumber.md rename to docs/react/api/hooks/useBlockNumber.md index 09cdf9678b..0edd3193ef 100644 --- a/docs/react/hooks/useBlockNumber.md +++ b/docs/react/api/hooks/useBlockNumber.md @@ -99,7 +99,7 @@ function App() { `boolean | UseWatchBlockNumberParameters | undefined` - Enables/disables listening for block number changes. -- Can pass a subset of [`UseWatchBlockNumberParameters`](/react/hooks/useWatchBlockNumber#parameters)directly to [`useWatchBlockNumber`](/react/hooks/useWatchBlockNumber). +- Can pass a subset of [`UseWatchBlockNumberParameters`](/react/api/hooks/useWatchBlockNumber#parameters)directly to [`useWatchBlockNumber`](/react/api/hooks/useWatchBlockNumber). ::: code-group ```tsx [index.tsx] @@ -139,5 +139,5 @@ import { type UseBlockNumberReturnType } from 'wagmi' ## Action -- [getBlockNumber](/core/actions/getBlockNumber) -- [watchBlockNumber](/core/actions/getBlockNumber#watchblocknumber) \ No newline at end of file +- [getBlockNumber](/core/api/actions/getBlockNumber) +- [watchBlockNumber](/core/api/actions/watchBlockNumber) \ No newline at end of file diff --git a/docs/react/hooks/useChainId.md b/docs/react/api/hooks/useChainId.md similarity index 90% rename from docs/react/hooks/useChainId.md rename to docs/react/api/hooks/useChainId.md index db34264353..37ea092706 100644 --- a/docs/react/hooks/useChainId.md +++ b/docs/react/api/hooks/useChainId.md @@ -59,5 +59,5 @@ Current chain ID from [`config.state.chainId`](/react/createConfig#chainid). ## Action -- [`getChainId`](/core/actions/getChainId) -- [`watchChainId`](/core/actions/getChainId#watchchainid) \ No newline at end of file +- [`getChainId`](/core/api/actions/getChainId) +- [`watchChainId`](/core/api/actions/watchChainId) \ No newline at end of file diff --git a/docs/react/hooks/useConfig.md b/docs/react/api/hooks/useConfig.md similarity index 100% rename from docs/react/hooks/useConfig.md rename to docs/react/api/hooks/useConfig.md diff --git a/docs/react/hooks/useConnect.md b/docs/react/api/hooks/useConnect.md similarity index 95% rename from docs/react/hooks/useConnect.md rename to docs/react/api/hooks/useConnect.md index c180ac1b3d..eb1244256c 100644 --- a/docs/react/hooks/useConnect.md +++ b/docs/react/api/hooks/useConnect.md @@ -10,7 +10,7 @@ const TVariables = '{ chainId?: number | undefined; connector?: CreateConnectorF # useConnect -Hook for connecting accounts with [connectors](/react/connectors). +Hook for connecting accounts with [connectors](/react/api/connectors). ## Import @@ -110,4 +110,4 @@ Not all connectors support connecting directly to a `chainId` (e.g. they don't s ## Action -[`connect`](/core/actions/connect) \ No newline at end of file +[`connect`](/core/api/actions/connect) \ No newline at end of file diff --git a/docs/react/hooks/useConnections.md b/docs/react/api/hooks/useConnections.md similarity index 88% rename from docs/react/hooks/useConnections.md rename to docs/react/api/hooks/useConnections.md index abfce4283e..44d32626b9 100644 --- a/docs/react/hooks/useConnections.md +++ b/docs/react/api/hooks/useConnections.md @@ -55,5 +55,5 @@ import { type UseConnectionsReturnType } from 'wagmi' ## Action -- [`getConnections`](/core/actions/getConnections) -- [`watchConnections`](/core/actions/getConnections#watchconnections) \ No newline at end of file +- [`getConnections`](/core/api/actions/getConnections) +- [`watchConnections`](/core/api/actions/watchConnections) \ No newline at end of file diff --git a/docs/react/hooks/useDisconnect.md b/docs/react/api/hooks/useDisconnect.md similarity index 97% rename from docs/react/hooks/useDisconnect.md rename to docs/react/api/hooks/useDisconnect.md index a587f1a99c..b32d6c8389 100644 --- a/docs/react/hooks/useDisconnect.md +++ b/docs/react/api/hooks/useDisconnect.md @@ -105,4 +105,4 @@ function App() { ## Actions -[`disconnect`](/core/actions/connect) \ No newline at end of file +[`disconnect`](/core/api/actions/connect) \ No newline at end of file diff --git a/docs/react/hooks/useEnsAddress.md b/docs/react/api/hooks/useEnsAddress.md similarity index 98% rename from docs/react/hooks/useEnsAddress.md rename to docs/react/api/hooks/useEnsAddress.md index d4eec63737..6552d75b40 100644 --- a/docs/react/hooks/useEnsAddress.md +++ b/docs/react/api/hooks/useEnsAddress.md @@ -209,4 +209,4 @@ import { type UseEnsAddressReturnType } from 'wagmi' ## Action -[getEnsAddress](/core/actions/getEnsAddress) \ No newline at end of file +[getEnsAddress](/core/api/actions/getEnsAddress) \ No newline at end of file diff --git a/docs/react/hooks/useEnsAvatar.md b/docs/react/api/hooks/useEnsAvatar.md similarity index 98% rename from docs/react/hooks/useEnsAvatar.md rename to docs/react/api/hooks/useEnsAvatar.md index 7abc6009b1..d0bbe1d7b1 100644 --- a/docs/react/hooks/useEnsAvatar.md +++ b/docs/react/api/hooks/useEnsAvatar.md @@ -211,4 +211,4 @@ import { type UseEnsAvatarReturnType } from 'wagmi' ## Action -[getEnsAvatar](/core/actions/getEnsAvatar) \ No newline at end of file +[getEnsAvatar](/core/api/actions/getEnsAvatar) \ No newline at end of file diff --git a/docs/react/hooks/useEnsName.md b/docs/react/api/hooks/useEnsName.md similarity index 98% rename from docs/react/hooks/useEnsName.md rename to docs/react/api/hooks/useEnsName.md index c4989dddf4..05e5048e77 100644 --- a/docs/react/hooks/useEnsName.md +++ b/docs/react/api/hooks/useEnsName.md @@ -178,4 +178,4 @@ import { type UseEnsNameReturnType } from 'wagmi' ## Action -[getEnsName](/core/actions/getEnsName) \ No newline at end of file +[getEnsName](/core/api/actions/getEnsName) \ No newline at end of file diff --git a/docs/react/hooks/useEnsResolver.md b/docs/react/api/hooks/useEnsResolver.md similarity index 98% rename from docs/react/hooks/useEnsResolver.md rename to docs/react/api/hooks/useEnsResolver.md index 7d643ef2e6..e40742f773 100644 --- a/docs/react/hooks/useEnsResolver.md +++ b/docs/react/api/hooks/useEnsResolver.md @@ -188,4 +188,4 @@ import { type UseEnsResolverReturnType } from 'wagmi' ## Action -[getEnsResolver](/core/actions/getEnsResolver) \ No newline at end of file +[getEnsResolver](/core/api/actions/getEnsResolver) \ No newline at end of file diff --git a/docs/react/hooks/useEstimateFeesPerGas.md b/docs/react/api/hooks/useEstimateFeesPerGas.md similarity index 97% rename from docs/react/hooks/useEstimateFeesPerGas.md rename to docs/react/api/hooks/useEstimateFeesPerGas.md index a57bca2568..8a41b278ea 100644 --- a/docs/react/hooks/useEstimateFeesPerGas.md +++ b/docs/react/api/hooks/useEstimateFeesPerGas.md @@ -138,4 +138,4 @@ import { type UseEstimateFeesPerGasReturnType } from 'wagmi' ## Action -[estimateFeesPerGas](/core/actions/estimateFeesPerGas) +[estimateFeesPerGas](/core/api/actions/estimateFeesPerGas) diff --git a/docs/react/hooks/useReconnect.md b/docs/react/api/hooks/useReconnect.md similarity index 95% rename from docs/react/hooks/useReconnect.md rename to docs/react/api/hooks/useReconnect.md index 28eeddfb3f..8b6c0b406e 100644 --- a/docs/react/hooks/useReconnect.md +++ b/docs/react/api/hooks/useReconnect.md @@ -10,7 +10,7 @@ const TVariables = '{ connectors?: (CreateConnectorFn | Connector)[] | undefined # useReconnect -Hook for reconnecting [connectors](/core/connectors). +Hook for reconnecting [connectors](/core/api/connectors). ## Import @@ -102,4 +102,4 @@ function App() { ## Action -[`reconnect`](/core/actions/reconnect) \ No newline at end of file +[`reconnect`](/core/api/actions/reconnect) \ No newline at end of file diff --git a/docs/react/hooks/useSwitchAccount.md b/docs/react/api/hooks/useSwitchAccount.md similarity index 92% rename from docs/react/hooks/useSwitchAccount.md rename to docs/react/api/hooks/useSwitchAccount.md index c0372d9acd..49006ab354 100644 --- a/docs/react/hooks/useSwitchAccount.md +++ b/docs/react/api/hooks/useSwitchAccount.md @@ -1,6 +1,6 @@ # useSwitchAccount -Hook for switching accounts with [connectors](/core/connectors). +Hook for switching accounts with [connectors](/core/api/connectors). ## Import diff --git a/docs/react/hooks/useToken.md b/docs/react/api/hooks/useToken.md similarity index 98% rename from docs/react/hooks/useToken.md rename to docs/react/api/hooks/useToken.md index 449934757b..41818b1dd6 100644 --- a/docs/react/hooks/useToken.md +++ b/docs/react/api/hooks/useToken.md @@ -135,4 +135,4 @@ import { type UseTokenReturnType } from 'wagmi' ## Action -[getToken](/core/actions/getToken) \ No newline at end of file +[getToken](/core/api/actions/getToken) \ No newline at end of file diff --git a/docs/react/utilities/deserialize.md b/docs/react/api/utilities/deserialize.md similarity index 100% rename from docs/react/utilities/deserialize.md rename to docs/react/api/utilities/deserialize.md diff --git a/docs/react/utilities/normalizeChainId.md b/docs/react/api/utilities/normalizeChainId.md similarity index 100% rename from docs/react/utilities/normalizeChainId.md rename to docs/react/api/utilities/normalizeChainId.md diff --git a/docs/react/utilities/serialize.md b/docs/react/api/utilities/serialize.md similarity index 100% rename from docs/react/utilities/serialize.md rename to docs/react/api/utilities/serialize.md diff --git a/docs/react/faq.md b/docs/react/guides/faq.md similarity index 100% rename from docs/react/faq.md rename to docs/react/guides/faq.md diff --git a/docs/react/tanstack-query.md b/docs/react/guides/tanstack-query.md similarity index 100% rename from docs/react/tanstack-query.md rename to docs/react/guides/tanstack-query.md diff --git a/docs/react/migration-guide.md b/docs/react/migration-guide.md deleted file mode 100644 index b8005e3761..0000000000 --- a/docs/react/migration-guide.md +++ /dev/null @@ -1,85 +0,0 @@ -# Migration Guide - -## 2.0.x Breaking Changes - -### createConfig - -- Removed `logger` -- Removed `publicClient` and `webSocketPublicClient` (use `transports` or `client` instead) - -### Chains - -- Removed `mainnet` and `sepolia` from main export (use `viem/chains` entrypoint instead) -- Removed `wagmi/chains` entrypoint (use `viem/chains` instead) - -### Providers - -- Removed `configureChains` (use `createConfig.transports`) -- Removed `alchemy`, `infura`, `public`, `jsonRpc` providers (use `createConfig.transports`) - -### Connectors - -- Import all connectors from `wagmi/connectors` entrypoint -- Renamed `CoinbaseWalletConnector` to `coinbaseWallet` (function instead of class) -- Renamed `InjectedConnector` to `injected` (function instead of class) -- Renamed `LedgerConnector` to `ledger` (function instead of class) -- Removed `MetaMaskConnector` (use `injected({ wallet: 'metaMask' })` instead) -- Removed `MockConnector` (TODO: Should we replace with something? `@wagmi/test.testConnector`?) -- Renamed `SafeConnector` to `safe` (function instead of class) -- Renamed `WalletConnectConnector` to `walletConnect` (function instead of class) -- Renamed `injected.getProvider` to `wallet` - -### Hooks - -- Removed `useNetwork` (use `useAccount.chainId` instead) (TODO: should we add `chain` to `useAccount`?) -- Removed `usePublicClient` (TODO: migration path?) -- Removed `useWebSocketClient` (TODO: migration path?) -- Removed `useInfiniteQuery`, `useMutation`, `useQuery`, `useQueryClient` (TODO: Should we export from wagmi? If TanStack Query was peer dependency, could tell folks to import from there instead.) -- Renamed `useFeeData` to `useEstimateFeesPerGas` (TODO: migration path) - -### Constants - -- ABIs (TODO: Need to figure out if we want to keep them, export from viem, etc.) - - `erc20ABI` - - `erc721ABI` - - `erc4626ABI` - -### Errors - -- TBD - -### Actions - -- Removed global `config` (all actions now take `config` as first parameter) -- Renamed `fetchBalance` to `getBalance` -- Renamed `fetchBlockNumber` to `getBlockNumber` -- Renamed `fetchEnsAddress` to `getEnsAddress` -- Renamed `fetchEnsAvatar` to `getEnsAvatar` -- Renamed `fetchEnsName` to `getEnsName` -- Renamed `fetchEnsResolver` to `getEnsResolver` -- Renamed `fetchFeeData` to `estimateFeesPerGas` (TODO: migration path) -- Renamed `fetchToken` to `getToken` -- Renamed `fetchTransaction` to `getTransaction` -- Removed `getContract` (use `viem.getContract` instead) -- Removed `getNetwork` (use `useAccount.chainId` instead) (TODO: should we add `chain` to `getAccount`?) -- Removed `getPublicClient` (use `config.getPublicClient` instead) -- Removed `getWebSocketClient` (use `config.getWebSocketClient` instead) -- Renamed `waitForTransaction` to `waitForTransactionReceipt` -- Renamed `watchNetwork` to `watchChain` -- Removed `watchPublicClient` and `watchWebSocketClient` (TODO: Getters are coming from `config` now. Do we want to keep these?) -- Removed `watchWalletClient` (TODO: Keep this around?) - -### Config - -- Removed `config.connector` (use `config.state.connections[config.state.current].connector` instead) -- Removed `config.data` (use `config.state.connections[config.state.current]` instead) -- Removed `config.error` -- Removed `config.lastUsedChainId` (use `config.state.connections[config.state.current].chainId` instead) -- Removed `config.publicClient` (use `config.getPublicClient()` instead) -- Removed `config.status` (use `config.state.status` instead) -- Removed `config.webSocketClient` (use `config.getWebSocketClient()` instead) (TODO: not implemented yet) -- Removed `config.clearState` (use `config.reset()` instead) -- Removed `config.autoConnect()` (use `reconnect` action instead) -- Renamed `config.setConnectors` (TODO: Was someone using this? Dynamic? Might want to figure out a better name/API) -- Removed `config.setLastUsedConnector` (use `config.storage?.setItem('recentConnectorId', connectorId)` instead) -- Removed `getConfig` (`config` should be passed explicitly to actions instead of using global `config`) diff --git a/docs/react/typescript.md b/docs/react/typescript.md index 6942a76c33..ced71e105a 100644 --- a/docs/react/typescript.md +++ b/docs/react/typescript.md @@ -146,7 +146,7 @@ Unfortunately [TypeScript doesn't support importing JSON `as const` yet](https:/ Anywhere you see the `abi` or `types` configuration property, you can likely use const-asserted or inline ABIs and Typed Data to get type-safety and inference. These properties are also called out in the docs. -Here's what [`useContractRead`](/react/hooks/useContractRead) looks like with and without a const-asserted `abi` property. +Here's what [`useContractRead`](/react/api/hooks/useContractRead) looks like with and without a const-asserted `abi` property. ::: code-group ```ts twoslash [Const-Asserted] diff --git a/docs/shared/mutation-result.md b/docs/shared/mutation-result.md index cbef24935a..4e91cdd496 100644 --- a/docs/shared/mutation-result.md +++ b/docs/shared/mutation-result.md @@ -23,7 +23,7 @@ The mutation function you can call with variables to trigger the mutation and op `{{TVariables}}` - The variables object to pass to the `{{mutate}}` action. + The variables object to pass to the `{{mutate}}` action. - #### onSuccess diff --git a/packages/core/src/actions/connect.ts b/packages/core/src/actions/connect.ts index cc6c07a5ea..1391f693ac 100644 --- a/packages/core/src/actions/connect.ts +++ b/packages/core/src/actions/connect.ts @@ -31,7 +31,7 @@ export type ConnectError = | BaseError | Error -/** https://alpha.wagmi.sh/core/actions/connect */ +/** https://alpha.wagmi.sh/core/api/actions/connect */ export async function connect( config: config, parameters: ConnectParameters, diff --git a/packages/core/src/actions/disconnect.ts b/packages/core/src/actions/disconnect.ts index e84135f3a5..9c0bade2ec 100644 --- a/packages/core/src/actions/disconnect.ts +++ b/packages/core/src/actions/disconnect.ts @@ -16,7 +16,7 @@ export type DisconnectReturnType = void export type DisconnectError = Error -/** https://alpha.wagmi.sh/core/actions/disconnect */ +/** https://alpha.wagmi.sh/core/api/actions/disconnect */ export async function disconnect( config: Config, parameters: DisconnectParameters = {}, diff --git a/packages/core/src/actions/estimateGas.ts b/packages/core/src/actions/estimateGas.ts index 86812201ca..b9efd4e11b 100644 --- a/packages/core/src/actions/estimateGas.ts +++ b/packages/core/src/actions/estimateGas.ts @@ -33,7 +33,7 @@ export type EstimateGasReturnType = viem_EstimateGasReturnType export type EstimateGasError = Error -/** https://alpha.wagmi.sh/core/actions/estimateGas */ +/** https://alpha.wagmi.sh/core/api/actions/estimateGas */ export async function estimateGas< config extends Config, chainId extends config['chains'][number]['id'] | undefined = undefined, diff --git a/packages/core/src/actions/getAccount.ts b/packages/core/src/actions/getAccount.ts index 52f9c8789d..f0b292d11e 100644 --- a/packages/core/src/actions/getAccount.ts +++ b/packages/core/src/actions/getAccount.ts @@ -48,7 +48,7 @@ export type GetAccountReturnType = status: 'disconnected' } -/** https://alpha.wagmi.sh/core/actions/getAccount */ +/** https://alpha.wagmi.sh/core/api/actions/getAccount */ export function getAccount(config: Config): GetAccountReturnType { const uid = config.state.current! const connection = config.state.connections.get(uid) diff --git a/packages/core/src/actions/getBalance.ts b/packages/core/src/actions/getBalance.ts index b0f867b8f5..031e87cfc2 100644 --- a/packages/core/src/actions/getBalance.ts +++ b/packages/core/src/actions/getBalance.ts @@ -36,7 +36,7 @@ export type GetBalanceReturnType = { export type GetBalanceError = Error -/** https://alpha.wagmi.sh/core/actions/getBalance */ +/** https://alpha.wagmi.sh/core/api/actions/getBalance */ export async function getBalance( config: config, parameters: GetBalanceParameters, diff --git a/packages/core/src/actions/getBlockNumber.ts b/packages/core/src/actions/getBlockNumber.ts index 928f60e39c..ffbc3eb13e 100644 --- a/packages/core/src/actions/getBlockNumber.ts +++ b/packages/core/src/actions/getBlockNumber.ts @@ -16,7 +16,7 @@ export type GetBlockNumberReturnType = viem_GetBlockNumberReturnType export type GetBlockNumberError = Error -/** https://alpha.wagmi.sh/core/actions/getBlockNumber */ +/** https://alpha.wagmi.sh/core/api/actions/getBlockNumber */ export function getBlockNumber( config: config, parameters: GetBlockNumberParameters = {}, diff --git a/packages/core/src/actions/getChainId.ts b/packages/core/src/actions/getChainId.ts index 2959451487..cb70c26eba 100644 --- a/packages/core/src/actions/getChainId.ts +++ b/packages/core/src/actions/getChainId.ts @@ -3,7 +3,7 @@ import type { Config } from '../createConfig.js' export type GetChainIdReturnType = config['chains'][number]['id'] -/** https://alpha.wagmi.sh/core/actions/getChainId */ +/** https://alpha.wagmi.sh/core/api/actions/getChainId */ export function getChainId( config: config, ): GetChainIdReturnType { diff --git a/packages/core/src/actions/getConnections.ts b/packages/core/src/actions/getConnections.ts index 3f3e24afd0..096c48003c 100644 --- a/packages/core/src/actions/getConnections.ts +++ b/packages/core/src/actions/getConnections.ts @@ -6,7 +6,7 @@ export type GetConnectionsReturnType = Evaluate[] let previousConnections: Connection[] = [] -/** https://alpha.wagmi.sh/core/actions/getConnections */ +/** https://alpha.wagmi.sh/core/api/actions/getConnections */ export function getConnections(config: Config): GetConnectionsReturnType { const connections = [...config.state.connections.values()] if (config.state.status === 'reconnecting') return previousConnections diff --git a/packages/core/src/actions/getConnectorClient.ts b/packages/core/src/actions/getConnectorClient.ts index 770715b9e7..b50831e398 100644 --- a/packages/core/src/actions/getConnectorClient.ts +++ b/packages/core/src/actions/getConnectorClient.ts @@ -44,7 +44,7 @@ export type GetConnectorClientError = | ConnectorNotConnectedError | Error -/** https://alpha.wagmi.sh/core/actions/getConnectorClient */ +/** https://alpha.wagmi.sh/core/api/actions/getConnectorClient */ export async function getConnectorClient< config extends Config, chainId extends config['chains'][number]['id'], diff --git a/packages/core/src/actions/getEnsAddress.ts b/packages/core/src/actions/getEnsAddress.ts index 527b5186f7..538ef2e2d6 100644 --- a/packages/core/src/actions/getEnsAddress.ts +++ b/packages/core/src/actions/getEnsAddress.ts @@ -16,7 +16,7 @@ export type GetEnsAddressReturnType = viem_GetEnsAddressReturnType export type GetEnsAddressError = Error -/** https://alpha.wagmi.sh/core/actions/getEnsAddress */ +/** https://alpha.wagmi.sh/core/api/actions/getEnsAddress */ export function getEnsAddress( config: config, parameters: GetEnsAddressParameters, diff --git a/packages/core/src/actions/getEnsAvatar.ts b/packages/core/src/actions/getEnsAvatar.ts index 5fe14b45eb..c5effcb16c 100644 --- a/packages/core/src/actions/getEnsAvatar.ts +++ b/packages/core/src/actions/getEnsAvatar.ts @@ -16,7 +16,7 @@ export type GetEnsAvatarReturnType = viem_GetEnsAvatarReturnType export type GetEnsAvatarError = Error -/** https://alpha.wagmi.sh/core/actions/getEnsAvatar */ +/** https://alpha.wagmi.sh/core/api/actions/getEnsAvatar */ export function getEnsAvatar( config: config, parameters: GetEnsAvatarParameters, diff --git a/packages/core/src/actions/getEnsName.ts b/packages/core/src/actions/getEnsName.ts index 1586490815..8c44c9f33b 100644 --- a/packages/core/src/actions/getEnsName.ts +++ b/packages/core/src/actions/getEnsName.ts @@ -16,7 +16,7 @@ export type GetEnsNameReturnType = viem_GetEnsNameReturnType export type GetEnsNameError = Error -/** https://alpha.wagmi.sh/core/actions/getEnsName */ +/** https://alpha.wagmi.sh/core/api/actions/getEnsName */ export function getEnsName( config: config, parameters: GetEnsNameParameters, diff --git a/packages/core/src/actions/getEnsResolver.ts b/packages/core/src/actions/getEnsResolver.ts index 1354d953c0..0b312ec411 100644 --- a/packages/core/src/actions/getEnsResolver.ts +++ b/packages/core/src/actions/getEnsResolver.ts @@ -16,7 +16,7 @@ export type GetEnsResolverReturnType = viem_GetEnsResolverReturnType export type GetEnsResolverError = Error -/** https://alpha.wagmi.sh/core/actions/getEnsResolver */ +/** https://alpha.wagmi.sh/core/api/actions/getEnsResolver */ export function getEnsResolver( config: config, parameters: GetEnsResolverParameters, diff --git a/packages/core/src/actions/getTransaction.ts b/packages/core/src/actions/getTransaction.ts index 832ec75d99..9c71ce9d5d 100644 --- a/packages/core/src/actions/getTransaction.ts +++ b/packages/core/src/actions/getTransaction.ts @@ -28,7 +28,7 @@ export type GetTransactionReturnType< export type GetTransactionError = Error -/** https://alpha.wagmi.sh/core/actions/getTransaction */ +/** https://alpha.wagmi.sh/core/api/actions/getTransaction */ export function getTransaction< config extends Config, chainId extends config['chains'][number]['id'], diff --git a/packages/core/src/actions/readContract.ts b/packages/core/src/actions/readContract.ts index 25d02c0006..3fd4725458 100644 --- a/packages/core/src/actions/readContract.ts +++ b/packages/core/src/actions/readContract.ts @@ -39,7 +39,7 @@ export type ReadContractReturnType< export type ReadContractError = Error -/** https://alpha.wagmi.sh/core/actions/readContract */ +/** https://alpha.wagmi.sh/core/api/actions/readContract */ export function readContract< config extends Config, const abi extends Abi | readonly unknown[], diff --git a/packages/core/src/actions/reconnect.ts b/packages/core/src/actions/reconnect.ts index dd3a421935..51464c1e4a 100644 --- a/packages/core/src/actions/reconnect.ts +++ b/packages/core/src/actions/reconnect.ts @@ -15,7 +15,7 @@ export type ReconnectError = Error let isReconnecting = false -/** https://alpha.wagmi.sh/core/actions/reconnect */ +/** https://alpha.wagmi.sh/core/api/actions/reconnect */ export async function reconnect( config: Config, parameters: ReconnectParameters = {}, diff --git a/packages/core/src/actions/sendTransaction.ts b/packages/core/src/actions/sendTransaction.ts index 5f9dad69ac..6b42016fea 100644 --- a/packages/core/src/actions/sendTransaction.ts +++ b/packages/core/src/actions/sendTransaction.ts @@ -39,7 +39,7 @@ export type SendTransactionReturnType = viem_SendTransactionReturnType export type SendTransactionError = Error -/** https://alpha.wagmi.sh/core/actions/sendTransaction */ +/** https://alpha.wagmi.sh/core/api/actions/sendTransaction */ export async function sendTransaction< config extends Config, chainId extends config['chains'][number]['id'], diff --git a/packages/core/src/actions/signMessage.ts b/packages/core/src/actions/signMessage.ts index 3968cfafe3..93dba98be1 100644 --- a/packages/core/src/actions/signMessage.ts +++ b/packages/core/src/actions/signMessage.ts @@ -18,7 +18,7 @@ export type SignMessageReturnType = viem_SignMessageReturnType export type SignMessageError = Error -/** https://alpha.wagmi.sh/core/actions/signMessage */ +/** https://alpha.wagmi.sh/core/api/actions/signMessage */ export async function signMessage( config: Config, parameters: SignMessageParameters, diff --git a/packages/core/src/actions/signTypedData.ts b/packages/core/src/actions/signTypedData.ts index c6db546f1c..4557bd4d00 100644 --- a/packages/core/src/actions/signTypedData.ts +++ b/packages/core/src/actions/signTypedData.ts @@ -19,7 +19,7 @@ export type SignTypedDataReturnType = viem_SignTypedDataReturnType export type SignTypedDataError = Error -/** https://alpha.wagmi.sh/core/actions/signTypedData */ +/** https://alpha.wagmi.sh/core/api/actions/signTypedData */ export async function signTypedData< const typedData extends TypedData | Record, primaryType extends keyof typedData | 'EIP712Domain', diff --git a/packages/core/src/actions/simulateContract.ts b/packages/core/src/actions/simulateContract.ts index 47c9ba0efe..422686a1f5 100644 --- a/packages/core/src/actions/simulateContract.ts +++ b/packages/core/src/actions/simulateContract.ts @@ -102,7 +102,7 @@ export type SimulateContractReturnType< export type SimulateContractError = Error -/** https://alpha.wagmi.sh/core/actions/simulateContract */ +/** https://alpha.wagmi.sh/core/api/actions/simulateContract */ export async function simulateContract< config extends Config, const abi extends Abi | readonly unknown[], diff --git a/packages/core/src/actions/switchAccount.ts b/packages/core/src/actions/switchAccount.ts index 83b29f3bbc..3587af834d 100644 --- a/packages/core/src/actions/switchAccount.ts +++ b/packages/core/src/actions/switchAccount.ts @@ -16,7 +16,7 @@ export type SwitchAccountReturnType = { export type SwitchAccountError = ConnectorNotConnectedError | Error -/** https://alpha.wagmi.sh/core/actions/switchAccount */ +/** https://alpha.wagmi.sh/core/api/actions/switchAccount */ export async function switchAccount( config: config, parameters: SwitchAccountParameters, diff --git a/packages/core/src/actions/switchChain.ts b/packages/core/src/actions/switchChain.ts index 4c04703269..cc47cc3eda 100644 --- a/packages/core/src/actions/switchChain.ts +++ b/packages/core/src/actions/switchChain.ts @@ -35,7 +35,7 @@ export type SwitchChainError = | BaseError | Error -/** https://alpha.wagmi.sh/core/actions/switchChain */ +/** https://alpha.wagmi.sh/core/api/actions/switchChain */ export async function switchChain< config extends Config, chainId extends config['chains'][number]['id'], diff --git a/packages/core/src/actions/watchAccount.ts b/packages/core/src/actions/watchAccount.ts index 1fae84009b..ba55a29561 100644 --- a/packages/core/src/actions/watchAccount.ts +++ b/packages/core/src/actions/watchAccount.ts @@ -8,7 +8,7 @@ export type WatchAccountParameters = { export type WatchAccountReturnType = () => void -/** https://alpha.wagmi.sh/core/actions/watchAccount */ +/** https://alpha.wagmi.sh/core/api/actions/watchAccount */ export function watchAccount( config: Config, parameters: WatchAccountParameters, diff --git a/packages/core/src/actions/watchBlockNumber.ts b/packages/core/src/actions/watchBlockNumber.ts index b67802c0b5..6eb62e9546 100644 --- a/packages/core/src/actions/watchBlockNumber.ts +++ b/packages/core/src/actions/watchBlockNumber.ts @@ -35,7 +35,7 @@ export type WatchBlockNumberParameters< export type WatchBlockNumberReturnType = viem_WatchBlockNumberReturnType // TODO: wrap in viem's `observe` to avoid duplicate invocations. -/** https://alpha.wagmi.sh/core/actions/watchBlockNumber */ +/** https://alpha.wagmi.sh/core/api/actions/watchBlockNumber */ export function watchBlockNumber< config extends Config, chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], diff --git a/packages/core/src/actions/watchChainId.ts b/packages/core/src/actions/watchChainId.ts index 19497df382..5bda2e56bc 100644 --- a/packages/core/src/actions/watchChainId.ts +++ b/packages/core/src/actions/watchChainId.ts @@ -7,7 +7,7 @@ export type WatchChainIdParameters = { export type WatchChainIdReturnType = () => void -/** https://alpha.wagmi.sh/core/actions/watchChainId */ +/** https://alpha.wagmi.sh/core/api/actions/watchChainId */ export function watchChainId( config: config, parameters: WatchChainIdParameters, diff --git a/packages/core/src/actions/watchConnections.ts b/packages/core/src/actions/watchConnections.ts index 479500643e..629e5dd84f 100644 --- a/packages/core/src/actions/watchConnections.ts +++ b/packages/core/src/actions/watchConnections.ts @@ -11,7 +11,7 @@ export type WatchConnectionsParameters = { export type WatchConnectionsReturnType = () => void -/** https://alpha.wagmi.sh/core/actions/watchConnections */ +/** https://alpha.wagmi.sh/core/api/actions/watchConnections */ export function watchConnections( config: Config, parameters: WatchConnectionsParameters, diff --git a/packages/core/src/actions/watchContractEvent.ts b/packages/core/src/actions/watchContractEvent.ts index 6b5ef1c514..3dffd0f50a 100644 --- a/packages/core/src/actions/watchContractEvent.ts +++ b/packages/core/src/actions/watchContractEvent.ts @@ -46,7 +46,7 @@ export type WatchContractEventParameters< export type WatchContractEventReturnType = viem_WatchContractEventReturnType // TODO: wrap in viem's `observe` to avoid duplicate invocations. -/** https://alpha.wagmi.sh/core/actions/watchContractEvent */ +/** https://alpha.wagmi.sh/core/api/actions/watchContractEvent */ export function watchContractEvent< config extends Config, chainId extends config['chains'][number]['id'], diff --git a/packages/core/src/actions/watchPendingTransactions.ts b/packages/core/src/actions/watchPendingTransactions.ts index 2bd5ed594e..672a00d0e7 100644 --- a/packages/core/src/actions/watchPendingTransactions.ts +++ b/packages/core/src/actions/watchPendingTransactions.ts @@ -36,7 +36,7 @@ export type WatchPendingTransactionsReturnType = viem_WatchPendingTransactionsReturnType // TODO: wrap in viem's `observe` to avoid duplicate invocations. -/** https://alpha.wagmi.sh/core/actions/watchPendingTransactions */ +/** https://alpha.wagmi.sh/core/api/actions/watchPendingTransactions */ export function watchPendingTransactions< config extends Config, chainId extends config['chains'][number]['id'], diff --git a/packages/core/src/actions/writeContract.ts b/packages/core/src/actions/writeContract.ts index fba27c6e9e..9a0d1e87b8 100644 --- a/packages/core/src/actions/writeContract.ts +++ b/packages/core/src/actions/writeContract.ts @@ -58,7 +58,7 @@ export type WriteContractReturnType = viem_WriteContractReturnType export type WriteContractError = Error -/** https://alpha.wagmi.sh/core/actions/writeContract */ +/** https://alpha.wagmi.sh/core/api/actions/writeContract */ export async function writeContract< config extends Config, const abi extends Abi | readonly unknown[], diff --git a/packages/react/src/exports/actions.ts b/packages/react/src/exports/actions.ts index e7d0bd02fd..c6305eb553 100644 --- a/packages/react/src/exports/actions.ts +++ b/packages/react/src/exports/actions.ts @@ -1,4 +1,4 @@ //////////////////////////////////////////////////////////////////////////////// -// @wagmi/core/actions +// @wagmi/core/api/actions export * from '@wagmi/core/actions' diff --git a/packages/react/src/hooks/useAccount.ts b/packages/react/src/hooks/useAccount.ts index 2ec62b8054..abda9b56f9 100644 --- a/packages/react/src/hooks/useAccount.ts +++ b/packages/react/src/hooks/useAccount.ts @@ -14,7 +14,7 @@ export type UseAccountParameters = ConfigParameter export type UseAccountReturnType = GetAccountReturnType -/** https://alpha.wagmi.sh/react/hooks/useAccount */ +/** https://alpha.wagmi.sh/react/api/hooks/useAccount */ export function useAccount( parameters: UseAccountParameters = {}, ): UseAccountReturnType { diff --git a/packages/react/src/hooks/useAccountEffect.ts b/packages/react/src/hooks/useAccountEffect.ts index 8fa9092553..8671f6ac79 100644 --- a/packages/react/src/hooks/useAccountEffect.ts +++ b/packages/react/src/hooks/useAccountEffect.ts @@ -23,7 +23,7 @@ export type UseAccountEffectParameters = Evaluate< } & ConfigParameter > -/** https://alpha.wagmi.sh/react/hooks/useAccountEffect */ +/** https://alpha.wagmi.sh/react/api/hooks/useAccountEffect */ export function useAccountEffect(parameters: UseAccountEffectParameters = {}) { const { onConnect, onDisconnect } = parameters diff --git a/packages/react/src/hooks/useBalance.ts b/packages/react/src/hooks/useBalance.ts index 2a7b50f222..9b479f6a63 100644 --- a/packages/react/src/hooks/useBalance.ts +++ b/packages/react/src/hooks/useBalance.ts @@ -42,7 +42,7 @@ export type UseBalanceReturnType = UseQueryResult< GetBalanceError > -/** https://alpha.wagmi.sh/react/hooks/useBalance */ +/** https://alpha.wagmi.sh/react/api/hooks/useBalance */ export function useBalance< config extends Config = ResolvedRegister['config'], selectData = GetBalanceData, diff --git a/packages/react/src/hooks/useBlockNumber.ts b/packages/react/src/hooks/useBlockNumber.ts index eec3e2a9d5..d55860bd05 100644 --- a/packages/react/src/hooks/useBlockNumber.ts +++ b/packages/react/src/hooks/useBlockNumber.ts @@ -54,7 +54,7 @@ export type UseBlockNumberParameters< export type UseBlockNumberReturnType = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useBlockNumber */ +/** https://alpha.wagmi.sh/react/api/hooks/useBlockNumber */ export function useBlockNumber< config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], diff --git a/packages/react/src/hooks/useChainId.ts b/packages/react/src/hooks/useChainId.ts index cc5cca4ed1..6057a886c7 100644 --- a/packages/react/src/hooks/useChainId.ts +++ b/packages/react/src/hooks/useChainId.ts @@ -18,7 +18,7 @@ export type UseChainIdParameters = export type UseChainIdReturnType = GetChainIdReturnType -/** https://alpha.wagmi.sh/react/hooks/useChainId */ +/** https://alpha.wagmi.sh/react/api/hooks/useChainId */ export function useChainId( parameters: UseChainIdParameters = {}, ): UseChainIdReturnType { diff --git a/packages/react/src/hooks/useConfig.ts b/packages/react/src/hooks/useConfig.ts index 9eb7b3cc78..d3eaa339a3 100644 --- a/packages/react/src/hooks/useConfig.ts +++ b/packages/react/src/hooks/useConfig.ts @@ -12,7 +12,7 @@ export type UseConfigParameters = export type UseConfigReturnType = config -/** https://alpha.wagmi.sh/react/hooks/useConfig */ +/** https://alpha.wagmi.sh/react/api/hooks/useConfig */ export function useConfig( parameters: UseConfigParameters = {}, ): UseConfigReturnType { diff --git a/packages/react/src/hooks/useConnect.ts b/packages/react/src/hooks/useConnect.ts index 619fecbdb6..265be18c83 100644 --- a/packages/react/src/hooks/useConnect.ts +++ b/packages/react/src/hooks/useConnect.ts @@ -48,7 +48,7 @@ export type UseConnectReturnType< } > -/** https://alpha.wagmi.sh/react/hooks/useConnect */ +/** https://alpha.wagmi.sh/react/api/hooks/useConnect */ export function useConnect< config extends Config = ResolvedRegister['config'], context = unknown, diff --git a/packages/react/src/hooks/useConnections.ts b/packages/react/src/hooks/useConnections.ts index 373885ea8c..6ba43d9e81 100644 --- a/packages/react/src/hooks/useConnections.ts +++ b/packages/react/src/hooks/useConnections.ts @@ -14,7 +14,7 @@ export type UseConnectionsParameters = ConfigParameter export type UseConnectionsReturnType = GetConnectionsReturnType -/** https://alpha.wagmi.sh/react/hooks/useConnections */ +/** https://alpha.wagmi.sh/react/api/hooks/useConnections */ export function useConnections( parameters: UseConnectionsParameters = {}, ): UseConnectionsReturnType { diff --git a/packages/react/src/hooks/useConnectorClient.ts b/packages/react/src/hooks/useConnectorClient.ts index 41c5be63b5..182f99c690 100644 --- a/packages/react/src/hooks/useConnectorClient.ts +++ b/packages/react/src/hooks/useConnectorClient.ts @@ -47,7 +47,7 @@ export type UseConnectorClientReturnType< selectData = GetConnectorClientData, > = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useConnectorClient */ +/** https://alpha.wagmi.sh/react/api/hooks/useConnectorClient */ export function useConnectorClient< config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], diff --git a/packages/react/src/hooks/useContractRead.ts b/packages/react/src/hooks/useContractRead.ts index 22e9688c91..4d80c021dd 100644 --- a/packages/react/src/hooks/useContractRead.ts +++ b/packages/react/src/hooks/useContractRead.ts @@ -67,7 +67,7 @@ export type UseContractReadReturnType< selectData = ReadContractData, > = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useContractRead */ +/** https://alpha.wagmi.sh/react/api/hooks/useContractRead */ export function useContractRead< const abi extends Abi | readonly unknown[], functionName extends ContractFunctionName, diff --git a/packages/react/src/hooks/useContractReads.ts b/packages/react/src/hooks/useContractReads.ts index 3f2fa26a04..06f69729bc 100644 --- a/packages/react/src/hooks/useContractReads.ts +++ b/packages/react/src/hooks/useContractReads.ts @@ -48,7 +48,7 @@ export type UseContractReadsReturnType< selectData = ReadContractsData, > = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useContractReads */ +/** https://alpha.wagmi.sh/react/api/hooks/useContractReads */ export function useContractReads< const contracts extends readonly unknown[], allowFailure extends boolean = true, diff --git a/packages/react/src/hooks/useContractSimulate.ts b/packages/react/src/hooks/useContractSimulate.ts index d1e821fd71..6ab307eac0 100644 --- a/packages/react/src/hooks/useContractSimulate.ts +++ b/packages/react/src/hooks/useContractSimulate.ts @@ -63,7 +63,7 @@ export type UseContractSimulateReturnType< selectData = SimulateContractData, > = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useContractSimulate */ +/** https://alpha.wagmi.sh/react/api/hooks/useContractSimulate */ export function useContractSimulate< const abi extends Abi | readonly unknown[], functionName extends ContractFunctionName, diff --git a/packages/react/src/hooks/useContractWrite.ts b/packages/react/src/hooks/useContractWrite.ts index e38ca7d25b..05449b5056 100644 --- a/packages/react/src/hooks/useContractWrite.ts +++ b/packages/react/src/hooks/useContractWrite.ts @@ -51,7 +51,7 @@ export type UseContractWriteReturnType< writeAsync: WriteContractMutateAsync } -/** https://alpha.wagmi.sh/react/hooks/useContractWrite */ +/** https://alpha.wagmi.sh/react/api/hooks/useContractWrite */ export function useContractWrite< config extends Config = ResolvedRegister['config'], context = unknown, diff --git a/packages/react/src/hooks/useDisconnect.ts b/packages/react/src/hooks/useDisconnect.ts index 7b468f0ce3..81749266b0 100644 --- a/packages/react/src/hooks/useDisconnect.ts +++ b/packages/react/src/hooks/useDisconnect.ts @@ -39,7 +39,7 @@ export type UseDisconnectReturnType = Evaluate< } > -/** https://alpha.wagmi.sh/react/hooks/useDisconnect */ +/** https://alpha.wagmi.sh/react/api/hooks/useDisconnect */ export function useDisconnect( parameters: UseDisconnectParameters = {}, ): UseDisconnectReturnType { diff --git a/packages/react/src/hooks/useEnsAddress.ts b/packages/react/src/hooks/useEnsAddress.ts index 4c54afb24b..7f4b6bfc64 100644 --- a/packages/react/src/hooks/useEnsAddress.ts +++ b/packages/react/src/hooks/useEnsAddress.ts @@ -36,7 +36,7 @@ export type UseEnsAddressParameters< export type UseEnsAddressReturnType = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useEnsAddress */ +/** https://alpha.wagmi.sh/react/api/hooks/useEnsAddress */ export function useEnsAddress< config extends Config = ResolvedRegister['config'], selectData = GetEnsAddressData, diff --git a/packages/react/src/hooks/useEnsAvatar.ts b/packages/react/src/hooks/useEnsAvatar.ts index c24623993c..17bea1dfd6 100644 --- a/packages/react/src/hooks/useEnsAvatar.ts +++ b/packages/react/src/hooks/useEnsAvatar.ts @@ -36,7 +36,7 @@ export type UseEnsAvatarParameters< export type UseEnsAvatarReturnType = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useEnsAvatar */ +/** https://alpha.wagmi.sh/react/api/hooks/useEnsAvatar */ export function useEnsAvatar< config extends Config = ResolvedRegister['config'], selectData = GetEnsAvatarData, diff --git a/packages/react/src/hooks/useEnsName.ts b/packages/react/src/hooks/useEnsName.ts index f6cccf157d..0413b907bb 100644 --- a/packages/react/src/hooks/useEnsName.ts +++ b/packages/react/src/hooks/useEnsName.ts @@ -38,7 +38,7 @@ export type UseEnsNameReturnType = UseQueryResult< GetEnsNameError > -/** https://alpha.wagmi.sh/react/hooks/useEnsName */ +/** https://alpha.wagmi.sh/react/api/hooks/useEnsName */ export function useEnsName< config extends Config = ResolvedRegister['config'], selectData = GetEnsNameData, diff --git a/packages/react/src/hooks/useEnsResolver.ts b/packages/react/src/hooks/useEnsResolver.ts index 09f22ee8db..4fc1971ce3 100644 --- a/packages/react/src/hooks/useEnsResolver.ts +++ b/packages/react/src/hooks/useEnsResolver.ts @@ -36,7 +36,7 @@ export type UseEnsResolverParameters< export type UseEnsResolverReturnType = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useEnsResolver */ +/** https://alpha.wagmi.sh/react/api/hooks/useEnsResolver */ export function useEnsResolver< config extends Config = ResolvedRegister['config'], selectData = GetEnsResolverData, diff --git a/packages/react/src/hooks/useEstimateFeesPerGas.ts b/packages/react/src/hooks/useEstimateFeesPerGas.ts index 2d4037766b..f94ec1419f 100644 --- a/packages/react/src/hooks/useEstimateFeesPerGas.ts +++ b/packages/react/src/hooks/useEstimateFeesPerGas.ts @@ -44,7 +44,7 @@ export type UseEstimateFeesPerGasReturnType< selectData = EstimateFeesPerGasData, > = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useEstimateFeesPerGas */ +/** https://alpha.wagmi.sh/react/api/hooks/useEstimateFeesPerGas */ export function useEstimateFeesPerGas< config extends Config = ResolvedRegister['config'], type extends FeeValuesType = 'eip1559', diff --git a/packages/react/src/hooks/useEstimateGas.ts b/packages/react/src/hooks/useEstimateGas.ts index 8f382d9186..f7d001afb3 100644 --- a/packages/react/src/hooks/useEstimateGas.ts +++ b/packages/react/src/hooks/useEstimateGas.ts @@ -35,7 +35,7 @@ export type UseEstimateGasParameters< export type UseEstimateGasReturnType = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useEstimateGas */ +/** https://alpha.wagmi.sh/react/api/hooks/useEstimateGas */ export function useEstimateGas< config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] | undefined = undefined, diff --git a/packages/react/src/hooks/useReconnect.ts b/packages/react/src/hooks/useReconnect.ts index be6fd00c51..7f53fc5e0a 100644 --- a/packages/react/src/hooks/useReconnect.ts +++ b/packages/react/src/hooks/useReconnect.ts @@ -38,7 +38,7 @@ export type UseReconnectReturnType = Evaluate< } > -/** https://alpha.wagmi.sh/react/hooks/useReconnect */ +/** https://alpha.wagmi.sh/react/api/hooks/useReconnect */ export function useReconnect( parameters: UseReconnectParameters = {}, ): UseReconnectReturnType { diff --git a/packages/react/src/hooks/useSendTransaction.ts b/packages/react/src/hooks/useSendTransaction.ts index a35c6d9fed..e9c301f13d 100644 --- a/packages/react/src/hooks/useSendTransaction.ts +++ b/packages/react/src/hooks/useSendTransaction.ts @@ -47,7 +47,7 @@ export type UseSendTransactionReturnType< } > -/** https://alpha.wagmi.sh/react/hooks/useSendTransaction */ +/** https://alpha.wagmi.sh/react/api/hooks/useSendTransaction */ export function useSendTransaction< config extends Config = ResolvedRegister['config'], context = unknown, diff --git a/packages/react/src/hooks/useSignMessage.ts b/packages/react/src/hooks/useSignMessage.ts index 3051e61529..f055f2c006 100644 --- a/packages/react/src/hooks/useSignMessage.ts +++ b/packages/react/src/hooks/useSignMessage.ts @@ -37,7 +37,7 @@ export type UseSignMessageReturnType = Evaluate< } > -/** https://alpha.wagmi.sh/react/hooks/useSignMessage */ +/** https://alpha.wagmi.sh/react/api/hooks/useSignMessage */ export function useSignMessage( parameters: UseSignMessageParameters = {}, ): UseSignMessageReturnType { diff --git a/packages/react/src/hooks/useSignTypedData.ts b/packages/react/src/hooks/useSignTypedData.ts index 1d9f37bf92..a618dcdcf9 100644 --- a/packages/react/src/hooks/useSignTypedData.ts +++ b/packages/react/src/hooks/useSignTypedData.ts @@ -37,7 +37,7 @@ export type UseSignTypedDataReturnType = Evaluate< } > -/** https://alpha.wagmi.sh/react/hooks/useSignTypedData */ +/** https://alpha.wagmi.sh/react/api/hooks/useSignTypedData */ export function useSignTypedData( parameters: UseSignTypedDataParameters = {}, ): UseSignTypedDataReturnType { diff --git a/packages/react/src/hooks/useSwitchAccount.ts b/packages/react/src/hooks/useSwitchAccount.ts index d8a596f8d0..2856139599 100644 --- a/packages/react/src/hooks/useSwitchAccount.ts +++ b/packages/react/src/hooks/useSwitchAccount.ts @@ -50,7 +50,7 @@ export type UseSwitchAccountReturnType< } > -/** https://alpha.wagmi.sh/react/hooks/useSwitchAccount */ +/** https://alpha.wagmi.sh/react/api/hooks/useSwitchAccount */ export function useSwitchAccount< config extends Config = ResolvedRegister['config'], context = unknown, diff --git a/packages/react/src/hooks/useSwitchChain.ts b/packages/react/src/hooks/useSwitchChain.ts index a35db340a1..bd0941ab06 100644 --- a/packages/react/src/hooks/useSwitchChain.ts +++ b/packages/react/src/hooks/useSwitchChain.ts @@ -44,7 +44,7 @@ export type UseSwitchChainReturnType< } > -/** https://alpha.wagmi.sh/react/hooks/useSwitchChain */ +/** https://alpha.wagmi.sh/react/api/hooks/useSwitchChain */ export function useSwitchChain< config extends Config = ResolvedRegister['config'], context = unknown, diff --git a/packages/react/src/hooks/useToken.ts b/packages/react/src/hooks/useToken.ts index 06f27244e7..0df7e8333a 100644 --- a/packages/react/src/hooks/useToken.ts +++ b/packages/react/src/hooks/useToken.ts @@ -38,7 +38,7 @@ export type UseTokenReturnType = UseQueryResult< GetTokenError > -/** https://alpha.wagmi.sh/react/hooks/useToken */ +/** https://alpha.wagmi.sh/react/api/hooks/useToken */ export function useToken< config extends Config = ResolvedRegister['config'], selectData = GetTokenData, diff --git a/packages/react/src/hooks/useTransaction.ts b/packages/react/src/hooks/useTransaction.ts index 6992fbcec6..ad1cc26668 100644 --- a/packages/react/src/hooks/useTransaction.ts +++ b/packages/react/src/hooks/useTransaction.ts @@ -40,7 +40,7 @@ export type UseTransactionReturnType< selectData = GetTransactionData, > = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useTransaction */ +/** https://alpha.wagmi.sh/react/api/hooks/useTransaction */ export function useTransaction< config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], diff --git a/packages/react/src/hooks/useWaitForTransactionReceipt.ts b/packages/react/src/hooks/useWaitForTransactionReceipt.ts index 1ef7d5348e..4080d863d0 100644 --- a/packages/react/src/hooks/useWaitForTransactionReceipt.ts +++ b/packages/react/src/hooks/useWaitForTransactionReceipt.ts @@ -44,7 +44,7 @@ export type UseWaitForTransactionReceiptReturnType< selectData = WaitForTransactionReceiptData, > = UseQueryResult -/** https://alpha.wagmi.sh/react/hooks/useWaitForTransactionReceipt */ +/** https://alpha.wagmi.sh/react/api/hooks/useWaitForTransactionReceipt */ export function useWaitForTransactionReceipt< config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], diff --git a/packages/react/src/hooks/useWatchBlockNumber.ts b/packages/react/src/hooks/useWatchBlockNumber.ts index 85be623599..a4a28014b8 100644 --- a/packages/react/src/hooks/useWatchBlockNumber.ts +++ b/packages/react/src/hooks/useWatchBlockNumber.ts @@ -24,7 +24,7 @@ export type UseWatchBlockNumberParameters< export type UseWatchBlockNumberReturnType = void -/** https://alpha.wagmi.sh/react/hooks/useWatchBlockNumber */ +/** https://alpha.wagmi.sh/react/api/hooks/useWatchBlockNumber */ export function useWatchBlockNumber< config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] = config['chains'][number]['id'], diff --git a/packages/react/src/hooks/useWatchContractEvent.ts b/packages/react/src/hooks/useWatchContractEvent.ts index 68587880f5..1a3851162d 100644 --- a/packages/react/src/hooks/useWatchContractEvent.ts +++ b/packages/react/src/hooks/useWatchContractEvent.ts @@ -30,7 +30,7 @@ export type UseWatchContractEventParameters< export type UseWatchContractEventReturnType = void -/** https://alpha.wagmi.sh/react/hooks/useWatchContractEvent */ +/** https://alpha.wagmi.sh/react/api/hooks/useWatchContractEvent */ export function useWatchContractEvent< const abi extends Abi | readonly unknown[], eventName extends ContractEventName, diff --git a/packages/react/src/hooks/useWatchPendingTransactions.ts b/packages/react/src/hooks/useWatchPendingTransactions.ts index 6a7d2166ce..d046a60cdc 100644 --- a/packages/react/src/hooks/useWatchPendingTransactions.ts +++ b/packages/react/src/hooks/useWatchPendingTransactions.ts @@ -24,7 +24,7 @@ export type UseWatchPendingTransactionsParameters< export type UseWatchPendingTransactionsReturnType = void -/** https://alpha.wagmi.sh/react/hooks/useWatchPendingTransactions */ +/** https://alpha.wagmi.sh/react/api/hooks/useWatchPendingTransactions */ export function useWatchPendingTransactions< config extends Config = ResolvedRegister['config'], chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],