Commit 984ef5b6 authored by Pascal Engélibert's avatar Pascal Engélibert

Improvec HTTP API doc

parent df8c5d7f
Pipeline #6726 passed with stage
in 51 seconds
......@@ -128,7 +128,7 @@ A peer info file is useful for connecting a node to an existing network. It cont
### HTTP API
URL is used like commandline arguments. Arguments are separated by slashes. Different commands can be set in the same request.
URL is used like commandline arguments. Arguments are separated by slashes. Multiple different commands can be set in the same request.
Command: **/json** send response in JSON instead of default UBJSON if possible (impossible if response contains binary values)
......@@ -162,11 +162,19 @@ Command: **/version** get peer version
Command: **/new** tell the peer about a new peer
Content: a peer info document
**ToDo**: check behind
Command: **/getconfirm/_sender\_pubkey_/_in\_seed1_** get mix confirmation
Command: **/getconfirm/_sender\_pubkey_/_in\_seed1_**
// response:
"confirm": CONFIRMATION
Command: **/mix/_sender_/_amount_/_base_[/client]** mix a transaction (set "client" option if request is sent to entry node)
* If "client": _sender_ is the sender pubkey
* Else: _sender_ is the sender peer hash
Command: **/mix/_pubkey_/_amount_/_base_** mix a transaction
_base_ is not used yet, please set it to `0`. (it is not fully handled by dependencies)
// response:
"mix_ok": IN_SEED1
TODO: update; translate into English
......@@ -176,7 +184,7 @@ L'URL contient la clé publique du compte émetteur de la transaction, ainsi que
Le contenu de la requête est chiffré avec la clé publique du nœud receveur puis signé par la clé publique du compte émetteur. Il est composé de la clé publique (ASCII, 44 caractères) du compte auquel le nœud doit renvoyer la transaction. Si cette clé correspond à un nœud ĞMix faisant partie du chemin prévu de la transaction, elle doit être immédiatement suivie (sans séparateur) d'une des clés à usage unique puis des données qui doivent être envoyées à ce nœud (syntaxe décrite par ce même paragraphe, signature exclue : pour garder l'anonymat de l'émetteur d'origine, les données doivent être signées par le nœud qui envoie le paquet).
Command: **/confirm/_pubkey_/_comment_** confirm a transaction
Command: **/confirm/_receiver_hash_/_out_seed1_** confirm a transaction
TODO: finish; translate into English
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment