Wallet Visibility
The Arcana wallet is an embedded, non-custodial Web3 wallet that is enabled for every user that logs into an app integrated with the Arcana Auth SDK. App developers can manage the wallet user experience by controlling the wallet's visibility in the app context.
To manage the Arcana wallet visibility, the applications must integrate with the Arcana Auth SDK, specify the appropriate alwaysVisible input parameter while instantiating the AuthProvider, and choose one of the wallet visibility modes:
- Always visible mode: Visible once the user logs into an app
- Not always visible mode: Visible only when a user is logged into an app and a blockchain transaction requires the user's approval
alwaysVisible=true
By default, alwaysVisible is set to true and the wallet is displayed immediately after a user logs into the app that is integrated with the Arcana Auth SDK.
As the wallet is always visible in the context of the app, an authenticated user has full access to all the Web3 wallet operations supported by the Arcana wallet. For example, checking the wallet account balance, adding or switching blockchain networks, and sending/receiving native/custom tokens. Users can choose to minimize/maximize the Arcana wallet UI displayed on the application screen.
alwaysVisible=false
If alwaysVisible is set to false, then the Arcana wallet UI does not show up on the application window immediately after a user logs in. The Arcana wallet UI is displayed only when a blockchain transaction is triggered that requires the user's approval.
Once the user takes action, the request disappears and the user cannot access the Arcana wallet UI until another blockchain transaction is triggered. Unlike the always visible mode, authenticated app users cannot access the Arcana wallet UI on demand and add or switch networks, view the account balance or initiate send/receive of native/custom tokens, or maximize/minimize the Arcana wallet.
Summary
The table below summarizes how alwaysVisible parameter specified during the AuthProvider initialization in the application code controls the user experience. For step-by-step instructions see how to configure the Arcana wallet visibility mode guide.
| Wallet UI Mode | Flag | User Experience |
|---|---|---|
| Always visible | alwaysVisible = true (default) |
1. Arcana walletis always visible on the application screen. |
| 2. Users can minimize the Arcana wallet and it shows as a small widget on the application screen. | ||
| 3. Users can access any of the supported Arcana wallet functions using the wallet UI at any point in time. | ||
| 4. When a user action triggers a blockchain transaction, a transaction notification is displayed, and the user can approve or reject the request or ignore it. If a user ignores the request, it is highlighted as a pending request. In the wallet minimized state, a red dot is shown to indicated a pending request. User can click on the wallet minimized state to bring up the wallet and act upon the notification. In the maximized wallet state, a red dot is displayed on the notification tab of the wallet indicating a pending transaction notification. Other transaction notifications queue up until the user takes action on the first one. | ||
| Not always visible | alwaysVisible = false |
1. Arcana wallet is not visible in the app context by default. It is displayed only when a user action triggers a blockchain transaction or if the developer calls showWallet() function in the app logic. A blockchain transaction triggers notification. Once the user takes an action, the notification disappears. |
| 2. Users cannot minimize the Arcana wallet if this mode is selected by the application. | ||
| 3. Users cannot access any of the supported Arcana wallet functions through the wallet UI. | ||
| 4. When a user action triggers a blockchain transaction, the Arcana wallet transaction notification pops up. It disappears after the user takes an action. If there are other blockchain transactions that show up while the user has not reviewed the current request, those will stay hidden and queue up. After the user action for the first action, subsequent transaction notifications will be displayed one by one for the other pending notifications. For multiple blockchain transactions, the user will see a series of pop-ups, and then after a user action, those will disappear. In this mode, there is no way for the user to ignore the transaction notification or access the Arcana wallet to perform other Web3 wallet operations before first acting upon the transaction notifications. |