itrpc_announce: Doc formatting. - tordam - A library for peer discovery inside the Tor network Err parazyd.org 70 hgit clone https://git.parazyd.org/tordam URL:https://git.parazyd.org/tordam parazyd.org 70 1Log /git/tordam/log.gph parazyd.org 70 1Files /git/tordam/files.gph parazyd.org 70 1Refs /git/tordam/refs.gph parazyd.org 70 1README /git/tordam/file/README.md.gph parazyd.org 70 1LICENSE /git/tordam/file/LICENSE.gph parazyd.org 70 i--- Err parazyd.org 70 1commit 5b44ffae1b92d260306b1297be457f827bc59fdd /git/tordam/commit/5b44ffae1b92d260306b1297be457f827bc59fdd.gph parazyd.org 70 1parent daa7463e0165ce6404ed3be8ab5c716c5cce306b /git/tordam/commit/daa7463e0165ce6404ed3be8ab5c716c5cce306b.gph parazyd.org 70 hAuthor: parazyd URL:mailto:parazyd@dyne.org parazyd.org 70 iDate: Sun, 7 Mar 2021 23:18:10 +0100 Err parazyd.org 70 i Err parazyd.org 70 irpc_announce: Doc formatting. Err parazyd.org 70 i Err parazyd.org 70 iDiffstat: Err parazyd.org 70 i M rpc_announce.go | 12 ++++++++---- Err parazyd.org 70 i Err parazyd.org 70 i1 file changed, 8 insertions(+), 4 deletions(-) Err parazyd.org 70 i--- Err parazyd.org 70 1diff --git a/rpc_announce.go b/rpc_announce.go /git/tordam/file/rpc_announce.go.gph parazyd.org 70 it@@ -34,7 +34,8 @@ type Ann struct{} Err parazyd.org 70 i // - pubkey: ed25519 public signing key in base64 Err parazyd.org 70 i // - portmap: List of ports available for communication Err parazyd.org 70 i // - (optional) revoke: Revocation key for updating peer info Err parazyd.org 70 i-// {"jsonrpc":"2.0", Err parazyd.org 70 i+// { Err parazyd.org 70 i+// "jsonrpc":"2.0", Err parazyd.org 70 i // "id": 1, Err parazyd.org 70 i // "method": "ann.Init", Err parazyd.org 70 i // "params": ["unlikelynameforan.onion:49371", "214=", "69:420,323:2354"] Err parazyd.org 70 it@@ -42,7 +43,8 @@ type Ann struct{} Err parazyd.org 70 i // Returns: Err parazyd.org 70 i // - nonce: A random nonce which is to be signed by the client Err parazyd.org 70 i // - revoke: A key which can be used to revoke key and portman and reannounce the peer Err parazyd.org 70 i-// {"jsonrpc":"2.0", Err parazyd.org 70 i+// { Err parazyd.org 70 i+// "jsonrpc":"2.0", Err parazyd.org 70 i // "id":1, Err parazyd.org 70 i // "result": ["somenonce", "somerevokekey"] Err parazyd.org 70 i // } Err parazyd.org 70 it@@ -126,14 +128,16 @@ func (Ann) Init(ctx context.Context, vals []string) ([]string, error) { Err parazyd.org 70 i // Validate takes two parameters: Err parazyd.org 70 i // - onion: onionaddress:port where the peer and tordam can be reached Err parazyd.org 70 i // - signature: base64 signature of the previously obtained nonce Err parazyd.org 70 i-// {"jsonrpc":"2.0", Err parazyd.org 70 i+// { Err parazyd.org 70 i+// "jsonrpc":"2.0", Err parazyd.org 70 i // "id":2, Err parazyd.org 70 i // "method": "ann.Announce", Err parazyd.org 70 i // "params": ["unlikelynameforan.onion:49371", "deadbeef=="] Err parazyd.org 70 i // } Err parazyd.org 70 i // Returns: Err parazyd.org 70 i // - peers: A list of known validated peers (max. 50) Err parazyd.org 70 i-// {"jsonrpc":"2.0", Err parazyd.org 70 i+// { Err parazyd.org 70 i+// "jsonrpc":"2.0", Err parazyd.org 70 i // "id":2, Err parazyd.org 70 i // "result": ["unlikelynameforan.onion:69", "yetanother.onion:420"] Err parazyd.org 70 i // } Err parazyd.org 70 .