Introduction

Overview of the Admin Panel
The admin panel serves as a centralized platform for managing various aspects of the system. It provides administrators and authorized users with access to powerful tools and functionalities to oversee and control the system's operations. Through the admin panel, users can configure settings, manage user accounts, monitor performance, analyze data, and perform various administrative tasks crucial for the smooth operation of the system.

Purpose of the Documentation
The purpose of this documentation is to provide comprehensive guidance and instructions on the usage, functionality, and administration of the admin panel. It aims to empower users, administrators, and stakeholders with the knowledge and resources necessary to effectively utilize the features of the admin panel. By offering detailed explanations, step-by-step procedures, best practices, and troubleshooting tips, this documentation strives to enhance user understanding, streamline operations, and maximize the value derived from the admin panel.

Target Audience
The primary audience for this documentation includes administrators, system operators, and technical personnel responsible for managing and maintaining the system. Additionally, it caters to users who interact with the admin panel to perform specific tasks or access certain functionalities within the system. This documentation is designed to accommodate users with varying levels of technical expertise, providing both basic instructions for beginners and advanced configurations for experienced administrators. Furthermore, stakeholders and decision-makers involved in the system's governance and strategy may also find this documentation valuable in understanding the capabilities and implications of the admin panel.

Roles and Permissions

In the context of the admin panel, roles define the level of access, permissions, and responsibilities granted to different users within the system. Each role is associated with specific privileges and limitations, ensuring that users can only perform actions relevant to their assigned tasks and responsibilities. Here's an overview of the common roles typically found in the admin panel.

Superadmin Role

The Superadmin role is a privileged position within the admin panel that grants unrestricted access and authority over various critical functions and configurations. Unlike other roles, actions performed by users assigned the Superadmin role do not require approval or the creation of tasks for decision-making.

Capabilities and Responsibilities:

Creation Permissions:

The Superadmin role allows for the creation of various entities within the system, including:

1. Currency creation.

2. Addition of new payment interfaces for currencies.

3. Market creation.

4. Workflow creation.

5. Role and level configuration for the referral program.

6. Implementation of withdrawal restriction levels.

7. Configuration of other essential options.

8. Configuration Management:
   Superadmins have the authority to configure crucial settings within the system, such as:

   • Currencies and their associated parameters.

   • Payment interfaces, including adding new interfaces and modifying existing ones.

   • Market configurations, including rate sources and other settings.

   • Staking conditions.

   • Referral program conditions.

   • Withdrawal restriction levels.

9. User Management:
   Superadmins can make decisions related to user authentication and verification, such as:

   • Verifying user KYC (Know Your Customer) information.

   • Updating employee permissions.

   • Adjusting user withdrawal restriction levels.

10. Transaction Operations:
    The Superadmin role includes the ability to perform operations related to transactions, such as:

    • Reviewing and approving transactions.

    • Modifying transaction parameters or conditions.

    • Updating rate sources for markets.

11. Comprehensive Access:

    • Superadmins have permissions for all available options within the admin panel, granting them comprehensive access to the system's functionalities and configurations.

The Superadmin role is designed to provide maximum flexibility and control to authorized users, allowing them to manage critical aspects of the system without constraints or delays. With the Superadmin role, individuals can efficiently oversee and administer various operations, configurations, and decisions within the admin panel, ensuring the smooth functioning and optimal performance of the system.

Requester Role

Capabilities and Responsibilities:

Edit Permissions:

The Requester role enables employees to create requests for various entities within the system, including:

• Currency creation.

• Addition of new payment interfaces for currencies.

• Market creation.

• Workflow creation.

• Role and level configuration for the referral program.

• Implementation of withdrawal restriction levels.

• Configuration of other essential options.

Configuration Management:

Requesters can create requests to configure crucial settings within the system, such as:

• Currencies and their associated parameters.

• Payment interfaces, including adding new interfaces and modifying existing ones.

• Market configurations, including rate sources and other settings.

• Staking conditions.

• Referral program conditions.

• Withdrawal restriction levels.

User Management:

Employees with the Requester Role can make decisions related to user authentication and verification, including:

• Verifying user KYC (Know Your Customer) information.

• Updating employee permissions.

• Adjusting user withdrawal restriction levels.

Transaction Operations:

The Requester role includes the ability to request to perform operations related to transactions, such as:

• Reviewing and approving transactions.

• Modifying transaction parameters or conditions.

• Updating rate sources for markets.

