Admin Panel Manual

Owned by Denys Tun
Last updated: Nov 12, 2024 by Denys Tun
44 min read

Marionette Admin Panel is a web-based Administrative interface used to by the operator to manage various aspects of Marionette.dev powered Financial Service Businesses. This Admin Panel Guide is written to share the full scope of supported functionality and assist the business operator in day to day tasks and management of the platform. Contents of this guide cover user management, configuring settings for currencies, payment interfaces, markets, performance analytics, content editing and a lot more. In this guide you will also find tips and best practices for making the most of the Admin Panel functionality.

1. Authorization Page

 

1.1 Admin Login

Admin can log into account using authorized email and password. If 2FA has been enabled for the admin account, the Admin can input security code from Google Authenticator to confirm login.


1.2 Admin Password Reset

Admin can reset the password by having password reset instructions emailed to their authorized email address

1.3 Sign in with Google
Admin can register with his Google account

2. Admin Panel Layout & Navigation

2.1 Navigation Bar (Navbar)

The Navigation Bar is visible to the admin from every page while navigating the admin panel. Selected Section of the Admin Panel in Navbar is underlined and highlighted. Each Section has a sub-section and all are further detailed in this document. The following sections of the admin panel are visible as tabs and available for navigation for the Admin:

2.2 Pagination

Pagination is available for content rich pages where data cannot be displayed on a single page to simplify navigation across data for the Admin.

  • "Page Number" navigate to desired page

  • "Right Arrow" 'forward' button to go to the next page

  • "Left Arrow" 'back' button to go to the previous page

  • "Drop Down" select amount of data to display on the page

  • Input number of the page in field 'Go to ... page' and press "Enter" to go to required page


3. Dashboard (section)

Dashboard section of the Admin Panel offers visual review of currencies and markets supported on the platform.

3.1 Liabilities and Assets (sub-section)

Rated liabilities and assets: In depth overview of financial data of the asset selected in ‘dropdown’ menu. Analyze ‘current liabilities’, ‘assets’ and ‘profit’ of the asset on the platform as recorded in platform accounting records.

Unrated liabilities and assets: Brief overview of currencies not selected in the ‘dropdown’ menu of ‘Rated liabilities and assets’


3.2 Trading (sub-section)

Navigating to the Trading section in Dashboard, the Admin can review chart, order book and recent trades for the market selected in the market selector dropdown. Admin has at their disposal all the charting tools made available by TradingView.

4. Users (section)

User section of the Admin Panel allows the admin to review user information, status and verification. Users section is composed from the following sub-sections:

  • Users Directory

  • KYC Waiting

  • Countries

4.1 Users Directory (sub-section)

Admin can see a summary of Users in list view with filters as pictured and further described. This page refreshes every 60 seconds.

  • Email: column with search feature built into filter for searching for user profile by email address

     

  • Sessions: column shows the number of login sessions performed by the user

  • Role: column with filter and definition of user role with two roles currently supported - Admin or User
    (role ‘member’ in case User signed up to the system with Google Account)

  • State: column with filter and definition of user state on the platform with 3 states currently supported- Active or Pending or Banned

  • Created: column with account creation timestamp and option to creation time range as a filter

  • User (…) Details: column to review individual user details in expanded view

  • Reload (button): reload page

4.1.1 User (…) Details

User (…) Details section has 5 tabs with User information the Admin can see and interact with: Main Info, KYC, Balance, Wallets, External Wallets and Recipients. Each is described below, starting with:

Main Info (tab): tab section with general user overview and the following admin capabilities:

 

  • Email: displays user email address

  • Role: displays user role and offers the ability to edit user role between supported roles

  • State: displays current user state and offers the ability to edit state between supported states

  • Email Verified: current status with toggle enable or disable verification status for user email

  • Phone Verified: current status with toggle enable or disable verification status for user email

  • Profile Verified: current status with toggle enable or disable verification status for user profile

  • Enabled 2FA: current status with toggle enable or disable verification status for user 2FA. This field can be utilized by admin to help end user reset their 2FA after loss of device, etc.

KYC (tab): tab section with User KYC details and see the following admin capabilities:

 

  • State: displays user status as Not Verified / Pending / Verified

  • First Name: see first name

  • Last Name: see last name

  • Date of Birth: see date of birth

  • Address: see street address

  • City: see city

  • Country: see country

  • Postcode: see postal code

  • Document Review: documents uploaded by the user are listed on the right section of KYC tab with corresponding names. Admin has the ability to open each in dropdown, click on the document to zoom in on various parts of the document and rotate the document

Balance (tab): admin can see the list of currencies generated for the user, their balances, expanded details and perform described actions.

 

  • Currency: displays the listed name of the currency

  • Balance: displays currency balance in user’s primary wallet (account 201)

  • Trading Balance: displays currency balance in user’s wallet dedicated to order book trading (account 202)

  • Trading Locked Balance: displays currency balance locked in trading as open orders (account 203)

  • Locked Balance: displays currency balance pending settlement on ‘Balance’ (account 204)
    Locked Balance (account 204) displays balance for assets that User required to withdraw. Withdrawal operations should be reviewed by Admin to approve User request.

  • Withdraw Locked Balance: Locked Balance (account 230) displays balance for assets that have “Liabilities in transfer” status. Withdrawal operations should be reviewed by Admin.


Optional Balance Version:
Separated Primary & Trading Wallets + Balance Transfer functionality

Balance (tab): admin can see the list of currencies generated for the user, their balances, expanded details and perform described actions.

 

  • Currency: displays the listed name of the currency

  • Balance: displays currency balance in user’s primary wallet (account 201)

  • Transfer: admin has the ability to shift balances on behalf of the user between ‘Balance’ (primary wallet) and ‘Trading Balance’ (order book trading wallet) by pressing '<-' or ‘->’ arrows in the column

  • Trading Balance: displays currency balance in user’s wallet dedicated to order book trading (account 202)

  • Trading Locked Balance: displays currency balance locked in trading as open orders (account 203)

  • Locked Balance: displays currency balance pending settlement on ‘Balance’ (account 204)
    Locked Balance (account 204) displays balance for assets that User required to withdraw. Withdrawal operations should be reviewed by Admin to approve User request.

  • Withdraw Locked Balance: Locked Balance (account 230) displays balance for assets that have “Liabilities in transfer” status. Withdrawal operations should be reviewed by Admin.

Balance (…) Details: admin has the ability to review user currencies and each balance type in the corresponding section by clicking on the (…) and see additional information:

  • Created: displays timestamp of transaction

  • Debit: displays if the transaction was a debit

  • Credit: displays if the transaction was a credit

  • Description

  • Link to operation as “Details” button

  • ‘Reload history’ button

  • + Create Deposit (button): opens a modal window and allows the admin to create a manual deposit for the user by performing a manual adjustment to the user’s account for the selected currency. This off-chain balance adjustment can be applied to user balance for any currency that has ‘Manual Admin Payment Interface’ enabled in settings.

  • Currency: allows you to select the currency from dropdown menu

  • Amount: allows you to set the amount to credit the user

  • Document ID: optional field to reference another document or support request resulting in crediting the user balance

 

- Create Withdrawal: button allows the admin to create a manual withdrawal for the user by opening a modal window and performing a manual adjustment for selected currency. This off-chain balance adjustment can be applied to user balance for any currency that has ‘Manual Admin Payment Interface’ enabled in settings.
*Admin should make configuration for 'Currency' and enable ‘Manual Admin Payment Interface’ for the withdrawal amount to be in line with their business goals and limitations for the end user:

  • Minimum Withdraw Amount

  • Maximum Withdraw Amount

  • Maximum Withdraw Amount (24h)

  • Maximum Withdraw Amount (72h)

