Staking Applications
Access prerequisites
- Permission (module):
manageToken - License/Feature:
STAKING_TOKENS - Menu container: GENERAL → group Investments / Financial Distributions
What it is / when to use
Staking is a passive income investment: the client locks a quantity of tokens for a pre-defined period and earns a return on the contribution, provided they meet the minimum number of days in the contract. This screen is the administrative panel for all staking applications — active and completed — for users of the platform.
Use it to monitor ongoing applications, edit an active contract (new percentage, new end date, or top-up contribution), cancel an application returning the contributed amount, and link an agent commission to an application. The configuration of staking products (plans, rates, terms) is done on a separate screen — this one operates on applications already made by clients.
Prerequisites
- Permission:
manageTokenregistered for the operator's role. The permission is dual — CPM enum on the backend (decorator) + dynamic module in the DB (controls menu visibility). Both must exist. - License/Feature:
STAKING_TOKENSenabled on the tenant's license (Vault). If disabled, the item does not appear in the menu at all. - Dependencies: applications made by users must already exist. Linking a commission requires that the agent exists (the backend returns
agent not foundotherwise).
Step by step
- Access the menu Investments → Staking Applications (route
/manage-applications). - Use the search (by user identifier) and the Status filter to locate applications.
- On each row, use the action icons to link an agent commission, edit, cancel, or view user details.
Filters and columns
| Filter / Column | What it shows | Data source |
|---|---|---|
| Search (text) | Filters by customerId / user identifier | customerId parameter sent to getAllStakesForAdmin |
| Status | All, Cancelled, Earning (income), Started (started) | status parameter (enum StakingStatuses) |
| Name | externalSourceId of the user or e-mail | Cross-reference of the application with the user list |
| Start / End | Start date and expected end date of the contract | startDate / endDate of the application |
| Contribution amount | Amount locked by the client | amountStaked (BigNumber, displayed with up to 8 decimal places) |
| Receives | Amount the application is configured to earn | amountToApply (BigNumber) |
| Status (column) | Completed when applied or earlyLeave are true; otherwise Active | applied/earlyLeave flags of the application |
Actions and modals
Each row offers four icons:
- Agent commission (
manage_accounts): opens the agent commission modal, which lists the agents already linked to that application and allows you to add or remove links — see Add or remove commission. - Edit (
edit): opens the Update staking dialog — see Update staking. - Cancel (
delete): only appears when the application is still active (!applied && !earlyLeave). Opens a confirmation (bottom-sheet) and, upon confirmation, callscancelUserStakeAdmin— see Cancel application. - User details (
visibility): navigates to the details screen of the user who owns the application.
Business rules / considerations
Attention
- Cancellation is only available while the application is active. Once completed (
applied) or after early exit (earlyLeave), the cancel icon disappears. - The agent commission requires that the agent exists; the system differentiates between
agent not foundandstake not foundfailures. - The status displayed in the column (
Active/Completed) is derived from the application's flags, not from the status filter at the top — they may diverge.
- Financial values:
amountStakedandamountToApplyare treated as BigNumber, without rounding. Check the token's decimal places (up to 8 in the display). - Status APPROVED: financial operations on the holder assume an approved user; cancellation returns the amount to the client's wallet.
Examples
Scenario 1 — Link an agent to an existing application
A client invested through a referral from a business partner. Locate the application using the search, click the Agent commission icon, go to the add tab, enter the agent ID and the percentage (e.g., 5 for 5%) and confirm. The link will appear in the modal list and the agent enters the commission flow for that application.
Scenario 2 — Extend the term and adjust the rate of an active contract
The client requested to keep the amount earning for a longer period at a new rate. Click Edit, enter the new percentage and the new end date (and, if there is a top-up contribution, the total applied) and save. Only one of the three fields is needed to enable the button. Details in Update staking.
Scenario 3 — Cancel an active application and return the capital
The client wants to exit before the end of the contract. Confirm that the application is still Active (the cancel icon is visible), click Cancel and confirm in the bottom-sheet. The backend executes cancelUserStakeAdmin, returning the applied amount (with or without a penalty, according to the contract). After cancellation, the application moves to Completed and the icon disappears. Details in Cancel application.