A pure Go Electrum JSON-RPC client library.
Note that Electrum daemon uses a random port number by default. In order to use a stable port number, you need to change configuration variable (and restart the daemon):
electrum setconfig rpcport 8001
Electrum will also initialize rpc username / password with a random string. To retreive the current values:
electrum getconfig rpcuser
electrum getconfig rpcpassword
Implemented Electrum commands based on v3.2.3.
| Command | Implemented | Notes |
|---|---|---|
| addrequest | ⬜ | |
| addtransaction | ⬜ | |
| broadcast | ✅ | |
| clearrequests | ⬜ | |
| create | ⬜ | Not yet available. |
| createmultisig | ⬜ | |
| createnewaddress | ✅ | |
| decrypt | ⬜ | |
| deserialize | ✅ | |
| encrypt | ⬜ | |
| freeze | ⬜ | |
| getaddressbalance | ✅ | |
| getaddresshistory | ✅ | |
| getaddressunspent | ✅ | |
| getalias | ⬜ | |
| getbalance | ✅ | |
| getconfig | ✅ | |
| getfeerate | ✅ | |
| getmasterprivate | ✅ | |
| getmerkle | ✅ | |
| getmpk | ✅ | |
| getprivatekeys | ✅ | |
| getpubkeys | ✅ | |
| getrequest | ⬜ | |
| getseed | ✅ | |
| getservers | ✅ | |
| gettransaction | ✅ | |
| getunusedaddress | ✅ | |
| history | ✅ | |
| importprivkey | ⬜ | |
| is_synchronized | ✅ | |
| ismine | ✅ | |
| listaddresses | ✅ | |
| listcontacts | ⬜ | |
| listrequests | ⬜ | |
| listunspent | ✅ | |
| make_seed | ✅ | |
| notify | ✅ | |
| password | ✅ | |
| payto | ✅ | |
| paytomany | ⬜ | |
| restore | ⬜ | Not yet available. |
| rmrequest | ⬜ | |
| searchcontacts | ⬜ | |
| serialize | ⬜ | |
| setconfig | ✅ | |
| setlabel | ⬜ | |
| signmessage | ✅ | |
| signrequest | ⬜ | |
| signtransaction | ⬜ | |
| sweep | ⬜ | |
| unfreeze | ⬜ | |
| validateaddress | ✅ | |
| verifymessage | ✅ | |
| version | ✅ |
To run the go tests use the environment variables: RPCHOST, RPCPORT, RPCUSER, RPCPASSWORD, WALLETPATH, WALLETPASSWORD
RPCHOST=127.0.0.1 RPCPORT=7001 RPCUSER=user RPCPASSWORD=usertest go test
TODO: test coverage needs to be implemented.
See example/ for more.
The MIT License (MIT)
Copyright (c) 2018 konez2k
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.