diff --git a/web/docs/docs/overview.mdx b/web/docs/docs/overview.mdx index a26ab4846..188e4fcd6 100644 --- a/web/docs/docs/overview.mdx +++ b/web/docs/docs/overview.mdx @@ -1,252 +1,302 @@ --- id: cashtab-overview title: Cashtab Web Wallet sidebar_label: Overview slug: / --- 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 ## Use Cashtab as a mobile app 1. Navigate to https://cashtabapp.com/ in your web browser on your mobile device :::note 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. Add Cashtab to Homescreen 3. Cashtab will appear as a mobile app icon on your phone's desktop. ## Create your first wallet 1. Navigate to https://cashtabapp.com/ on your desktop or mobile device. 2. Click or tap the "New Wallet" button. Create your first wallet 3. Click or tap the "Okay, make me a wallet!" button to create your first wallet. Confirm wallet creation 4. Your wallet is ready to use! New wallet no balance ## Back up your wallet 1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. -Settings +Settings 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. :::caution 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. -Copied cash address +Copied cash address -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. -Received cash +Received cash -## Send Cash +## Send eCash 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. +::: + Send screen with balance -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. +Send screen with balance + +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 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 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. Copied token address -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. +eTokens screen with blank form + +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/" Token balance -## 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 -In order to send tokens, your wallet must have a BCHA balance. -::: +eTokens confirmation -1. Click or tap the token you would like to send. Your tokens are listed in tiles below your address on the "Wallet" screen. +Successfully created eToken Token balance +## 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. + Send token screen -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. + +eToken balance + +eTokens screen with balance + +## 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. + +eToken balance + +eTokens screen with balance + +Send eToken screen + +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 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 ``" button to send your token. +4. Click the orange "Send ``" button to send your eToken. ## Add a new wallet 1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. Settings screen collapsed 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. +Settings screen collapsed + ## 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. 1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. Settings screen collapsed 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. :::note Cashtab currently only supports importing Cashtab wallets with 12-word seeds. ::: :::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. ::: 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 1. Click the "Saved wallets" button to reveal your list of wallets. Saved wallets list expanded 2. You can rename, delete, or activate your wallets by clicking the appropriate button next to your wallet in the "Saved wallets" list. :::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. ::: :::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. ::: + +## Select custom fiat currency + +1. Click or tap the "Settings" icon at the bottom right of your screen to navigate to the "Settings" screen. + +Settings screen collapsed + +2. Scroll to the bottom to find the selection of available fiat currencies under the "Fiat Currency" heading. + +Select Fiat + +3. Select your preferred fiat currency. + +Select Fiat diff --git a/web/docs/docusaurus.config.js b/web/docs/docusaurus.config.js index e5c7e1d84..1c86c4c03 100644 --- a/web/docs/docusaurus.config.js +++ b/web/docs/docusaurus.config.js @@ -1,93 +1,93 @@ module.exports = { title: 'Cashtab Docs', tagline: 'Add cash payments to your website', url: 'https://docs.cashtabapp.com', baseUrl: '/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', favicon: 'img/favicon.ico', organizationName: 'bitcoin-abc', projectName: 'cashtab', themeConfig: { colorMode: { // "light" | "dark" defaultMode: 'dark', }, googleAnalytics: { trackingID: 'UA-183678810-2', }, - image: 'img/twitter-card.jpg', + image: 'img/cashtab_twitter.png', navbar: { title: 'Cashtab', logo: { alt: 'Cashtab Logo', - src: 'img/logo.svg', + src: 'img/ecash512.png', }, items: [ { to: 'docs/', activeBasePath: 'docs', label: 'Docs', position: 'left', }, { href: 'https://github.com/bitcoin-abc/bitcoin-abc/', label: 'GitHub', position: 'right', }, ], }, footer: { style: 'dark', links: [ { title: 'Docs', items: [ { label: 'Overview', to: 'docs/', }, { label: 'cashtab-components', to: 'docs/components-overview/', }, ], }, { title: 'Community', items: [ { label: 'Twitter', - href: 'https://twitter.com/Bitcoin_ABC', + href: 'https://twitter.com/ecashofficial', }, ], }, { title: 'More', items: [ { - label: 'BCHA', - href: 'https://bitcoinabc.org/bcha/', + label: 'eCash Home', + href: 'https://e.cash//', }, ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} Bitcoin ABC.`, + copyright: `Copyright © ${new Date().getFullYear()} Bitcoin ABC`, }, }, presets: [ [ '@docusaurus/preset-classic', { docs: { sidebarPath: require.resolve('./sidebars.js'), editUrl: 'https://github.com/Bitcoin-ABC/bitcoin-abc/tree/master/web/docs/', }, theme: { customCss: require.resolve('./src/css/custom.css'), }, }, ], ], }; diff --git a/web/docs/src/css/custom.css b/web/docs/src/css/custom.css index 822411125..30261f35f 100644 --- a/web/docs/src/css/custom.css +++ b/web/docs/src/css/custom.css @@ -1,25 +1,25 @@ /* stylelint-disable docusaurus/copyright-header */ /** * Any CSS included here will be global. The classic template * bundles Infima by default. Infima is a CSS framework designed to * work well for content-centric websites. */ /* You can override the default Infima variables here. */ :root { - --ifm-color-primary: rgb(255, 141, 0); + --ifm-color-primary: rgb(205, 11, 195); --ifm-color-primary-dark: rgb(33, 175, 144); --ifm-color-primary-darker: rgb(31, 165, 136); --ifm-color-primary-darkest: rgb(26, 136, 112); --ifm-color-primary-light: rgb(70, 203, 174); --ifm-color-primary-lighter: rgb(102, 212, 189); --ifm-color-primary-lightest: rgb(146, 224, 208); --ifm-code-font-size: 95%; } .docusaurus-highlight-code-line { background-color: rgb(72, 77, 91); display: block; margin: 0 calc(-1 * var(--ifm-pre-padding)); padding: 0 var(--ifm-pre-padding); } diff --git a/web/docs/static/img/00_first_start_google-pixel5-sortasage-portrait.png b/web/docs/static/img/00_first_start_google-pixel5-sortasage-portrait.png deleted file mode 100644 index 3e14fa79e..000000000 Binary files a/web/docs/static/img/00_first_start_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/01_seed_alert_google-pixel5-sortasage-portrait.png b/web/docs/static/img/01_seed_alert_google-pixel5-sortasage-portrait.png deleted file mode 100644 index b2719cea1..000000000 Binary files a/web/docs/static/img/01_seed_alert_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/02_empty_wallet_google-pixel5-sortasage-portrait.png b/web/docs/static/img/02_empty_wallet_google-pixel5-sortasage-portrait.png deleted file mode 100644 index 4383aaa23..000000000 Binary files a/web/docs/static/img/02_empty_wallet_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/03_01_balance_google-pixel5-sortasage-portrait.png b/web/docs/static/img/03_01_balance_google-pixel5-sortasage-portrait.png deleted file mode 100644 index 773a958d4..000000000 Binary files a/web/docs/static/img/03_01_balance_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/04_send_screen_google-pixel5-sortasage-portrait.png b/web/docs/static/img/04_send_screen_google-pixel5-sortasage-portrait.png deleted file mode 100644 index bac8a4c7e..000000000 Binary files a/web/docs/static/img/04_send_screen_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/05_pwa_dl_google-pixel5-sortasage-portrait.png b/web/docs/static/img/05_pwa_dl_google-pixel5-sortasage-portrait.png deleted file mode 100644 index 5e74ed70f..000000000 Binary files a/web/docs/static/img/05_pwa_dl_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/06_copy_cash_address_google-pixel5-sortasage-portrait.png b/web/docs/static/img/06_copy_cash_address_google-pixel5-sortasage-portrait.png deleted file mode 100644 index a318e495a..000000000 Binary files a/web/docs/static/img/06_copy_cash_address_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/07_cash_received_google-pixel5-sortasage-portrait.png b/web/docs/static/img/07_cash_received_google-pixel5-sortasage-portrait.png deleted file mode 100644 index ec1e07c52..000000000 Binary files a/web/docs/static/img/07_cash_received_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/08_copy_token_address_google-pixel5-sortasage-portrait.png b/web/docs/static/img/08_copy_token_address_google-pixel5-sortasage-portrait.png deleted file mode 100644 index 08bfb3adf..000000000 Binary files a/web/docs/static/img/08_copy_token_address_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/09_token_received_google-pixel5-sortasage-portrait.png b/web/docs/static/img/09_token_received_google-pixel5-sortasage-portrait.png deleted file mode 100644 index ae9e10e73..000000000 Binary files a/web/docs/static/img/09_token_received_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/10_SendScreenWithBalance_google-pixel5-sortasage-portrait.png b/web/docs/static/img/10_SendScreenWithBalance_google-pixel5-sortasage-portrait.png deleted file mode 100644 index bac8a4c7e..000000000 Binary files a/web/docs/static/img/10_SendScreenWithBalance_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/11_SettingsScreenCollapsed_google-pixel5-sortasage-portrait.png b/web/docs/static/img/11_SettingsScreenCollapsed_google-pixel5-sortasage-portrait.png deleted file mode 100644 index 16504e5e1..000000000 Binary files a/web/docs/static/img/11_SettingsScreenCollapsed_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/12_SettingsScreen2Wallets_google-pixel5-sortasage-portrait.png b/web/docs/static/img/12_SettingsScreen2Wallets_google-pixel5-sortasage-portrait.png deleted file mode 100644 index cb87e8d32..000000000 Binary files a/web/docs/static/img/12_SettingsScreen2Wallets_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/13_SendTokenScreen_google-pixel5-sortasage-portrait.png b/web/docs/static/img/13_SendTokenScreen_google-pixel5-sortasage-portrait.png deleted file mode 100644 index 364f4c0d3..000000000 Binary files a/web/docs/static/img/13_SendTokenScreen_google-pixel5-sortasage-portrait.png and /dev/null differ diff --git a/web/docs/static/img/A001.png b/web/docs/static/img/A001.png new file mode 100644 index 000000000..66a573ad0 Binary files /dev/null and b/web/docs/static/img/A001.png differ diff --git a/web/docs/static/img/A002.png b/web/docs/static/img/A002.png new file mode 100644 index 000000000..e7eee6520 Binary files /dev/null and b/web/docs/static/img/A002.png differ diff --git a/web/docs/static/img/A004.png b/web/docs/static/img/A004.png new file mode 100644 index 000000000..34dee96ec Binary files /dev/null and b/web/docs/static/img/A004.png differ diff --git a/web/docs/static/img/A005.png b/web/docs/static/img/A005.png new file mode 100644 index 000000000..e7e0d8686 Binary files /dev/null and b/web/docs/static/img/A005.png differ diff --git a/web/docs/static/img/A006.png b/web/docs/static/img/A006.png new file mode 100644 index 000000000..b540b8545 Binary files /dev/null and b/web/docs/static/img/A006.png differ diff --git a/web/docs/static/img/A007.png b/web/docs/static/img/A007.png new file mode 100644 index 000000000..0f51ca444 Binary files /dev/null and b/web/docs/static/img/A007.png differ diff --git a/web/docs/static/img/A008.png b/web/docs/static/img/A008.png new file mode 100644 index 000000000..0ff77b38d Binary files /dev/null and b/web/docs/static/img/A008.png differ diff --git a/web/docs/static/img/A009.png b/web/docs/static/img/A009.png new file mode 100644 index 000000000..ccaccf652 Binary files /dev/null and b/web/docs/static/img/A009.png differ diff --git a/web/docs/static/img/A010.png b/web/docs/static/img/A010.png new file mode 100644 index 000000000..a570c0b8b Binary files /dev/null and b/web/docs/static/img/A010.png differ diff --git a/web/docs/static/img/A011.png b/web/docs/static/img/A011.png new file mode 100644 index 000000000..ecd58df69 Binary files /dev/null and b/web/docs/static/img/A011.png differ diff --git a/web/docs/static/img/A013.png b/web/docs/static/img/A013.png new file mode 100644 index 000000000..9fee150e1 Binary files /dev/null and b/web/docs/static/img/A013.png differ diff --git a/web/docs/static/img/A014.png b/web/docs/static/img/A014.png new file mode 100644 index 000000000..58894c027 Binary files /dev/null and b/web/docs/static/img/A014.png differ diff --git a/web/docs/static/img/A015.png b/web/docs/static/img/A015.png new file mode 100644 index 000000000..2303c6a38 Binary files /dev/null and b/web/docs/static/img/A015.png differ diff --git a/web/docs/static/img/A016.png b/web/docs/static/img/A016.png new file mode 100644 index 000000000..4584e2874 Binary files /dev/null and b/web/docs/static/img/A016.png differ diff --git a/web/docs/static/img/A017.png b/web/docs/static/img/A017.png new file mode 100644 index 000000000..82022962e Binary files /dev/null and b/web/docs/static/img/A017.png differ diff --git a/web/docs/static/img/A018.png b/web/docs/static/img/A018.png new file mode 100644 index 000000000..6119bcc59 Binary files /dev/null and b/web/docs/static/img/A018.png differ diff --git a/web/docs/static/img/A019.png b/web/docs/static/img/A019.png new file mode 100644 index 000000000..a9a82b1a2 Binary files /dev/null and b/web/docs/static/img/A019.png differ diff --git a/web/docs/static/img/A020.png b/web/docs/static/img/A020.png new file mode 100644 index 000000000..263916af4 Binary files /dev/null and b/web/docs/static/img/A020.png differ diff --git a/web/docs/static/img/A021.png b/web/docs/static/img/A021.png new file mode 100644 index 000000000..c1467eaf4 Binary files /dev/null and b/web/docs/static/img/A021.png differ diff --git a/web/docs/static/img/A022.png b/web/docs/static/img/A022.png new file mode 100644 index 000000000..9b7ea78aa Binary files /dev/null and b/web/docs/static/img/A022.png differ diff --git a/web/docs/static/img/A023.png b/web/docs/static/img/A023.png new file mode 100644 index 000000000..a19e7a31b Binary files /dev/null and b/web/docs/static/img/A023.png differ diff --git a/web/docs/static/img/A024.png b/web/docs/static/img/A024.png new file mode 100644 index 000000000..a6279d3c9 Binary files /dev/null and b/web/docs/static/img/A024.png differ diff --git a/web/docs/static/img/cashtab_twitter.png b/web/docs/static/img/cashtab_twitter.png new file mode 100644 index 000000000..df43505da Binary files /dev/null and b/web/docs/static/img/cashtab_twitter.png differ diff --git a/web/docs/static/img/ecash512.png b/web/docs/static/img/ecash512.png new file mode 100644 index 000000000..a7d1ad32d Binary files /dev/null and b/web/docs/static/img/ecash512.png differ diff --git a/web/docs/static/img/favicon.ico b/web/docs/static/img/favicon.ico index db48048f6..a4f74e528 100644 Binary files a/web/docs/static/img/favicon.ico and b/web/docs/static/img/favicon.ico differ diff --git a/web/docs/static/img/logo.svg b/web/docs/static/img/logo.svg deleted file mode 100644 index c3f7066cc..000000000 --- a/web/docs/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ -12-bitcoin-cash-square-crop \ No newline at end of file diff --git a/web/docs/static/img/twitter-card.jpg b/web/docs/static/img/twitter-card.jpg deleted file mode 100644 index 4fcf06833..000000000 Binary files a/web/docs/static/img/twitter-card.jpg and /dev/null differ