After successful withdrawal operation through ‘Manual Admin Payment Interface’, the system creates a ‘Recipient ID’ for currency Payment Interface and option to create ‘New Withdrawal’ in ‘Recipients’ tab, further described below.

  • + Create Withdrawal (button): opens a modal window to enter manual withdrawal instructions

  • Currency: dropdown menu with supported currencies

  • Amount: set withdrawal amount

Wallets (tab): the wallet tab, in individual user section, allows the admin to see user wallet addresses, review in-depth information relevant to this user and perform the below described actions. The addresses for these currencies and payment interfaces are generated by the platform at the time when user initiates a deposit in that particular currency and payment interface.

 

  • Currency: displays currency name, logo and ability to sort

  • Payment Interface: displays the payment interface assigned to the currency and ability to sort

  • Address: displays wallet address and links to blockchain explorer

  • Type: displays the wallet address for corresponding currency and payment interface

External Wallets (tab): allows the admin to see user external wallet addresses, review in-depth information relevant to this user and perform the below described actions. The addresses for these currencies and payment interfaces are recognized by the platform at the time when user initiates a direct deposit through WalletConnect service.

 

Recipients (tab): Recipients are withdrawal addresses associated with the user profile directly linked to the currency and payment interface. These addresses are saved by the system for user convenience and admin review of activity.

 

  • Recipient ID: displays the Recipient ID created by the system for addresses submitted by end user for withdrawal

  • Currency: displays the currency ticker associated with Recipient ID and ability to filter

  • Payment Interface: displays the payment interface associated with the Recipient ID and ability to filter

  • Info: with addresses on the blockchain or ID for Manual Admin PI

  • Option to open the modal window to create a withdrawal in system ledger records (off-chain) for Manual Admin Payment Interface is available to make manual adjustments.

4.2 KYC Waiting (sub-section)

KYC Waiting sub-section allows the admin to review KYC information and documents submitted by the User that are pending admin verification. First 2 levels, phone and email verification, are automated. Personal identifying information must be uploaded by the User and review process is manual by the Admin.

Note: KYC process can be customized and automated with the user of a 3rd party KYC service.

  • "+" (button): expands user information and allows the admin to see user First Name, Last Name, Date of Birth, Address, City, Country, Postcode and submitted Document(s)

  • ID: user ID assigned to the registered user

  • Email: email address of the registered user

  • Accept (button): accept submitted document

  • Reject (button): reject submitted document

  • Ban: ban the user and document they submitted for identity verification

  • Document Name: pressing the Document Name defined by User at the time of document upload opens the document and allows the admin to click, rotate and zoom on different parts of the document

4.3 Countries (sub-section)

Admin can enable country restrictions for users registering on the platform by adding country to the list and enabling or disabling registration by users from the defined country.

  • ID: country ticker

  • Name: country name

  • Enabled: toggle switch ‘Enabled’ to enable to allow registration and disable to restrict

  • + New Country: opens modal window to add new country where restrictions will be applied

5. Operations (section)

Operations section displays all operations performed on the platform like trading, swapping, market orders, deposits, withdrawals. This section consists of data for multiple sub-sections related to transactions that have impact on platform and user balances.

5.1 Operations Sub-section (left column)

Operations sub-section lists individual transaction related data where the admin can see data in real time and sort this data to preference.

  • Type: label of operation type. Labels:
    - deposit (off-chain)
    - deposit (on-chain)
    - withdrawal
    - exchange
    - move to advanced
    - move from advanced
    - other labels may be added based on the supported accounting functionality

  • Date: timestamp of operation with filter

  • search feature built into filter for searching for user profile by email address

  • User: email address of registered user with user status light
    - green: verified user with completed KYC
    - gray: unverified user
    - (…) Details: review the user and their details

  • Status: displays operation status label. Labels:
    - success
    - payout_success
    - exchange_success
    - move_to_advanced_success
    - move_from_advanced_success
    - rejected
    - canceled
    - exchange_canceled
    - check_withdraw_payout_amount
    - withdraw_pending_approval
    - payout
    - exchange
    - incoming_payment
    - collection_prep
    - collection
    - deferred_income
    - check_withdraw_payout_amount_error
    - payout_error
    - approve_withdraw_error
    - incoming_payment_error
    - exchange_error
    - collection_prep_error
    - collection_error
    - deferred_income_error
    - other statuses may be added based on newly added accounting functionality

  • Search field: search deposit or withdrawal operations by transaction ID

  • (…) Details: details associated with the operation described in ‘5.1.1 Operation (…) Details’

  • Reload (button): reload page or page will auto-reload every 60 seconds

5.1.1 Operation (…) Details

Operation (…) Details shows the operator expanded details for every operation and access additional features related to operations for every operations selected.

 

  • Type: operation type and label (5.1 Operations sub-section left column)

  • Status: operation status label

  • Parent Operation (if applicable): applicable to some transactions

  • Amount: displays operation type label and the amount

  • User: email of registered user

  • Date: timestamp of operation creation and timestamp(s) of update(s) relevant to the operation

  • Transactions: links to blockchain explorer for applicable transactions details, or additional order details for order book transactions like Limit and Market order types

  • Description: description manually entered by admin, typically related to manual adjustments

  • Ledger Records (sub section below): displays detailed accounting data for the operations entered in system ledger records

     

  • Account: accounting ledger responsible for tracking the associated portion of the operation

  • Debit: relevant to accounting ledger record with amount and currency ticker

  • Credit: relevant to accounting ledger record with amount and currency ticker

  • Counterparty: email of user or payment interface or currency on the other side of the operation

  • Description: label of accounting ledger record with filter

  • Created: timestamp of accounting ledger record

  • Operation: field for special information for the operation

    *When the operation is for limit or market order type, there is a clickable link to open and review the order details.
    ** When fee amount is lower than currency amount as defined in currency precision configuration, the amount in ledger records will be displayed as ' - - '

5.1.2 Accounting for Ledger Records in Operation Details

Admin can review accounts which are using in Ledger Records.

Liabilities (200’s):

200

Transferable liabilities (on-chain swap)

201

Long Term liabilities

202

Advanced trading liabilities active

203

Advanced trading liabilities locked

204

Deferred liabilities

210

Donate Project liabilities

230

Liabilities in transfer

Assets (100’s):

101

Deferred income

120

User Assets

130

Funds En Route

110

Hot System Assets

