From 984ef5b6572cff07f99dbe8048e5ebdaa181b8df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pascal=20Eng=C3=A9libert?= <tuxmain@zettascript.org> Date: Mon, 9 Sep 2019 18:59:34 +0200 Subject: [PATCH] Improvec HTTP API doc --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4afa5b3..2a7d674 100644 --- a/README.md +++ b/README.md @@ -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 -- GitLab