Skip to content

Commit a181c77

Browse files
rohit-710rohit-710
authored
Merge pull request #466 from reown-com/feat/add-appkit-faq
Feat: add appkit faq
2 parents e20e749 + ebd3ae0 commit a181c77

File tree

4 files changed

+154
-1
lines changed

4 files changed

+154
-1
lines changed

‎appkit/faq.mdx

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
---
2+
title: "AppKit FAQs"
3+
sidebarTitle: "FAQs"
4+
---
5+
6+
This FAQ section covers common questions and solutions for using AppKit. The questions are organized into three main categories:
7+
8+
- **Configuration**: Questions about setting up AppKit, including project configuration, wallet visibility, and RPC customization.
9+
- **Features**: Information about AppKit's capabilities, including off-ramp support, multi-wallet address retrieval, and branding options.
10+
- **Technical**: Technical details about project approval requirements and initialization constraints.
11+
12+
## AppKit Configuration
13+
14+
<AccordionGroup>
15+
<Accordion title="Why am I seeing an 'Invalid App Configuration' error?">
16+
<img src="/images/faq/invalidAppConfiguration.png" />
17+
18+
This error typically occurs when the `projectId` is not configured correctly. To resolve this:
19+
20+
1. Create a valid project ID at [https://cloud.reown.com/](https://cloud.reown.com/)
21+
2. Add it to your AppKit configuration:
22+
23+
```javascript
24+
const modal = createAppKit({
25+
...
26+
projectId: "..." // Add your valid projectId here
27+
});
28+
```
29+
3. Ensure that you have added your domain to the allowed domains in your project settings. If you have not done so, you can do so by navigating to **"Project Domains"** on the Dashboard, clicking on **"Configure Domains"** and adding your domain.
30+
</Accordion>
31+
32+
<Accordion title="Why can't I see any wallets in the modal and only see the 'Connect Wallet' title?">
33+
**Problem**: Users only see the "Connect Wallet" title in the modal after clicking the connect button.
34+
35+
**Solution**: This issue typically has two possible causes:
36+
37+
1. **Version Mismatch**: Ensure all @reown libraries use the same version in your `package.json`:
38+
39+
```json
40+
{
41+
"dependencies": {
42+
"@reown/appkit": "1.7.8",
43+
"@reown/appkit-adapter-wagmi": "1.7.8"
44+
// ... other dependencies
45+
}
46+
}
47+
```
48+
49+
2. **Initialization Location**: Call `createAppKit` outside of your component to ensure proper initialization:
50+
51+
```javascript
52+
// Create modal
53+
createAppKit({
54+
adapters: [wagmiAdapter],
55+
...generalConfig,
56+
features: {
57+
analytics: true // Optional - defaults to your Cloud configuration
58+
}
59+
})
60+
61+
export function App() {
62+
return (
63+
<WagmiProvider ...>
64+
<QueryClientProvider ...>
65+
<appkit-button />
66+
</QueryClientProvider>
67+
</WagmiProvider>
68+
)
69+
}
70+
```
71+
</Accordion>
72+
73+
<Accordion title="How can I use custom RPCs with AppKit?">
74+
You can use your own RPC by setting the `customRpcUrls` option in the AppKit configuration. This lets you define custom RPC URLs for specific chains. Each entry must follow the format:
75+
76+
```javascript
77+
customRpcUrls: {
78+
[ChainId.Ethereum]: 'https://your.custom.rpc.url',
79+
[ChainId.Polygon]: 'https://your.polygon.rpc.url'
80+
}
81+
```
82+
83+
AppKit will prioritize these URLs over the default ones.
84+
</Accordion>
85+
</AccordionGroup>
86+
87+
## Features
88+
89+
<AccordionGroup>
90+
<Accordion title="When will Reown support off-ramp functionality?">
91+
Reown currently does not plan to support off-ramp functionality.
92+
</Accordion>
93+
94+
<Accordion title="How do I get retrieve multiple addresses from multiple connected wallets?">
95+
To retrieve addresses from multiple connected wallets, refer to our multichain example:
96+
97+
- [Live Demo](https://appkit-web-examples-react-multichain.reown.com/)
98+
- [Source Code](https://github.com/reown-com/appkit-web-examples/tree/main/react/react-multichain)
99+
100+
Example using React SDK:
101+
102+
```javascript
103+
import { useAppKitAccount } from '@reown/appkit/react'
104+
105+
// Get account states for different chains
106+
const eip155AccountState = useAppKitAccount({ namespace: 'eip155' })
107+
const solanaAccountState = useAppKitAccount({ namespace: 'solana' })
108+
```
109+
110+
```javascript
111+
<>
112+
EVM Address: {eip155AccountState.address}<br />
113+
Solana Address: {solanaAccountState.address}<br />
114+
</>
115+
```
116+
</Accordion>
117+
118+
<Accordion title="How do I remove the 'UX by Reown' branding?">
119+
Currently, only enterprise clients can hide "UX by Reown" on the AppKit modal by adjusting this option on our Dashboard. If you are an enterprise client and would like to hide this branding, please contact sales@reown.com.
120+
</Accordion>
121+
122+
<Accordion title="How do I increase my project's RPC limits?">
123+
Reown currently provides 2.5 million requests per 30 days. If you wish to increase this limit, you need to upgrade to AppKit Pro.
124+
</Accordion>
125+
</AccordionGroup>
126+
127+
## Technical
128+
129+
<AccordionGroup>
130+
<Accordion title="Do I need to wait for Web3 app approval before using my projectId?">
131+
No, dApps do not need approval in order to use your projectId.
132+
</Accordion>
133+
134+
<Accordion title="Can I reinitialize AppKit with different network configurations?">
135+
Currently, `createAppKit` can only be called once during the application's lifecycle.
136+
It cannot be lazily initialized and then torn down for re-initialization.
137+
This means you must pass in all the networks you plan to support during the initial setup.
138+
</Accordion>
139+
</AccordionGroup>
140+
141+
## Support
142+
143+
<AccordionGroup>
144+
<Accordion title="How do I get technical support for AppKit?">
145+
Free tier AppKit customers only are only entitled to support via [Discord](https://discord.gg/reown). Please join the Discord server and create a forum post **#developers-forum** and the team will get back to you.
146+
147+
AppKit Pro and Enterprise customers get priority support via dedicated channels.
148+
</Accordion>
149+
</AccordionGroup>

‎appkit/payments/pay-with-exchange.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ With **72% of crypto users holding funds on exchanges**, **Pay with Exchange** h
3232
Want to see AppKit Pay with Exchange in action? Try out the live demo to experience Reown AppKit's AppKit Pay with Exchange flow firsthand.
3333

3434
<CardGroup cols={2}>
35-
<Card icon="flask" title="Try Demo" href="https://appkit-lab.reown.com/library/pay-default/?utm_source=appkit-pay-with-exchange&utm_medium=docs&utm_campaign=backlinks" external />
35+
<Card icon="flask" title="Try Demo" href="https://appkit-web-examples-pay.reown.com/?utm_source=appkit-pay-with-exchange&utm_medium=docs&utm_campaign=backlinks" external />
3636
</CardGroup>
3737

3838
## Networks and Assets Supported

‎docs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,10 @@
300300
"appkit/migration/from-connectkit-next",
301301
"appkit/migration/from-anza-adapter-react"
302302
]
303+
},
304+
{
305+
"group": "Technical Reference",
306+
"pages": ["appkit/faq"]
303307
}
304308
]
305309
},

‎images/faq/invalidAppConfiguration.png

68 KB
Loading

0 commit comments

Comments
 (0)