Profit (600's):

600

On-chain Swap profit

601

Off-chain Swap profit

602

Swap-in profit

603

Withdraw profit

604

Custodial deposit profit

605

Trading profit

Expenses (400’s):

400

On-chain Swap expenses

401

Off-chain Swap expenses

402

Swap-in Swap expenses

403

Withdraw expenses

404

Custodial deposit expenses

405

Donation expenses

410

Donation Bonus expenses

420

One Time Reward expenses

5.2 Pending Withdrawals

Admin can view Pending Withdrawals and see the list of pending withdrawals and their details. Some withdrawal operations may require manual approval if outside of Payment Interface and/or Currency setting defined by the Admin.

  • Type: defined the type of withdrawal

  • Timestamp: time of withdrawal creation and the latest update(s)

  • Amount: currency ticker with withdrawal amount and net withdrawal amount

  • User: email address of registered user initiating withdrawal

  • Status: withdrawal status

  • '+' Details (button): review the details of each operation

  • Reload (button): reload page or page will auto-reload every 60 seconds

5.2.1. Pending Withdrawal(s) Details

Admin can access Withdrawals Details to see additional information on withdrawal transaction.

 

  • Type: type of operation

  • Parent Operation: with option to visit it the operation (if applicable)

  • Status: status of operation with options to ‘Approve’ or ‘Reject’ the withdrawal

  • Amount: currency and ticker

  • User: email address of registered user

  • Details (button): see additional details of registered user

  • Timestamp: time of withdrawal creation and the latest update(s)

  • Transactions: links to blockchain explorer and expanded transaction details

  • Description with details of conditions for review (Example: 24 hours withdrawal limit)

Ledger Records (sub-section): allows the admin to view ledger records for associated withdrawal operation:

  • Account: ledger record account and filter

  • Debit: amount debited to ledger account record with currency and ticker

  • Credit: amount credited to ledger account record with currency and ticker

  • Counterparty: the other side of transaction with registered user email and/or Payment Interface

  • Description: description of transaction with filter to browse by ledger record type

  • Timestamp: timestamp of ledger record creation

  • Operation: field for additional information for the ledger record

5.2.2. Admin Action for Withdrawal Operation with "Payout Error" status:

 

  • Try again (button): restart withdrawal operation

  • Reject (button): and Discard User's withdrawal operation. Operation transfer to the list of all Operations with status "Rejected"

5.2.3. Admin Action for Withdrawal Operation with "Withdraw Pending Approval" status:

  • Approve (button): manually approve withdrawal operation

  • Reject (button): reject use initiated withdrawal operation

5.3. Exchange Rates

See the list of rates used by the platform as the rate sources for On-Chain and Off-Chain exchange and swap operations, per settings in the Markets section

In case there are 2 or more Rate Sources for the market, the average will be calculated.

5.4. Orders

Orders allow the Admin to review the full history of orders that took place on the Order Book and ability to interact with features related to this type of operations.

  • Date: timestamp of order creation and filter by date

  • Market: currencies involved in trade displayed as currency tickers with (…) Details (button) to visit ‘Market Settings’ and filter by ‘Market ID’

  • Amount: displays the amount and ‘Base Currency’ of the order, along with currency ticker and order fulfillment progress circle.
    *Fully executed order(s) is marked by 'green' completed circle

  • Executed Volume: displays the other side of the trade as amount fulfilled and ‘Quote Currency’ ticker

  • User: email address of user behind Base Currency side of the order

  • Type: lists the order type and filter by order type

  • Side: side of the order, relevant to Market setting and filter by side

  • Status: of the order with option to filter by status

  • (…) Details (button): opens order details

  • Reload (button): reload page or page will auto-reload every 60 seconds

5.4.1. Order Details

Admin can access Order Details and see available data and options:

  • Status: of the Order

  • Cancel Order (button): cancels open order

  • Market: displays both sides of the market with currency tickers and market (…) details

  • Type: of the Order

  • Side:

  • Date: The timestamp of creation and the latest update

  • Amount: filled with Base Currency ID and filling progress bar of order in percent. Fully executed order is marked by 'done' checkbox

  • Executed Volume: with amount and ID of the Quote Currency

  • Price: in Quote Currency

  • Average Executed Price: (actually utilized during trades)

  • Seller or Buyer: email address of creator with the option to go to his account page

  • Operation: (…) Details (button) opens order details

     

  • Trades: trades amount per order. With the list of their details:

a) Trades: with the timestamp of creation

b) Market: with Market ID

c) Price: in Quote Currency, with Currency ID

d) Amount: in Base Currency, with Currency ID

e) Maker fee: with amount and Currency ID

f) Taker fee: with amount and Currency ID

g) Maker Order Side: Buy or Sell

h) Seller or Buyer: matched order with counterparty email address and (…) Details (button) opens order details

i) Sell Order or Buy Order: matched order price with currency ID, and (…) Details (button) opens order details

5.5. Trades

Admin can access Trade History List and review the trades performed on advanced trading side with the following details:

  • Date: the timestamp of execution: with option to filter by date

  • Market: with Currencies IDs and option to visit Market settings and option to filter by market ID

  • Amount: in Base Currency, with Currency ID

  • Price: in Quote Currency, with Currency ID

  • Volume: in Quote Currency

  • Maker Fee: with amount and Currency ID

  • Taker fee: with amount and Currency ID

  • Maker Order Side: Buy or Sell

  • Seller: email address and option go to Seller's Account by pressing "Details" button and with option to filter by email

  • Buyer: email address and option go to Buyer's Account by pressing "Details" button and with option to filter by email

  • Sell Order: (…) Details (button) opens sell order details

  • Buy Order: (…) Details (button) opens buy order details

  • Reload (button): reload page or page will auto-reload every 60 seconds

6. Configuration

6.1. Blockchains Settings

Admin can see the list of the blockchains connected to system with the following details by columns:

  • ID: blockchain ID

  • Name: full name for blockchain

  • Height: parameter with the details about:

    a) Current block on the blockchain (from the left)

    b) Current block analyzed by system (from the right)

    c) The difference between current block on the blockchain and block analyzed by system (in the middle)

  • Chain ID: with a number

  • Created: with he timestamp of blockchain creation

  • Updated: with the timestamp of the latest update of the blockchain configurations

  • Status: status of the blockchain, and options to enable or disable it using toggle switch

  • (…) Details (button): opens blockchain details

 

  • Reload (button): reload page or page will auto-reload every 60 seconds

6.1.1. Blockchain Details

Pressing (…) Details (button) opens blockchain details where the admin can see additional information related to the blockchain.

 

  • Name: with light indicator if it's enabled (green) or disabled (red)

  • Height: parameter with the details about:

    a) Current block on the blockchain (from the left)

    b) Current block analyzed by system (from the right)

    c) The difference between current block on the blockchain and block analyzed by system (in the middle)
    d) Reset (button): with an opportunity to reset height to actualize the crypto node height (See part 6.1.2 of the Admin Panel Manual)

  • Chain ID: with a number

  • Explorer: links for addresses and transaction IDs

  • Connected blockchains: with option to change or update connection (See part 6.1.3 of the Admin Panel Manual)
    a) Change (button): with an opportunity to connect blockchain
    b) Connect (button): with option to make edits for connected blockchain

  • Minimum confirmations: amount of minimum confirmations

  • Wallet: link to explorer - main system wallet that ties together generated deposit addresses for the users, collects funds from generated deposit addresses for the users and pays the blockchain transaction fees (Fee wallet), keeps the funds (Hot wallet)

  • Currencies: currencies added for the blockchain and their Names and IDs with an option to visit the extended currency details by pressing (…) Details (button) opens order details

  • Reload (button): reload page

In case the Minimum amount of confirmations or Explorer settings should be changed, or new blockchain should be added, Admin should contact the DevOps, as it’s a deeper level of configuration

6.1.2 How to reset height to actualize the crypto node height:

  1. Identify the required block number you prefer to re-read the blocks from (for example, 10-20 blocks before the transaction or the last read block)

  2. Press “Reset” button and insert the required block number

 

3. Overview the reflection of reading the blocks - the difference between the blockchain and in the system should decrease. ‘Reload’ button can be used to see the most recent data

 

6.1.3 How to connect blockchains reading data from different sources:
1. Press “Change” button
2. Select blockchain to connect from the drop-down list
3. Press “Update” button to confirm changes

How to make edits for connected blockchain:

  1. Press “Connect” button

  2. Select blockchain to connect from the drop-down list

  3. Press “Update” button to confirm changes

