Changeset View
Changeset View
Standalone View
Standalone View
web/docs/docs/overview.mdx
--- | --- | ||||
id: cashtab-overview | id: cashtab-overview | ||||
title: Cashtab Web Wallet | title: Cashtab Web Wallet | ||||
sidebar_label: Overview | sidebar_label: Overview | ||||
slug: / | slug: / | ||||
--- | --- | ||||
import useBaseUrl from '@docusaurus/useBaseUrl'; | import useBaseUrl from '@docusaurus/useBaseUrl'; | ||||
Cashtab is a BCHA web wallet available at https://cashtabapp.com/ | Cashtab is an eCash (XEC) web wallet available at https://cashtabapp.com/ | ||||
# Getting Started | # Getting Started | ||||
## Use Cashtab as a mobile app | ## Use Cashtab as a mobile app | ||||
1. Navigate to https://cashtabapp.com/ in your web browser on your mobile device | 1. Navigate to https://cashtabapp.com/ in your web browser on your mobile device | ||||
:::note | :::note | ||||
If you are using an iPhone, Cashtab works best in the Safari browser. | If you are using an iPhone, Cashtab works best in the Safari browser. | ||||
::: | ::: | ||||
2. Click the "Add Cashtab to Homescreen" prompt at the bottom of your screen. | 2. Click the "Add Cashtab to Homescreen" prompt at the bottom of your screen. | ||||
<img | <img | ||||
alt="Add Cashtab to Homescreen" | alt="Add Cashtab to Homescreen" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl('img/05_pwa_dl_google-pixel5-sortasage-portrait.png')} | src={useBaseUrl('img/A001.png')} | ||||
/> | /> | ||||
3. Cashtab will appear as a mobile app icon on your phone's desktop. | 3. Cashtab will appear as a mobile app icon on your phone's desktop. | ||||
## Create your first wallet | ## Create your first wallet | ||||
1. Navigate to https://cashtabapp.com/ on your desktop or mobile device. | 1. Navigate to https://cashtabapp.com/ on your desktop or mobile device. | ||||
2. Click or tap the "New Wallet" button. | 2. Click or tap the "New Wallet" button. | ||||
<img | <img | ||||
alt="Create your first wallet" | alt="Create your first wallet" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl('img/00_first_start_google-pixel5-sortasage-portrait.png')} | src={useBaseUrl('img/A002.png')} | ||||
/> | /> | ||||
3. Click or tap the "Okay, make me a wallet!" button to create your first wallet. | 3. Click or tap the "Okay, make me a wallet!" button to create your first wallet. | ||||
<img | <img | ||||
alt="Confirm wallet creation" | alt="Confirm wallet creation" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl('img/01_seed_alert_google-pixel5-sortasage-portrait.png')} | src={useBaseUrl('img/A004.png')} | ||||
/> | /> | ||||
4. Your wallet is ready to use! | 4. Your wallet is ready to use! | ||||
<img | <img | ||||
alt="New wallet no balance" | alt="New wallet no balance" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl('img/02_empty_wallet_google-pixel5-sortasage-portrait.png')} | src={useBaseUrl('img/A005.png')} | ||||
/> | /> | ||||
## Back up your wallet | ## Back up your wallet | ||||
1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. | 1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. | ||||
<img | <img alt="Settings" width="300px" src={useBaseUrl('img/A006.png')} /> | ||||
alt="Settings" | |||||
width="300px" | |||||
src={useBaseUrl( | |||||
'img/11_SettingsScreenCollapsed_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | |||||
2. Click or tap the "Click to reveal seed phrase" button to display your 12-word seed phrase. | 2. Click or tap the "Click to reveal seed phrase" button to display your 12-word seed phrase. | ||||
3. Write down your seed phrase using pen and paper and store in a safe place. If you lose your device, you can recover your wallet with this seed phrase. | 3. Write down your seed phrase using pen and paper and store in a safe place. If you lose your device, you can recover your wallet with this seed phrase. | ||||
:::caution | :::caution | ||||
Treat this seed phrase like cash. If you have $100 in your Cashtab wallet, this seed phrase is effectively a $100 bill. | Treat this seed phrase like cash. If you have $100 in your Cashtab wallet, this seed phrase is effectively a $100 bill. | ||||
::: | ::: | ||||
## Receive Cash | ## Receive eCash | ||||
1. Copy your BCHA address by clicking or tapping the QR code on your home screen. | 1. Copy your eCash address by clicking or tapping the QR code on your home screen. | ||||
<img | <img alt="Copied cash address" width="300px" src={useBaseUrl('img/A007.png')} /> | ||||
alt="Copied cash address" | |||||
width="300px" | |||||
src={useBaseUrl( | |||||
'img/06_copy_cash_address_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | |||||
2. Send yourself some BCHA using another wallet, or have a friend send you some BCHA. | 2. Send yourself some eCash using another wallet, or have a friend send you some eCash. | ||||
3. When your Cashtab wallet receives BCHA, your balance will update and a notification will appear at the top of your screen. | 3. When your Cashtab wallet receives eCash, your balance will update and a notification will appear at the top of your screen. | ||||
<img | <img alt="Received cash" width="300px" src={useBaseUrl('img/A008.png')} /> | ||||
alt="Received cash" | |||||
width="300px" | |||||
src={useBaseUrl( | |||||
'img/07_cash_received_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | |||||
## Send Cash | ## Send eCash | ||||
1. Click or tap the "Send" button at the bottom center of your screen to navigate to the "Send" screen. | 1. Click or tap the "Send" button at the bottom center of your screen to navigate to the "Send" screen. | ||||
:::note | |||||
On mobile devices, the send screen defaults to loading with the QR scanner open. Click "Allow" to use your devices webcam. | |||||
::: | |||||
<img | <img | ||||
alt="Send screen with balance" | alt="Send screen with balance" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A009.png')} | ||||
'img/10_SendScreenWithBalance_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
2. Enter the address where you would like to send BCHA into the top input field labeled "BCHA Address." You may do this by copy pasting an address into the field, or by scanning a QR code. To scan a QR code, click or tap the "QR Code Scan" icon at the right of the "BCHA Address" field to use your phone camera or webcam to scan the QR code of a receiving address. | <img | ||||
alt="Send screen with balance" | |||||
width="300px" | |||||
src={useBaseUrl('img/A010.png')} | |||||
/> | |||||
2. Enter the address where you would like to send eCash into the top input field labeled "eCash Address." You may do this by copy pasting an address into the field, or by scanning a QR code. To scan a QR code, click or tap the "QR Code Scan" icon at the right of the "eCash Address" field to use your phone camera or webcam to scan the QR code of a receiving address. | |||||
:::info | :::info | ||||
On Apple mobile devices, only the Safari browser supports scanning QR codes. | On Apple mobile devices, only the Safari browser supports scanning QR codes. | ||||
::: | ::: | ||||
3. Enter the USD or BCHA amount you would like to send in the "Amount" field. To send the full contents of your wallet, click the "max" button at the far right of the "Amount" field. | 3. Enter the USD or eCash amount you would like to send in the "Amount" field. To send the full contents of your wallet, click the "max" button at the far right of the "Amount" field. | ||||
:::info | :::info | ||||
Due to transaction fees, the full amount you are able to send is slightly less than your total balance. | Due to transaction fees, the full amount you are able to send is slightly less than your total balance. | ||||
::: | ::: | ||||
4. Click "Send" to send cash. | 4. Click "Send" to send eCash. | ||||
## Receive Tokens | ## Create eTokens | ||||
1. Copy your token address by clicking or tapping the green SLPA button on your home screen, then clicking or tapping the QR code. | :::note | ||||
You need at least 5.5 XEC to create an eToken. | |||||
::: | |||||
1. Navigate to the "eTokens" screen by selecting the "eTokens" icon at the bottom of the screen. | |||||
<img | <img | ||||
alt="Copied token address" | alt="eTokens screen with balance" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A019.png')} | ||||
'img/08_copy_token_address_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
2. Send yourself a token using another wallet, or have a friend send you some tokens. | 2. Click the "Create eToken" button to reveal the form. | ||||
3. When your Cashtab wallet receives an SLPA token, it will appear on your Wallet screen below your address QR code. | <img | ||||
alt="eTokens screen with blank form" | |||||
width="300px" | |||||
src={useBaseUrl('img/A020.png')} | |||||
/> | |||||
3. Input your token name, ticker, decimal places, supply, and URL. If you do not enter a URL, the app will default to "https://cashtabapp.com/" | |||||
<img | <img | ||||
alt="Token balance" | alt="eTokens screen with filled form" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A021.png')} | ||||
'img/09_token_received_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
## Send Tokens | 4. Click "Create eToken." A pop-up will display the parameters of your eToken. Click "okay" to confirm. Your eToken will appear in your eToken list when the wallet detects the transaction. | ||||
:::info | <img | ||||
In order to send tokens, your wallet must have a BCHA balance. | alt="eTokens confirmation" | ||||
::: | width="300px" | ||||
src={useBaseUrl('img/A022.png')} | |||||
/> | |||||
1. Click or tap the token you would like to send. Your tokens are listed in tiles below your address on the "Wallet" screen. | <img | ||||
alt="Successfully created eToken" | |||||
width="300px" | |||||
src={useBaseUrl('img/A023.png')} | |||||
/> | |||||
<img | <img | ||||
alt="Token balance" | alt="Successfully created eToken on eTokens screen" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A024.png')} | ||||
'img/09_token_received_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
## Receive eTokens | |||||
1. Copy your eToken address by clicking or tapping the eToken button on your home screen, then clicking or tapping the QR code. | |||||
<img | <img | ||||
alt="Send token screen" | alt="Copied eToken address" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A011.png')} | ||||
'img/13_SendTokenScreen_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
2. Enter the token address where you would like to send your token into the top input field labeled "SLPA Address." You may do this by copy pasting an address into the field, or by scanning a QR code. To scan a QR code, click or tap the "QR Code Scan" icon at the right of the "SLPA Address" field to use your phone camera or webcam to scan the QR code of a receiving address. | 2. Send yourself an eToken using another wallet, or have a friend send you some eTokens. | ||||
3. When your Cashtab wallet receives an eToken, it will appear on your Wallet screen below your address QR code if you select "eTokens" instead of "Transaction History." You can also see your eToken balances on the "eToken" screen, selected from the main navigation. | |||||
<img alt="eToken balance" width="300px" src={useBaseUrl('img/A013.png')} /> | |||||
<img | |||||
alt="eTokens screen with balance" | |||||
width="300px" | |||||
src={useBaseUrl('img/A019.png')} | |||||
/> | |||||
## Send eTokens | |||||
:::info | |||||
In order to send eTokens, your wallet must have a eCash balance. | |||||
::: | |||||
1. Click or tap the eToken you would like to send. Your eTokens are listed in tiles below your address on the "Wallet" screen if you select "eTokens" instead of "Transaction History," or on the dedicated "eTokens" screen. | |||||
<img alt="eToken balance" width="300px" src={useBaseUrl('img/A013.png')} /> | |||||
<img | |||||
alt="eTokens screen with balance" | |||||
width="300px" | |||||
src={useBaseUrl('img/A019.png')} | |||||
/> | |||||
<img alt="Send eToken screen" width="300px" src={useBaseUrl('img/A014.png')} /> | |||||
2. Enter the eToken address where you would like to send your eToken into the top input field labeled "eToken Address." You may do this by copy pasting an address into the field, or by scanning a QR code. To scan a QR code, click or tap the "QR Code Scan" icon at the right of the "eToken Address" field to use your phone camera or webcam to scan the QR code of a receiving address. | |||||
:::info | :::info | ||||
On Apple mobile devices, only the Safari browser supports scanning QR codes. | On Apple mobile devices, only the Safari browser supports scanning QR codes. | ||||
::: | ::: | ||||
3. Enter the token quantity you would like to send in the "Amount" field. To send the full contents of your wallet, click the "max" button at the far right of the "Amount" field. | 3. Enter the eToken quantity you would like to send in the "Amount" field. To send the full contents of your wallet, click the "max" button at the far right of the "Amount" field. | ||||
4. Click the orange "Send `<TokenName>`" button to send your token. | 4. Click the orange "Send `<TokenName>`" button to send your eToken. | ||||
## Add a new wallet | ## Add a new wallet | ||||
1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. | 1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. | ||||
<img | <img | ||||
alt="Settings screen collapsed" | alt="Settings screen collapsed" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A006.png')} | ||||
'img/11_SettingsScreenCollapsed_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
2. Click the orange "New Wallet" button. | 2. Click the orange "New Wallet" button. | ||||
3. Your new wallet will be added to the end of your "Saved wallets." Click the "Saved wallets" button, then click "Activate" next to the wallet to begin using your new wallet. | 3. Your new wallet will be added to the end of your "Saved wallets." Click the "Saved wallets" button, then click "Activate" next to the wallet to begin using your new wallet. | ||||
<img | |||||
alt="Settings screen collapsed" | |||||
width="300px" | |||||
src={useBaseUrl('img/A015.png')} | |||||
/> | |||||
## Import wallet | ## Import wallet | ||||
If you have already created a Cashtab wallet on one device, you can use your seed phrase to import this wallet to any other device. | If you have already created a Cashtab wallet on one device, you can use your seed phrase to import this wallet to any other device. | ||||
1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. | 1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. | ||||
<img | <img | ||||
alt="Settings screen collapsed" | alt="Settings screen collapsed" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A006.png')} | ||||
'img/11_SettingsScreenCollapsed_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
2. Click the grey "Import Wallet" button. A text field labeled "mnemonic (seed phrase) is revealed. | 2. Click the grey "Import Wallet" button. A text field labeled "mnemonic (seed phrase) is revealed. | ||||
3. Type or copy paste your 12-word seed phrase into the text field and click the "Import" button. | 3. Type or copy paste your 12-word seed phrase into the text field and click the "Import" button. | ||||
:::note | :::note | ||||
Cashtab currently only supports importing Cashtab wallets with 12-word seeds. | Cashtab currently only supports importing Cashtab wallets with 12-word seeds. | ||||
::: | ::: | ||||
:::caution | :::caution | ||||
If you import a wallet that was not created with Cashtab, Cashtab may not properly load the balance or transaction history for this wallet. | If you import a wallet that was not created with Cashtab, Cashtab may not properly load the balance or transaction history for this wallet. | ||||
::: | ::: | ||||
4. Your wallet will be added to the end of your Saved Wallets list. To activate the imported wallet, click the "Activate" button next to your imported wallet. | 4. Your wallet will be added to the end of your Saved Wallets list. To activate the imported wallet, click the "Activate" button next to your imported wallet. | ||||
## Manage your wallets | ## Manage your wallets | ||||
1. Click the "Saved wallets" button to reveal your list of wallets. | 1. Click the "Saved wallets" button to reveal your list of wallets. | ||||
<img | <img | ||||
alt="Saved wallets list expanded" | alt="Saved wallets list expanded" | ||||
width="300px" | width="300px" | ||||
src={useBaseUrl( | src={useBaseUrl('img/A016.png')} | ||||
'img/12_SettingsScreen2Wallets_google-pixel5-sortasage-portrait.png', | |||||
)} | |||||
/> | /> | ||||
2. You can rename, delete, or activate your wallets by clicking the appropriate button next to your wallet in the "Saved wallets" list. | 2. You can rename, delete, or activate your wallets by clicking the appropriate button next to your wallet in the "Saved wallets" list. | ||||
:::note | :::note | ||||
Only one wallet at a time is active in Cashtab. To view the seed phrase of a saved wallet, activate the wallet and then click "Reveal seed phrase" on the "Settings" screen. | Only one wallet at a time is active in Cashtab. To view the seed phrase of a saved wallet, activate the wallet and then click "Reveal seed phrase" on the "Settings" screen. | ||||
::: | ::: | ||||
:::danger | :::danger | ||||
Make sure to back up your wallet before deleting it. If you delete a wallet and do not have its seed phrase, there is no way to recover the wallet. | Make sure to back up your wallet before deleting it. If you delete a wallet and do not have its seed phrase, there is no way to recover the wallet. | ||||
::: | ::: | ||||
## Select custom fiat currency | |||||
1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. | |||||
<img | |||||
alt="Settings screen collapsed" | |||||
width="300px" | |||||
src={useBaseUrl('img/A006.png')} | |||||
/> | |||||
2. Scroll to the bottom to find the selection of available fiat currencies under the "Fiat Currency" heading. | |||||
<img alt="Select Fiat" width="300px" src={useBaseUrl('img/A017.png')} /> | |||||
3. Select your preferred fiat currency. | |||||
<img alt="Select Fiat" width="300px" src={useBaseUrl('img/A018.png')} /> |