Upon creation of a request by a Requester, a corresponding task is generated in the Workspace page of the admin panel. Requesters can view the main details of the request and its status following their decision-making process. This integrated workflow ensures transparency, accountability, and streamlined management of system modifications and operations.

Approver Role

Workspace Page for Approvers:

Employees assigned the Approver Role have access to the Workspace page within the Admin panel. This page serves as a centralized hub where Approvers can observe tasks awaiting their attention. The Workspace page provides essential details of each request, including its origin and pertinent information.

Main Features:

1. Task Overview:

   • Approvers can view a list of tasks awaiting their review and decision-making.

   • Each task is accompanied by a summary of its main details, facilitating quick analysis.

2. Request Details:

   • Approvers have access to comprehensive information regarding each request.

   • Key details such as the type of request, associated entities, and any relevant notes are readily available.

3. Request Origin:

   • The Workspace page displays the source of each request, allowing Approvers to identify the requester.

4. Decision Making:

   • Approvers are provided with options to either accept or reject each request.

   • Upon analyzing the request, Approvers can make informed decisions regarding its approval or rejection.

Benefits:

• Efficient Decision-Making: Approvers can swiftly analyze requests and make timely decisions from a centralized location.

• Transparency: The Workspace page provides visibility into the request process, ensuring transparency and accountability.

• Streamlined Workflow: Integration with the request submission process streamlines workflow management, enhancing productivity and effectiveness.

Overall, the Workspace page serves as a crucial tool for Approvers, facilitating efficient task management and decision-making within the Admin panel.

Permissions Matrix

List of Permissions

View Permission: This permission grants the admin access to particular information or functionalities within the system. Admins with view permission can browse through data, reports, or sections of the application, gaining insight into various aspects of the system's operations. However, they do not possess the authority to make any alterations or edits. Instead, their access is limited to viewing and analyzing the existing data or reports. This permission is crucial for admins who need to monitor the system's performance, review analytics, or access specific information without the need to modify it.

1. viewWithdrawalRestrictions

2. viewUserKYC

3. viewMarkets

4. viewAudit

5. viewPaymentInterfaces

6. viewCurrencyPI

7. viewExchangeRates

8. viewCurrencies

9. viewStaking

10. viewUserTracking

11. viewKYCWaiting

12. viewSoftban

13. viewStatistics

14. viewWorkflows

15. viewManualRateSources

16. viewReferralProgram

1. viewWithdrawalRestrictions
   Grants access to view the Withdrawal Restrictions page, allowing administrators to review withdrawal limits, eligibility criteria, and other relevant information without modifying settings.

2. viewKYCWaiting
   Allows access to the KYC Waiting sub-menu on the Users page for administrators to review pending Know Your Customer (KYC) verifications without the ability to alter or approve submissions.

3. viewAudit
   Enables access to the Audit Logs sub-menu located within the Security page, allowing administrators to review system activity logs for monitoring purposes, without the capability to modify or delete audit entries.

4. viewEmployees
   Grants access to the employees sub-menu located within the Security page, enabling administrators to review employee accounts, and roles without the ability to modify or create/delete employee information.

5. viewReferralProgram
   Grants access to the referral program page, allowing administrators to review details, statistics, and settings related to the referral program without the ability to modify or alter its configurations.

6. viewStaking
   Grants access to the staking page, enabling administrators to review information, statistics, and settings related to staking activities without the ability to modify or alter staking configurations.

7. viewSoftban
   Allows access to the Softban sub-menu located within the Security page, enabling administrators to review and manage Softban settings and configurations without the ability to modify or delete them.

8. viewUserGeneral
   Grants access to the user general submenu within individual user details on the Users page, enabling administrators to review general information and settings associated with Main info of User Email, Status, Enabled 2FA, Soft ban, Withdrawal Restriction Level, Email verification, Phone verification, and Profile verification. Overall, this permission provides administrators with the necessary access to review crucial user information and settings, ensuring compliance, security, and effective account management within the system.

9. viewMarkets
   Grants access to the markets sub-menu within the Configurations page, enabling administrators to review market-related settings, such as swap and trading settings, without the ability to modify or alter them.

10. viewStatistics ?

11. viewUserTracking
    Grants access to the tracking submenu within individual user details on the Users page, allowing administrators to review tracking information and activity associated with user accounts, without the ability to modify or alter this data.

