You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/admin/admin-user-guide.mdx
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Ory Kratos and Rafiki Admin should be hosted on the same top-level domain. Hosti
25
25
26
26
### Login and account management
27
27
28
-
Access to Rafiki Admin is restricted to ensure that only authorized users can register. This is achieved by using an invitation-only system, where new users are invited by an administrator. The registration flow is not public, so users cannot sign up on their own. Instead, administrators create accounts using the `invite-user` script.
28
+
Access to Rafiki Admin uses an invitation-only system to ensure that only authorized users can register for an account. New users must be invited by an administrator. The registration flow is not public, so users cannot sign up on their own. Instead, administrators create accounts using the `invite-user` script.
29
29
30
30
#### Invite a user
31
31
@@ -60,7 +60,7 @@ If sending the link through Slack, ensure you format it as code by placing it in
60
60
61
61
#### Generate a recovery link
62
62
63
-
There is an automated account recovery flow which requires an SMTP mail server for sending recovery links to users. Alternatively, an administrator can generate a recovery link using the same `invite-user` script.
63
+
Rafiki Admin provides an automated account recovery flow which requires an SMTP mail server for sending recovery links to users. Alternatively, an administrator can generate a recovery link using the same `invite-user` script.
64
64
65
65
#### Remove a user
66
66
@@ -91,7 +91,7 @@ In the [Local Playground](/integration/playground/overview#rafiki-admin), authen
91
91
92
92
## Navigation
93
93
94
-
After logging in, you’ll be greeted by the main landing page with a left-hand navigation menu. This menu provides access to all of the main functionality needed to manage your Rafiki instance.
94
+
After logging in, you’ll be greeted by the main landing page with a left-hand navigation menu. This menu provides access to the main functionality needed to manage your Rafiki instance.
95
95
96
96
<LargeImg
97
97
src='/img/admin-guide/home.png'
@@ -111,7 +111,7 @@ Each of the following menu items leads to a different page of the Rafiki Admin a
111
111
112
112
The Peers page allows you to manage peering relationships in your Rafiki instance, including viewing, creating, editing, and deleting peers.
113
113
114
-
On this page, all configured peers are displayed in a table where you can view the peer name, its ILP address, asset details including the asset type and scale, and the outgoing HTTP endpoint.
114
+
On this page, all configured peers appear in a table where you can view the peer name, its ILP address, asset details including the asset type and scale, and the outgoing HTTP endpoint.
115
115
116
116
<LargeImg
117
117
src='/img/admin-guide/peers.png'
@@ -143,14 +143,14 @@ After completing these fields, select **Create** to add the new peer.
143
143
144
144
### Edit peer
145
145
146
-
To edit an existing peer, select any peer entry from the table on the main Peers page. This opens the Edit Peer page where you can view and modify peer settings.
146
+
To edit an existing peer, select any peer entry from the table on the main Peers page. This opens the Edit Peer page where you can view and change peer settings.
147
147
148
148
<LargeImg
149
149
src='/img/admin-guide/edit-peer.png'
150
150
alt='A screenshot of the Rafiki Admin application user interface displaying the "Edit Peer" section. It shows several text fields configured for an existing peer. This page is used to view peer details, edit peer details, and delete a peer.'
151
151
/>
152
152
153
-
While the Edit Peer page shares fields with the Create Peer page, it also includes additional fields and actions specific to managing an existing peer:
153
+
While the Edit Peer page shares fields with the Create Peer page, it also includes fields and actions specific to managing an existing peer:
@@ -160,7 +160,7 @@ While the Edit Peer page shares fields with the Create Peer page, it also includ
160
160
|| Deposit Liquidity | To increase the amount of liquidity available, select **Deposit liquidity**. |
161
161
|| Withdraw Liquidity | To reduce the amount of liquidity available, select **Withdraw liquidity**. |
162
162
163
-
After editing any of the above fields in the General Information or HTTP Information sections, select **Save** to commit those changes.
163
+
After editing any of the preceding fields in the General Information or HTTP Information sections, select **Save** to commit those changes.
164
164
165
165
#### Delete peer
166
166
@@ -179,7 +179,7 @@ Confirm the deletion by typing "delete peer" into the text field and selecting *
179
179
180
180
The Assets page allows you to manage assets in your Rafiki instance, including viewing, editing, and creating assets.
181
181
182
-
On this page, all configured assets are displayed in a table where you can view the asset ID, the asset code, the scale, and the withdrawal threshold.
182
+
On this page, all configured assets appear in a table where you can view the asset ID, the asset code, the scale, and the withdrawal threshold.
183
183
184
184
<LargeImg
185
185
src='/img/admin-guide/assets.png'
@@ -207,14 +207,14 @@ After completing these fields, select **Create** to add the new asset.
207
207
208
208
### Edit asset
209
209
210
-
To edit an existing asset, select any asset entry from the table on the main Assets page. This opens the Edit Asset page where you can view and modify asset settings.
210
+
To edit an existing asset, select any asset entry from the table on the main Assets page. This opens the Edit Asset page where you can view and change asset settings.
211
211
212
212
<LargeImg
213
213
src='/img/admin-guide/edit-asset.png'
214
214
alt='A screenshot of the Rafiki Admin application user interface displaying the "Edit Asset" section. It shows several text fields configured for an existing asset. This page is used to view and edit asset details.'
215
215
/>
216
216
217
-
While the Edit Asset page shares fields with the Create Asset page, it also includes additional fields and actions specific to managing an existing asset:
217
+
While the Edit Asset page shares fields with the Create Asset page, it also includes fields and actions specific to managing an existing asset:
@@ -226,13 +226,13 @@ While the Edit Asset page shares fields with the Create Asset page, it also incl
226
226
|| Basis Points | A variable fee per asset. One basis point fee is equal to 0.01% of the total amount, 100 basis points = 1%, 10000 basis points = 100% |
227
227
|| Fee history | To view a list of asset fees over time, select **Fee history**. |
228
228
229
-
After editing any of the above fields in the General Information or Sending Fee sections, select **Save** to commit those changes.
229
+
After editing any of the preceding fields in the General Information or Sending Fee sections, select **Save** to commit those changes.
230
230
231
231
## Wallet addresses
232
232
233
233
The Wallet Addresses page allows you to manage the wallet addresses associated with your Rafiki instance, including viewing, editing, and creating wallet addresses.
234
234
235
-
On this page, all configured wallet addresses are displayed in the table where you can view the address URL, the public name, and the wallet status.
235
+
On this page, all configured wallet addresses appear in the table where you can view the address URL, the public name, and the wallet status.
236
236
237
237
<LargeImg
238
238
src='/img/admin-guide/wallet-addresses.png'
@@ -258,22 +258,22 @@ Fill out the following fields to create a new wallet address:
258
258
259
259
:::note[Wallet address requirements]
260
260
261
-
- At least one asset has to be created prior to creating a new wallet address. Refer to [Create asset](#create-asset) for more information.
261
+
- At least one asset must be created before creating a new wallet address. Refer to [Create asset](#create-asset) for more information.
262
262
- Wallet address URLs are treated as case-insensitive, meaning that both lowercase and uppercase variations of the same address will be recognized as identical.
263
263
:::
264
264
265
265
After completing this section, select **Create** to add the new wallet address.
266
266
267
267
### Edit wallet address
268
268
269
-
To edit an existing wallet address, select any wallet address entry from the table on the main Wallet Addresses page. This opens the Edit Wallet Address page where you can view and modify wallet address details.
269
+
To edit an existing wallet address, select any wallet address entry from the table on the main Wallet Addresses page. This opens the Edit Wallet Address page where you can view and change wallet address details.
270
270
271
271
<LargeImg
272
272
src='/img/admin-guide/edit-wallet-address.png'
273
273
alt='A screenshot of the Rafiki Admin application user interface displaying the "Edit Wallet Address" section. It shows several text fields configured for an existing wallet address. This page is used to view and edit wallet address details.'
274
274
/>
275
275
276
-
While the Edit Wallet Address page shares fields with the Create Wallet Address page, it also includes additional fields and actions specific to managing an existing wallet address.
276
+
While the Edit Wallet Address page shares fields with the Create Wallet Address page, it also includes fields and actions specific to managing an existing wallet address.
@@ -287,7 +287,7 @@ While the Edit Wallet Address page shares fields with the Create Wallet Address
287
287
| Liquidity Information | Amount | Current amount of liquidity available for this wallet. |
288
288
|| Withdraw | To withdraw funds from this wallet, select **Withdraw**. |
289
289
290
-
After editing any of the above fields in the General Information section, select **Save** to commit those changes.
290
+
After editing any of the preceding fields in the General Information section, select **Save** to commit those changes.
291
291
292
292
:::note[What if I need to edit or delete a wallet address?]
293
293
When managing wallet addresses in Rafiki, there are certain restrictions and limitations to be aware of:
@@ -309,7 +309,7 @@ In both cases, the recommended approach is to create a new wallet address and de
309
309
310
310
The Webhook Events page allows you to monitor and manage webhook events within your Rafiki instance. Webhook events in Rafiki are the main communication channel between you and your Rafiki instance. See Webhook events for more information about webhook events.
311
311
312
-
All webhook events that have been triggered are displayed in the table. For each webhook event, you can see the webhook ID, the event type, and the date and time of the event. There is also a field at the top of the page allowing you to filter the table by event type, making it easier to drill down into specific events.
312
+
All triggered webhook events appear in the table. For each webhook event, you can see the webhook ID, the event type, and the date and time of the event. A field at the top of the page allows you to filter the table by event type, making it easier to drill down into specific events.
313
313
314
314
<LargeImg
315
315
src='/img/admin-guide/webhooks.png'
@@ -322,7 +322,7 @@ To view the webhook event as a JSON representation, select **View data**.
322
322
323
323
The Payments page allows you to view all incoming and outgoing payments in your Rafiki instance. This allows you to monitor payment activity as well as track the status of payments.
324
324
325
-
All payments are displayed in the table. For each payment, you can view the unique payment ID, type of payment, state of the payment, and the date and time the payment was created. There is also a field at the top of the page allowing you to filter the table by payment type, making it easier to drill down into specific transactions.
325
+
All payments appear in the table. For each payment, you can view the unique payment ID, type of payment, state of the payment, and the date and time the payment was created. A field at the top of the page allows you to filter the table by payment type, making it easier to drill down into specific transactions.
Asset liquidity is the amount of value, denominated in a given asset, that Rafiki has available to handle cross-currency (foreign exchange) transactions between you and your peer. Whenever an outgoing payment/incoming payment is in a different asset than the peering relationship, the liquidity of asset accounts will change depending on the FX direction.
11
+
Asset liquidity is the amount of value, denominated in a given asset, that Rafiki has available to handle cross-currency (foreign exchange) transactions between you and your peer. Whenever an outgoing payment/incoming payment is in a different asset than the peering relationship, the liquidity of asset accounts change depending on the FX direction.
12
12
13
-
You should deposit and withdraw liquidity as necessary, based on your risk tolerance. Rafiki will fail any transaction that would cause an asset's liquidity to fall below zero.
13
+
You should deposit and withdraw liquidity as necessary, based on your risk tolerance. Rafiki fails any transaction that would cause an asset's liquidity to fall below zero.
14
14
15
15
For more information about how Rafiki handles liquidity, see the [Accounting](/overview/concepts/accounting) concepts page and the [low asset liquidity](/integration/requirements/webhook-events#low-asset-liquidity) section of the webhook events page.
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/admin/liquidity/payment-liquidity.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Because Rafiki doesn't hold funds, anything you receive in an incoming payment m
18
18
Any excess liquidity that remains after an outgoing payment completes must be withdrawn. You may also find that you must deposit liquidity into Rafiki to fund an outgoing payment. Listen for Rafiki's [outgoing payments](/integration/requirements/webhook-events#outgoing-payments) webhook events to know when action is required on your part.
19
19
20
20
:::note[Rafiki Admin]
21
-
The Rafiki Admin does not allow you to manage payment liquidity; however, you can view details about incoming and outgoing payments through the application's [Payments](/admin/admin-user-guide#payments) screen.
21
+
The Rafiki Admin does not allow you to manage payment liquidity, but you can view details about incoming and outgoing payments through the application's [Payments](/admin/admin-user-guide#payments) screen.
22
22
:::
23
23
24
24
For more information about how Rafiki handles liquidity, see the [Accounting](/overview/concepts/accounting) concepts page.
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/admin/liquidity/peer-liquidity.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Peer liquidity is the line of credit you extend to a peer, denominated in your a
12
12
13
13
A peer's liquidity increases when payments are made to the peer and decreases when payments are made from the peer. For example, if a customer of your peer sends your customer a payment of $20 USD, then your peer's liquidity account decreases by 20.
14
14
15
-
If a peer’s liquidity is insufficient (e.g., they’ve used up their allotted credit line), transactions initiated from the peer will fail. Once a peer's liquidity is used up, you should settle with your peer and reset their liquidity. Deposit and withdraw peer liquidity as necessary, based on your risk profile.
15
+
If a peer’s liquidity is insufficient (for example, they’ve used up their allotted credit line), transactions initiated from the peer will fail. Once a peer's liquidity is used up, you should settle with your peer and reset their liquidity. Deposit and withdraw peer liquidity as necessary, based on your risk profile.
16
16
17
17
For more information about how Rafiki handles liquidity, see the [Accounting](/overview/concepts/accounting) concepts page and the [low peer liquidity](/integration/requirements/webhook-events#low-peer-liquidity) section of the webhook events page.
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/admin/liquidity/two-phase-transfers.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ The following transactions support two-phase transfers:
19
19
- Outgoing payment withdrawal
20
20
- Wallet address withdrawal
21
21
22
-
When a withdraw-liquidity transaction is requested with a timeout greater than `0`, the transaction is processed as a two-phase transfer. A `0` denotes the absence of a timeout.
22
+
When a withdraw-liquidity transaction is requested with a timeout greater than `0`, the transaction processes as a two-phase transfer. A `0` denotes the absence of a timeout.
23
23
24
24
If the timeout interval passes before the transaction posts or is voided, the transaction expires and the full amount is returned to the original account.
0 commit comments