diff --git a/appkit/overview.mdx b/appkit/overview.mdx index 97ff0ac4a..9f5a78548 100644 --- a/appkit/overview.mdx +++ b/appkit/overview.mdx @@ -1,21 +1,32 @@ --- -title: Overview +title: About Reown SDK --- -**Reown AppKit** is an open-source all-in-one SDK with a generous free tier and the official gateway to the WalletConnect Network for delivering smooth wallet connections, transactions, logins, and more within your app - designed to onboard millions and scale with data-driven precision. It abstracts the complexity of blockchain infrastructure so you can focus on building apps that users love. +**The Reown SDK (AppKit)** is an open-source all-in-one SDK for building seamless onchain apps. Offering smooth wallet connections, transactions, logins, and more, the Reown SDK is designed to onboard millions and scale with data-driven precision. It abstracts the complexity of blockchain infrastructure so you can focus on building apps that users love. -**AppKit includes:** +**The Reown SDK (AppKit) includes:** -- Onboarding through email, social logins, and wallet connections -- Multichain compatible (EVM, Solana, Bitcoin, etc.) -- Access 600+ wallets with millions of users -- Transaction UX flows (chain/stablecoin abstraction) -- Payment solutions (Pay with Wallet, Pay with Exchange, and Subscriptions) +**Accounts & Authentication** +- Connections to 600+ wallets via the WalletConnect Network (SIWE) +- [Email & social logins](/appkit/authentication/socials) +- [Multichain authentication (SIWX)](/appkit/authentication/siwx/default) +- [Smart Accounts](/appkit/features/smart-accounts) + +**Payments Solutions** +- [In-platform Swap feature](/appkit/features/swaps) +- [In-platform Onramps](/appkit/features/onramp) +- [Pay with Exchange](/appkit/payments/pay-with-exchange) +- [Deposit with Exchange](/appkit/payments/deposit-with-exchange) +- [One-click checkout](/appkit/payments/one-click-checkout) + +**Multichain Tools** +- [Multichain Support](/appkit/features/multichain) +- [Chain Abstraction](/appkit/features/chain-abstraction) + +**Flexible Frameworks & Platform Support** - Mobile and mini-app support - Built-in security (transaction screening and domain verification) -- SDKs for **React, React Native, Flutter, Kotlin, Swift, Unity**, and more - - +- A choice of Frameworks, including; **React, React Native, Flutter, Kotlin, Swift, Unity** & more ### Demo @@ -27,7 +38,7 @@ title: Overview />
-**Ready to get started? Check out the Quickstart section [here](#quickstart). Learn more about all the features AppKit offers [here](#features).** +**Ready to get started? Check out the Quickstart section [here](#quickstart).** ## Quickstart @@ -77,62 +88,49 @@ title: Overview -## Features - -![AppKit banner](/images/appkit.png) - -#### Framework Agnostic - -Integrate effortlessly with popular frameworks like React, Vue, Svelte, vanilla JavaScript, and more. - -#### EIP-6963 Support - -Seamlessly connect browser extension wallets for an enhanced user experience. Learn more about **EIP-6963 [here](https://eips.ethereum.org/EIPS/eip-6963).** - -#### Email & Social Login - -Expand your app’s reach by enabling users to connect using their email or social accounts. Implement these features with minimal code and leverage Smart Account functionality for advanced capabilities. - -#### On-Ramp - -Allow users to securely purchase crypto with fiat, directly within your app, supporting over 100 cryptocurrencies. +## Framework Support -#### Customizable UI +While AppKit offers a wide range of features, networks, and authentication methods that make it easy to build interactive and user-friendly blockchain applications, certain features are limited to specific frameworks. -Choose between light and dark modes, accent colors, or fully customize the interface with your own branding. +**The following table provides an overview of the features, networks, and authentication methods available in AppKit and the frameworks they support.** -#### Multi-Chain Ready +- ✅ - indicates the feature is supported and can be integrated. +- ❌ - indicates the feature is not supported and cannot be integrated. -Easily configure support for EVM and non-EVM chains, giving users access to multiple blockchain networks. +| | React | Next.js | Vue | JavaScript | React Native | Flutter | Android | Swift | Unity (Web) | Unity (Native) | +|----------------|--------------------------|-------------------|------------------|-------------------| ------------------| ------------------| -----------------| ----------------- | ----------------- | ----------------- | +| ***Features*** | | | | | | | | | | | +| Swaps (EVM Only)|
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
✅
|
❌
| +| On-Ramp |
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
✅
|
❌
| +| Multichain Modal |
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
❌
|
❌
| +| Smart Accounts |
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
✅
|
✅
| +| Notifications |
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
❌
|
❌
|
❌
| +| Telegram Mini Apps |
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
❌
|
✅
|
❌
| +| ***Networks*** | | | | | | | | | | | +| EVM Chains |
✅
|
✅
|
✅
|
✅
|
✅
|
✅
|
✅
|
✅
|
✅
|
✅
| +| Solana |
✅
|
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
✅
| +| Bitcoin |
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
❌
|
❌
| +| ***Authentication*** | | | | | | | | | | | +| Email & Social Login |
✅
|
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
✅
|
✅
| +| One-Click Auth |
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
✅
|
✅
|
✅
|
✅
| +| SIWX |
✅
|
✅
|
✅
|
✅
|
✅
|
❌
|
❌
|
❌
|
❌
|
❌
| -#### Hundreds of Wallets +## Reown SDK (AppKit) vs AppKit Core -Connect with popular wallets like MetaMask, Rainbow, Coinbase, and many more to maximize accessibility. +### What is AppKit Core? +AppKit Core is a **chain-agnostic** implementation that uses the Universal Provider/Universal Connector for blockchain interactions. Whereas the Reown SDK (AppKit) includes chain-specific adapters and full UI, AppKit Core offers a minimal, chain-agnostic foundation. -#### Transaction History +The Reown SDK is best for most builders, but AppKit Core is ideal for developers who want to build more flexible custom-built solutions—those that don't need built-in features from day one. -Display all user transactions directly in the account view for added transparency. - -#### Swaps - -Simplify token swapping for users with AppKit Modal, allowing secure, in-app swaps with just one line of code. - -#### One-Click Auth - -Streamline user authentication with WalletConnect v2 integration. Users can sign in and connect to your app with just one tap, supporting multi-chain and multi-account signing. - -#### Smart Accounts - -Enhance security and user convenience with features like multi-signature authorization and automated transaction workflows. - -#### Solana Support - -Bring the Solana blockchain to your application with simple, secure wallet connections and seamless transaction support. - -#### Notifications - -Engage your users with web3-native notifications sent straight to their wallets or through in-app and Web3Inbox notifications. - -#### Telegram MiniApps +--- -Build Web3 mini-apps for Telegram with a prebuilt interface for connecting self-custodial wallets or enabling wallet creation via email or social login. +| Feature | Reown SDK (AppKit) | AppKit Core | +| :--- | :---: | :---: | +| Swaps | ✅ | ❌ | +| Onramps | ✅ | ❌ | +| Smart Accounts | ✅ | ❌ | +| Pre-Built Modal UI | ✅ | ❌ | +| Chain-specific adapters | ✅ | ❌ | +| Wallet Connections via WalletConnect Protocol | ✅ | ✅ | +| Multichain support | ✅ | ✅ | +| Multichain auth (SIWX) | ✅ | ✅ | diff --git a/docs.json b/docs.json index 9274edf1e..78352e3fd 100644 --- a/docs.json +++ b/docs.json @@ -73,120 +73,76 @@ "pages": [ { "group": "Getting Started", - "pages": ["appkit/overview"] - }, - { - "group": "Paid Plans", - "pages": ["appkit/paid-plans/pro", "appkit/paid-plans/enterprise"] - }, - { - "group": "Features", - "pages": [ - "appkit/features/index", - "appkit/features/swaps", - "appkit/features/onramp", - "appkit/features/multichain", - "appkit/features/smart-accounts", - "appkit/features/smart-accounts-interaction", - "appkit/features/chain-abstraction" - ] - }, - { - "group": "Authentication", "pages": [ - "appkit/authentication/socials", - "appkit/authentication/one-click-auth", - "appkit/authentication/siwx/default" + "appkit/overview", + { + "group": "Pricing Plans", + "pages": [ + "appkit/paid-plans/pro", + "appkit/paid-plans/enterprise" + ] + } ] }, { - "group": "Integrations", + "group": "Accounts & Authentication", "pages": [ - "appkit/integrations/telegram-mini-apps", - "appkit/integrations/farcaster-mini-apps" + { + "group": "Authentication", + "pages": [ + "appkit/authentication/socials", + "appkit/authentication/one-click-auth", + "appkit/authentication/siwx/default" + ] + }, + "appkit/features/smart-accounts" ] }, { "group": "Payments", "pages": [ "appkit/payments/overview", + "appkit/features/swaps", + "appkit/features/onramp", "appkit/payments/pay-with-exchange", "appkit/payments/deposit-with-exchange", "appkit/payments/one-click-checkout" ] }, { - "group": "Network", + "group": "Multichain Tools", "pages": [ - "appkit/networks/supported-chains", - "appkit/networks/evm", - "appkit/networks/solana", - "appkit/networks/bitcoin" + "appkit/features/multichain", + "appkit/features/chain-abstraction" ] }, { - "group": "Guides", + "group": "Dashboard", "pages": [ - { - "group": "AppKit Guides", - "pages": [ - "appkit/recipes/telegram-mini-app", - "appkit/recipes/tenderly-virtual-testnets", - "appkit/recipes/wallet-buttons-react", - "appkit/recipes/wagmi-send-transaction", - "appkit/recipes/ethers-send-transaction", - "appkit/recipes/EVM-smart-contract-interaction", - "appkit/recipes/solana-send-transaction", - "appkit/recipes/bitcoin-send-transaction", - "appkit/recipes/switching-to-send-calls", - "appkit/recipes/travel-rule", - "appkit/recipes/update-appkit", - "appkit/recipes/universal-connector", - "appkit/recipes/troubleshooting" - ] - }, - "appkit/recipes/gtm-checklist" + "cloud/analytics" ] }, { - "group": "Upgrade", + "group": "Interactions", "pages": [ - { - "group": "AppKit", - "pages": [ - { - "group": "Web3Modal to Reown AppKit", - "pages": [ - "appkit/upgrade/from-w3m-to-reown", - { - "group": "Reown AppKit - Web", - "pages": [ - "appkit/upgrade/to-reown-appkit-web", - "appkit/upgrade/to-reown-appkit-ethers-web", - "appkit/upgrade/to-reown-appkit-ethers5-web", - "appkit/upgrade/to-reown-appkit-solana-web" - ] - }, - "appkit/upgrade/from-web3modal-react-native", - "appkit/upgrade/from-web3modal-flutter", - "appkit/upgrade/from-web3modal-android", - "appkit/upgrade/from-web3modal-ios", - "appkit/upgrade/from-web3modal-unity" - ] - } - ] - }, - "appkit/upgrade/wcm" + "cloud/blockchain-api", + "appkit/features/smart-accounts-interaction" ] }, { - "group": "Migration", + "group": "Supported Networks", "pages": [ - "appkit/migration/index", - "appkit/migration/from-privy-next", - "appkit/migration/from-rainbowkit-next", - "appkit/migration/from-connectkit-next", - "appkit/migration/from-anza-adapter-react" + "appkit/networks/supported-chains", + "appkit/networks/evm", + "appkit/networks/solana", + "appkit/networks/bitcoin" + ] + }, + { + "group": "Use Cases", + "pages": [ + "appkit/integrations/telegram-mini-apps", + "appkit/integrations/farcaster-mini-apps" ] }, { @@ -653,11 +609,47 @@ ] }, { - "tab": "Dashboard & Advanced", + "tab": "Advanced", "icon": "cloud", "pages": [ { - "group": "Dashboard", + "group": "Migration", + "pages": [ + "appkit/migration/index", + { + "group": "Migrate from other libraries", + "pages": [ + "appkit/migration/from-privy-next", + "appkit/migration/from-rainbowkit-next", + "appkit/migration/from-connectkit-next", + "appkit/migration/from-anza-adapter-react" + ] + }, + { + "group": "Web3Modal to Reown AppKit", + "pages": [ + "appkit/upgrade/from-w3m-to-reown", + { + "group": "Reown AppKit - Web", + "pages": [ + "appkit/upgrade/to-reown-appkit-web", + "appkit/upgrade/to-reown-appkit-ethers-web", + "appkit/upgrade/to-reown-appkit-ethers5-web", + "appkit/upgrade/to-reown-appkit-solana-web" + ] + }, + "appkit/upgrade/from-web3modal-react-native", + "appkit/upgrade/from-web3modal-flutter", + "appkit/upgrade/from-web3modal-android", + "appkit/upgrade/from-web3modal-ios", + "appkit/upgrade/from-web3modal-unity" + ] + }, + "appkit/upgrade/wcm" + ] + }, + { + "group": "Advanced", "pages": [ { "group": "WalletGuide", @@ -673,15 +665,7 @@ "cloud/explorer" ] }, - "cloud/reown-authentication", "cloud/relay", - "cloud/blockchain-api", - "cloud/analytics" - ] - }, - { - "group": "Advanced", - "pages": [ { "group": "Multi-Chain", "pages": [ @@ -764,6 +748,30 @@ "advanced/walletkit-migration" ] }, + { + "group": "Guides", + "pages": [ + { + "group": "How Tos", + "pages": [ + "appkit/recipes/telegram-mini-app", + "appkit/recipes/tenderly-virtual-testnets", + "appkit/recipes/wallet-buttons-react", + "appkit/recipes/wagmi-send-transaction", + "appkit/recipes/ethers-send-transaction", + "appkit/recipes/EVM-smart-contract-interaction", + "appkit/recipes/solana-send-transaction", + "appkit/recipes/bitcoin-send-transaction", + "appkit/recipes/switching-to-send-calls", + "appkit/recipes/travel-rule", + "appkit/recipes/update-appkit", + "appkit/recipes/universal-connector", + "appkit/recipes/troubleshooting" + ] + }, + "appkit/recipes/gtm-checklist" + ] + }, { "group": "Technical Reference", "pages": ["link-spec", "external-link-01", "advanced/faq"]