6.2. Payment Interfaces Settings

Admin can see the list of Payment Interfaces configured for the currencies with the following details:

  • Logo and ID

  • Title: with the Payment Interface full name

  • MultiCurrency: with the 'Yes/No' Status

  • Invoice Based: with the 'Yes/No' Status

  • Collectable: with the 'Yes/No' Status

  • Blockchain: with the 'Yes/No' Status

  • Description: with details of conditions for review

  • (…) Details (button): opens additional information on Payment Interface

  • Reload (button): reload page

6.2.1. Payment Interface Details

Admin can access Payment Interface (…) Details (button) opens additional information on the Payment Interface and see data and available options:

  • ID: Payment Interface ID

  • Title: with the Payment Interface Full Name

  • Subtitle: with the subtitle for Payment Interface

  • Logo: with option to replace logo file by pressing "Upload" button/logo

  • Description: with details of conditions for review

  • MultiCurrency: with the 'Yes/No' Status

  • Invoice Based: with the 'Yes/No' Status

  • Collectable: with the 'Yes/No' Status

  • Blockchain: with the 'Yes/No' Status and (…) Details (button) opens Blockchain details (if applicable)

  • Created at with the timestamp

  • Currencies added for the blockchain and their Names and IDs with an option to visit the extended currency details by (…) Details (button): opens order details

  • Reload (button): reload page

 

6.3 Currencies Settings

Admin can review the list of currencies configured on the platform with main details for each currency:

  • ID: with logo and ID of the currency

  • Name: Full Name of the Currency

  • Payment Interfaces: Payment Interfaces the Currency is using with the option to visit the Payment Interface by pressing on it's Name as a link. Enabled Payment Interface for the Currency is highlighted

  • Position: number for priority of reflection in User UI Wallets list

  • User balance enabled: status (with the 'Yes/No' Status) and options to enable or disable it using toggle switch

  • Enabled: status (with the 'Yes/No' Status) and options to enable or disable it using toggle switch

  • Hidden: status (with the 'Yes/No' Status) and options to enable or disable it using toggle switch

  • Trading commission: status (with the 'Yes/No' Status) and options to enable or disable it using toggle switch

  • (…) Details (button) opens currency details

  • Reload (button): reload page

Press "+ New Currency" button to add a New Currency (See part 6.3.2 of the Admin Panel Manual)

Press "Payment Interface" as a button and switch to "Payment Interfaces" tab to see more details about the selected Payment Interface

6.3.1. Currency (…) Details

Admin can press (…) Details (button) and see more details about the currency

  • Full Name and ID of selected Currency

  • Tab "Info" selected by default

  • Tab "Edit"

  • Reload (button): reload page or page with auto-reload every 10 seconds

In "Info" mode Admin can review:

  • Name: with ID of selected Currency with 'Users balance enabled' status

  • Precision: with a number for decimals (using in Ledger Records, operation details, order details, trade details)

  • Position: number for priority of reflection in User UI Wallets list

  • Icon URL: proxy service uses URL from file uploaded

  • Dates: timestamp of creation and timestamp of the latest update

  • Light Theme: selected colors for Light Theme

  • Dark Theme: selected colors for Dark Theme

Admin can review and navigate tabs of "Payment Interfaces" for Currency with main details:

  • Enabled: with the 'Yes/No' Status and options to enable or disable it using toggle switch

  • Type: type of the Currency

  • Subunits: decimals from contract

  • Fee/Gas limit: for EVM based blockchain tokens only

  • Smart contract address: not required for main coin of the blockchain

  • Minimum Collection Amount: minimum currency amount that system will collect to Hot Wallet after incoming payment (Deposit, On-chain Swap)

    Direct Deposit section

  • User Direct Deposit Enabled: status for deposit through WalletConnect and options to enable or disable it using toggle switch

  • Minimum Direct Deposit Amount: minimum amount for deposit through WalletConnect

  • Direct Deposit Fee (%): fee for deposit through WalletConnect

  • Minimum Direct Deposit Fee: minimum fee for deposit through WalletConnect

  • Maximum Direct Deposit Fee: maximum fee for deposit through WalletConnect

    Proxy deposit section

  • User Deposit enabled: status for deposit to Proxy Wallet and options to enable or disable it using toggle switch

  • Minimum Deposit Amount: minimum amount for deposit to Proxy Wallet

  • Deposit Fee (%): fee for deposit to Proxy Wallet

  • Minimum Deposit Fee: minimum fee for deposit to Proxy Wallet

  • Maximum Deposit Fee: maximum fee for deposit to Proxy Wallet

    Withdraw section

  • User Withdraw Enable: status and options to enable or disable it using toggle switch

  • Minimum Withdraw Amount: minimum withdrawal amount from Proxy Wallet

  • Maximum Withdraw Amount: maximum withdrawal amount from Proxy Wallet

  • 24 Hours Withdrawal Limit: 24 hour limit for withdrawal from Proxy Wallet

  • 72 Hours Withdrawal Limit: 72 hour limit for withdrawal from Proxy Wallet

  • Withdraw Fee (%): fee for withdrawal from Proxy Wallet

  • Minimum Withdraw Fee: minimum fee for withdrawal from Proxy Wallet

  • Maximum Withdraw Fee: maximum fee for withdrawal from Proxy Wallet

 

Press "Edit" tab and perform the edits (except ID):

 

  • Name: Full Name of the selected Currency

  • Position: number for priority of reflection in User UI Wallets list

  • Precision: with a number for decimals (using in Ledger Records, operation details, order details, trade details)

  • Light Theme: selected colors for Light Theme

  • Dark Theme: selected colors for Dark Theme

  • Enabled: currency status and options to enable or disable it using toggle switch

  • Hidden: currency status and options to enable or disable it using toggle switch

  • User balance enabled: status and options to enable or disable it using toggle switch

  • Trading Commission Enabled: status and options to enable or disable it using toggle switch

Perform Currency payment interfaces edits:

  • Payment Interface (Drop button): to select the Payment Interface for coin or token

  • Type (Drop button): to select Type of the Currency: coin, token or fiat

  • Smart contract address: not required for main coin of the blockchain

  • Subunits: decimals from contract

  • Fee/Gas limit: for EVM based blockchain tokens only. This parameter is used for ETH (recommended 21000) and ERC20 tokens (recommended 90000 or more), BNB and BEP20 tokens.
    IMPORTANT: TRX and TRC20 tokens should have 0 and & Gas limit

  • Minimum Collection Amount: minimum currency amount that system will collect to Hot Wallet after incoming payment (Deposit, On-chain Swap)

  • User Deposit enabled: status for deposit to Proxy Wallet and options to enable or disable it using toggle switch

  • Minimum Deposit Amount: minimum amount for deposit to Proxy Wallet

  • Deposit Fee (%): fee for deposit to Proxy Wallet

  • Minimum Deposit Fee: minimum fee for deposit to Proxy Wallet

  • Maximum Deposit Fee: maximum fee for deposit to Proxy Wallet

  • User Direct Deposit Enabled: status for deposit through WalletConnect and options to enable or disable it using toggle switch

  • Minimum Direct Deposit Amount: minimum amount for deposit through WalletConnect

  • Direct Deposit Fee (%): fee for deposit through WalletConnect

  • Minimum Direct Deposit Fee: minimum fee for deposit through WalletConnect

  • Maximum Direct Deposit Fee: maximum fee for deposit through WalletConnect

  • User Withdraw Enable: status and options to enable or disable it using toggle switch

  • Minimum Withdraw Amount: minimum withdrawal amount from Proxy Wallet

  • Maximum Withdraw Amount: maximum withdrawal amount from Proxy Wallet

  • 24 Hours Withdrawal Limit: 24 hour limit for withdrawal from Proxy Wallet

  • 72 Hours Withdrawal Limit: 72 hour limit for withdrawal from Proxy Wallet

  • Withdraw Fee (%): fee for withdrawal from Proxy Wallet

  • Minimum Withdraw Fee: minimum fee for withdrawal from Proxy Wallet

  • Maximum Withdraw Fee: maximum fee for withdrawal from Proxy Wallet

  • Enable: status for Payment Interface and options to enable or disable it using toggle switch

  • Description: with details of conditions for review

