Files: a3fbb13af620b96665efdac152a1d6b792a4bc3f / electrumc.1
1209 bytesRaw
1 | .\" See LICENSE file for copyright and license details. |
2 | .Dd 2018-08-27 |
3 | .Dt electrumc 1 |
4 | .Os |
5 | .ds REPO ssb:// |
6 | .Sh NAME |
7 | .Nm electrumc |
8 | .Nd Electrum RPC client |
9 | .Sh SYNOPSIS |
10 | .Nm |
11 | .Ar address |
12 | .Ar method |
13 | .Op Ar params |
14 | .Sh DESCRIPTION |
15 | Connect to a Electrum server, make a request, and output the response. |
16 | .Pp |
17 | Arguments: |
18 | .Bl -tag -width indent |
19 | .It Ar address |
20 | Address of the server to connect to. Format is |
21 | .Ql host:port:tag |
22 | where |
23 | .Ql tag |
24 | is |
25 | .Ql t |
26 | to use TCP, or |
27 | .Ql s |
28 | for SSL over TCP. |
29 | .It Ar method |
30 | RPC method to call |
31 | .It Op Ar params |
32 | params as JSON to include in the request |
33 | .El |
34 | .Sh EXIT |
35 | .Ex -std |
36 | An error in the server's JSON response is treated as success. |
37 | .Sh EXAMPLES |
38 | Request a server's donation address |
39 | .Bd -literal -offset indent |
40 | $ electrumc electrum.faircoin.world:51812:s server.donation_address |
41 | {"jsonrpc": "2.0", "id": 0, "result": "fairVs8iHyLzgHQrdxb9j6hR4WGpdDbKN3"} |
42 | .Ed |
43 | .Sh REFERENCES |
44 | .Dq Electrum protocol |
45 | .Aq https://electrumx.readthedocs.io/en/latest/protocol-methods.html |
46 | .Sh AUTHORS |
47 | The |
48 | .Nm |
49 | command and manual were written by |
50 | .An cel Aq @f/6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU=.ed25519 . |
51 | .Sh BUGS |
52 | .Pp |
53 | Please report any bugs by making a post on SSB mentioning the repo, |
54 | .Lk \*[REPO] |
55 | and author. |
56 |
Built with git-ssb-web