NEX-FS12 ETH-SONs Deposit/Withdraw Functionality
The functional requirement for Peerplays NEX application to explain the ETH deposit/withdraw functionality.
1. Purpose
The purpose of this functional specification (FS) document is to detail functional requirements for the Peerplays NEX application (the “app”) relating to the inclusion of ETH as one of the asset in the existing NEX deposit/withdraw functionality in the Dashboard page. The document explains the functionality from a business and user perspective.
2. Document Tracking
2.1 Parent Document
This document is a child document of NEX Dashboard page (NEX-FS01).
2.2 Categorization
This document relates to the following tags,
App component
process
page
3. Scope
This FS will describe the requirements and basic design for the app’s ETH withdraw/deposit design and functions.
3.1 Components
Specific components and features covered in this FS include:
Dashboard ETH Deposit function
Dashboard ETH Withdraw function
4. Document Conventions
For the purpose of traceability, the following code(s) will be used in this functional specification:
The keyword shall indicates a requirement statement.
The keywords may, could, and should are not requirements but rather indicate items related to requirements that are worthy of consideration.
5. Process Overview
The following process will be described here as follows,
ETH Deposit
ETH Withdraw
In this process overview, the example is considered as the authenticated user using the application and has an appropriate balance in wallet to perform the transactions.
5.1 ETH Deposit
The user navigates to the Dashboard page's Deposit tab to begin the deposit function.
The select asset option has a drop-down list to select the desired asset.
The user selects ETH from the list of asset available for deposit.
The page loads instruction for initiating a ETH deposit to the user's app account.
In this case, Metamask can be used as an external application to perform the ETH deposit.
User should login the Metamask wallet, from where the ETH asset should be transferred to the user app's wallet.
When the user returns to the app, message will be notified after the successful ETH deposit into the account
Other methods to deposit ETH into the wallet are described below,
5.2 ETH Withdraw
The user navigates to the dashboard page’s Withdraw tab to begin the withdraw function.
The select asset option has a drop-down list to select the desired asset.
The user shall selects ETH asset from a list of assets available for withdraw.
The page loads the instruction for initiating a ETH withdraw from use app's account.
The user reviews the ETH balance in their wallet and enter the required amount of ETH to withdraw.
The user should enter a valid son-account address to which they wish to receive the ETH asset.
The app should check the account name and ensure its validity.
The user should review the withdraw information and click to confirm the withdraw.
The app processes and submit the withdraw request to son-account.
A notification message shall be displayed to indicate the successful ETH withdraw.
The app page will load to reflect the new available balance and any other changes after the withdraw.
The command line to withdraw ETH is explained below,
6. Context
The existing dashboard page holds many of the most used functions of the app to facilitate ease of use and it can be used as the home page. This document include the functionality for ETH deposit and withdraw along with the existing assets in dashboard page.
7. Design Wire-frames
The wire-frame design explain the representation of deposit and withdraw of existing assets.
Deposit Asset: https://xd.adobe.com/view/84e727ac-fe5c-4c6b-9dd2-d668cec13fc9-d1b4/
Withdraw Asset: https://xd.adobe.com/view/84e727ac-fe5c-4c6b-9dd2-d668cec13fc9-d1b4/screen/e0b637fc-73ee-4b45-80b4-03bace4df74f/
The same design can be used to represent ETH deposit/withdraw into the dashboard.
The overall dashboard designs are available in the below location, https://xd.adobe.com/view/84e727ac-fe5c-4c6b-9dd2-d668cec13fc9-d1b4/
8. Requirements
The requirement specific to ETH deposit and withdraw are explained below,
The Dashboard page layout, Asset Deposit function, Asset withdraw function, Asset swap function are the modules in the Dashboard. Click on each topic to learn in details about its requirement.
8.1 ETH Deposit
If ETH asset is selected in the asset deposit function,
NEX-FS12-01: shall display the ETH icon in the deposit instructions.
NEX-FS12-02: shall display steps to deposit asset into wallet.
NEX-FS12-03: Shall display the button "Connect Metamask", which on-click directs to MetaMask wallet. From the wallet, ETH asset can be transferred to the User app's wallet. (Only After successful MetaMask connection)
8.2 MetaMask Connection
To perform the ETH deposit, Metamask connection is required.
NEX-FS12-04: shall provide a button named "Connect MetaMask" with arrow which directs to MetaMask wallet to establish connection.
NEX-FS12-05: shall provide an option to input credentials to login into MetaMask wallet.
NEX-FS12-06: shall display check mark in the button when MetaMask is connected and
NEX-FS12-07: shall gray out the button after connection establishment.
The Peerplays user account's son information will be updated with the new Ethereum account information
NEX-FS12-08: shall provide a link at the bottom of the card which helps to download MetaMask.
8.3 ETH Withdraw
If ETH asset is selected in the asset withdraw function,
NEX-FS12-09: shall display the ETH icon in the withdraw function with available asset for withdraw.
NEX-FS12-10: shall provide an option to input "withdraw address" to login into Peerplays account
NEX-FS12-11: shall provide an option to input son-account address in case of ETH asset selection.
NEX-FS12-12: shall provide the details about estimated Fees, Total transaction, confirmation time, etc., based on the amount of ETH asset chosen for withdraw.
NEX-FS12-13: shall provide a button to withdraw ETH after successful validation of account address.
9. Appendix A: Glossary
Last updated