Press "Trash can" button and delete Currency payment interface

Press "+" button and add Payment Interface(s)

  • Reload (button): reload page or page with auto-reload every 10 seconds

After making edits in currency settings Press the “Save Currency” button to activate the changes

6.3.2. Add New Currency

Admin can press "+ New Currency" button and open the modal window to Add a New Currency by input:

 

  1. ID: ID of the currency (Cannot be changed in Admin Panel then)

  2. Name: Full Name of the Currency

  3. Position: number for priority of reflection in User UI Wallets list

  4. Precision: with a number for decimals (using in Ledger Records, operation details, order details, trade details)

  5. Light Theme: selected colors for Light Theme

  6. Dark Theme: selected colors for Dark Theme

  7. Enabled: currency status and options to enable or disable it using toggle switch

  8. Hidden: currency status and options to enable or disable it using toggle switch

  9. User balance enabled: status and options to enable or disable it using toggle switch

  10. Trading Commission Enabled: status and options to enable or disable it using toggle switch

Press"+" button and input Payment Interface parameters:

  1. Payment Interface (Drop button): to select the Payment Interface for coin or token

  2. Type (Drop button): to select Type of the Currency: coin, token or fiat

  3. Smart contract address: not required for main coin of the blockchain

  4. Subunits: decimals from contract

  5. Fee/Gas limit: for EVM based blockchain tokens only. This parameter is used for ETH (recommended 21000) and ERC20 tokens (recommended 90000 or more), BNB and BEP20 tokens.
    IMPORTANT: TRX and TRC20 tokens should have 0 and & Gas limit

  6. Minimum Collection Amount: minimum currency amount that system will collect to Hot Wallet after incoming payment (Deposit, On-chain Swap)

  7. User Deposit enabled: status for deposit to Proxy Wallet and options to enable or disable it using toggle switch

  8. Minimum Deposit Amount: minimum amount for deposit to Proxy Wallet

  9. Deposit Fee (%): fee for deposit to Proxy Wallet

  10. Minimum Deposit Fee: minimum fee for deposit to Proxy Wallet

  11. Maximum Deposit Fee: maximum fee for deposit to Proxy Wallet

  12. User Direct Deposit Enabled: status for deposit through WalletConnect and options to enable or disable it using toggle switch

  13. Minimum Direct Deposit Amount: minimum amount for deposit through WalletConnect

  14. Direct Deposit Fee (%): fee for deposit through WalletConnect

  15. Minimum Direct Deposit Fee: minimum fee for deposit through WalletConnect

  16. Maximum Direct Deposit Fee: maximum fee for deposit through WalletConnect

  17. User Withdraw Enable: status and options to enable or disable it using toggle switch

  18. Minimum Withdraw Amount: minimum withdrawal amount from Proxy Wallet

  19. Maximum Withdraw Amount: maximum withdrawal amount from Proxy Wallet

  20. 24 Hours Withdrawal Limit: 24 hour limit for withdrawal from Proxy Wallet

  21. 72 Hours Withdrawal Limit: 72 hour limit for withdrawal from Proxy Wallet

  22. Withdraw Fee (%): fee for withdrawal from Proxy Wallet

  23. Minimum Withdraw Fee: minimum fee for withdrawal from Proxy Wallet

  24. Maximum Withdraw Fee: maximum fee for withdrawal from Proxy Wallet

  25. Enable: status for Payment Interface and options to enable or disable it using toggle switch

  26. Description: with details of conditions for review

 

Press "Trash can" button and delete Currency payment interface

Press "+" button and add Payment Interface(s)

After Input currency settings press “Create Currency” button and see modal window closing, "Success" notification, and New Currency added to the list of Currencies

IMPORTANT

Be very careful!

ID can not be changed in the admin panel after initial saving, only in the database by DevOps. Changing this information while having the history of operations with old parameters in the database is risky, before changes please make sure the history of operations with previous parameters is deleted.

Tokens should be added ONLY after Coin and it’s Payment Interface settings adding

6.4. Markets

Admin can review the list of Markets configured to the platform with main details:

 

  • ID: market pair ID

  • Rate Source: displays Base to Quote rate that system use for Swap

  • On-Chain Swap: status and options to enable or disable it using toggle switch

  • Off-Chain Swap: status and options to enable or disable it using toggle switch

  • Trading: status and options to enable or disable it using toggle switch

  • Bot: status and option to disable it using toggle switch

  • Trading price: last trading price

  • Enabled: status and options to enable or disable market using toggle switch

  • (…) Details (button): opens Market Pair details

  • Reload (button): on the top right

  • + New Market (button): to add a New Market Pair

IMPORTANT!In case of disabled 'Market' by using toggle switch: All 'Open Orders" for this market will be canceled

IMPORTANT!In case of disabled 'Trading' by using toggle switch: All 'Open Orders" for this market will be canceled

6.4.1. Market Pair Details

Admin can access Market Pair (…) Details (button) and see additional details about the Market Pair.

  • Market ID

  • Tab "Details" selected by default

  • Tab "Edit"

  • Tab "Trading Bot" (in case 'Enabled')

  • Reload (button): reload page

 

In "Details" tab Admin can review Market configurations:

  • ID: market pair ID

  • Base Currency: with the full name,ID and green indicator(active) or grey indicator(inactive). Press "Details" to review the extended details of the Base Currency.

  • Quote Currency: with the full name,ID and green indicator(active) or grey indicator(inactive). Press "Details" to review the extended details of the Quote Currency.

  • Minimum Base Currency: minimum amount for Swap (Base Currency)

  • Minimum Quote Currency: minimum amount for Swap (Quote Currency)

  • Commission Currency: quote or base

  • Swap Quote → Base price precision: precision for price (Market Pair rate) displaying on UI

  • Swap Base → Quote price precision: precision for price (Market Pair rate) displaying on UI

Trading:

  • Enabled: status and options to enable or disable trading for market using toggle switch

  • Trading Bot: status with green indicator(Enabled) or grey indicator(Disabled)

  • (…) Details (button): switch to 'Trading Bot' tab if 'Enabled' or to 'Trading Bot' Settings if 'Disabled'

  • Market position: number for priority of reflection in User UI Market list

  • Amount precision: for Base Currency

  • Minimum amount: for Base Currency

  • Price precision: in Quote Currency

  • Minimum price: for Base Currency (in Quote Currency)

  • Maximum price: for Base Currency (in Quote Currency)

  • Maker fee (%): fee for every trade that Maker pays

  • Taker fee (%): fee for every trade that Taker pays

Swap Types:

  • On-Chain Swap Enabled: status and options to enable or disable On-Chain Swap using toggle switch

  • Off-Chain Swap Enabled: status and options to enable or disable Off-Chain Swap using toggle switch

  • Chain-In Swap Enabled: status and options to enable or disable Chain-In Swap using toggle switch

  • Chain-Out Swap Enabled: status and options to enable or disable Chain-Out Swap using toggle switch


