From db5ed7530c524d4247a2477cc461804562f59430 Mon Sep 17 00:00:00 2001
From: Ben van Hartingsveldt <ben.vanhartingsveldt@yocto.com>
Date: Wed, 27 Nov 2024 22:09:10 +0100
Subject: [PATCH] Improve documentation of server commands

---
 bip-0040/service-client.mediawiki       | 25 -------
 bip-0040/service-node.mediawiki         | 76 ---------------------
 bip-0040/service-server.mediawiki       | 87 ++++++++++++++++++++++++-
 bip-0040/service-server.peers.mediawiki | 10 +++
 4 files changed, 96 insertions(+), 102 deletions(-)
 delete mode 100644 bip-0040/service-client.mediawiki
 delete mode 100644 bip-0040/service-node.mediawiki
 create mode 100644 bip-0040/service-server.peers.mediawiki

diff --git a/bip-0040/service-client.mediawiki b/bip-0040/service-client.mediawiki
deleted file mode 100644
index d6145467..00000000
--- a/bip-0040/service-client.mediawiki
+++ /dev/null
@@ -1,25 +0,0 @@
-=Service: Client=
-
-* Service type: <code>client</code>
-* Service vendor: ???
-
-==Method: Version==
-
-Send the version of the client to the server. This command doesn't expect a response.
-
-* Method name: <code>version</code>
-
-{|
-! <ins>[Request]</ins>
-! Type
-! Example
-! Description
-|-
-! Method
-| colspan="3" | <code>client.version</code>
-|-
-! Params [0]
-| <code>string</code>
-| <code>0.41</code>
-| The client version.
-|}
\ No newline at end of file
diff --git a/bip-0040/service-node.mediawiki b/bip-0040/service-node.mediawiki
deleted file mode 100644
index 6d5e6615..00000000
--- a/bip-0040/service-node.mediawiki
+++ /dev/null
@@ -1,76 +0,0 @@
-=Service: Node=
-
-* Service type: <code>node</code>
-* Service vendor: <code>Electrum</code>
-
-==Method: Get Banner==
-
-* Method name: <code>get_banner</code>
-
-{|
-! <ins>[Request]</ins>
-! Type
-! Example
-! Description
-|-
-! Method
-| colspan="3" | <code>node.get_banner</code>
-|-
-! <ins>[Response]</ins>
-! Type
-! Example
-! Description
-|-
-! Result
-| <code>string</code>
-| <code>Dummy banner</code>
-| The banner.
-|}
-
-==Method: Get Peers==
-
-* Method name: <code>get_peers</code>
-
-{|
-! <ins>[Request]</ins>
-! Type
-! Example
-! Description
-|-
-! Method
-| colspan="3" | <code>node.get_peers</code>
-|-
-! <ins>[Response]</ins>
-! Type
-! Example
-! Description
-|-
-! Result
-| <code>array</code>
-| <code>[ {"hostname":"","trusted":true,"weight":0,"ipv4":"1.2.3.4","ipv6":"2001:db8:85a3:8d3:1319:8a2e:370:7348"} ]</code>
-| An array of peers.
-|}
-
-==Method: Stop==
-
-* Method name: <code>stop</code>
-
-{|
-! <ins>[Request]</ins>
-! Type
-! Example
-! Description
-|-
-! Method
-| colspan="3" | <code>node.stop</code>
-|-
-! <ins>[Response]</ins>
-! Type
-! Example
-! Description
-|-
-! Result
-| <code>boolean</code>
-| <code>true</code>
-| True when the server will be stopped.
-|}
\ No newline at end of file
diff --git a/bip-0040/service-server.mediawiki b/bip-0040/service-server.mediawiki
index bb266641..b616488d 100644
--- a/bip-0040/service-server.mediawiki
+++ b/bip-0040/service-server.mediawiki
@@ -1,7 +1,13 @@
 =Service: Server=
 
 * Service type: <code>server</code>
-* Service vendor: ???
+* Service vendor: <code>Electrum</code>
+
+==Method: Add Peer==
+
+A command to add the node to the peer list.
+
+* Method name: <code>add_peer</code>
 
 ==Method: Banner==
 
@@ -27,4 +33,83 @@ A command to get the server banner.
 | <code>string</code>
 | <code>Welcome to Electrum!</code>
 | The server banner.
+|}
+
+==Method: Cache==
+
+A command to get the server cache size.
+
+* Method name: <code>cache</code>
+
+==Method: Debug==
+
+* Method name: <code>debug</code>
+
+==Method: Donation Address==
+
+A command to get the server donation address.
+
+* Method name: <code>donation_address</code>
+
+==Method: Features==
+
+A command to get the server features.
+
+* Method name: <code>features</code>
+
+==Method: Info==
+
+A command to get information about the active sessions.
+
+* Method name: <code>info</code>
+
+==Method: Load==
+
+A command to get the server load.
+
+* Method name: <code>load</code>
+
+==Method: Peers==
+
+A event to announce peers.
+
+* Method name: <code>peers</code>
+
+==Method: Ping==
+
+A command to ping the server.
+
+* Method name: <code>ping</code>
+
+==Method: Stop==
+
+A command to stop the server.
+
+* Method name: <code>stop</code>
+
+==Method: Version==
+
+A command to set the client version, get the server version and negotiate the protocol version.
+
+* Method name: <code>version</code>
+* Introduced in: <code>0.1</code>
+
+{|
+! <ins>[Request]</ins>
+! Type
+! Example
+! Description
+|-
+! Method
+| colspan="3" | <code>server.version</code>
+|-
+! <ins>[Response]</ins>
+! Type
+! Example
+! Description
+|-
+! Result
+| <code>string</code> or <code>array</code>
+| <code>Welcome to Electrum!</code>
+| The server banner.
 |}
\ No newline at end of file
diff --git a/bip-0040/service-server.peers.mediawiki b/bip-0040/service-server.peers.mediawiki
new file mode 100644
index 00000000..1d93a480
--- /dev/null
+++ b/bip-0040/service-server.peers.mediawiki
@@ -0,0 +1,10 @@
+=Service: Server Peers=
+
+* Service type: <code>server.peers</code>
+* Service vendor: <code>Electrum</code>
+
+==Method: Subscribe==
+
+A command to get current peers.
+
+* Method name: <code>subscribe</code>
\ No newline at end of file