Skip to content

Commit ba34462

Browse files
committed
Fix: #AR-9484 solver dashboard updates
1 parent 750528c commit ba34462

File tree

6 files changed

+102
-56
lines changed

6 files changed

+102
-56
lines changed

docs/img/solver_db_connect.webp

73.9 KB
Loading

docs/img/solver_db_earnings.webp

-10.5 KB
Loading

docs/img/solver_db_profile.webp

51.3 KB
Loading

docs/img/solver_db_url.webp

27.9 KB
Loading

docs/solvers/solver-dashboard.md

Lines changed: 91 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,76 +8,105 @@ arcana:
88

99
# Solver Dashboard
1010

11-
Solvers play a key role in enabling the users to spend any asset on any
12-
destination chain. A [[concept-solver| solver]] is a third-party market
13-
maker that runs the {{config.extra.arcana.company_name}} provided solver
14-
executable.
11+
Solver Dashboard helps solver administrators in setting up solver profiles. They
12+
can track and manage solver funds for the configured solver profiles.
1513

16-
Only a permitted set of solvers can interact with the
17-
{{config.extra.arcana.company_name}} chain abstraction (CA) protocol.
14+
??? an-tip "What is a Solver?"
1815

19-
The protocol converts user intents into requests for funds (RFF). It publishes
20-
these requests on a specified channel. Solvers watch the channel for new
21-
requests. They compete to provide the desired liquidity and fulfill each
22-
request.
16+
A [[concept-solver| solver]] is a third-party market maker that runs the
17+
{{config.extra.arcana.company_name}} provided solver executable. Solvers
18+
play a key role in the {{config.extra.arcana.company_name}} chain abstraction
19+
(CA) protocol. They provide liquidity and enable users to spend any asset on
20+
any destination chain.
2321

24-
The Solver Dashboard allows an administrator to manage one or more solvers.
25-
It allows the admin to perform the following actions:
22+
The protocol converts user intents into requests for funds (RFF). It publishes
23+
these requests on a specified channel. Only a permitted set of solvers can
24+
interact with the protocol.
2625

27-
{% include "./text-snippets/solver_actions.md" %}
26+
Solvers watch the channel for new requests. They compete to provide the desired
27+
liquidity and fulfill user requests.
2828

29-
## Prerequisites
29+
Solver admins can perform the following actions:
3030

31-
To access the Solver Dashboard, you need two things:
31+
{% include "./text-snippets/solver_actions.md" %}
3232

33-
1. An EOA wallet address
34-
2. Registration with the {{config.extra.arcana.company_name}} protocol
33+
<figure markdown="span">
34+
<img alt="Solver Dashbaord" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_login.{{config.extra.arcana.img_png}}"/>
35+
<figcaption>Solver Dashboard</figcaption>
36+
</figure>
3537

36-
Solver administrators have to set up authorized EOA addresses when
37-
configuring a solver. The same admin address be authorized to
38-
manage more than one solver. The dashboard displays details in the
39-
context of a single solver at a time.
38+
## Prerequisites
39+
40+
To access the Solver Dashboard, the solver admin must:
4041

41-
To run a solver, you need to:
42+
1. Own an EOA, wallet address
43+
2. Register the EOA with the {{config.extra.arcana.company_name}} protocol
44+
3. Make sure the solver is accessible at a URL such as `ws://ip:port/api/v1/admin-api`
4245

43-
* [[solver-config|Configure the solver]] with the required settings
44-
* Run the executable on a server
46+
!!! an-caution "Running a Solver"
4547

46-
Once running, the solver takes part in the {{config.extra.arcana.company_name}}
47-
CA protocol.
48+
To run a solver:
49+
50+
* Get the solver executable from {{config.extra.arcana.company_name}}
51+
* [[solver-config|Configure the solver]] settings
52+
* Run the executable on a server; it should be accessible via WebSocket
53+
`ws:` or WebSocket with TLS `wss:`
54+
55+
Once the executable runs, the solver is active and participates in the
56+
{{config.extra.arcana.company_name}} CA protocol. **The solver admin will
57+
require the `wss` URL to set up and manage the solver profile in the solver
58+
dashboard.**
4859

4960
## Connect Wallet
5061