Swap Commission:

  • Quote → Base (%): fee in commission currency for Quote to Base Swap (All Swap Types)

  • Quote → Base (Minimum): minimum fee in commission currency for Quote to Base Swap (All Swap Types)

  • Quote → Base (Maximum): maximum fee in commission currency for Quote to Base Swap (All Swap Types)

  • Base → Quote (%): fee in commission currency for Base to Quote Swap (All Swap Types)

  • Base → Quote (Minimum): minimum fee in commission currency for Base to Quote Swap (All Swap Types)

  • Base → Quote (Maximum): minimum fee in commission currency for Base to Quote Swap (All Swap Types)

Rate Sources:

  • Name of the Service with Market ID and green indicator(active) or grey indicator(inactive) for getting the prices from third parties

  • 'Enabled' status and options to enable or disable it using toggle switch

Admin can access "Edit" tab and perform the edits:

Basic info:

 

  • Base Currency: field with the selected Base Currency (disable for edits)

  • Quote Currency: field with the selected Quote Currency (disable for edits)

  • Minimum Base Currency: minimum amount for Swap (Base Currency)

  • Minimum Quote Currency: minimum amount for Swap (Quote Currency)

  • Swap Quote → Base price precision: precision for price (Market Pair rate) displaying on UI

  • Swap Base → Quote price precision: precision for price (Market Pair rate) displaying on UI

  • Market owner ID: with details of conditions for review

  • Commission Currency: quote or base

Market operations:

  • Enabled On-Chain Swap: status and options to enable or disable On-Chain Swap using toggle switch

  • Enabled Off-Chain Swap Commission: status and options to enable or disable Off-Chain Swap using toggle switch

  • Enabled Chain-In Swap: status and options to enable or disable Chain-In Swap using toggle switch

  • Enabled Chain-Out Swap: status and options to enable or disable Chain-Out Swap using toggle switch

  • Enabled trading: status and options to enable or disable Trading using toggle switch

Swap Commission:

  • Quote → Base (%): fee in commission currency for Quote to Base Swap (All Swap Types)

  • Quote → Base (Minimum): minimum fee in commission currency for Quote to Base Swap (All Swap Types)

  • Quote → Base (Maximum): maximum fee in commission currency for Quote to Base Swap (All Swap Types)

  • Base → Quote (%): fee in commission currency for Base to Quote Swap (All Swap Types)

  • Base → Quote (Minimum): minimum fee in commission currency for Base to Quote Swap (All Swap Types)

  • Base → Quote (Maximum): minimum fee in commission currency for Base to Quote Swap (All Swap Types)

Trading:

  • Market position: number for priority of reflection in User UI Market list

  • Amount precision: for Base Currency

  • Minimum amount: for Base Currency

  • Price precision: in Quote Currency

  • Minimum price: for Base Currency (in Quote Currency)

  • Maximum price: for Base Currency (in Quote Currency)

  • Maker fee (%): fee for every trade that Maker pays

  • Taker fee (%): fee for every trade that Taker pays

  • Buy limit order enabled: status and options to enable or disable Open limit buy order on market using toggle switch

  • Buy market order enabled: status and options to enable or disable Open market buy order on market using toggle switch

  • Buy trade cancellable: status and options to enable or disable it

  • Sell limit order enabled: status and options to enable or disable Open limit sell order on market using toggle switch

  • Sell market order enabled: status and options to enable or disable Open market sell order on market using toggle switch

  • Sell trade cancellable: status and options to enable or disable it

  • Reload (button): reload page

After making edits in Market Pair settings press “Update Market” button to activate changes

 

Admin can access 'Trading Bot" tab or "Trading Bot" settings and see following details and options to create a New Trading Bot for the selected Market:

  • Bot user email: input field for trading bot email

  • Bot user password: input field for trading bot password

  • Quantity of orders per side: limit orders amount per side which trading bot will create

  • Create order timeout (in seconds): timeout for limit order creation by trading bot

  • Minimum amount: minimum amount for limit order creation by trading bot (in Base Currency) according Trading Market settings

  • Maximum amount: maximum amount for limit order creation by trading bot (in Base Currency)

  • Spread (%): buffer for the limit order price creation by trading bot (in Quote Currency). Price should not be lower than minimum price from the Trading Market settings.

  • Bot enabled: status and options to enable or disable trading bot using toggle switch

  • Reload (button): reload page

After making edits for Trading Bot press the "Set bot settings" button to activate Trading Bot or submit changes.

6.4.2. Add New Market

Admin can press "+ New Market" button and Open the modal window to create a New Market Pair and review Basic Info:

 

  1. Base Currency: to select Base Currency for the market from the list of existing currencies)

  2. Quote Currency: to select Quote Currency for the market from the list of existing currencies

  3. Minimum Base Currency: minimum amount for Swap (Base Currency)

  4. Minimum Quote Currency: minimum amount for Swap (Quote Currency)

  5. Swap Quote → Base price precision: precision for price (Market Pair rate) displaying on UI

  6. Swap Base → Quote price precision: precision for price (Market Pair rate) displaying on UI

  7. Market owner ID: with details of conditions for review

  8. Commission Currency: quote or base

    Market operations:

  • Enabled On-Chain Swap: status and options to enable or disable On-Chain Swap using toggle switch

  • Enabled Off-Chain Swap Commission: status and options to enable or disable Off-Chain Swap using toggle switch

  • Enabled Chain-In Swap: status and options to enable or disable Chain-In Swap using toggle switch

  • Enabled Chain-Out Swap: status and options to enable or disable Chain-Out Swap using toggle switch

  • Enabled trading: status and options to enable or disable Trading using toggle switch

Swap Commission:

  1. Quote → Base (%): fee in commission currency for Quote to Base Swap (All Swap Types)

  2. Quote → Base (Minimum): minimum fee in commission currency for Quote to Base Swap (All Swap Types)

  3. Quote → Base (Maximum): maximum fee in commission currency for Quote to Base Swap (All Swap Types)

  4. Base → Quote (%): fee in commission currency for Base to Quote Swap (All Swap Types)

  5. Base → Quote (Minimum): minimum fee in commission currency for Base to Quote Swap (All Swap Types)

  6. Base → Quote (Maximum): minimum fee in commission currency for Base to Quote Swap (All Swap Types)

Trading:

  • Market position: number for priority of reflection in User UI Market list

  • Amount precision: for Base Currency

  • Minimum amount: for Base Currency

  • Price precision: in Quote Currency

  • Minimum price: for Base Currency (in Quote Currency)

  • Maximum price: for Base Currency (in Quote Currency)

  • Maker fee (%): fee for every trade that Maker pays

  • Taker fee (%): fee for every trade that Taker pays

  • Buy limit order enabled: status and options to enable or disable Open limit buy order on market using toggle switch

  • Buy market order enabled: status and options to enable or disable Open market buy order on market using toggle switch

  • Buy trade cancellable: status and options to enable or disable it

  • Sell limit order enabled: status and options to enable or disable Open limit sell order on market using toggle switch

  • Sell market order enabled: status and options to enable or disable Open market sell order on market using toggle switch

  • Sell trade cancellable: status and options to enable or disable it

  • Reload (button): reload page

After making edits for New Market creation press “Create Market” button and see modal window closing, "Success" notification, and New Market added to the list of Markets

6.5. Manual Rates

