mirrors/bitcoin-bips
1
0
Fork 0
mirror of https://github.com/bitcoin/bips.git synced 2025-03-04 11:08:05 +01:00
Code Issues Projects Releases Wiki Activity

Improve service documentation

Browse source
This commit is contained in:
Ben van Hartingsveldt 2024-05-12 23:26:08 +02:00
parent 2787db0163
commit 40bc7213f7
No known key found for this signature in database
GPG key ID: 261AA214130CE7AB
4 changed files with 305 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
bip-0040/service-discovery.mediawiki
View file

@ -110,6 +110,6 @@
|-
! Result
| <code>array</code>
| <code>["Some method help text",[ ["address","string","String containing full Bitcoin address."] ]].</code>
| <code>["Some method help text",[ ["address","string","String containing full Bitcoin address."] ]]</code>
| The parameters of the requested method.
|}

60
bip-0040/service-firstbits.mediawiki
View file

@ -1,4 +1,62 @@
=Service: Firstbits=
* Service type: <code>firstbits</code>
* Service vendor: <code>blockchain.info</code> and <code>firstbits.com</code>
* Service vendor: <code>blockchain.info</code> and <code>firstbits.com</code>
==Method: Create==
* Method name: <code>create</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>firstbits.create</code>
|-
! Params [0] (<code>address</code>)
| <code>string</code>
| <code>1MarekMKDKRb6PEeHeVuiCGayk9avyBGBB</code>
| The address.
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>string</code>
| <code></code>
| The firstbits string.
|}
==Method: Resolve==
* Method name: <code>resolve</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>firstbits.resolve</code>
|-
! Params [0] (<code>firstbits</code>)
| <code>string</code>
| <code>1MarekM</code>
| The address.
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>string</code>
| <code></code>
| The address.
|}

74
bip-0040/service-node.mediawiki
View file

@ -1,4 +1,76 @@
=Service: Node=
* Service type: <code>node</code>
* Service vendor: <code>Electrum</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.
|}

173
bip-0040/service-wallet.mediawiki
View file

@ -1,4 +1,175 @@
=Service: Wallet=
This service has never been properly defined. It is therefore not standardized and may be removed.
* Service type: <code>wallet</code>
* Service vendor: <code>Electrum</code>
* Service vendor: <code>Electrum</code>
==Method: Import Seed==
* Method name: <code>import_seed</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>wallet.import_seed</code>
|-
! Params [0] (<code>seed</code>)
| <code>string</code>
| <code>update stomach couch actress cart dose coral slice frozen settle alarm boost</code>
| The seed.
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>boolean</code>
| <code>true</code>
| Unknown
|}
==Method: Add Public Key==
* Method name: <code>add_pubkey</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>wallet.add_pubkey</code>
|-
! Params [0] (<code>pubkey</code>)
| <code>string</code>
| Unknown
| The public key.
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>boolean</code>
| <code>true</code>
| Unknown
|}
==Method: Remove Public Key==
* Method name: <code>remove_pubkey</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>wallet.remove_pubkey</code>
|-
! Params [0] (<code>pubkey</code>)
| <code>string</code>
| Unknown
| The public key.
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>boolean</code>
| <code>true</code>
| Unknown
|}
==Method: Create transaction==
* Method name: <code>create_transaction</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>wallet.create_transaction</code>
|-
! Params [0] (<code>address</code>)
| <code>string</code>
| <code>1NS17iag9jJgTHD1VXjvLCEnZuQ3rJDE9L</code>
| The address.
|-
! Params [1] (<code>amount</code>)
| Unknown
| Unknown
| The amount.
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>string</code>
| <code></code>
| Unknown
|}
==Method: Save==
* Method name: <code>save</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>wallet.save</code>
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>boolean</code>
| <code>true</code>
| Unknown
|}
==Method: Load==
* Method name: <code>load</code>
{|
! <ins>[Request]</ins>
! Type
! Example
! Description
|-
! Method
| colspan="3" | <code>wallet.load</code>
|-
! <ins>[Response]</ins>
! Type
! Example
! Description
|-
! Result
| <code>boolean</code>
| <code>true</code>
| Unknown
|}