diff --git a/docs/activity.md b/docs/activity.md new file mode 100644 index 00000000..1814ba25 --- /dev/null +++ b/docs/activity.md @@ -0,0 +1,10 @@ +# Activity + +Activity section lets users see their transactions history in the wallet and also let users view the transaction data on Solana Explorer. + + + + + + +--------------------------------------------------------------------------------------------------- diff --git a/docs/discover.md b/docs/discover.md new file mode 100644 index 00000000..d5f5f875 --- /dev/null +++ b/docs/discover.md @@ -0,0 +1,13 @@ +# Discover + + +Users can discover popular DApps on solana on the Discover page. + + + + + + + +--------------------------------------------------------------------------------------------------- + diff --git a/docs/home.md b/docs/home.md new file mode 100644 index 00000000..abf6f16f --- /dev/null +++ b/docs/home.md @@ -0,0 +1,110 @@ +# Home + + +## _Main Page_ + + + + +While running this repo locally user will be able to access the above landing page (screenshot - 1) of Solana Wallet at [http://localhost:8080/wallet/home](http://localhost:8080/wallet/home) . + +--------------------------------------------------------------------------------------------------- + + + + +## _Account Balance_ + + + + + + + + + +Account Balance section shows the cumulative account balance of user in the wallet. It also displays the current value of one SOL token. There is a drop down menu to change the currency type (13 supported currencies) and default is USD. + +--------------------------------------------------------------------------------------------------- + +## _Share Address / QR code_ + + + +Clicking the QR code icon on the home page will trigger a popup with a QR code embedded with the wallet address. There is also an option to download +the QR code or one click copy the public address. User can share the QR Code or public address with anyone to receive SOL tokens or NFT's on this wallet. +(Anyone with the public address can see your wallet balance and previous transactions). + +--------------------------------------------------------------------------------------------------- + + + +## _Scan & Pay_ + + + + + +Scan & Pay button on top lets the user harness [Solana Pay](https://solanapay.com/), which is a decentralized and performant payment network for immediate transactions in SOL or SPL tokens like USDC. + +Scan & Pay opens the device camera to scan merchants QR Code. + +Interested to know more about Solana Pay? [How Solana Pay works](https://solana.com/news/solana-pay-transaction-requests-bring-on-chain-interactivity-to-the-off-chain-world) +--------------------------------------------------------------------------------------------------- + + + +## _Buying SOL Tokens_ + + + + +Solana wallet allow users to purchase SOL tokens directly from the wallet. +- Clicking on the topup button takes user to a page to select the topup service provider to buy tokens from. +- Currently users can purchase and topup SOL tokens from [Moonpay](https://www.moonpay.com/) only. +- User can select the topup value in user's preferred fiat currency and the wallet will redirect user to moonpay website to complete the payment. +- On completing the payment user will receive the equivalent tokens in the wallet. +--------------------------------------------------------------------------------------------------- + + + + +## _Transfer Button_ + + + + + + + +Transfer Button on the wallet redirects user to a transfer page to send SOL/SPL/NFT tokens to other wallets. +- Make sure a valid Solana address/SOL Domain is provided (eg: transferring SOL to ETH or BTC address will result in permanent loss of tokens) +- There is a dropdown menu to select the token. +- For sending SOL tokens, user can set the transfer amount in SOL tokens or in user's preferred currency of choice. +- User can select the topup value in his/her preferred fiat currency and the wallet will redirect user to moonpay website to complete the payment. +- Confirm Transaction popup will show the details of the transaction. If the state changes are parsable, users can check the net account balance change as well. + +--------------------------------------------------------------------------------------------------- + + + +## _Tokens_ + + + + + +Tokens section in the wallet lists the available tokens in the wallet. + +- By default SOL token is listed here and corresponding number of tokens is also shown. +- Solana Wallet can also display tokens belonging to the user which are minted using [SPL](https://spl.solana.com/). +- User can click on Import Token button and fill in the details to import SPL tokens owned by the public address. + +--------------------------------------------------------------------------------------------------- + +## _Logout or Choose different Address_ + + + + +User can click on their username on top right corner of the screen to logout or choose an alternate wallet address. diff --git a/docs/howToClientId.md b/docs/howToClientId.md new file mode 100644 index 00000000..d710c4c1 --- /dev/null +++ b/docs/howToClientId.md @@ -0,0 +1,17 @@ +# Generating clientId for your fork from Web3Auth Dashboard + +You can login to Web3Auth dashboard [here](https://dashboard.web3auth.io/). + + + + + + + +Click on the Torus Wallet button on left side. + + + + + + Click on create a new project button to start a new project and generate a Client ID which you can copy and use in your project. diff --git a/docs/howToFork.md b/docs/howToFork.md new file mode 100644 index 00000000..0fa26f3c --- /dev/null +++ b/docs/howToFork.md @@ -0,0 +1,17 @@ +## How to fork the repo + +Developers who wish to fork this repo may please go through our license agreement [here](https://github.com/torusresearch/solana-wallet/blob/develop/LICENSE.md). + +Please contact hello@tor.us for any questions. + +Mandatory changes required: + +- 1. Get your Client ID from Web3Auth [Dashboard](https://dashboard.web3auth.io/) by creating a new project ([ How to generate a clientId from Web3Auth dashboard ](howToClientId.md)). [Readmore](https://web3auth.io/docs/quick-start) + +- 2. In config.ts file, replace the clientId with your Client ID + +- 3. Generate your own sentry and google analytics credentials and use them in .env files. + +- 4. API calls to https://solana-api.tor.us are restricted. Please contact our team for help. + +- 5. Generate a different sentry dsn for your fork. All your error logs will be lost if dsn value in the current env file is reused. diff --git a/docs/login.md b/docs/login.md new file mode 100644 index 00000000..72e3f37d --- /dev/null +++ b/docs/login.md @@ -0,0 +1,23 @@ +# Login + + +You can login to Solana Wallet at [Production URL](https://solana-testing.tor.us/login). + +To login to your local deployment at : [Local Version](http://localhost:8080/login). + + + + + + + +Solana Wallet has one click login with your Google account / Facebook / Twitter / Discord. +Users can also login with their email id and validating a link via email. + + + +Things to remember: + +- Torus does not store any data related to your social logins. +- The following sign-ins involve a third party authenticator: Apple, Email, GitHub, Kakao, LINE, LinkedIn, Twitter, WeChat. +--------------------------------------------------------------------------------------------------- diff --git a/docs/main.md b/docs/main.md new file mode 100644 index 00000000..3b9cdd26 --- /dev/null +++ b/docs/main.md @@ -0,0 +1,47 @@ +# User guide to Solana Wallet + + + +Solana wallet is a non custodial crypto wallet built for [Solana Blockchain](https://solana.com/) with a seamless & secure login mechanism powered by [web3auth](https://web3auth.io/). +This document is composed to help +- Crypto enthusiasts +- Anyone forking this repo. +- Anyone who wants to explore the functionalities of the wallet without creating an account. + + + +## Features + +- Generate and manage private key public key pair for interacting with Solana blockchain. +- Key management powered by [web3auth](https://web3auth.io/). +- Buy SOL tokens from Moonpay. +- Send and receive SOL and SPL Tokens. +- Store frequently used addresses and domains in the address book. +- Connect to Solana Mainnet, Testnet or Devnet. +- Discover and interact with Solana DApps. +- Built in dark mode 😆 + + + +## Below are the views available in the wallet + +Go the the respective page below for more information. + + +- [Login](login.md) - Solana Wallet login page. + +- [Home](home.md) - Landing page. + +- [NFTs](nfts.md) - NFTs in your wallet. + +- [Activity](activity.md) - Activity across all dapps (including wallet) + +- [Settings](settings.md) - Change networks, theme, error reporting, etc. + +- [Discover](discover.md) - Discover popular DApps on Solana. + + + +## How to fork the repo + +Please read this [page](howToFork.md) for more information about forking this repository. diff --git a/docs/nfts.md b/docs/nfts.md new file mode 100644 index 00000000..30a17133 --- /dev/null +++ b/docs/nfts.md @@ -0,0 +1,24 @@ +# NFTs + + +Popular NFT projects are listed in this page and users are redirected to [MAGIC EDEN](https://magiceden.io/) . + +If user don't own any NFT's wallet will display popular NFT projects from which user can buy them. + + + + + +Users can click on the nft icon to open a detailed view of the asset and the detailed page allows transfer and burning NFT. + + + + +NFT can be transferred to any other valid solana address via the transfer page. + + + +Burning NFT's will free up the resources and the sol tokens are returned to the user's wallet. + + +--------------------------------------------------------------------------------------------------- diff --git a/docs/screenshots/Inspect on blockexplorer.png b/docs/screenshots/Inspect on blockexplorer.png new file mode 100644 index 00000000..27aa2ae5 Binary files /dev/null and b/docs/screenshots/Inspect on blockexplorer.png differ diff --git a/docs/screenshots/account-highlighted.png b/docs/screenshots/account-highlighted.png new file mode 100644 index 00000000..31e034ee Binary files /dev/null and b/docs/screenshots/account-highlighted.png differ diff --git a/docs/screenshots/activity.png b/docs/screenshots/activity.png new file mode 100644 index 00000000..90356b96 Binary files /dev/null and b/docs/screenshots/activity.png differ diff --git a/docs/screenshots/clientid-copy.png b/docs/screenshots/clientid-copy.png new file mode 100644 index 00000000..353d1be6 Binary files /dev/null and b/docs/screenshots/clientid-copy.png differ diff --git a/docs/screenshots/confirm-transfer.png b/docs/screenshots/confirm-transfer.png new file mode 100644 index 00000000..45fa485c Binary files /dev/null and b/docs/screenshots/confirm-transfer.png differ diff --git a/docs/screenshots/create-client-id.png b/docs/screenshots/create-client-id.png new file mode 100644 index 00000000..384eb790 Binary files /dev/null and b/docs/screenshots/create-client-id.png differ diff --git a/docs/screenshots/discover.png b/docs/screenshots/discover.png new file mode 100644 index 00000000..341c7a7d Binary files /dev/null and b/docs/screenshots/discover.png differ diff --git a/docs/screenshots/exchanges.png b/docs/screenshots/exchanges.png new file mode 100644 index 00000000..a2720fe3 Binary files /dev/null and b/docs/screenshots/exchanges.png differ diff --git a/docs/screenshots/homepage-landing.png b/docs/screenshots/homepage-landing.png new file mode 100644 index 00000000..15f5529d Binary files /dev/null and b/docs/screenshots/homepage-landing.png differ diff --git a/docs/screenshots/loginPage.png b/docs/screenshots/loginPage.png new file mode 100644 index 00000000..4f062755 Binary files /dev/null and b/docs/screenshots/loginPage.png differ diff --git a/docs/screenshots/logout.png b/docs/screenshots/logout.png new file mode 100644 index 00000000..e612e902 Binary files /dev/null and b/docs/screenshots/logout.png differ diff --git a/docs/screenshots/nft-3.png b/docs/screenshots/nft-3.png new file mode 100644 index 00000000..e3c86ebb Binary files /dev/null and b/docs/screenshots/nft-3.png differ diff --git a/docs/screenshots/nft-burn.png b/docs/screenshots/nft-burn.png new file mode 100644 index 00000000..2de3f05a Binary files /dev/null and b/docs/screenshots/nft-burn.png differ diff --git a/docs/screenshots/nft-detail.png b/docs/screenshots/nft-detail.png new file mode 100644 index 00000000..1a4ce6ab Binary files /dev/null and b/docs/screenshots/nft-detail.png differ diff --git a/docs/screenshots/nft-send.png b/docs/screenshots/nft-send.png new file mode 100644 index 00000000..74d2855c Binary files /dev/null and b/docs/screenshots/nft-send.png differ diff --git a/docs/screenshots/nft-transfer.png b/docs/screenshots/nft-transfer.png new file mode 100644 index 00000000..57dec941 Binary files /dev/null and b/docs/screenshots/nft-transfer.png differ diff --git a/docs/screenshots/nfts.png b/docs/screenshots/nfts.png new file mode 100644 index 00000000..a56c01cf Binary files /dev/null and b/docs/screenshots/nfts.png differ diff --git a/docs/screenshots/qrCode-stuff.png b/docs/screenshots/qrCode-stuff.png new file mode 100644 index 00000000..fbf04356 Binary files /dev/null and b/docs/screenshots/qrCode-stuff.png differ diff --git a/docs/screenshots/settings-address-book.png b/docs/screenshots/settings-address-book.png new file mode 100644 index 00000000..d4b997de Binary files /dev/null and b/docs/screenshots/settings-address-book.png differ diff --git a/docs/screenshots/settings-crashreporting.png b/docs/screenshots/settings-crashreporting.png new file mode 100644 index 00000000..b15563a2 Binary files /dev/null and b/docs/screenshots/settings-crashreporting.png differ diff --git a/docs/screenshots/settings-darkmode.png b/docs/screenshots/settings-darkmode.png new file mode 100644 index 00000000..ad82b1a6 Binary files /dev/null and b/docs/screenshots/settings-darkmode.png differ diff --git a/docs/screenshots/settings-language.png b/docs/screenshots/settings-language.png new file mode 100644 index 00000000..c8ef73b8 Binary files /dev/null and b/docs/screenshots/settings-language.png differ diff --git a/docs/screenshots/settings-main.png b/docs/screenshots/settings-main.png new file mode 100644 index 00000000..06ffe7f9 Binary files /dev/null and b/docs/screenshots/settings-main.png differ diff --git a/docs/screenshots/settings-network-1.png b/docs/screenshots/settings-network-1.png new file mode 100644 index 00000000..b31cc3d8 Binary files /dev/null and b/docs/screenshots/settings-network-1.png differ diff --git a/docs/screenshots/settings-network-select.png b/docs/screenshots/settings-network-select.png new file mode 100644 index 00000000..8991d4e2 Binary files /dev/null and b/docs/screenshots/settings-network-select.png differ diff --git a/docs/screenshots/settings-privacy&security.png b/docs/screenshots/settings-privacy&security.png new file mode 100644 index 00000000..cc25e60e Binary files /dev/null and b/docs/screenshots/settings-privacy&security.png differ diff --git a/docs/screenshots/settings-show-key.png b/docs/screenshots/settings-show-key.png new file mode 100644 index 00000000..958553ea Binary files /dev/null and b/docs/screenshots/settings-show-key.png differ diff --git a/docs/screenshots/signin-page.png b/docs/screenshots/signin-page.png new file mode 100644 index 00000000..23499323 Binary files /dev/null and b/docs/screenshots/signin-page.png differ diff --git a/docs/screenshots/solPay.png b/docs/screenshots/solPay.png new file mode 100644 index 00000000..76e7465b Binary files /dev/null and b/docs/screenshots/solPay.png differ diff --git a/docs/screenshots/token-import.png b/docs/screenshots/token-import.png new file mode 100644 index 00000000..99dca966 Binary files /dev/null and b/docs/screenshots/token-import.png differ diff --git a/docs/screenshots/token-list.png b/docs/screenshots/token-list.png new file mode 100644 index 00000000..2c61144f Binary files /dev/null and b/docs/screenshots/token-list.png differ diff --git a/docs/screenshots/topup-button.png b/docs/screenshots/topup-button.png new file mode 100644 index 00000000..7c4a0e60 Binary files /dev/null and b/docs/screenshots/topup-button.png differ diff --git a/docs/screenshots/transfer-button.png b/docs/screenshots/transfer-button.png new file mode 100644 index 00000000..c43e49ac Binary files /dev/null and b/docs/screenshots/transfer-button.png differ diff --git a/docs/screenshots/transfer-token.png b/docs/screenshots/transfer-token.png new file mode 100644 index 00000000..a54e6122 Binary files /dev/null and b/docs/screenshots/transfer-token.png differ diff --git a/docs/screenshots/wallet-home-import-token.png b/docs/screenshots/wallet-home-import-token.png new file mode 100644 index 00000000..d755eb70 Binary files /dev/null and b/docs/screenshots/wallet-home-import-token.png differ diff --git a/docs/screenshots/wallet-home-qrCode.png b/docs/screenshots/wallet-home-qrCode.png new file mode 100644 index 00000000..b4563f93 Binary files /dev/null and b/docs/screenshots/wallet-home-qrCode.png differ diff --git a/docs/screenshots/wallet-home-qrScanner.png b/docs/screenshots/wallet-home-qrScanner.png new file mode 100644 index 00000000..134262e1 Binary files /dev/null and b/docs/screenshots/wallet-home-qrScanner.png differ diff --git a/docs/screenshots/wallet-home-topup.png b/docs/screenshots/wallet-home-topup.png new file mode 100644 index 00000000..a9830175 Binary files /dev/null and b/docs/screenshots/wallet-home-topup.png differ diff --git a/docs/screenshots/web3auth-dashboard-button.png b/docs/screenshots/web3auth-dashboard-button.png new file mode 100644 index 00000000..811b2593 Binary files /dev/null and b/docs/screenshots/web3auth-dashboard-button.png differ diff --git a/docs/screenshots/web3auth-dashboard.png b/docs/screenshots/web3auth-dashboard.png new file mode 100644 index 00000000..a3ce6a86 Binary files /dev/null and b/docs/screenshots/web3auth-dashboard.png differ diff --git a/docs/settings.md b/docs/settings.md new file mode 100644 index 00000000..39fd45cf --- /dev/null +++ b/docs/settings.md @@ -0,0 +1,74 @@ +# Settings + + + + +Settings page is Solana Wallet allow users to tweak settings of the wallet according to their preferences. Below are the current tweaks available in settings page. + + + +## _Privacy and Security_ + + + + + +Privacy and Security tab allow user to view and copy the private key from the wallet. Don't this feature if you are new to blockchain and crypto universe and also try not to use this feature while you are screensharing / screenrecording. + +--------------------------------------------------------------------------------------------------- + + + +## _Network_ + + + + + + + + + +Network tab let user choose the solana network the user wants to connect the wallet to. User can opt between Solana Mainnet, Solana Testnet and Solana Devnet. Same public key is used to interact with all 3 networks. + +Keep in mind that the SOL tokens you receive in Devnet and Testnet are worthless and they cannot be converted into fiat currencies instead they are just for testing purpose. + +--------------------------------------------------------------------------------------------------- + + + + +## _Address Book_ + + + + +Solana Wallet let users store contact information in the wallet and use it at the time of sending transactions. + +--------------------------------------------------------------------------------------------------- + + + +## _Crash Reporting_ + + + + + +Enabling crash reporting will help us improve the performance and reliability of Solana Wallet. You can disable it if you want. + +--------------------------------------------------------------------------------------------------- + + + + +## _Display and Language tabs_ + + + + + + +Users can change language and display settings accordingly to their preference. + +---------------------------------------------------------------------------------------------------