Admin can see the list of the Market Pairs configured to the platform (which have Manual Rate) with the following information:

  • Market: ID of the Market Pair

  • Base Currency: with Currency ID

  • Quote Currency: with Currency ID

  • Rate: Base to Quote manual rate

  • Created: timestamp of creation

  • Updated: timestamp of the latest Manual rate configurations update

  • Reload (button): reload page

Admin can press (…) Details (button) and open a modal window to perform the edits for the Market Manual rate:

  1. Base Currency: to select the Base Currency from the list of existing currencies

  2. Quote Currency: to select the Quote Currency from the list of existing currencies

  3. Rate: input Base to Quote rate

  4. Press "Update" button to save changes

Admin can press "+ New" button and open a modal window to add Manual rate for Market Pair:

  1. Base Currency: to select the Base Currency from the list of existing currencies

  2. Quote Currency: to select the Quote Currency from the list of existing currencies

  3. Rate: input Base to Quote rate

  4. Press "Create" button to add

7. DevOps

7.1. 'General' part

Admin can review the following information:

 

  • Total users: amount as a reflection of a number of all users with all roles registered on the platform (including admin users)

  • Current sessions: amount to understand the amount of logged in users, including users logged in from several devices

  • User balances loaded: amount to understand the amount of user balances loaded

  • Total operations: amount as a number of all executed operations

  • Operations 24h: number of total Operations executed within 24 hours. Operations in current definition is every transaction and/or operation that has an effect on the system's accounting balances. Deposits, order book trades, custodian trades, non-custodian trades, multiple layers of referral commissions, adjustments, withdrawals, funds locking and any transaction that incurs either a blockchain or a system fee set by the admin.

  • Trading Queue

7.2. 'System Health' part

Admin can review the following information:

Nodes with microservices running inside that node. Admin can use this real time reporting for identifying inconsistencies in node activity and monitor the following parameters in the default node cluster configuration:

  • Node Name - top of box in bold

  • Version of the Service - some services will require individual updates to their node and the corresponding version number is displayed

  • CPU Load - colored bar represents the load

  • Memory Load - colored bar represents the load

  • Uptime in Seconds - easiest way to see when a service restarted

  • Amount of mirco-services running on the node

For deeper review the list of the micro-services running on the node opens by clicking at "Actions" ordered by alphabet.

For deeper review the list of the micro-services running on the node opens by clicking at "Details" and open info Panel with main details about selected node:

System:

  • Uptime in hours,minutes and seconds - easiest way to see when a service restarted

  • Version of the Service

  • CPU Load - colored circle bar represents the load

  • OS memory - colored circle bar represents the load

  • Service memory - colored circle bar represents the load

Requests:

  • Active

  • Total

  • Errored

  • Timeout

Events:

  • Active

  • Total

  • Errored

IMPORTANT!

In case the node goes offline, the according label will appear on top right of the tile.

When the node that has a number in the name goes offline, the replacement node will be deployed by the system automatically and have the same name. but with number -1 or +1.

For example, bitcoin-pi-20 went offline and was replaced by bitcoin-pi-19,

Then bitcoin-pi-19 went offline and was replaced by bitcoin-pi-18.

8. Profile

In profile settings Admin can use:

Theme Switcher for Dark & Light mode

Logout button

  • Reload (button): reload page

Press "Wallet Connect" button and open modal window to Scan QR code with a WalletConnect-compatible wallet

See Address and Chain ID for Connected Wallets

 

For more details and tutorials please book a training call:
Operator Training for Marionette.dev Software

 

9. Admin Panel Version

Admin Panel and Back-End versions are stated on the bottom of the Admin Panel screen and can be used as reference for corresponding Admin Panel Guide, User Story Backlog, Customization and reporting any malfunction of the component.

 

10. Staking Service

10.1. Staking

Admin can see the list of Users Active or Closed Staking operations with following details by columns:

  • User: email address of registered user with user status light
    - green: verified user with completed KYC
    - gray: unverified user
    - (…) Details: review the user and their details
    Additionally: Search feature built into filter for searching for user profile by email address

  • Amount: the amount that the user staked

  • Currency: ID of the currency that the user staked.
    Additionally: Search feature built into filter for searching for currency by currency ID

  • Status: displays operation status label.
    Options:
    - Open
    - Closed
    Additionally: SSearch feature built into filter for searching for operation by email status

  • Date: timestamp of operation.

  • (…) Details: details associated with the operation described in ‘5.1.1 Operation (…) Details’

  • Reload (button): reload page

Admin can access operation details with active staking and see main details:

  • Type: type of operation

  • Parent Operation: with option to visit it the operation (if applicable)

  • Status: status of operation

  • User: email address of registered user
    Details (button) to see additional details of registered user

  • Amount: currency and ticker

  • Date: timestamp of staking operation creation

Ledger Records (sub-section): allows the admin to view ledger records for associated active staking operation:

  • Account: ledger record account and filter

  • Debit: amount debited to ledger account record with currency and ticker

  • Credit: amount credited to ledger account record with currency and ticker

  • Counterparty: the other side of transaction with registered user email

  • Description: description of transaction with filter to browse by ledger record type

  • Created: timestamp of ledger record creation

  • Operation: field for additional information for the ledger record
    Details (button): see additional details of operation

Admin can review additional accounts which are using in Ledger Records:

205

Staked liabilities

206

Ready to stake liabilities

In case User has Active Staking amount and make Top-Up Staking amount for this currency system will add this amount in already active staking operation:

 

Admin can access operation details with closed staking and see main details:

10.2. Rewards

Admin can see the list of Staking Rewards operations with following details by columns:

  • Date: timestamp of operation with filter option

  • User: email address of registered user with user status light
    - green: verified user with completed KYC
    - gray: unverified user
    - (…) Details: review the user and their details
    Additionally: Search feature built into filter for searching for user profile by email address

  • Amount: the amount that the user received as staking reward

  • Currency: ID of the currency that the user received as staking reward
    Additionally: Search feature built into filter for searching for currency by currency ID

  • (…) Details: details associated with the operation described in ‘5.1.1 Operation (…) Details’

  • Reload (button): reload page

Admin can access Staking Reward operation details and see main details:

  • Type: type of operation

  • Parent Operation: with option to visit it the operation (if applicable)

  • Status: status of operation

  • User: email address of registered user
    - Details (button): see additional details of registered user

  • Amount: currency amount and ticker

  • Date: timestamp of operation

Ledger Records (sub-section): allows the admin to view ledger records for associated staking operation:

  • Account: ledger record account and filter

  • Debit: amount debited to ledger account record with currency and ticker

  • Credit: amount credited to ledger account record with currency and ticker

  • Counterparty: the other side of transaction with registered user email

  • Description: description of transaction with filter to browse by ledger record type

  • Created: timestamp of ledger record creation

  • Operation: field for additional information for the ledger record

Admin can review additional accounts which are using in Ledger Records:

207

Pending staking rewards

407

Staking bonus expenses

10.3. Unstaking

Admin can see the list of operations that are awaiting cancellation of the staking process by the system.
The Active Staking operation will be closed on the specified time according to the cron expression.

10.4. Currency configurations for Staking

Admin can access Configurations for Currency and see following for Staking details:

  • Staking enabled: status and options to enable or disable staking for currency using toggle switch

  • Staking period: cron schedule or cron job expression used in Unix-like operating systems to specify a schedule for running a command or script