5162
To access the dashboard, visit [https://solver.arcana.network/](https://solver.arcana.network/).
5263

53-
Solver administrators must connect the wallet by using the same EOA address
54-
that was registered earlier. Sign the message displayed in the wallet UI
55-
asking for permission to connect to the dashboard and view the landing page.
64+
At the initial access, the admin must set up a solver profile by specifying:
65+
66+
* Solver name
67+
* Solver URL
68+
69+
### Solver URL
70+
71+
Solver URL refers to the WebSocket communication channel specified as:
72+
`wss://ip:port/api/v1/admin-api` or `ws://ip:port/api/v1/admin-api`
5673

5774
<figure markdown="span">
58-
<img alt="Solver Dashbaord" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_login.{{config.extra.arcana.img_png}}"/>
59-
<figcaption>Solver Dashboard</figcaption>
75+
<img alt="Solver URL" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_url.{{config.extra.arcana.img_png}}"/>
76+
<figcaption>Solver Profiles</figcaption>
6077
</figure>
6178

62-
### EOA Addresses
79+
Next, solver admins must use a registered EOA to connect the wallet to the solver
80+
dashboard and log in.
81+
82+
<figure markdown="span">
83+
<img alt="Solver Dashbaord" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_connect.{{config.extra.arcana.img_png}}"/>
84+
<figcaption>Connect Wallet</figcaption>
85+
</figure>
6386

64-
The landing page shows:
87+
After the wallet connects, the admin can view the total available solver funds. The dashboard also shows thresholds for various supported tokens. Admins can view and configure fees for the supported liquidity routes.
6588

66-
* EVM and non-EVM addresses for your connected wallet
67-
* A dropdown list of solvers you can manage
89+
## EOA Addresses
90+
91+
The top RHS on the landing page shows:
92+
93+
* EVM and non-EVM addresses for the connected wallet
94+
* Option to disconnect the wallet
6895

6996
<figure markdown="span">
7097
<img alt="Solver EOA Addresses" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_eoa_addr.{{config.extra.arcana.img_png}}"/>
7198
<figcaption>Solver EOA Addresses</figcaption>
7299
</figure>
73100

74-
### Select Solver
101+
## Select Solver
102+
103+
Manage one or more solvers registered for the EOA account. Choose the solver
104+
profile via the dropdown list at the top RHS.
75105

76-
You can manage one or more solvers with your registered EOA account. Select
77-
the solver you want to view or configure by clicking on the dropdown on the
78-
top right next to the address.
106+
The selected solver page shows:
79107

80-
The landing page shows the settings and solver usage data for the selected solver.
108+
* Wallet balances: total balance, per token balance
109+
* Token threshold setting
81110

82111
<figure markdown="span">
83112
<img alt="Solver Selection" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_solverinfo.{{config.extra.arcana.img_png}}"/>
@@ -141,12 +170,12 @@ You can filter the fees using these fields:
141170

142171
The *Fees* field on the right is editable and solvers can change them as needed.
143172
The protocol uses the fees you set in the dashboard. When a user creates an intent,
144-
the protocol displays fee details including solver fees, when building the
145-
request for funds ensuring fee transparency.
173+
the protocol displays all fee details, including solver fees. This ensures
174+
transparency when building the request for funds.
146175

147-
If the admin modifies the fees via the solver dashboard, the UI submits the
148-
updated fee information to the solver. The solver turns it into a Cosmos transaction
149-
and submits on chain. The updated fee value becomes effective from the next block.
176+
If the admin modifies the fees via the solver dashboard, the solver turns it
177+
into a Cosmos SDK transaction. It submits the transaction on chain. The updated
178+
fee becomes effective from the next block.
150179

151180
<figure markdown="span">
152181
<img alt="Solver Route Filters" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_filters.{{config.extra.arcana.img_png}}"/>
@@ -155,14 +184,14 @@ and submits on chain. The updated fee value becomes effective from the next bloc
155184

156185
### Route Earnings
157186

158-
You can see the earnings for each route next to the fees field. A miniature
159-
earnings chart appears next to it.
187+
You can see the earnings for each route next to the fees field.
160188

161189
<figure markdown="span">
162190
<img alt="Solver Earnings" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_earnings.{{config.extra.arcana.img_png}}"/>
163191
<figcaption>Solver Earnings</figcaption>
164192
</figure>
165193

194+
<!---
166195
### Earnings Chart
167196
168197
Find the chart icon next to the earnings field. Click it to see a historical
@@ -173,8 +202,20 @@ view of earnings for that route.
173202
<figcaption>Earnings Chart</figcaption>
174203
</figure>
175204
205+
NOT IMPLEMENTED YET
206+
--->
207+
208+
## Profile
209+
210+
The solver profile page displays all configured solvers. The connected admin EOA
211+
manages these solvers. They can edit or delete the configured solver profiles.
212+
213+
<figure markdown="span">
214+
<img alt="Solver Profile" class="an-screenshots " src="{{config.extra.arcana.img_dir}}/solver_db_profile.{{config.extra.arcana.img_png}}"/>
215+
<figcaption>Solver Profiles</figcaption>
216+
</figure>
217+
176218
## Disconnect
177219

178-
Click on the account icon in the top right corner to display the solver
179-
selection drop down menu. Select 'log out' to disconnect your wallet from the
180-
Solver Dashboard.
220+
Click on the account icon in the top right corner. Then select the option to
221+
disconnect your wallet from the Solver Dashboard.
Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
* Select a solver
2-
* Track total balance
3-
* View and set chain thresholds
4-
* View configured liquidity routes
5-
* View and set fees for each route
6-
* Track route earnings
1+
* Configure a solver profile
2+
- Name
3+
- URL
4+
* Select a solver profile
5+
* Manage solver funds:
6+
- Track total balance
7+
- View and set thresholds
8+
- View configured liquidity routes
9+
- View and set fees for each route
10+
- Track route earnings
11+
* Edit / Delete solver profile

0 commit comments

Comments
 (0)