1
0
Fork 0
mirror of https://github.com/bitcoin/bips.git synced 2025-03-03 18:57:18 +01:00

Improve documentation of server commands

This commit is contained in:
Ben van Hartingsveldt 2024-11-27 22:09:10 +01:00
parent 387af0f819
commit db5ed7530c
No known key found for this signature in database
GPG key ID: 261AA214130CE7AB
4 changed files with 96 additions and 102 deletions

View file

@ -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.
|}

View file

@ -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.
|}

View file

@ -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.
|}

View file

@ -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>