commit cb136d04dfc6a3c77322f5ca79f84a67f63cc1b1
parent 7689f72ac5d2a9d854a4988bdda542c1465dc425
Author: Florian Dold <florian@dold.me>
Date: Thu, 5 Jun 2025 11:44:09 +0200
-rst formatting
Diffstat:
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/design-documents/064-kyc-operation-algo.rst b/design-documents/064-kyc-operation-algo.rst
@@ -24,43 +24,43 @@ Requirements
Proposed Solution
=================
-Steps for processing operation of type `op` and amount `amt`:
+Steps for processing operation of type ``op`` and amount ``amt``:
-0. Initialize `last_check_success := null`, `last_op_attempt := null`, `last_rule_gen := null`
+0. Initialize ``last_check_success := null``, ``last_op_attempt := null``, ``last_rule_gen := null``
-1. Check if a zero limit for `op` is applicable.
+1. Check if a zero limit for ``op`` is applicable.
- * If the zero limit blocks `op`, proceed with step 3.
+ * If the zero limit blocks ``op``, proceed with step 3.
* Proceed with step 2.
-2. Attempt to make a request for `op` at the exchange. Set `last_op_attempt` to
+2. Attempt to make a request for ``op`` at the exchange. Set ``last_op_attempt`` to
the current time.
* If the request succeeds, *halt*.
- * If `last_rule_gen` is not `null` (Note 2), proceed with step 4.
+ * If ``last_rule_gen`` is not ``null`` (Note 2), proceed with step 4.
* Proceed with step 3.
-3. Request the `/kyc-check/...` endpoint applicable for `op` (no long-polling!)
+3. Request the ``/kyc-check/...`` endpoint applicable for ``op`` (no long-polling!)
- * If the request returns `204 No Content`, proceed with step 2.
- * If the request returns `200 Ok` or a `202 Accepted`:
+ * If the request returns ``204 No Content``, proceed with step 2.
+ * If the request returns ``200 Ok`` or a ``202 Accepted``:
- * Set `last_rule_gen := response.rule_gen`
- * If the exposed limits do not deny `op`, set `last_check_success := now()` and proceed with step 2.
+ * Set ``last_rule_gen := response.rule_gen``
+ * If the exposed limits do not deny ``op``, set ``last_check_success := now()`` and proceed with step 2.
* Proceed with the next step 4.
-4. Request the `/kyc-check/...` endpoint applicable for `op`
- with long-polling for `min_rule` set to `last_rule_gen`.
+4. Request the ``/kyc-check/...`` endpoint applicable for ``op``
+ with long-polling for ``min_rule`` set to ``last_rule_gen``.
- * If the request returns `200 Ok` or a `202 Accepted`:
+ * If the request returns ``200 Ok`` or a ``202 Accepted``:
- * Set `last_rule_gen := response.rule_gen`
+ * Set ``last_rule_gen := response.rule_gen``
* If the exposed limits
- do not deny `op`, set `last_check_success := now()` and proceed with step 2.
+ do not deny ``op``, set ``last_check_success := now()`` and proceed with step 2.
- * If if the `last_op_attempt` is `null` or is more than 10 minutes in the past,
+ * If if the ``last_op_attempt`` is ``null`` or is more than 10 minutes in the past,
proceed with step 2. (See Note 1)
* Proceed with step 4.