12. viewUserAccounting
    Grants access to view the main details of users for Balances (including accounting details), Wallets, External Wallets, and Recipients submenus on the Users page. This enables administrators to review financial transactions and accounting information associated with user accounts without the ability to modify or alter this data. Additionally, it allows access to view User's Generated proxy wallets, User's connected External wallets, and User's recipients that were created during withdrawal.

13. viewBlockchains
    Grants access to the blockchains sub-menu within the Configurations page, allowing administrators to review and manage settings related to blockchain integration, configurations, or network parameters without the ability to modify or alter them.

14. viewWorkflows
    Grants access to the workflows sub-menu within the Configurations page, enabling administrators to review workflow settings, including approval processes and task assignments, without the ability to modify or alter them.

15. viewSystemHealth
    Grants access to the System Health sub-menu within the Dashboard page, allowing administrators to monitor and review the overall health and performance metrics of the system without the ability to modify or alter these settings.

16. viewExchangeRates
    Grants access to the Exchange rates sub-menu within the Configurations page, enabling administrators to review settings related to market exchange rates without the ability to modify or alter them.

17. viewCurrencies
    Grants access to the currencies sub-menu within the Configurations page, enabling administrators to review settings related to currencies, such as currency types, currency precision, or currencies payment interface, without the ability to modify or alter them.

18. viewUserKYC
    Grants access to the KYC (Know Your Customer) sub-menu within individual user details on the Users page, enabling administrators to review KYC information and verification statuses associated with specific user accounts without the ability to modify or alter them.

19. viewPermissions
    Grants access to the Permissions sub-menu within the Security page, allowing administrators to review user permissions, roles, and access levels without the ability to modify or alter them.

20. viewManualRateSources
    Grants access to the manual rate source sub-menu within the Configuration page, allowing administrators to review settings related to manual rate sources for the market without the ability to modify or alter them.

21. viewRoles
    Grants access to the Roles sub-menu within the Security page, allowing administrators to review user roles and permissions without the ability to modify or alter them.

22. viewOperations
    Grants access to view the operations page, allowing administrators to monitor and review operational activities and processes within the system without the ability to modify or alter them.

23. viewPaymentInterfaces
    Grants access to the Payment interfaces sub-menu within the Configurations page, enabling administrators to review settings related to payment methods, gateways, or interfaces without the ability to modify or alter them.

Edit/Create Permission: With edit permission, the admin gains the ability to modify and update existing data or settings within the system. This includes making changes to user information and adjusting configurations to better suit the organization's needs. Additionally, in scenarios involving workflow settings, admins with edit permission can initiate changes directly. Moreover, if necessary, they can request approval for proposed alterations from another administrator, ensuring proper oversight and governance over system modifications. This permission empowers admins to actively manage and customize the system according to evolving requirements and preferences.

1. editPaymentInterface
   Grants the ability to modify and customize settings associated with payment interfaces

2. editEmployee
   Grants the ability to modify and update information related to an employee, such as their roles, permissions, or employment status.

3. editWithdrawalRestriction
   Grants the ability to modify existing withdrawal restriction levels or create new ones. This includes adjusting withdrawal limits, eligibility criteria, or any other parameters governing withdrawal transactions.

4. editUserKYC
   Grants the ability to modify the KYC (Know Your Customer) status of a user. This includes updating the verification status or marking the user as verified or unverified based on the provided documentation and information.

5. editManualRate
   Grants the ability to modify the manual rate source for a specific market or create a new manual rate source for an existing market. This includes updating the exchange rates manually or adding new rate sources for the specified market.

6. setSoftBan
   Grants the ability to impose a soft ban on either a specific user or on all users. This includes restricting access or certain functionalities for the designated user(s), typically as a temporary measure, without permanently suspending their account(s).

7. reset2FA
   Grants the ability to turn off or disable the enabled two-factor authentication (2FA) for a specific user. This action removes the requirement for the user to provide additional authentication beyond their password when logging into their account or to confirm withdrawal operation.

8. editStaking ?
   

9. editMarket
   Grants the ability to modify existing market settings or create a new market. This includes adjusting parameters such as fees, minimum amounts for operations, or any other settings relevant to the operation of the market.

10. editCurrency
    Grants the ability to modify existing currency settings or payment interfaces associated with currencies, or to create entirely new currency settings or payment interfaces. This includes adjusting parameters such as currency types, precision, deposit and withdrawal settings, or Staking configuration.

