From de7e4fd1d07134fba3c065909a9b976f63da45cf Mon Sep 17 00:00:00 2001 From: Patrick Hughes Date: Tue, 10 Mar 2026 13:15:44 -0500 Subject: [PATCH 1/8] remove onchainkit --- AGENTS.md | 49 +- docs/docs.json | 1253 ++++++++++------- docs/get-started/deploy-smart-contracts.mdx | 2 +- docs/get-started/migrate-from-onchainkit.mdx | 38 + docs/llms-full.txt | 27 +- docs/llms.txt | 1 - .../core-concepts/authentication.mdx | 2 +- docs/mini-apps/core-concepts/navigation.mdx | 6 +- .../technical-guidelines.mdx | 4 +- docs/mini-apps/growth/optimize-onboarding.mdx | 6 +- docs/mini-apps/llms-full.txt | 55 +- docs/mini-apps/llms.txt | 5 +- .../sharing-and-social-graph.mdx | 4 +- .../troubleshooting/common-issues.mdx | 2 +- .../api/build-deposit-to-morpho-tx.mdx | 28 - .../onchainkit/api/build-mint-transaction.mdx | 51 - .../onchainkit/api/build-swap-transaction.mdx | 132 -- .../api/build-withdraw-from-morpho-tx.mdx | 28 - docs/onchainkit/api/get-mint-details.mdx | 65 - docs/onchainkit/api/get-portfolios.mdx | 63 - docs/onchainkit/api/get-swap-quote.mdx | 93 -- docs/onchainkit/api/get-token-details.mdx | 54 - docs/onchainkit/api/get-tokens.mdx | 109 -- docs/onchainkit/api/types.mdx | 159 --- docs/onchainkit/buy/buy.mdx | 117 -- docs/onchainkit/buy/types.mdx | 31 - docs/onchainkit/checkout/checkout.mdx | 491 ------- docs/onchainkit/checkout/types.mdx | 73 - docs/onchainkit/config/is-base.mdx | 38 - docs/onchainkit/config/is-ethereum.mdx | 38 - .../onchainkit/config/onchainkit-provider.mdx | 150 -- .../config/supplemental-providers.mdx | 87 -- docs/onchainkit/config/types.mdx | 74 - .../create-a-basename-profile-component.mdx | 304 ---- docs/onchainkit/earn/earn.mdx | 264 ---- docs/onchainkit/earn/types.mdx | 301 ---- docs/onchainkit/fund/fetch-onramp-config.mdx | 59 - docs/onchainkit/fund/fetch-onramp-options.mdx | 79 -- docs/onchainkit/fund/fetch-onramp-quote.mdx | 113 -- .../fund/fetch-onramp-transaction-status.mdx | 67 - docs/onchainkit/fund/fund-button.mdx | 226 --- docs/onchainkit/fund/fund-card.mdx | 298 ---- docs/onchainkit/fund/get-onramp-buy-url.mdx | 61 - .../fund/setup-onramp-event-listeners.mdx | 61 - docs/onchainkit/fund/types.mdx | 338 ----- docs/onchainkit/getting-started.mdx | 62 - docs/onchainkit/guides/ai-prompting-guide.mdx | 259 ---- docs/onchainkit/guides/build-onchain-apps.mdx | 106 -- docs/onchainkit/guides/contribution.mdx | 143 -- docs/onchainkit/guides/lifecycle-status.mdx | 171 --- docs/onchainkit/guides/reporting-bug.mdx | 29 - docs/onchainkit/guides/tailwind.mdx | 100 -- docs/onchainkit/guides/telemetry.mdx | 80 -- docs/onchainkit/guides/themes.mdx | 203 --- docs/onchainkit/guides/troubleshooting.mdx | 142 -- .../guides/use-basename-in-onchain-app.mdx | 97 -- .../guides/using-ai-powered-ides.mdx | 30 - .../hooks/use-build-deposit-to-morpho-tx.mdx | 32 - .../use-build-withdraw-from-morpho-tx.mdx | 33 - docs/onchainkit/hooks/use-earn-context.mdx | 36 - docs/onchainkit/hooks/use-mint-details.mdx | 86 -- docs/onchainkit/hooks/use-morpho-vault.mdx | 33 - docs/onchainkit/hooks/use-token-details.mdx | 76 - docs/onchainkit/identity/address.mdx | 65 - docs/onchainkit/identity/avatar.mdx | 160 --- docs/onchainkit/identity/badge.mdx | 180 --- docs/onchainkit/identity/get-address.mdx | 46 - docs/onchainkit/identity/get-attestations.mdx | 86 -- docs/onchainkit/identity/get-avatar.mdx | 52 - docs/onchainkit/identity/get-avatars.mdx | 78 - docs/onchainkit/identity/get-name.mdx | 68 - docs/onchainkit/identity/get-names.mdx | 78 - docs/onchainkit/identity/identity-card.mdx | 175 --- docs/onchainkit/identity/identity.mdx | 220 --- docs/onchainkit/identity/name.mdx | 109 -- docs/onchainkit/identity/socials.mdx | 166 --- docs/onchainkit/identity/types.mdx | 253 ---- docs/onchainkit/identity/use-address.mdx | 31 - docs/onchainkit/identity/use-avatar.mdx | 32 - docs/onchainkit/identity/use-avatars.mdx | 68 - docs/onchainkit/identity/use-name.mdx | 57 - docs/onchainkit/identity/use-names.mdx | 68 - docs/onchainkit/installation.mdx | 12 - docs/onchainkit/installation/astro.mdx | 202 --- docs/onchainkit/installation/nextjs.mdx | 179 --- docs/onchainkit/installation/remix.mdx | 200 --- docs/onchainkit/installation/vite.mdx | 162 --- .../latest/components/appchain/bridge.mdx | 495 ------- docs/onchainkit/latest/components/buy/buy.mdx | 141 -- .../latest/components/checkout/checkout.mdx | 517 ------- .../latest/components/connected/connected.mdx | 199 --- .../latest/components/earn/earn.mdx | 337 ----- .../latest/components/fund/fund-button.mdx | 226 --- .../latest/components/fund/fund-card.mdx | 298 ---- .../latest/components/identity/address.mdx | 78 - .../latest/components/identity/avatar.mdx | 160 --- .../latest/components/identity/badge.mdx | 173 --- .../components/identity/identity-card.mdx | 171 --- .../latest/components/identity/identity.mdx | 233 --- .../latest/components/identity/name.mdx | 109 -- .../latest/components/identity/socials.mdx | 164 --- .../components/minikit/hooks/useAddFrame.mdx | 224 --- .../minikit/hooks/useAuthenticate.mdx | 144 -- .../components/minikit/hooks/useClose.mdx | 194 --- .../minikit/hooks/useComposeCast.mdx | 261 ---- .../components/minikit/hooks/useMiniKit.mdx | 171 --- .../minikit/hooks/useNotification.mdx | 409 ------ .../components/minikit/hooks/useOpenUrl.mdx | 77 - .../minikit/hooks/usePrimaryButton.mdx | 242 ---- .../components/minikit/hooks/useViewCast.mdx | 312 ---- .../minikit/hooks/useViewProfile.mdx | 251 ---- .../latest/components/minikit/overview.mdx | 94 -- .../minikit/provider-and-initialization.mdx | 111 -- .../latest/components/mint/nft-card.mdx | 325 ----- .../latest/components/mint/nft-mint-card.mdx | 342 ----- .../latest/components/signature/signature.mdx | 419 ------ .../latest/components/swap/swap-settings.mdx | 210 --- .../latest/components/swap/swap.mdx | 623 -------- .../latest/components/token/token-chip.mdx | 45 - .../latest/components/token/token-image.mdx | 99 -- .../latest/components/token/token-row.mdx | 92 -- .../latest/components/token/token-search.mdx | 59 - .../token/token-select-dropdown.mdx | 75 - .../components/transaction/transaction.mdx | 474 ------- .../wallet/wallet-dropdown-basename.mdx | 85 -- .../wallet/wallet-dropdown-disconnect.mdx | 95 -- .../wallet/wallet-dropdown-fund-link.mdx | 159 --- .../wallet/wallet-dropdown-link.mdx | 138 -- .../components/wallet/wallet-island.mdx | 239 ---- .../latest/components/wallet/wallet-modal.mdx | 152 -- .../latest/components/wallet/wallet.mdx | 440 ------ .../configuration/onchainkit-provider.mdx | 295 ---- .../latest/configuration/themes.mdx | 170 --- .../configuration/wagmi-viem-integration.mdx | 157 --- .../getting-started/manual-installation.mdx | 193 --- .../latest/getting-started/overview.mdx | 61 - .../getting-started/quickstart-guide.mdx | 52 - .../getting-started/troubleshooting.mdx | 111 -- .../latest/guides/ai-prompting-guide.mdx | 239 ---- .../onchainkit/latest/guides/contributing.mdx | 94 -- .../earn/use-build-deposit-to-morpho-tx.mdx | 48 - .../use-build-withdraw-from-morpho-tx.mdx | 50 - .../latest/hooks/earn/use-earn-context.mdx | 81 -- .../latest/hooks/earn/use-morpho-vault.mdx | 75 - .../latest/hooks/identity/use-address.mdx | 45 - .../latest/hooks/identity/use-avatar.mdx | 46 - .../latest/hooks/identity/use-avatars.mdx | 87 -- .../latest/hooks/identity/use-name.mdx | 75 - .../latest/hooks/identity/use-names.mdx | 87 -- .../latest/hooks/mint/use-mint-details.mdx | 128 -- .../latest/hooks/mint/use-token-details.mdx | 104 -- docs/onchainkit/latest/images/quickstart.png | Bin 292948 -> 0 bytes .../earn/build-deposit-to-morpho-tx.mdx | 49 - .../earn/build-withdraw-from-morpho-tx.mdx | 46 - .../utilities/fund/fetch-onramp-config.mdx | 73 - .../utilities/fund/fetch-onramp-options.mdx | 118 -- .../utilities/fund/fetch-onramp-quote.mdx | 151 -- .../fund/fetch-onramp-transaction-status.mdx | 103 -- .../utilities/fund/get-onramp-buy-url.mdx | 61 - .../fund/setup-onramp-event-listeners.mdx | 112 -- .../latest/utilities/identity/get-address.mdx | 69 - .../utilities/identity/get-attestations.mdx | 120 -- .../latest/utilities/identity/get-avatar.mdx | 75 - .../latest/utilities/identity/get-avatars.mdx | 98 -- .../latest/utilities/identity/get-name.mdx | 94 -- .../latest/utilities/identity/get-names.mdx | 103 -- .../latest/utilities/token/format-amount.mdx | 40 - .../wallet/is-valid-aa-entrypoint.mdx | 42 - .../is-wallet-a-coinbase-smart-wallet.mdx | 73 - docs/onchainkit/llms-full.txt | 196 --- docs/onchainkit/llms.txt | 50 - docs/onchainkit/mint/nft-card.mdx | 312 ---- docs/onchainkit/mint/nft-mint-card.mdx | 327 ----- docs/onchainkit/mint/types.mdx | 143 -- docs/onchainkit/paymaster/erc20-paymaster.mdx | 272 ---- docs/onchainkit/paymaster/errors.mdx | 96 -- .../gasless-transactions-with-paymaster.mdx | 680 --------- .../paymaster/how-to-contribute.mdx | 1 - .../onchainkit/paymaster/quickstart-guide.mdx | 116 -- .../paymaster/quickstart-headless.mdx | 196 --- docs/onchainkit/paymaster/security.mdx | 25 - docs/onchainkit/paymaster/troubleshooting.mdx | 107 -- docs/onchainkit/paymaster/welcome.mdx | 11 - docs/onchainkit/restricted.mdx | 16 - docs/onchainkit/signature/signature.mdx | 318 ----- docs/onchainkit/signature/types.mdx | 167 --- docs/onchainkit/swap/swap-settings.mdx | 387 ----- docs/onchainkit/swap/swap.mdx | 703 --------- docs/onchainkit/swap/types.mdx | 239 ---- .../templates/onchain-commerce-app.mdx | 4 - docs/onchainkit/templates/onchain-nft-app.mdx | 4 - .../templates/onchain-social-profile.mdx | 5 - docs/onchainkit/token/format-amount.mdx | 30 - docs/onchainkit/token/token-chip.mdx | 48 - docs/onchainkit/token/token-image.mdx | 148 -- docs/onchainkit/token/token-row.mdx | 186 --- docs/onchainkit/token/token-search.mdx | 55 - .../token/token-select-dropdown.mdx | 103 -- docs/onchainkit/token/types.mdx | 109 -- docs/onchainkit/transaction/transaction.mdx | 394 ------ docs/onchainkit/transaction/types.mdx | 204 --- .../use-coinbase-smart-wallet-and-eoas.mdx | 215 --- .../wallet/is-valid-aa-entrypoint.mdx | 35 - .../is-wallet-a-coinbase-smart-wallet.mdx | 44 - docs/onchainkit/wallet/types.mdx | 180 --- .../wallet/wallet-dropdown-basename.mdx | 114 -- .../wallet/wallet-dropdown-disconnect.mdx | 138 -- .../wallet/wallet-dropdown-fund-link.mdx | 226 --- .../wallet/wallet-dropdown-link.mdx | 217 --- docs/onchainkit/wallet/wallet-island.mdx | 272 ---- docs/onchainkit/wallet/wallet-modal.mdx | 152 -- docs/onchainkit/wallet/wallet.mdx | 377 ----- docs/snippets/ai-powered.mdx | 25 - docs/snippets/installation-options.mdx | 47 - docs/snippets/start-building.mdx | 12 - docs/snippets/svg/miniKitSvg.mdx | 9 - docs/snippets/svg/onchainKitSvg.mdx | 7 - 217 files changed, 826 insertions(+), 30354 deletions(-) create mode 100644 docs/get-started/migrate-from-onchainkit.mdx delete mode 100644 docs/onchainkit/api/build-deposit-to-morpho-tx.mdx delete mode 100644 docs/onchainkit/api/build-mint-transaction.mdx delete mode 100644 docs/onchainkit/api/build-swap-transaction.mdx delete mode 100644 docs/onchainkit/api/build-withdraw-from-morpho-tx.mdx delete mode 100644 docs/onchainkit/api/get-mint-details.mdx delete mode 100644 docs/onchainkit/api/get-portfolios.mdx delete mode 100644 docs/onchainkit/api/get-swap-quote.mdx delete mode 100644 docs/onchainkit/api/get-token-details.mdx delete mode 100644 docs/onchainkit/api/get-tokens.mdx delete mode 100644 docs/onchainkit/api/types.mdx delete mode 100644 docs/onchainkit/buy/buy.mdx delete mode 100644 docs/onchainkit/buy/types.mdx delete mode 100644 docs/onchainkit/checkout/checkout.mdx delete mode 100644 docs/onchainkit/checkout/types.mdx delete mode 100644 docs/onchainkit/config/is-base.mdx delete mode 100644 docs/onchainkit/config/is-ethereum.mdx delete mode 100644 docs/onchainkit/config/onchainkit-provider.mdx delete mode 100644 docs/onchainkit/config/supplemental-providers.mdx delete mode 100644 docs/onchainkit/config/types.mdx delete mode 100644 docs/onchainkit/create-a-basename-profile-component.mdx delete mode 100644 docs/onchainkit/earn/earn.mdx delete mode 100644 docs/onchainkit/earn/types.mdx delete mode 100644 docs/onchainkit/fund/fetch-onramp-config.mdx delete mode 100644 docs/onchainkit/fund/fetch-onramp-options.mdx delete mode 100644 docs/onchainkit/fund/fetch-onramp-quote.mdx delete mode 100644 docs/onchainkit/fund/fetch-onramp-transaction-status.mdx delete mode 100644 docs/onchainkit/fund/fund-button.mdx delete mode 100644 docs/onchainkit/fund/fund-card.mdx delete mode 100644 docs/onchainkit/fund/get-onramp-buy-url.mdx delete mode 100644 docs/onchainkit/fund/setup-onramp-event-listeners.mdx delete mode 100644 docs/onchainkit/fund/types.mdx delete mode 100644 docs/onchainkit/getting-started.mdx delete mode 100644 docs/onchainkit/guides/ai-prompting-guide.mdx delete mode 100644 docs/onchainkit/guides/build-onchain-apps.mdx delete mode 100644 docs/onchainkit/guides/contribution.mdx delete mode 100644 docs/onchainkit/guides/lifecycle-status.mdx delete mode 100644 docs/onchainkit/guides/reporting-bug.mdx delete mode 100644 docs/onchainkit/guides/tailwind.mdx delete mode 100644 docs/onchainkit/guides/telemetry.mdx delete mode 100644 docs/onchainkit/guides/themes.mdx delete mode 100644 docs/onchainkit/guides/troubleshooting.mdx delete mode 100644 docs/onchainkit/guides/use-basename-in-onchain-app.mdx delete mode 100644 docs/onchainkit/guides/using-ai-powered-ides.mdx delete mode 100644 docs/onchainkit/hooks/use-build-deposit-to-morpho-tx.mdx delete mode 100644 docs/onchainkit/hooks/use-build-withdraw-from-morpho-tx.mdx delete mode 100644 docs/onchainkit/hooks/use-earn-context.mdx delete mode 100644 docs/onchainkit/hooks/use-mint-details.mdx delete mode 100644 docs/onchainkit/hooks/use-morpho-vault.mdx delete mode 100644 docs/onchainkit/hooks/use-token-details.mdx delete mode 100644 docs/onchainkit/identity/address.mdx delete mode 100644 docs/onchainkit/identity/avatar.mdx delete mode 100644 docs/onchainkit/identity/badge.mdx delete mode 100644 docs/onchainkit/identity/get-address.mdx delete mode 100644 docs/onchainkit/identity/get-attestations.mdx delete mode 100644 docs/onchainkit/identity/get-avatar.mdx delete mode 100644 docs/onchainkit/identity/get-avatars.mdx delete mode 100644 docs/onchainkit/identity/get-name.mdx delete mode 100644 docs/onchainkit/identity/get-names.mdx delete mode 100644 docs/onchainkit/identity/identity-card.mdx delete mode 100644 docs/onchainkit/identity/identity.mdx delete mode 100644 docs/onchainkit/identity/name.mdx delete mode 100644 docs/onchainkit/identity/socials.mdx delete mode 100644 docs/onchainkit/identity/types.mdx delete mode 100644 docs/onchainkit/identity/use-address.mdx delete mode 100644 docs/onchainkit/identity/use-avatar.mdx delete mode 100644 docs/onchainkit/identity/use-avatars.mdx delete mode 100644 docs/onchainkit/identity/use-name.mdx delete mode 100644 docs/onchainkit/identity/use-names.mdx delete mode 100644 docs/onchainkit/installation.mdx delete mode 100644 docs/onchainkit/installation/astro.mdx delete mode 100644 docs/onchainkit/installation/nextjs.mdx delete mode 100644 docs/onchainkit/installation/remix.mdx delete mode 100644 docs/onchainkit/installation/vite.mdx delete mode 100644 docs/onchainkit/latest/components/appchain/bridge.mdx delete mode 100644 docs/onchainkit/latest/components/buy/buy.mdx delete mode 100644 docs/onchainkit/latest/components/checkout/checkout.mdx delete mode 100644 docs/onchainkit/latest/components/connected/connected.mdx delete mode 100644 docs/onchainkit/latest/components/earn/earn.mdx delete mode 100644 docs/onchainkit/latest/components/fund/fund-button.mdx delete mode 100644 docs/onchainkit/latest/components/fund/fund-card.mdx delete mode 100644 docs/onchainkit/latest/components/identity/address.mdx delete mode 100644 docs/onchainkit/latest/components/identity/avatar.mdx delete mode 100644 docs/onchainkit/latest/components/identity/badge.mdx delete mode 100644 docs/onchainkit/latest/components/identity/identity-card.mdx delete mode 100644 docs/onchainkit/latest/components/identity/identity.mdx delete mode 100644 docs/onchainkit/latest/components/identity/name.mdx delete mode 100644 docs/onchainkit/latest/components/identity/socials.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useAddFrame.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useAuthenticate.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useClose.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useComposeCast.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useMiniKit.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useNotification.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useOpenUrl.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/usePrimaryButton.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useViewCast.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/hooks/useViewProfile.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/overview.mdx delete mode 100644 docs/onchainkit/latest/components/minikit/provider-and-initialization.mdx delete mode 100644 docs/onchainkit/latest/components/mint/nft-card.mdx delete mode 100644 docs/onchainkit/latest/components/mint/nft-mint-card.mdx delete mode 100644 docs/onchainkit/latest/components/signature/signature.mdx delete mode 100644 docs/onchainkit/latest/components/swap/swap-settings.mdx delete mode 100644 docs/onchainkit/latest/components/swap/swap.mdx delete mode 100644 docs/onchainkit/latest/components/token/token-chip.mdx delete mode 100644 docs/onchainkit/latest/components/token/token-image.mdx delete mode 100644 docs/onchainkit/latest/components/token/token-row.mdx delete mode 100644 docs/onchainkit/latest/components/token/token-search.mdx delete mode 100644 docs/onchainkit/latest/components/token/token-select-dropdown.mdx delete mode 100644 docs/onchainkit/latest/components/transaction/transaction.mdx delete mode 100644 docs/onchainkit/latest/components/wallet/wallet-dropdown-basename.mdx delete mode 100644 docs/onchainkit/latest/components/wallet/wallet-dropdown-disconnect.mdx delete mode 100644 docs/onchainkit/latest/components/wallet/wallet-dropdown-fund-link.mdx delete mode 100644 docs/onchainkit/latest/components/wallet/wallet-dropdown-link.mdx delete mode 100644 docs/onchainkit/latest/components/wallet/wallet-island.mdx delete mode 100644 docs/onchainkit/latest/components/wallet/wallet-modal.mdx delete mode 100644 docs/onchainkit/latest/components/wallet/wallet.mdx delete mode 100644 docs/onchainkit/latest/configuration/onchainkit-provider.mdx delete mode 100644 docs/onchainkit/latest/configuration/themes.mdx delete mode 100644 docs/onchainkit/latest/configuration/wagmi-viem-integration.mdx delete mode 100644 docs/onchainkit/latest/getting-started/manual-installation.mdx delete mode 100644 docs/onchainkit/latest/getting-started/overview.mdx delete mode 100644 docs/onchainkit/latest/getting-started/quickstart-guide.mdx delete mode 100644 docs/onchainkit/latest/getting-started/troubleshooting.mdx delete mode 100644 docs/onchainkit/latest/guides/ai-prompting-guide.mdx delete mode 100644 docs/onchainkit/latest/guides/contributing.mdx delete mode 100644 docs/onchainkit/latest/hooks/earn/use-build-deposit-to-morpho-tx.mdx delete mode 100644 docs/onchainkit/latest/hooks/earn/use-build-withdraw-from-morpho-tx.mdx delete mode 100644 docs/onchainkit/latest/hooks/earn/use-earn-context.mdx delete mode 100644 docs/onchainkit/latest/hooks/earn/use-morpho-vault.mdx delete mode 100644 docs/onchainkit/latest/hooks/identity/use-address.mdx delete mode 100644 docs/onchainkit/latest/hooks/identity/use-avatar.mdx delete mode 100644 docs/onchainkit/latest/hooks/identity/use-avatars.mdx delete mode 100644 docs/onchainkit/latest/hooks/identity/use-name.mdx delete mode 100644 docs/onchainkit/latest/hooks/identity/use-names.mdx delete mode 100644 docs/onchainkit/latest/hooks/mint/use-mint-details.mdx delete mode 100644 docs/onchainkit/latest/hooks/mint/use-token-details.mdx delete mode 100644 docs/onchainkit/latest/images/quickstart.png delete mode 100644 docs/onchainkit/latest/utilities/earn/build-deposit-to-morpho-tx.mdx delete mode 100644 docs/onchainkit/latest/utilities/earn/build-withdraw-from-morpho-tx.mdx delete mode 100644 docs/onchainkit/latest/utilities/fund/fetch-onramp-config.mdx delete mode 100644 docs/onchainkit/latest/utilities/fund/fetch-onramp-options.mdx delete mode 100644 docs/onchainkit/latest/utilities/fund/fetch-onramp-quote.mdx delete mode 100644 docs/onchainkit/latest/utilities/fund/fetch-onramp-transaction-status.mdx delete mode 100644 docs/onchainkit/latest/utilities/fund/get-onramp-buy-url.mdx delete mode 100644 docs/onchainkit/latest/utilities/fund/setup-onramp-event-listeners.mdx delete mode 100644 docs/onchainkit/latest/utilities/identity/get-address.mdx delete mode 100644 docs/onchainkit/latest/utilities/identity/get-attestations.mdx delete mode 100644 docs/onchainkit/latest/utilities/identity/get-avatar.mdx delete mode 100644 docs/onchainkit/latest/utilities/identity/get-avatars.mdx delete mode 100644 docs/onchainkit/latest/utilities/identity/get-name.mdx delete mode 100644 docs/onchainkit/latest/utilities/identity/get-names.mdx delete mode 100644 docs/onchainkit/latest/utilities/token/format-amount.mdx delete mode 100644 docs/onchainkit/latest/utilities/wallet/is-valid-aa-entrypoint.mdx delete mode 100644 docs/onchainkit/latest/utilities/wallet/is-wallet-a-coinbase-smart-wallet.mdx delete mode 100644 docs/onchainkit/llms-full.txt delete mode 100644 docs/onchainkit/llms.txt delete mode 100644 docs/onchainkit/mint/nft-card.mdx delete mode 100644 docs/onchainkit/mint/nft-mint-card.mdx delete mode 100644 docs/onchainkit/mint/types.mdx delete mode 100644 docs/onchainkit/paymaster/erc20-paymaster.mdx delete mode 100644 docs/onchainkit/paymaster/errors.mdx delete mode 100644 docs/onchainkit/paymaster/gasless-transactions-with-paymaster.mdx delete mode 100644 docs/onchainkit/paymaster/how-to-contribute.mdx delete mode 100644 docs/onchainkit/paymaster/quickstart-guide.mdx delete mode 100644 docs/onchainkit/paymaster/quickstart-headless.mdx delete mode 100644 docs/onchainkit/paymaster/security.mdx delete mode 100644 docs/onchainkit/paymaster/troubleshooting.mdx delete mode 100644 docs/onchainkit/paymaster/welcome.mdx delete mode 100644 docs/onchainkit/restricted.mdx delete mode 100644 docs/onchainkit/signature/signature.mdx delete mode 100644 docs/onchainkit/signature/types.mdx delete mode 100644 docs/onchainkit/swap/swap-settings.mdx delete mode 100644 docs/onchainkit/swap/swap.mdx delete mode 100644 docs/onchainkit/swap/types.mdx delete mode 100644 docs/onchainkit/templates/onchain-commerce-app.mdx delete mode 100644 docs/onchainkit/templates/onchain-nft-app.mdx delete mode 100644 docs/onchainkit/templates/onchain-social-profile.mdx delete mode 100644 docs/onchainkit/token/format-amount.mdx delete mode 100644 docs/onchainkit/token/token-chip.mdx delete mode 100644 docs/onchainkit/token/token-image.mdx delete mode 100644 docs/onchainkit/token/token-row.mdx delete mode 100644 docs/onchainkit/token/token-search.mdx delete mode 100644 docs/onchainkit/token/token-select-dropdown.mdx delete mode 100644 docs/onchainkit/token/types.mdx delete mode 100644 docs/onchainkit/transaction/transaction.mdx delete mode 100644 docs/onchainkit/transaction/types.mdx delete mode 100644 docs/onchainkit/use-coinbase-smart-wallet-and-eoas.mdx delete mode 100644 docs/onchainkit/wallet/is-valid-aa-entrypoint.mdx delete mode 100644 docs/onchainkit/wallet/is-wallet-a-coinbase-smart-wallet.mdx delete mode 100644 docs/onchainkit/wallet/types.mdx delete mode 100644 docs/onchainkit/wallet/wallet-dropdown-basename.mdx delete mode 100644 docs/onchainkit/wallet/wallet-dropdown-disconnect.mdx delete mode 100644 docs/onchainkit/wallet/wallet-dropdown-fund-link.mdx delete mode 100644 docs/onchainkit/wallet/wallet-dropdown-link.mdx delete mode 100644 docs/onchainkit/wallet/wallet-island.mdx delete mode 100644 docs/onchainkit/wallet/wallet-modal.mdx delete mode 100644 docs/onchainkit/wallet/wallet.mdx delete mode 100644 docs/snippets/ai-powered.mdx delete mode 100644 docs/snippets/installation-options.mdx delete mode 100644 docs/snippets/start-building.mdx delete mode 100644 docs/snippets/svg/miniKitSvg.mdx delete mode 100644 docs/snippets/svg/onchainKitSvg.mdx diff --git a/AGENTS.md b/AGENTS.md index 8c1ba9a22..d6cdb3d3b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,10 +1,10 @@ # Base Docs Index IMPORTANT: Prefer retrieval-led reasoning. Read relevant docs before generating code. -Base is an Ethereum L2 by Coinbase. Docs for: Base Chain, Smart Wallet, OnchainKit, MiniKit. +Base is an Ethereum L2 by Coinbase. Docs for: Base Chain, Smart Wallet, MiniKit. [Docs]|root:./docs |ai-agents:index,trading |ai-agents/core-concepts:agent-apps,agent-frameworks,identity-verification-auth,payments-and-transactions,wallets -|base-account/basenames:basename-transfer,basenames-faq,basenames-onchainkit-tutorial,basenames-wagmi-tutorial +|base-account/basenames:basename-transfer,basenames-faq,basenames-wagmi-tutorial |base-account/contribute:contribute-to-base-account-docs,security-and-bug-bounty |base-account/framework-integrations:cdp,rainbowkit,reown,thirdweb |base-account/framework-integrations/privy:authentication,setup,spend-permissions,sub-accounts,wallet-actions @@ -43,49 +43,4 @@ Base is an Ethereum L2 by Coinbase. Docs for: Base Chain, Smart Wallet, OnchainK |mini-apps/resources:design-resources,templates |mini-apps/technical-guides:accept-payments,building-chat-agents,dynamic-embeds,neynar-notifications,sharing-and-social-graph,sign-manifest |mini-apps/troubleshooting:base-app-compatibility,common-issues,error-handling,how-search-works,testing -|onchainkit:create-a-basename-profile-component,getting-started,installation,restricted,use-coinbase-smart-wallet-and-eoas -|onchainkit/api:build-deposit-to-morpho-tx,build-mint-transaction,build-swap-transaction,build-withdraw-from-morpho-tx,get-mint-details,get-portfolios,get-swap-quote,get-token-details,get-tokens,types -|onchainkit/buy:buy,types -|onchainkit/checkout:checkout,types -|onchainkit/config:is-base,is-ethereum,onchainkit-provider,supplemental-providers,types -|onchainkit/earn:earn,types -|onchainkit/fund:fetch-onramp-config,fetch-onramp-options,fetch-onramp-quote,fetch-onramp-transaction-status,fund-button,fund-card,get-onramp-buy-url,setup-onramp-event-listeners,types -|onchainkit/guides:ai-prompting-guide,build-onchain-apps,contribution,lifecycle-status,reporting-bug,tailwind,telemetry,themes,troubleshooting,use-basename-in-onchain-app,using-ai-powered-ides -|onchainkit/hooks:use-build-deposit-to-morpho-tx,use-build-withdraw-from-morpho-tx,use-earn-context,use-mint-details,use-morpho-vault,use-token-details -|onchainkit/identity:address,avatar,badge,get-address,get-attestations,get-avatar,get-avatars,get-name,get-names,identity-card,identity,name,socials,types,use-address,use-avatar,use-avatars,use-name,use-names -|onchainkit/installation:astro,nextjs,remix,vite -|onchainkit/latest/components/appchain:bridge -|onchainkit/latest/components/buy:buy -|onchainkit/latest/components/checkout:checkout -|onchainkit/latest/components/connected:connected -|onchainkit/latest/components/earn:earn -|onchainkit/latest/components/fund:fund-button,fund-card -|onchainkit/latest/components/identity:address,avatar,badge,identity-card,identity,name,socials -|onchainkit/latest/components/minikit:overview,provider-and-initialization -|onchainkit/latest/components/minikit/hooks:useAddFrame,useAuthenticate,useClose,useComposeCast,useMiniKit,useNotification,useOpenUrl,usePrimaryButton,useViewCast,useViewProfile -|onchainkit/latest/components/mint:nft-card,nft-mint-card -|onchainkit/latest/components/signature:signature -|onchainkit/latest/components/swap:swap-settings,swap -|onchainkit/latest/components/token:token-chip,token-image,token-row,token-search,token-select-dropdown -|onchainkit/latest/components/transaction:transaction -|onchainkit/latest/components/wallet:wallet-dropdown-basename,wallet-dropdown-disconnect,wallet-dropdown-fund-link,wallet-dropdown-link,wallet-island,wallet-modal,wallet -|onchainkit/latest/configuration:onchainkit-provider,themes,wagmi-viem-integration -|onchainkit/latest/getting-started:manual-installation,overview,quickstart-guide,troubleshooting -|onchainkit/latest/guides:ai-prompting-guide,contributing -|onchainkit/latest/hooks/earn:use-build-deposit-to-morpho-tx,use-build-withdraw-from-morpho-tx,use-earn-context,use-morpho-vault -|onchainkit/latest/hooks/identity:use-address,use-avatar,use-avatars,use-name,use-names -|onchainkit/latest/hooks/mint:use-mint-details,use-token-details -|onchainkit/latest/utilities/earn:build-deposit-to-morpho-tx,build-withdraw-from-morpho-tx -|onchainkit/latest/utilities/fund:fetch-onramp-config,fetch-onramp-options,fetch-onramp-quote,fetch-onramp-transaction-status,get-onramp-buy-url,setup-onramp-event-listeners -|onchainkit/latest/utilities/identity:get-address,get-attestations,get-avatar,get-avatars,get-name,get-names -|onchainkit/latest/utilities/token:format-amount -|onchainkit/latest/utilities/wallet:is-valid-aa-entrypoint,is-wallet-a-coinbase-smart-wallet -|onchainkit/mint:nft-card,nft-mint-card,types -|onchainkit/paymaster:erc20-paymaster,errors,gasless-transactions-with-paymaster,how-to-contribute,quickstart-guide,quickstart-headless,security,troubleshooting,welcome -|onchainkit/signature:signature,types -|onchainkit/swap:swap-settings,swap,types -|onchainkit/templates:onchain-commerce-app,onchain-nft-app,onchain-social-profile -|onchainkit/token:format-amount,token-chip,token-image,token-row,token-search,token-select-dropdown,types -|onchainkit/transaction:transaction,types -|onchainkit/wallet:is-valid-aa-entrypoint,is-wallet-a-coinbase-smart-wallet,types,wallet-dropdown-basename,wallet-dropdown-disconnect,wallet-dropdown-fund-link,wallet-dropdown-link,wallet-island,wallet-modal,wallet |root:AGENTS,cookie-policy,privacy-policy,terms-of-service,tone_of_voice diff --git a/docs/docs.json b/docs/docs.json index 2c4c70279..de3d4ffd7 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -42,7 +42,8 @@ "get-started/build-app", "get-started/launch-token", "get-started/deploy-smart-contracts", - "get-started/learning-resources" + "get-started/learning-resources", + "get-started/migrate-from-onchainkit" ] }, { @@ -540,508 +541,6 @@ ] } ] - }, - { - "tab": "OnchainKit", - "versions": [ - { - "version": "latest", - "groups": [ - { - "group": "Getting started", - "pages": [ - "onchainkit/latest/getting-started/overview", - "onchainkit/latest/getting-started/quickstart-guide", - "onchainkit/latest/getting-started/manual-installation", - "onchainkit/latest/getting-started/troubleshooting" - ] - }, - { - "group": "Configuration", - "pages": [ - "onchainkit/latest/configuration/onchainkit-provider", - "onchainkit/latest/configuration/wagmi-viem-integration", - "onchainkit/latest/configuration/themes" - ] - }, - { - "group": "Components", - "pages": [ - { - "group": "Buy", - "pages": [ - "onchainkit/latest/components/buy/buy" - ] - }, - { - "group": "Checkout", - "pages": [ - "onchainkit/latest/components/checkout/checkout" - ] - }, - { - "group": "Earn", - "pages": [ - "onchainkit/latest/components/earn/earn" - ] - }, - { - "group": "Fund", - "pages": [ - "onchainkit/latest/components/fund/fund-button", - "onchainkit/latest/components/fund/fund-card" - ] - }, - { - "group": "Identity", - "pages": [ - "onchainkit/latest/components/identity/identity", - "onchainkit/latest/components/identity/address", - "onchainkit/latest/components/identity/avatar", - "onchainkit/latest/components/identity/badge", - "onchainkit/latest/components/identity/identity-card", - "onchainkit/latest/components/identity/name", - "onchainkit/latest/components/identity/socials" - ] - }, - { - "group": "Mint", - "pages": [ - "onchainkit/latest/components/mint/nft-card", - "onchainkit/latest/components/mint/nft-mint-card" - ] - }, - { - "group": "MiniKit", - "pages": [ - "onchainkit/latest/components/minikit/overview", - "onchainkit/latest/components/minikit/provider-and-initialization", - { - "group": "Hooks", - "pages": [ - "onchainkit/latest/components/minikit/hooks/useMiniKit", - "onchainkit/latest/components/minikit/hooks/useOpenUrl", - "onchainkit/latest/components/minikit/hooks/useClose", - "onchainkit/latest/components/minikit/hooks/usePrimaryButton", - "onchainkit/latest/components/minikit/hooks/useViewProfile", - "onchainkit/latest/components/minikit/hooks/useComposeCast", - "onchainkit/latest/components/minikit/hooks/useViewCast", - "onchainkit/latest/components/minikit/hooks/useAuthenticate", - "onchainkit/latest/components/minikit/hooks/useAddFrame", - "onchainkit/latest/components/minikit/hooks/useNotification" - ] - } - ] - }, - { - "group": "Signature", - "pages": [ - "onchainkit/latest/components/signature/signature" - ] - }, - { - "group": "Swap", - "pages": [ - "onchainkit/latest/components/swap/swap", - "onchainkit/latest/components/swap/swap-settings" - ] - }, - { - "group": "Token", - "pages": [ - "onchainkit/latest/components/token/token-chip", - "onchainkit/latest/components/token/token-image", - "onchainkit/latest/components/token/token-row", - "onchainkit/latest/components/token/token-search", - "onchainkit/latest/components/token/token-select-dropdown" - ] - }, - { - "group": "Transaction", - "pages": [ - "onchainkit/latest/components/transaction/transaction" - ] - }, - { - "group": "Wallet", - "pages": [ - "onchainkit/latest/components/wallet/wallet", - "onchainkit/latest/components/wallet/wallet-dropdown-basename", - "onchainkit/latest/components/wallet/wallet-dropdown-disconnect", - "onchainkit/latest/components/wallet/wallet-dropdown-fund-link", - "onchainkit/latest/components/wallet/wallet-dropdown-link", - "onchainkit/latest/components/wallet/wallet-island", - "onchainkit/latest/components/wallet/wallet-modal" - ] - }, - { - "group": "Connected", - "pages": [ - "onchainkit/latest/components/connected/connected" - ] - } - ] - }, - { - "group": "Utilities", - "pages": [ - { - "group": "Earn", - "pages": [ - "onchainkit/latest/utilities/earn/build-deposit-to-morpho-tx", - "onchainkit/latest/utilities/earn/build-withdraw-from-morpho-tx" - ] - }, - { - "group": "Fund", - "pages": [ - "onchainkit/latest/utilities/fund/get-onramp-buy-url", - "onchainkit/latest/utilities/fund/fetch-onramp-config", - "onchainkit/latest/utilities/fund/fetch-onramp-quote", - "onchainkit/latest/utilities/fund/fetch-onramp-options", - "onchainkit/latest/utilities/fund/fetch-onramp-transaction-status", - "onchainkit/latest/utilities/fund/setup-onramp-event-listeners" - ] - }, - { - "group": "Identity", - "pages": [ - "onchainkit/latest/utilities/identity/get-address", - "onchainkit/latest/utilities/identity/get-attestations", - "onchainkit/latest/utilities/identity/get-avatar", - "onchainkit/latest/utilities/identity/get-avatars", - "onchainkit/latest/utilities/identity/get-name", - "onchainkit/latest/utilities/identity/get-names" - ] - }, - { - "group": "Token", - "pages": [ - "onchainkit/latest/utilities/token/format-amount" - ] - }, - { - "group": "Wallet", - "pages": [ - "onchainkit/latest/utilities/wallet/is-valid-aa-entrypoint", - "onchainkit/latest/utilities/wallet/is-wallet-a-coinbase-smart-wallet" - ] - } - ] - }, - { - "group": "Hooks", - "pages": [ - { - "group": "Earn", - "pages": [ - "onchainkit/latest/hooks/earn/use-earn-context", - "onchainkit/latest/hooks/earn/use-build-deposit-to-morpho-tx", - "onchainkit/latest/hooks/earn/use-build-withdraw-from-morpho-tx", - "onchainkit/latest/hooks/earn/use-morpho-vault" - ] - }, - { - "group": "Identity", - "pages": [ - "onchainkit/latest/hooks/identity/use-address", - "onchainkit/latest/hooks/identity/use-avatar", - "onchainkit/latest/hooks/identity/use-avatars", - "onchainkit/latest/hooks/identity/use-name", - "onchainkit/latest/hooks/identity/use-names" - ] - }, - { - "group": "Mint", - "pages": [ - "onchainkit/latest/hooks/mint/use-token-details", - "onchainkit/latest/hooks/mint/use-mint-details" - ] - } - ] - }, - { - "group": "Guides", - "pages": [ - "onchainkit/latest/guides/ai-prompting-guide", - "onchainkit/latest/guides/contributing" - ] - } - ] - }, - { - "version": "v0.38.x", - "groups": [ - { - "group": "Introduction", - "pages": [ - "onchainkit/getting-started", - "onchainkit/guides/telemetry", - "onchainkit/guides/troubleshooting" - ] - }, - { - "group": "Installation", - "pages": [ - "onchainkit/installation/nextjs", - "onchainkit/installation/vite", - "onchainkit/installation/remix", - "onchainkit/installation/astro" - ] - }, - { - "group": "Config", - "pages": [ - "onchainkit/config/onchainkit-provider", - "onchainkit/config/supplemental-providers" - ] - }, - { - "group": "Guides", - "pages": [ - "onchainkit/guides/lifecycle-status", - "onchainkit/guides/tailwind", - "onchainkit/guides/themes", - "onchainkit/guides/use-basename-in-onchain-app", - "onchainkit/guides/using-ai-powered-ides", - "onchainkit/guides/ai-prompting-guide" - ] - }, - { - "group": "Templates", - "pages": [ - "onchainkit/templates/onchain-nft-app", - "onchainkit/templates/onchain-commerce-app", - "onchainkit/templates/onchain-social-profile" - ] - }, - { - "group": "Components", - "pages": [ - { - "group": "Buy", - "pages": [ - "onchainkit/buy/buy" - ] - }, - { - "group": "Checkout", - "pages": [ - "onchainkit/checkout/checkout" - ] - }, - { - "group": "Earn", - "pages": [ - "onchainkit/earn/earn" - ] - }, - { - "group": "Fund", - "pages": [ - "onchainkit/fund/fund-button", - "onchainkit/fund/fund-card" - ] - }, - { - "group": "Identity", - "pages": [ - "onchainkit/identity/identity", - "onchainkit/identity/address", - "onchainkit/identity/avatar", - "onchainkit/identity/badge", - "onchainkit/identity/identity-card", - "onchainkit/identity/name", - "onchainkit/identity/socials" - ] - }, - { - "group": "Mint", - "pages": [ - "onchainkit/mint/nft-card", - "onchainkit/mint/nft-mint-card" - ] - }, - "onchainkit/signature/signature", - { - "group": "Swap", - "pages": [ - "onchainkit/swap/swap", - "onchainkit/swap/swap-settings" - ] - }, - { - "group": "Token", - "pages": [ - "onchainkit/token/token-chip", - "onchainkit/token/token-image", - "onchainkit/token/token-row", - "onchainkit/token/token-search", - "onchainkit/token/token-select-dropdown" - ] - }, - "onchainkit/transaction/transaction", - { - "group": "Wallet", - "pages": [ - "onchainkit/wallet/wallet", - "onchainkit/wallet/wallet-dropdown-basename", - "onchainkit/wallet/wallet-dropdown-disconnect", - "onchainkit/wallet/wallet-dropdown-fund-link", - "onchainkit/wallet/wallet-dropdown-link", - "onchainkit/wallet/wallet-island", - "onchainkit/wallet/wallet-modal" - ] - } - ] - }, - { - "group": "API", - "pages": [ - { - "group": "Mint", - "pages": [ - "onchainkit/api/get-token-details", - "onchainkit/api/get-mint-details", - "onchainkit/api/build-mint-transaction" - ] - }, - { - "group": "Swap", - "pages": [ - "onchainkit/api/build-swap-transaction", - "onchainkit/api/get-swap-quote" - ] - }, - { - "group": "Token", - "pages": [ - "onchainkit/api/get-tokens" - ] - }, - { - "group": "Wallet", - "pages": [ - "onchainkit/api/get-portfolios" - ] - } - ] - }, - { - "group": "Utilities", - "pages": [ - { - "group": "Config", - "pages": [ - "onchainkit/config/is-base", - "onchainkit/config/is-ethereum" - ] - }, - { - "group": "Earn", - "pages": [ - "onchainkit/api/build-deposit-to-morpho-tx", - "onchainkit/api/build-withdraw-from-morpho-tx", - "onchainkit/hooks/use-build-deposit-to-morpho-tx", - "onchainkit/hooks/use-build-withdraw-from-morpho-tx", - "onchainkit/hooks/use-earn-context" - ] - }, - { - "group": "Fund", - "pages": [ - "onchainkit/fund/get-onramp-buy-url", - "onchainkit/fund/fetch-onramp-config", - "onchainkit/fund/fetch-onramp-quote", - "onchainkit/fund/fetch-onramp-options", - "onchainkit/fund/fetch-onramp-transaction-status", - "onchainkit/fund/setup-onramp-event-listeners" - ] - }, - { - "group": "Identity", - "pages": [ - "onchainkit/identity/get-address", - "onchainkit/identity/get-attestations", - "onchainkit/identity/get-avatar", - "onchainkit/identity/get-avatars", - "onchainkit/identity/get-name", - "onchainkit/identity/get-names", - "onchainkit/identity/use-address", - "onchainkit/identity/use-avatar", - "onchainkit/identity/use-avatars", - "onchainkit/identity/use-name", - "onchainkit/identity/use-names" - ] - }, - { - "group": "Mint", - "pages": [ - "onchainkit/hooks/use-token-details", - "onchainkit/hooks/use-mint-details" - ] - }, - { - "group": "Token", - "pages": [ - "onchainkit/token/format-amount" - ] - }, - { - "group": "Wallet", - "pages": [ - "onchainkit/wallet/is-valid-aa-entrypoint", - "onchainkit/wallet/is-wallet-a-coinbase-smart-wallet" - ] - } - ] - }, - { - "group": "Types", - "pages": [ - "onchainkit/api/types", - "onchainkit/checkout/types", - "onchainkit/config/types", - "onchainkit/earn/types", - "onchainkit/fund/types", - "onchainkit/identity/types", - "onchainkit/mint/types", - "onchainkit/signature/types", - "onchainkit/swap/types", - "onchainkit/token/types", - "onchainkit/transaction/types", - "onchainkit/wallet/types" - ] - }, - { - "group": "Contribution", - "pages": [ - "onchainkit/guides/contribution", - "onchainkit/guides/reporting-bug" - ] - } - ] - } - ], - "global": { - "anchors": [ - { - "anchor": "GitHub", - "href": "https://github.com/coinbase/onchainkit", - "icon": "github" - }, - { - "anchor": "Playground", - "href": "https://onchainkit.xyz/playground", - "icon": "gamepad" - }, - { - "anchor": "Support", - "href": "https://discord.com/invite/buildonbase", - "icon": "discord" - } - ] - } } ] }, @@ -1104,6 +603,754 @@ ] }, "redirects": [ + { + "source": "/onchainkit/getting-started", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/getting-started/overview", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/getting-started/quickstart-guide", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/getting-started/manual-installation", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/getting-started/troubleshooting", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/installation/nextjs", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/installation/vite", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/installation/remix", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/installation/astro", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/config/onchainkit-provider", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/config/supplemental-providers", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/config/is-base", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/config/is-ethereum", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/config/types", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/configuration/onchainkit-provider", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/configuration/wagmi-viem-integration", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/configuration/themes", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/telemetry", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/troubleshooting", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/lifecycle-status", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/tailwind", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/themes", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/use-basename-in-onchain-app", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/using-ai-powered-ides", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/ai-prompting-guide", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/contribution", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/guides/reporting-bug", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/guides/ai-prompting-guide", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/guides/contributing", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/templates/onchain-nft-app", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/templates/onchain-commerce-app", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/templates/onchain-social-profile", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/welcome", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/quickstart-guide", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/quickstart-headless", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/erc20-paymaster", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/gasless-transactions-with-paymaster", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/security", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/troubleshooting", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/errors", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/paymaster/how-to-contribute", + "destination": "/get-started/build-app" + }, + { + "source": "/onchainkit/latest/components/minikit/overview", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/provider-and-initialization", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useMiniKit", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useOpenUrl", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useClose", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/usePrimaryButton", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useViewProfile", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useComposeCast", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useViewCast", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useAuthenticate", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useAddFrame", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/latest/components/minikit/hooks/useNotification", + "destination": "/mini-apps/introduction/overview" + }, + { + "source": "/onchainkit/identity/identity", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/address", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/avatar", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/badge", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/identity-card", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/name", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/socials", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/get-address", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/get-attestations", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/get-avatar", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/get-avatars", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/get-name", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/get-names", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/use-address", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/use-avatar", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/use-avatars", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/use-name", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/use-names", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/identity/types", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/components/identity/identity", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/components/identity/address", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/components/identity/avatar", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/components/identity/badge", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/components/identity/identity-card", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/components/identity/name", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/components/identity/socials", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/utilities/identity/get-address", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/utilities/identity/get-attestations", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/utilities/identity/get-avatar", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/utilities/identity/get-avatars", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/utilities/identity/get-name", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/utilities/identity/get-names", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/hooks/identity/use-address", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/hooks/identity/use-avatar", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/hooks/identity/use-avatars", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/hooks/identity/use-name", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/latest/hooks/identity/use-names", + "destination": "/base-account/basenames/basenames-wagmi-tutorial" + }, + { + "source": "/onchainkit/checkout/checkout", + "destination": "/mini-apps/technical-guides/accept-payments" + }, + { + "source": "/onchainkit/checkout/types", + "destination": "/mini-apps/technical-guides/accept-payments" + }, + { + "source": "/onchainkit/latest/components/checkout/checkout", + "destination": "/mini-apps/technical-guides/accept-payments" + }, + { + "source": "/onchainkit/wallet/wallet", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/wallet-dropdown-basename", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/wallet-dropdown-disconnect", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/wallet-dropdown-fund-link", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/wallet-dropdown-link", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/wallet-island", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/wallet-modal", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/is-valid-aa-entrypoint", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/is-wallet-a-coinbase-smart-wallet", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/wallet/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/wallet/wallet", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/wallet/wallet-dropdown-basename", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/wallet/wallet-dropdown-disconnect", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/wallet/wallet-dropdown-fund-link", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/wallet/wallet-dropdown-link", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/wallet/wallet-island", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/wallet/wallet-modal", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/wallet/is-valid-aa-entrypoint", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/wallet/is-wallet-a-coinbase-smart-wallet", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/connected/connected", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/transaction/transaction", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/transaction/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/transaction/transaction", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/swap/swap", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/swap/swap-settings", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/swap/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/swap/swap", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/swap/swap-settings", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/buy/buy", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/buy/buy", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/fund-button", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/fund-card", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/get-onramp-buy-url", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/fetch-onramp-config", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/fetch-onramp-quote", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/fetch-onramp-options", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/fetch-onramp-transaction-status", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/setup-onramp-event-listeners", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/fund/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/fund/fund-button", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/fund/fund-card", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/fund/get-onramp-buy-url", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/fund/fetch-onramp-config", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/fund/fetch-onramp-quote", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/fund/fetch-onramp-options", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/fund/fetch-onramp-transaction-status", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/fund/setup-onramp-event-listeners", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/earn/earn", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/earn/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/earn/earn", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/earn/build-deposit-to-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/earn/build-withdraw-from-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/hooks/earn/use-earn-context", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/hooks/earn/use-build-deposit-to-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/hooks/earn/use-build-withdraw-from-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/hooks/earn/use-morpho-vault", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/build-deposit-to-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/build-withdraw-from-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/hooks/use-build-deposit-to-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/hooks/use-build-withdraw-from-morpho-tx", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/hooks/use-earn-context", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/mint/nft-card", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/mint/nft-mint-card", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/mint/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/mint/nft-card", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/mint/nft-mint-card", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/hooks/mint/use-token-details", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/hooks/mint/use-mint-details", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/get-mint-details", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/build-mint-transaction", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/hooks/use-mint-details", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/hooks/use-token-details", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/token/token-chip", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/token/token-image", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/token/token-row", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/token/token-search", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/token/token-select-dropdown", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/token/format-amount", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/token/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/token/token-chip", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/token/token-image", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/token/token-row", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/token/token-search", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/token/token-select-dropdown", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/utilities/token/format-amount", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/signature/signature", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/signature/types", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/latest/components/signature/signature", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/get-token-details", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/build-swap-transaction", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/get-swap-quote", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/get-tokens", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/get-portfolios", + "destination": "/get-started/migrate-from-onchainkit" + }, + { + "source": "/onchainkit/api/types", + "destination": "/get-started/migrate-from-onchainkit" + }, { "source": "/basenames/basenames-onchainkit-tutorial", "destination": "/base-account/basenames/basenames-wagmi-tutorial" diff --git a/docs/get-started/deploy-smart-contracts.mdx b/docs/get-started/deploy-smart-contracts.mdx index 7554b28ad..e56cb1919 100644 --- a/docs/get-started/deploy-smart-contracts.mdx +++ b/docs/get-started/deploy-smart-contracts.mdx @@ -139,5 +139,5 @@ This will return the initial value of the Counter contract's `number` storage va ## Next Steps -- Use [Onchainkit](https://onchainkit.com) to connect your frontend to your contracts! Onchainkit is a library of ready-to-use React components and Typescript utilities. +- Use [wagmi](https://wagmi.sh) or [viem](https://viem.sh) to connect your frontend to your contracts. - Learn more about interacting with your contracts in the command line using Foundry from our [Foundry tutorial](/learn/foundry/deploy-with-foundry). diff --git a/docs/get-started/migrate-from-onchainkit.mdx b/docs/get-started/migrate-from-onchainkit.mdx new file mode 100644 index 000000000..ab00a33b1 --- /dev/null +++ b/docs/get-started/migrate-from-onchainkit.mdx @@ -0,0 +1,38 @@ +--- +title: "Migrate your OnchainKit App" +description: "How to migrate your OnchainKit app to wagmi and viem using the Base migration skill." +--- + +OnchainKit is being deprecated. This guide helps you migrate your existing OnchainKit app to standalone [wagmi](https://wagmi.sh) and [viem](https://viem.sh) using the Base migration skill. + +The skill covers three components: `OnchainKitProvider`, `Wallet`, and `Transaction`. Install it from the [Base Skills repo](https://github.com/base/skills/tree/master/skills) and use the prompts below with your AI coding assistant. + +## Migration Prompts + +### One-Shot (all three components) + +```text +Migrate my OnchainKit app to use standalone wagmi and viem. Replace the provider, wallet component, and transaction component. Remove the OnchainKit dependency entirely. +``` + +### Provider + +```text +Replace my OnchainKitProvider with WagmiProvider and QueryClientProvider. +``` + +### Wallet + +```text +Migrate my OnchainKit wallet component to a standalone wagmi-based connect button. +``` + +### Transaction + +```text +Migrate my OnchainKit transaction component to use wagmi hooks directly. +``` + + +If migrating components individually, the provider must be migrated first. The wallet and transaction components depend on `WagmiProvider` being in the tree. The skill will automatically create a `mistakes.md` file to log any errors encountered during migration. + diff --git a/docs/llms-full.txt b/docs/llms-full.txt index ead46c926..fe26b6219 100644 --- a/docs/llms-full.txt +++ b/docs/llms-full.txt @@ -6,7 +6,7 @@ ## How the docs are organized - Products have two files each: `//llms.txt` (index) and `//llms-full.txt` (expanded) -- Main sections: Get Started, Base Chain, Base Account, AI Agents, Mini Apps, OnchainKit +- Main sections: Get Started, Base Chain, Base Account, AI Agents, Mini Apps ## Cross-site concepts @@ -22,45 +22,23 @@ Sources: Sources: - `https://docs.base.org/base-account/guides/authenticate-users.md` - `https://docs.base.org/mini-apps/features/Authentication.md` -- `https://docs.base.org/onchainkit/config/onchainkit-provider.md` -> Auth patterns vary by product. Use SIWE (ERC‑6492 compatible) for user sign-in where smart wallets may not yet exist. In Mini Apps, defer auth until needed; prefer scoped, revocable permissions and transaction trays for intent. For SDK/server APIs (e.g., OnchainKit), supply API keys via environment variables, rotate regularly, and verify server-side signatures or webhooks. Never store user passkeys or raw private keys server-side. +> Auth patterns vary by product. Use SIWE (ERC‑6492 compatible) for user sign-in where smart wallets may not yet exist. In Mini Apps, defer auth until needed; prefer scoped, revocable permissions and transaction trays for intent. Supply API keys via environment variables, rotate regularly, and verify server-side signatures or webhooks. Never store user passkeys or raw private keys server-side. ### Errors and retries Sources: -- `https://docs.base.org/onchainkit/api/get-swap-quote.md` - `https://docs.base.org/base-chain/node-operators/troubleshooting.md` > Expect standard JSON error envelopes with `code`, `message`, and optional `details`. Treat 429 as rate-limited: respect `Retry-After` and apply exponential backoff with jitter. For idempotent operations (payments, tx-build), include an idempotency key if supported. Distinguish user-declined actions from transport or server errors and surface clear recovery guidance to users. ### Rate limits Sources: -- `https://docs.base.org/onchainkit/api/get-tokens.md` - `https://docs.base.org/base-chain/tools/node-providers.md` > Rate limits vary by provider and endpoint. Batch reads when possible, cache static metadata, and use conditional requests. On 429, back off and retry after the indicated window. Avoid concurrent duplicate builds/quotes; fan out only when necessary. ### SDK install and hello world (JS/TS) -OnchainKit (UI + server APIs) - -```bash -npm install @coinbase/onchainkit wagmi viem -``` - -```tsx -import { OnchainKitProvider } from '@coinbase/onchainkit' -import { base } from 'wagmi/chains' - -export function Providers(props: { children: React.ReactNode }) { - return ( - - {props.children} - - ) -} -``` - Base Account (smart wallet + pay helper) ```bash @@ -95,7 +73,6 @@ const client = createPublicClient({ chain: base, transport: http() }) - AI Agents — `./ai-agents/llms-full.txt` - Base Chain — `./base-chain/llms-full.txt` - Mini Apps — `./mini-apps/llms-full.txt` -- OnchainKit — `./onchainkit/llms-full.txt` ## Related indexes - Root index: `./llms.txt` diff --git a/docs/llms.txt b/docs/llms.txt index ffeace6e3..605b9bf79 100644 --- a/docs/llms.txt +++ b/docs/llms.txt @@ -9,6 +9,5 @@ - [Base Account](./base-account/llms.txt) — Passkey smart wallet, payments, sponsored gas, sub‑accounts - [AI Agents](./ai-agents/llms.txt) — Build onchain AI agents: wallets, payments, identity, frameworks - [Mini Apps](./mini-apps/llms.txt) — MiniKit, manifests, features, growth, troubleshooting -- [OnchainKit](./onchainkit/llms.txt) — React SDK: provider, components, APIs, utilities, templates diff --git a/docs/mini-apps/core-concepts/authentication.mdx b/docs/mini-apps/core-concepts/authentication.mdx index 521559ad7..d000b460d 100644 --- a/docs/mini-apps/core-concepts/authentication.mdx +++ b/docs/mini-apps/core-concepts/authentication.mdx @@ -149,7 +149,7 @@ Your mini app's domain - + use Minikit's useAuthenticate hook to authenticate users. diff --git a/docs/mini-apps/core-concepts/navigation.mdx b/docs/mini-apps/core-concepts/navigation.mdx index 434f41cb0..2c3c7df77 100644 --- a/docs/mini-apps/core-concepts/navigation.mdx +++ b/docs/mini-apps/core-concepts/navigation.mdx @@ -101,7 +101,7 @@ composeCast({ - Use [`useOpenUrl()`](/onchainkit/latest/components/minikit/hooks/useOpenUrl) to safely open external websites in the client's in-app browser: + Use [`useOpenUrl()`](/mini-apps/core-concepts/navigation) to safely open external websites in the client's in-app browser: ```tsx components/ExternalLinks.tsx highlight={8 -10} import { useOpenUrl } from '@coinbase/onchainkit/minikit'; @@ -153,7 +153,7 @@ composeCast({ ``` - Use [`useComposeCast()`](/onchainkit/latest/components/minikit/hooks/useComposeCast) to open the native composer with prefilled content: + Use [`useComposeCast()`](/mini-apps/core-concepts/navigation) to open the native composer with prefilled content: ```tsx components/ShareCast.tsx highlight={8-13} import { useComposeCast } from '@coinbase/onchainkit/minikit'; @@ -198,7 +198,7 @@ composeCast({ - Use [`useViewCast()`](/onchainkit/latest/components/minikit/hooks/useViewCast) to open a specific cast by its hash: + Use [`useViewCast()`](/mini-apps/core-concepts/navigation) to open a specific cast by its hash: ```tsx components/ViewCastButton.tsx highlight={4,7-9} import { useViewCast } from '@coinbase/onchainkit/minikit'; diff --git a/docs/mini-apps/featured-guidelines/technical-guidelines.mdx b/docs/mini-apps/featured-guidelines/technical-guidelines.mdx index 7a4803043..1614262b0 100644 --- a/docs/mini-apps/featured-guidelines/technical-guidelines.mdx +++ b/docs/mini-apps/featured-guidelines/technical-guidelines.mdx @@ -48,13 +48,13 @@ There must be no client‑specific behaviors or wording that degrade the experie ## Sponsor Transactions -Sponsor transaction fees to remove friction and reduce drop‑off for new users. For mini apps on Base, we recommend using the [Base Paymaster](/onchainkit/paymaster/quickstart-guide). +Sponsor transaction fees to remove friction and reduce drop‑off for new users. For mini apps on Base, we recommend using the [Base Paymaster](/base-account/improve-ux/sponsor-gas/paymasters). **Acceptance criteria** - Transactions are sponsored via a paymaster **How to Implement** -- Recommended: [Base Paymaster](/onchainkit/paymaster/quickstart-guide) +- Recommended: [Base Paymaster](/base-account/improve-ux/sponsor-gas/paymasters) Claim free gas credits on base.dev. diff --git a/docs/mini-apps/growth/optimize-onboarding.mdx b/docs/mini-apps/growth/optimize-onboarding.mdx index 40cc77b47..3d05f124e 100644 --- a/docs/mini-apps/growth/optimize-onboarding.mdx +++ b/docs/mini-apps/growth/optimize-onboarding.mdx @@ -20,7 +20,7 @@ Deliver value instantly and avoid blocking actions. - Show immediate value (demo content, sample state, or read-only mode) -- Personalize instantly with [`context`](/onchainkit/latest/components/minikit/provider-and-initialization) of the user's profile to instantly personalize +- Personalize instantly with [`context`](/mini-apps/core-concepts/context) of the user's profile to instantly personalize - Display one clear CTA that leads to a meaningful action (e.g. "Post a message", "Buy a token", "Follow a user") @@ -108,8 +108,8 @@ Learn how to implement them with [SDK actions](/mini-apps/features/links). - - + + diff --git a/docs/mini-apps/llms-full.txt b/docs/mini-apps/llms-full.txt index 96dcdccf2..9a4ff411d 100644 --- a/docs/mini-apps/llms-full.txt +++ b/docs/mini-apps/llms-full.txt @@ -7,21 +7,25 @@ ### What you can do here - Scaffold new Mini Apps with MiniKit and integrate existing Next.js apps - Configure manifests for discovery and client capabilities -- Build social‑native UX using OnchainKit components +- Build social‑native UX using MiniKit and wagmi - Plan growth loops (sharing, search, notifications) and optimize onboarding - Diagnose issues specific to Base App vs. other Farcaster clients -## Minimal Critical Code (MiniKit + OnchainKit wiring) +## Minimal Critical Code (MiniKit wiring) ```tsx -// MiniKit and OnchainKit often co‑exist in Mini Apps. Keep providers minimal. -import { OnchainKitProvider } from '@coinbase/onchainkit' -import { base } from 'wagmi/chains' +import { WagmiProvider } from 'wagmi' +import { QueryClient, QueryClientProvider } from '@tanstack/react-query' +import { wagmiConfig } from './wagmi-config' +import { useState } from 'react' export function Providers(props: { children: React.ReactNode }) { + const [queryClient] = useState(() => new QueryClient()) return ( - - {props.children} - + + + {props.children} + + ) } ``` @@ -84,9 +88,7 @@ export function Providers(props: { children: React.ReactNode }) { - [Testing](https://docs.base.org/mini-apps/troubleshooting/testing.md) — Testing guide ### Technical Reference -- [MiniKit Overview](https://docs.base.org/onchainkit/latest/components/minikit/overview.md) — Overview -- [Provider & Initialization](https://docs.base.org/onchainkit/latest/components/minikit/provider-and-initialization.md) — Provider -- [Hooks](https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md) — Hooks +- [MiniKit Overview](https://docs.base.org/mini-apps/introduction/overview.md) — Overview ## Quickstart (excerpts) @@ -105,7 +107,7 @@ Source: `https://docs.base.org/mini-apps/quickstart/migrate-existing-apps.md` Add MiniKit to an existing Next.js app: ```bash -npm install @coinbase/minikit @coinbase/onchainkit +npm install @coinbase/minikit wagmi viem @tanstack/react-query ``` @@ -139,13 +141,12 @@ Sources: Hook reference: - useAuthenticate — Returns verified user from SIWF or wallet auth. Use alongside `useMiniKit` context. - - Source: `https://docs.base.org/onchainkit/latest/components/minikit/hooks/useAuthenticate.md` + - Source: `https://docs.base.org/mini-apps/core-concepts/authentication.md` Example (hook usage): ```tsx -import { useMiniKit } from '@coinbase/minikit' -import { useAuthenticate } from '@coinbase/onchainkit/minikit' +import { useMiniKit, useAuthenticate } from '@coinbase/minikit' export function AuthGate(props: { children: React.ReactNode }) { const { context } = useMiniKit() @@ -164,9 +165,9 @@ export function AuthGate(props: { children: React.ReactNode }) { ## API and Schemas (pruned) - MiniKit Provider and initialization props - - Source: `https://docs.base.org/onchainkit/latest/components/minikit/provider-and-initialization.md` + - Source: `https://docs.base.org/mini-apps/introduction/overview.md` - `useMiniKit` hook: access frame context, user, and client capabilities - - Source: `https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md` + - Source: `https://docs.base.org/mini-apps/core-concepts/context.md` Example manifest fields (conceptual): @@ -196,27 +197,9 @@ Example manifest fields (conceptual): ## Examples (common flows) -Example: Wire providers for OnchainKit + MiniKit - -Sources: -- `https://docs.base.org/onchainkit/latest/components/minikit/provider-and-initialization.md` - -```tsx -import { OnchainKitProvider } from '@coinbase/onchainkit' -import { base } from 'wagmi/chains' - -export function Providers(props: { children: React.ReactNode }) { - return ( - - {props.children} - - ) -} -``` - Example: Use `useMiniKit` to access client context -Source: `https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md` +Source: `https://docs.base.org/mini-apps/core-concepts/context.md` ```tsx import { useMiniKit } from '@coinbase/minikit' diff --git a/docs/mini-apps/llms.txt b/docs/mini-apps/llms.txt index bdea38c01..699bd494c 100644 --- a/docs/mini-apps/llms.txt +++ b/docs/mini-apps/llms.txt @@ -2,7 +2,7 @@ ## Mini Apps Documentation -> Mini Apps are social-native, instant-launch web apps that run inside Base App. This section provides instruction on how to get started with MiniKit and OnchainKit as well as best practices developers should follow. +> Mini Apps are social-native, instant-launch web apps that run inside Base App. This section provides instruction on how to get started with MiniKit as well as best practices developers should follow. ## Introduction - [Overview](https://docs.base.org/mini-apps/introduction/overview.md) — What Mini Apps are and why they matter @@ -37,8 +37,7 @@ - [Base App Compatibility](https://docs.base.org/mini-apps/troubleshooting/base-app-compatibility.md) — Base App client-specific behaviors ## Technical Reference -- [MiniKit Overview](https://docs.base.org/onchainkit/latest/components/minikit/overview.md) — Architecture, provider, CLI, and hooks -- [Hooks: useMiniKit](https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md) — Access frame context and client features +- [MiniKit Overview](https://docs.base.org/mini-apps/introduction/overview.md) — Architecture, provider, CLI, and hooks ## Optional - [Accept Payments](https://docs.base.org/mini-apps/technical-guides/accept-payments.md) — Integrate payments in Mini Apps diff --git a/docs/mini-apps/technical-guides/sharing-and-social-graph.mdx b/docs/mini-apps/technical-guides/sharing-and-social-graph.mdx index f24ea5352..5a9c91515 100644 --- a/docs/mini-apps/technical-guides/sharing-and-social-graph.mdx +++ b/docs/mini-apps/technical-guides/sharing-and-social-graph.mdx @@ -42,8 +42,8 @@ Strategic sharing moments include: post‑achievement, post‑mint, after beatin Link users into casts and profiles directly from your app via MiniKit hooks. - - + + ## Best Practices diff --git a/docs/mini-apps/troubleshooting/common-issues.mdx b/docs/mini-apps/troubleshooting/common-issues.mdx index 8929ea8fc..95f3a9703 100644 --- a/docs/mini-apps/troubleshooting/common-issues.mdx +++ b/docs/mini-apps/troubleshooting/common-issues.mdx @@ -112,7 +112,7 @@ Solution: Use `name="fc:miniapp"` meta tag in `` and validate using the Em ### 4. Wallet Connection Problems -Always use the user's connected wallet for optimal experience. You can do this either by using [OnchainKit's Wallet component](/onchainkit/wallet/wallet) or Wagmi hooks. Below is a Wagmi hook example: +Always use the user's connected wallet for optimal experience. You can do this using Wagmi hooks. Below is an example: ```tsx App.tsx import { useAccount } from 'wagmi'; diff --git a/docs/onchainkit/api/build-deposit-to-morpho-tx.mdx b/docs/onchainkit/api/build-deposit-to-morpho-tx.mdx deleted file mode 100644 index d533a0924..000000000 --- a/docs/onchainkit/api/build-deposit-to-morpho-tx.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: buildDepositToMorphoTx ---- - - -The `buildDepositToMorphoTx` function is used to build [Calls](/onchainkit/transaction/types#calls) for depositing an asset to Morpho. These calls can be passed the `` component to send a transaction. - -## Usage - -```tsx code -import { buildDepositToMorphoTx } from '@coinbase/onchainkit/earn'; - -const calls = await buildDepositToMorphoTx({ - vaultAddress: '0x...', // Morpho vault address on Base - tokenAddress: '0x...', // Address of the token to deposit - amount: 1000000000000000000n, // Amount of tokens to deposit - recipientAddress: '0x...', // Address of the recipient -}); -``` - -## Returns - -[`Call[]`](/onchainkit/transaction/types#calls) - -## Parameters - -[`DepositToMorphoParams`](/onchainkit/earn/types#deposittomorphoparams) - diff --git a/docs/onchainkit/api/build-mint-transaction.mdx b/docs/onchainkit/api/build-mint-transaction.mdx deleted file mode 100644 index 6c80cb2d3..000000000 --- a/docs/onchainkit/api/build-mint-transaction.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: buildMintTransaction -openapi: post /BuildMintTransaction ---- - - -The `buildMintTransaction` function is used to get an unsigned transaction for minting an NFT. - -Before using them, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key) from Coinbase Developer Platform. - -{/* ## Usage */} - -{/* -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { buildMintTransaction } from '@coinbase/onchainkit/api'; - -const response = await buildMintTransaction({ - mintAddress: '0x...', - takerAddress: '0x...', - tokenId: '1', - quantity: 1, - network: 'networks/base-mainnet', -}); -``` - -```json return value -{ - "call_data": { - "from": "0x...", - "to": "0x...", - "data": "0x...", - "value": "0x000000000001" - } -} -``` - */} - -## Returns - -[`Promise`](/onchainkit/api/types#buildminttransactionresponse) - -## Parameters - -[`BuildMintTransactionParams`](/onchainkit/api/types#buildminttransactionparams) - -## Types - -- [`BuildMintTransactionResponse`](/onchainkit/api/types#buildminttransactionresponse) -- [`BuildMintTransactionParams`](/onchainkit/api/types#buildminttransactionparams) - diff --git a/docs/onchainkit/api/build-swap-transaction.mdx b/docs/onchainkit/api/build-swap-transaction.mdx deleted file mode 100644 index cf6a73454..000000000 --- a/docs/onchainkit/api/build-swap-transaction.mdx +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: buildSwapTransaction -openapi: post /buildSwapTransaction ---- - - -The `buildSwapTransaction` function is used to get an unsigned transaction for a swap between two Tokens. - -Before using this function, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key) from Coinbase Developer Platform. - -{/* ## Usage */} - -{/* -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { buildSwapTransaction } from '@coinbase/onchainkit/api'; -import type { Token } from '@coinbase/onchainkit/token'; - -setOnchainKitConfig({ apiKey: 'YOUR_API_KEY' }); - -const fromToken: Token = { - name: 'ETH', - address: '', - symbol: 'ETH', - decimals: 18, - image: 'https://wallet-api-production.s3.amazonaws.com/uploads/tokens/eth_288.png', - chainId: 8453, -}; - -const toToken: Token = { - name: 'USDC', - address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', - symbol: 'USDC', - decimals: 6, - image: - 'https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/44/2b/442b80bd16af0c0d9b22e03a16753823fe826e5bfd457292b55fa0ba8c1ba213-ZWUzYjJmZGUtMDYxNy00NDcyLTg0NjQtMWI4OGEwYjBiODE2', - chainId: 8453, -}; - -const response = await buildSwapTransaction({ - fromAddress: '0x...', - from: fromToken, - to: toToken, - amount: '0.1', - useAggregator: false, -}); -``` - -```json return value -{ - "approveTransaction": { - "chainId": 8453, - "data": "", - "gas": 0, - "to": "", - "value": 0 - }, - "fee": { - "baseAsset": { - "name": "USDC", - "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913", - "currencyCode": "USDC", - "decimals": 6, - "imageURL": "https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/44/2b/442b80bd16af0c0d9b22e03a16753823fe826e5bfd457292b55fa0ba8c1ba213-ZWUzYjJmZGUtMDYxNy00NDcyLTg0NjQtMWI4OGEwYjBiODE2", - "blockchain": "eth", - "aggregators": [Array], - "swappable": true, - "unverified": false, - "chainId": 8453 - }, - "percentage": "1", - "amount": "3517825" - }, - "quote": { - "from": { - "address": "", - "chainId": 8453, - "decimals": 18, - "image": "https://wallet-api-production.s3.amazonaws.com/uploads/tokens/eth_288.png", - "name": "ETH", - "symbol": "ETH" - }, - "to": { - "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913", - "chainId": 8453, - "decimals": 6, - "image": "https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/44/2b/442b80bd16af0c0d9b22e03a16753823fe826e5bfd457292b55fa0ba8c1ba213-ZWUzYjJmZGUtMDYxNy00NDcyLTg0NjQtMWI4OGEwYjBiODE2", - "name": "USDC", - "symbol": "USDC" - }, - "fromAmount": "100000000000000000", - "toAmount": "348264739", - "amountReference": "from", - "priceImpact": "", - "chainId": 8453, - "highPriceImpact": false, - "slippage": "3", - "warning": { - "type": "warning", - "message": "This transaction has a very high likelihood of failing if submitted", - "description": "failed with 500000000 gas: insufficient funds for gas * price + value: address 0x4ed4E862860beD51a9570b96d89aF5E1B0Efefed have 0 want 100000000000000000" - } - }, - "transaction": { - "chainId": 8453, - "data": "0x...", - "gas": 419661, - "to": "0xdef1c0ded9bec7f1a1670819833240f027b25eff", - "value": 100000000000000000 - }, - "warning": { - "type": "warning", - "message": "This transaction has a very high likelihood of failing if submitted", - "description": "failed with 500000000 gas: insufficient funds for gas * price + value: address 0x4ed4E862860beD51a9570b96d89aF5E1B0Efefed have 0 want 100000000000000000" - } -} -``` - */} - -## Returns - -[`Promise`](/onchainkit/api/types#buildswaptransactionresponse) - -## Parameters - -[`BuildSwapTransactionParams`](/onchainkit/api/types#buildswaptransactionparams) - -## Types - -- [`BuildSwapTransactionResponse`](/onchainkit/api/types#buildswaptransactionresponse) -- [`BuildSwapTransactionParams`](/onchainkit/api/types#buildswaptransactionparams) - diff --git a/docs/onchainkit/api/build-withdraw-from-morpho-tx.mdx b/docs/onchainkit/api/build-withdraw-from-morpho-tx.mdx deleted file mode 100644 index f540d5e45..000000000 --- a/docs/onchainkit/api/build-withdraw-from-morpho-tx.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: buildWithdrawFromMorphoTx ---- - - -The `buildWithdrawFromMorphoTx` function is used to build [Calls](/onchainkit/transaction/types#calls) for withdrawing an asset from Morpho. These calls can be passed the `` component to send a transaction. - -## Usage - -```tsx code -import { buildWithdrawFromMorphoTx } from '@coinbase/onchainkit/earn'; - -const calls = await buildWithdrawFromMorphoTx({ - vaultAddress: '0x...', // Morpho vault address on Base - amount: 1000000000000000000n, // Amount of tokens to withdraw - recipientAddress: '0x...', // Address of the recipient -}); -``` - - -## Returns - -[`Call[]`](/onchainkit/transaction/types#calls) - -## Parameters - -[`WithdrawFromMorphoParams`](/onchainkit/earn/types#withdrawfrommorphoparams) - diff --git a/docs/onchainkit/api/get-mint-details.mdx b/docs/onchainkit/api/get-mint-details.mdx deleted file mode 100644 index 5c92adb4b..000000000 --- a/docs/onchainkit/api/get-mint-details.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: getMintDetails -openapi: get /getMintDetails ---- - - -The `getMintDetails` function returns data required to view an NFT to be minted - -Before using them, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key) from Coinbase Developer Platform. - -{/* ## Usage - - -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { getMintDetails } from '@coinbase/onchainkit/api'; - -const response = await getMintDetails({ - contractAddress: '0x...', - takerAddress: '0x...', - tokenId: '1', -}); -``` - -```json return value -{ - "name": "NFT Name", - "description": "NFT description", - "imageUrl": "https://example.com/image.png", - "animationUrl": "", - "mimeType": "image/png", - "contractType": "ERC721", - "price": { - "amount": "0.0001", - "currency": "ETH", - "amountUSD": "0.242271" - }, - "mintFee": { - "amount": "0", - "currency": "ETH", - "amountUSD": "0" - }, - "maxMintsPerWallet": 100, - "isEligibleToMint": true, - "creatorAddress": "0x...", - "network": "", - "totalTokens": "300", - "totalOwners": "200" -} -``` - */} - -## Returns - -[`Promise`](/onchainkit/api/types#getmintdetailsresponse) - -## Parameters - -[`GetMintDetailsParams`](/onchainkit/api/types#getmintdetailsparams) - -## Types - -- [`GetMintDetailsResponse`](/onchainkit/api/types#getmintdetailsresponse) -- [`GetMintDetailsParams`](/onchainkit/api/types#getmintdetailsparams) - diff --git a/docs/onchainkit/api/get-portfolios.mdx b/docs/onchainkit/api/get-portfolios.mdx deleted file mode 100644 index 23a27a1fa..000000000 --- a/docs/onchainkit/api/get-portfolios.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: getPortfolios -openapi: get /getPortfolios ---- - - -The `getPortfolios` function returns an object containing an array of -portfolios for the provided addresses. Each portfolio is an object with the address -of the wallet, the fiat value of the portfolio, and an array of tokens held by the -provided address. - - -Before using this endpoint, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key) -from Coinbase Developer Platform. - - - - -Please note: `getPortfolios` is only available for Base mainnet and Ethereum mainnet. -You can control the network in the `OnchainKitProvider` by setting the `chain` prop. - - - -{/* ## Usage - - -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { getPortfolios } from '@coinbase/onchainkit/api'; - -const response = await getPortfolios({ - addresses: ['0x...'], -}); -``` - -```json return value - "portfolios": [ - { - "address": "0x...", - "portfolioBalanceInUsd": 100, - "tokenBalances": [{ - "address": "0x...", - "chainId": 1, - "decimals": 18, - "image": "https://example.com/image.png", - "name": "Token Name", - "symbol": "TKN", - "cryptoBalance": 10, - "fiatBalance": 100 - }] - } - ] -``` - */} - -## Returns - -[`Promise`](/onchainkit/api/types#getportfoliosresponse) - -## Parameters - -[`GetPortfoliosParams`](/onchainkit/api/types#getportfoliosparams) - diff --git a/docs/onchainkit/api/get-swap-quote.mdx b/docs/onchainkit/api/get-swap-quote.mdx deleted file mode 100644 index a8cc651e8..000000000 --- a/docs/onchainkit/api/get-swap-quote.mdx +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: getSwapQuote -openapi: get /getSwapQuote ---- - - -The `getSwapQuote` function is used to get a quote for a swap between two Tokens. - -Before using them, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key) from Coinbase Developer Platform. - -{/* ## Usage - - -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { getSwapQuote } from '@coinbase/onchainkit/api'; -import type { Token } from '@coinbase/onchainkit/token'; - -setOnchainKitConfig({ apiKey: 'YOUR_API_KEY' }); - -const fromToken: Token = { - name: 'ETH', - address: '', - symbol: 'ETH', - decimals: 18, - image: 'https://wallet-api-production.s3.amazonaws.com/uploads/tokens/eth_288.png', - chainId: 8453, -}; - -const toToken: Token = { - name: 'USDC', - address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', - symbol: 'USDC', - decimals: 6, - image: - 'https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/44/2b/442b80bd16af0c0d9b22e03a16753823fe826e5bfd457292b55fa0ba8c1ba213-ZWUzYjJmZGUtMDYxNy00NDcyLTg0NjQtMWI4OGEwYjBiODE2', - chainId: 8453, -}; - -const quote = await getSwapQuote({ - from: fromToken, - to: toToken, - amount: '0.001', - useAggregator: false, -}); -``` - -```json return value -{ - "amountReference": "from", - "chainId": 8453, - "from": { - "address": "", - "chainId": 8453, - "decimals": 18, - "image": "https://wallet-api-production.s3.amazonaws.com/uploads/tokens/eth_288.png", - "name": "ETH", - "symbol": "ETH" - }, - "to": { - "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913", - "chainId": 8453, - "decimals": 6, - "image": "https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/…-ZWUzYjJmZGUtMDYxNy00NDcyLTg0NjQtMWI4OGEwYjBiODE2", - "name": "USDC", - "symbol": "USDC" - }, - "fromAmount": "1000000000000000", - "fromAmountUSD": "2.6519265340000002", - "toAmount": "2650405", - "toAmountUSD": "2.64980125", - "amountReference": "from", - "priceImpact": "0", - "chainId": 8453, - "highPriceImpact": false, - "slippage": "3" -} -``` - */} - -## Returns - -[`Promise`](/onchainkit/api/types#getswapquoteresponse) - -## Parameters - -[`GetSwapQuoteParams`](/onchainkit/api/types#getswapquoteparams) - -## Types - -- [`GetSwapQuoteResponse`](/onchainkit/api/types#getswapquoteresponse) -- [`GetSwapQuoteParams`](/onchainkit/api/types#getswapquoteparams) - diff --git a/docs/onchainkit/api/get-token-details.mdx b/docs/onchainkit/api/get-token-details.mdx deleted file mode 100644 index 442ce2e87..000000000 --- a/docs/onchainkit/api/get-token-details.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: getTokenDetails -openapi: get /getTokenDetails ---- - - -The `getTokenDetails` function returns data required to view an NFT - -Before using them, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key) from Coinbase Developer Platform. - -{/* ## Usage */} - -{/* -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { getTokenDetails } from '@coinbase/onchainkit/api'; - -const response = await getTokenDetails({ - contractAddress: '0x...', - tokenId: '1', -}); -``` - -```json return value - "collectionName": "NFT Collection Name", - "collectionDescription": "NFT Collection Description", - "name": "NFT Name", - "description": "NFT Description", - "imageUrl": "https://example.com/image.png", - "animationUrl": "", - "ownerAddress": "0x...", - "lastSoldPrice": { - "amount": "0.0001", - "currency": "ETH", - "amountUSD": "0.242271" - }, - "mimeType": "image/png", - "contractType": "ERC721" -``` - */} - -## Returns - -[`Promise`](/onchainkit/api/types#gettokendetailsresponse) - -## Parameters - -[`GetTokenDetailsParams`](/onchainkit/api/types#gettokendetailsparams) - -## Types - -- [`GetTokenDetailsResponse`](/onchainkit/api/types#gettokendetailsresponse) -- [`GetTokenDetailsParams`](/onchainkit/api/types#gettokendetailsparams) - diff --git a/docs/onchainkit/api/get-tokens.mdx b/docs/onchainkit/api/get-tokens.mdx deleted file mode 100644 index 9f6dcb32d..000000000 --- a/docs/onchainkit/api/get-tokens.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: getTokens -openapi: get /getTokens ---- - - -The `getTokens` function retrieves a list of tokens on Base by searching for the name, symbol, or address of a token. - -Before using them, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key) from Coinbase Developer Platform. - -{/* ## Usage - -Search by symbol - - -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { getTokens } from '@coinbase/onchainkit/api'; // [!code focus] - -setOnchainKitConfig({ apiKey: 'YOUR_API_KEY' }); - -const tokens = await getTokens({ limit: '1', search: 'degen' }); // [!code focus] -``` - -```ts return value -[ - { - address: '0x4ed4e862860bed51a9570b96d89af5e1b0efefed', - chainId: 8453, - decimals: 18, - image: - 'https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/3b/bf/3bbf118b5e6dc2f9e7fc607a6e7526647b4ba8f0bea87125f971446d57b296d2-MDNmNjY0MmEtNGFiZi00N2I0LWIwMTItMDUyMzg2ZDZhMWNm', - name: 'DEGEN', - symbol: 'DEGEN', - }, -]; -``` - - -Search by name - - -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { getTokens } from '@coinbase/onchainkit/api'; // [!code focus] - -setOnchainKitConfig({ apiKey: 'YOUR_API_KEY' }); - -const tokens = await getTokens({ limit: '1', search: 'Wrapped Ether' }); // [!code focus] -``` - -```ts return value -[ - { - address: '0x4200000000000000000000000000000000000006', - chainId: 8453, - decimals: 18, - image: - 'https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/47/bc/47bc3593c2dec7c846b66b7ba5f6fa6bd69ec34f8ebb931f2a43072e5aaac7a8-YmUwNmRjZDUtMjczYy00NDFiLWJhZDUtMzgwNjFmYWM0Njkx', - name: 'Wrapped Ether', - symbol: 'WETH', - }, -]; -``` - - -Search by address - - -```tsx code -import { setOnchainKitConfig } from '@coinbase/onchainkit'; -import { getTokens } from '@coinbase/onchainkit/api'; // [!code focus] - -setOnchainKitConfig({ apiKey: 'YOUR_API_KEY' }); - -const tokens = await getTokens({ - limit: '1', - search: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', -}); // [!code focus] -``` - -```ts return value -[ - { - address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', - chainId: 8453, - decimals: 6, - image: - 'https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/44/2b/442b80bd16af0c0d9b22e03a16753823fe826e5bfd457292b55fa0ba8c1ba213-ZWUzYjJmZGUtMDYxNy00NDcyLTg0NjQtMWI4OGEwYjBiODE2', - name: 'USDC', - symbol: 'USDC', - }, -]; -``` - */} - -## Returns - -[`Promise`](/onchainkit/api/types#gettokensresponse) - -## Parameters - -[`GetTokensOptions`](/onchainkit/api/types#gettokensoptions) - -## Types - -- [`GetTokensResponse`](/onchainkit/api/types#gettokensresponse) -- [`GetTokensOptions`](/onchainkit/api/types#gettokensoptions) - diff --git a/docs/onchainkit/api/types.mdx b/docs/onchainkit/api/types.mdx deleted file mode 100644 index 7b53fdd34..000000000 --- a/docs/onchainkit/api/types.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: API types -sidebarTitle: API -description: Glossary of Types in APIs. ---- - -## `APIError` - -```ts -type APIError = { - code: string; // The Error code - error: string; // The Error long message - message: string; // The Error short message -}; -``` - -## `BuildPayTransactionParams` - -```ts -type BuildPayTransactionParams = { - address: Address; // The address of the wallet paying - chainId: number; // The Chain ID of the payment Network (only Base is supported) - chargeId: string; // The ID of the Commerce Charge to be paid -}; -``` - -## `BuildPayTransactionResponse` - -```ts -type BuildPayTransactionResponse = PayTransaction | APIError; -``` - -## `BuildSwapTransaction` - -```ts -type BuildSwapTransaction = { - approveTransaction?: Transaction; // ERC20 approve transaction which allows token holders to authorize spending - fee: Fee; // The fee for the swap - quote: SwapQuote; // The quote for the swap - transaction: Transaction; // The object developers should pass into Wagmi's signTransaction - warning?: QuoteWarning; // The warning associated with the swap -}; -``` - -## `BuildSwapTransactionParams` - -```ts -type BuildSwapTransactionParams = GetSwapQuoteParams & { - fromAddress: Address; // The address of the user -}; -``` - -## `BuildSwapTransactionResponse` - -```ts -type BuildSwapTransactionResponse = BuildSwapTransaction | APIError; -``` - -## `GetSwapQuoteParams` - -```ts -type GetSwapQuoteParams = { - amount: string; // The amount to be swapped - amountReference?: string; // The reference amount for the swap - from: Token; // The source token for the swap - isAmountInDecimals?: boolean; // Whether the amount is in decimals - maxSlippage?: string; // The slippage of the swap - to: Token; // The destination token for the swap - useAggregator: boolean; // Whether to use a DEX aggregator -}; -``` - -## `GetSwapQuoteResponse` - -```ts -type GetSwapQuoteResponse = SwapQuote | APIError; -``` - -## `GetTokensOptions` - -```ts -type GetTokensOptions = { - limit?: string; // The maximum number of tokens to return (default: 50) - page?: string; // The page number to return (default: 1) - search?: string; // A string to search for in the token name, symbol or address -}; -``` - -## `GetTokensResponse` - -```ts -type GetTokensResponse = Token[] | APIError; -``` - -## `GetTokenDetailsParams` - -```ts -type GetTokenDetailsParams = { - contractAddress: Address; - tokenId?: string; -}; -``` - -## `GetTokenDetailsResponse` - -```ts -type GetTokenDetailsResponse = TokenDetails | APIError; -``` - -## `GetMintDetailsParams` - -```ts -type GetMintDetailsParams = { - contractAddress: Address; - takerAddress?: Address; - tokenId?: string; -}; -``` - -## `GetMintDetailsResponse` - -```ts -type GetMintDetailsResponse = MintDetails | APIError; -``` - -## `BuildMintTransactionParams` - -```ts -type BuildMintTransactionParams = { - mintAddress: Address; - takerAddress: Address; - tokenId?: string; - quantity: number; - network?: string; -}; -``` - -## `BuildMintTransactionResponse` - -```ts -type BuildMintTransactionResponse = MintTransaction | APIError; -``` - -## `GetPortfoliosParams` - -```ts -type GetPortfoliosParams = { - addresses: Address[] | null | undefined; -}; -``` - -## `GetPortfoliosResponse` - -```ts -type GetPortfoliosResponse = { - portfolios: Portfolio[]; -}; -``` - diff --git a/docs/onchainkit/buy/buy.mdx b/docs/onchainkit/buy/buy.mdx deleted file mode 100644 index 17dc01e15..000000000 --- a/docs/onchainkit/buy/buy.mdx +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: · OnchainKit -sidebarTitle: -description: Buy components & utilities ---- - -import { Danger } from "/snippets/danger.mdx"; - - -Buy - - -The `Buy` components provide a comprehensive interface for users to purchase [Tokens](/onchainkit/token/types#token). - -The `Buy` component supports token swaps from USDC and ETH by default with the option to provide an additional token of choice using the `fromToken` prop. In addition, users are able to purchase tokens using their Coinbase account, Apple Pay, or debit card. - - -The Apple Pay and Debit Card onramp options are only available for Coinbase supported assets. - - - -Before using, ensure you've completed all [Getting Started steps](/onchainkit/getting-started). - - -This component requires a `projectId` to be set in the `OnchainKitProvider`. You can find your `projectId` on [Coinbase Developer Platform](https://portal.cdp.coinbase.com/products/onchainkit). - - - -## Usage - -Example using `@coinbase/onchainkit/buy`. - -```tsx -import { Buy } from '@coinbase/onchainkit/buy'; // [!code focus] -import type { Token } from '@coinbase/onchainkit/token'; - -export default function BuyComponents() { // [!code focus] - const degenToken: Token = { - name: 'DEGEN', - address: '0x4ed4e862860bed51a9570b96d89af5e1b0efefed', - symbol: 'DEGEN', - decimals: 18, - image: - 'https://d3r81g40ycuhqg.cloudfront.net/wallet/wais/3b/bf/3bbf118b5e6dc2f9e7fc607a6e7526647b4ba8f0bea87125f971446d57b296d2-MDNmNjY0MmEtNGFiZi00N2I0LWIwMTItMDUyMzg2ZDZhMWNm', - chainId: 8453, - }; - - return ( // [!code focus] - // [!code focus] - ) // [!code focus] -} // [!code focus] - -``` - -