DESCRIPTION The time and date fields are: field allowed values ----- -------------- minute 0-59 hour 0-23 day of month 0-31 month 0-12 day of week 0-7 A field may be an asterisk (*), which always stands for ``first-last''. Step values can be used in conjunction with ranges. Fol- lowing a range with ``/<number>'' specifies skips of the number's value through the range. For example, if you want to say ``every two hours'', just use ``*/2''. EXAMPLE CRON FILE # run five minutes after midnight, every day 5 0 * * * # run at 2:15pm on the first of every month -- output mailed to paul 15 14 1 * * # run at 10 pm 0 22 * * * # run every hour * */1 * * *

  • Staking APR: "Annual percent reward" refers to the percentage or rate of return Users can earn on an investment or savings account over the course of a year.

  • Min staking amount: minimum currency amount that can be staked

  • Instant unstaking: status and options to enable or disable instant staking for currency using toggle switch
    - In case enabled: active staking operation will be closed instantly after user request
    - In case disabled: active staking operation will be closed on the specified time according to the cron expression after user request. Staking reward will be send to user.

After making configurations for currency staking details Admin should press ‘Save currency’.

Prior to saving the edits for staking configuration the system will request to unstake all active staking operation for related currency:

11. Referrals Service

11.1. Trade Groups

Admin can see the list of trade groups with following details by columns:

  • Name: name of the group

  • Description: description for the group

  • Details (button): see additional details of the group

  • Reload (button): reload page

  • + New Group: opens modal window to add new trade group

Admin can access trade group details and see following:

In "Main" mode Admin can review:

  • Name: name of the group

  • Description: description for the group

  • Type of referral program

  • Levels: the corresponding reward percentage for each level of the referral program
    (amount of levels is set in configuration file during seployment)

  • Reload (button): reload page

Admin can press "Edit" tab and perform the edits (except group name and number of the Level)

  • Description: description for the group

  • Percent: this reward is calculated as a percentage of the system’s profit from trades of involved users - referrals. It is carried out at the time of day specified in the service settings with the specified interval (for example, once a week).

After making edits for trade group details Admin should press 'Update’

11.1.1. New Trade Group

Admin can press "+ New Group" button and open the modal window to Add a New Trade Group by input:

  1. Name: create name for trade group

  2. Description: create description for trade group

  3. Levels: the number of levels is set at the DevOps level and each trade group will have the same number of levels. Reward in the form of a percentage of the platform’s income for trading operations of referred users.

  4. Percent: this reward is calculated as a percentage of the system’s profit from trades of involved users - referrals. It is carried out at the time of day specified in the service settings with the specified interval (for example, once a week).

Referral program with multiple levels may work as follows:

A. Level 1: You, the initial referrer, bring in new customers or members directly. You earn a commission or reward for their actions.

B. Level 2: When the customers or members you referred in Level 1 refer others, you may earn a smaller commission from their referrals. These are considered your Level 2 referrals.

C. Level 3: If Level 2 referrals refer additional individuals, you may earn a commission from their referrals, and these are your Level 3 referrals.

After making configurations for trade group details Admin should press 'Create’ and observe new group in the list of trade groups.

11.1.2. Referral trade reward operation
Admin can review operation details with referral trade reward:

  • Type: operation type

  • Parent Operation (if applicable): applicable to some transactions

  • Status: operation status label

  • Amount: currency amount and ticker

  • User: email of registered user
    Details (button): see additional details of registered user

  • Date: timestamp of operation creation and timestamp(s) of update(s) relevant to the operation

  • Transactions: additional details for transaction

  • Description: description manually entered by admin, typically related to manual adjustments

Ledger Records (sub-section): allows the admin to view ledger records for associated staking operation:

  • Account: ledger record account and filter

  • Debit: amount debited to ledger account record with currency and ticker

  • Credit: amount credited to ledger account record with currency and ticker

  • Counterparty: the other side of transaction with registered user email

  • Description: description of transaction with filter to browse by ledger record type

  • Created: timestamp of ledger record creation

  • Operation: field for additional information for the ledger record

 

11.2. Deposit Groups

Admin can see the list of deposit groups with following details by columns:

  • Name: name of the group

  • Description: description for the group

  • Details (button): see additional details of the group

  • Reload (button): reload page

  • + New Group: opens modal window to add new trade group

Admin can access deposit group details and see following:

In "Main" mode Admin can review:

  • Name: name of the group

  • Description: description for the group

  • Payment interface: currency payment interface that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Currency: currency that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Operation: type of the operation that should be done by the referred user to receive ‘one time’ reward

  • Min base: minimum currency amount that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Percent: this reward is calculated as a percentage of the amount from deposit transactions of involved users - Level 1 referrals. Reward is paid after the deposit operation.

  • Max reward: maximum reward currency amount that can be received

  • Reload (button): reload page

Admin can press "Edit" tab and perform the edits (except group name)

  • Description: description for the group

  • Type of referral program

  • Currency ID: currency that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Payment interface ID: currency payment interface that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Min base: minimum currency amount that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Percent: this reward is calculated as a percentage of the amount from deposit transactions of involved users - Level 1 referrals. Reward is paid after the deposit operation.

  • Max reward: maximum reward currency amount that can be received

  • Reload (button): reload page

After making edits for deposit group details Admin should press 'Update’

 

11.2.1. Add One Time Payment reward for deposit operation

Admin can press "+ Add One Time Payment" button and add ‘One time Payment’ reward to Deposit Group with following edits:

  • Currency ID: currency that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Payment interface ID: currency payment interface that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Min base: minimum currency amount that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Percent: this reward is calculated as a percentage of the amount from deposit transactions of involved users - Level 1 referrals. Reward is paid after the deposit operation.

  • Max reward: maximum reward currency amount that can be received

After making edits for new One Time Payment details Admin should press 'Update’

 

11.2.2. Referral deposit reward operation
Admin can review operation details with referral deposit reward:

 

  • Type: operation type

  • Parent Operation (if applicable): applicable to some transactions

  • Status: operation status label

  • Amount: currency amount and ticker

  • User: email of registered user
    - Details (button): see additional details of registered user

  • Date: timestamp of operation creation and timestamp(s) of update(s) relevant to the operation

  • Transactions: additional details for transaction

  • Description: description manually entered by admin, typically related to manual adjustments

Ledger Records (sub-section): allows the admin to view ledger records for associated staking operation:

  • Account: ledger record account and filter

  • Debit: amount debited to ledger account record with currency and ticker

  • Credit: amount credited to ledger account record with currency and ticker

  • Counterparty: the other side of transaction with registered user email

  • Description: description of transaction with filter to browse by ledger record type

  • Created: timestamp of ledger record creation

  • Operation: field for additional information for the ledger record

 

11.3. Users

Admin can see the list of users with following details by columns:

  • User ID: id of registered user

  • Email: email address of registered user
    Additionally: Search feature built into filter for searching for user profile by email address

  • Referral Code: referral code generated by the system

  • - (…) Details: review the user and their details

  • Reload (button): reload page

11.3.1. User details

Admin can access user details and see following:

In Referral Info block Admin can review main details:

  • Referral Code: referral code generated by the system

  • Parent: email address of user that is ‘parent’ in referral program
    - Details (button): see additional details of ‘parent’ user
    - n/a in case no ‘parent’ user

  • Referral Group: user’s selected referral group with option to change Referral Group

 

In Referral Children block Admin can review main details by columns:

  • Level: the number of levels is set at the DevOps level and each group will have the same number of levels.

  • Referrals Children Count: refers to the number of individual referrals who are the subject of the user by levels. It is a way to quantify and keep track of the volume of Referrals.

  • Referrals Children: emails of individual referrals who are the subject of the user with option to see additional details of ‘children referral'

  • Reload (button): reload page