11. editRole
    Grants the ability to modify existing roles or create new ones within the system. This includes defining role permissions, access levels, and privileges for different user groups, and ensuring appropriate access and security measures are in place.

12. editWorkflow
    Grants the ability to modify existing workflows or create entirely new workflow configurations within the system. This includes defining workflow steps, approval processes, task assignments, and automation rules to streamline business operations and improve efficiency.

13. manageTasks ?

14. editBlockchain
    Grants the ability to modify existing blockchain configurations within the system. This includes adjusting parameters such as network settings, consensus mechanisms, or block validation rules to accommodate changes in blockchain technology or network requirements.

15. editUserStatus
    Grants the ability to modify the status of a user account, either banning or unbanning the user. This action restricts or restores the user's ability to access the system and perform activities based on their account status.

16. editUserWithdrawalRestriction
    Grants the ability to adjust the withdrawal restriction level for a verified user, either increasing or decreasing it. This action modifies the withdrawal limits, eligibility criteria, or processing times for the user's withdrawal transactions based on their verified status.

Request Operation Permission: These permissions grant administrators the ability to perform operational tasks within the system. This may include managing user balance through deposit and withdrawal operations, managing operations, and performing other administrative duties necessary for the smooth operation of the system.

1. resolveOperationError
   This permission allows administrators to manage operations that encounter errors. Administrators can choose to retry collection for deposit operations, retry or reject withdrawal operations, and retry exchange operations to ensure smooth processing and resolve any issues that may arise.

2. useWorkspace ?

3. cancelOrder
   This permission enables administrators to cancel open orders placed by users within the system. It allows administrators to intervene in trading activities and manage order books effectively, ensuring the integrity and stability of the trading platform.

4. requestWithdrawal
   This permission allows the Admin to request the transfer of funds from the User`s wallet balance to an internal account of the system.

5. requestDeposit
   This permission allows the Admin to request deposit operations, initiating the transfer of funds from an internal system account to the User`s wallet balance.

Approval Permission: grants users the authority to approve or reject requests, transactions, or configurations from other Employees. It enables Admin to review and take action on pending requests, ensuring compliance with established procedures and maintaining operational integrity.

1. acceptWithdraw
   This permission allows administrators to approve withdrawal requests submitted by other Employees, initiating the transfer of funds from the user's account to the specified destination.

2. acceptCurrency
   This permission grants employees the authority to review and approve requests from their peers to modify existing currency settings or payment interfaces or to create new ones. It ensures that changes to currency-related configurations are properly vetted and authorized before implementation.

3. acceptSoftBan
   This permission allows employees to review and approve requests from their peers to modify the softban status for specific users or all users in the system. It ensures that changes to softban statuses are properly reviewed and authorized before being applied to user accounts.

4. acceptMarket
   This permission grants employees the authority to review and approve requests from their peers to modify existing market settings or create entirely new markets. It ensures that changes to market-related configurations are properly vetted and authorized before implementation.

5. acceptReset2FA
   This permission allows employees to review and approve requests from their peers to reset the two-factor authentication (2FA) verification for a user. It ensures that such requests are properly reviewed and authorized before the user's 2FA settings are reset.

6. acceptDeposit
   This permission enables employees to review and approve requests from their peers to initiate deposit operations for users, facilitating the transfer of funds from an internal system account to the user's wallet balance. It ensures that such requests are properly vetted and authorized before funds are transferred.

7. Roles Assigned to Each Permission

Workflow Overview

1. Description of Workflow Process

2. Roles Involved in Workflow

3. Workflow Diagram

Creation Process

1. Steps for Requester

   • Initiating a Creation Request

   • Providing Necessary Information

2. Steps for Approver

   • Reviewing the Request

   • Approving or Rejecting the Request

Update Configurations

1. Steps for Requester

   • Initiating an Update Request

   • Providing Details of Configuration Changes

2. Steps for Approver

   • Reviewing the Update Request

   • Approving or Rejecting the Changes

Operations Approval

1. Steps for Requester

   • Requesting Approval for Operations

   • Providing Context and Details

2. Steps for Approver

   • Reviewing the Operation Request

   • Approving or Rejecting the Operation

Best Practices

1. Tips for Effective Request Submission

2. Guidelines for Approvers

Troubleshooting

1. Common Issues and Solutions

2. Error Messages and Their Meanings

Glossary

1. Definitions of Key Terms Used in the Documentation

Appendix

1. Additional Resources

2. Contact Information for Support