Compatibility with Electrum protocol 1.4 and Electrs v0.8.6 #1124
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,7 +13,7 @@ | |
| // limitations under the License. | ||
|
|
||
| // Package client implements an Electrum JSON RPC client. | ||
| // See ElectrumClient for more details. | ||
| package client | ||
|
|
||
| import ( | ||
|
|
@@ -35,21 +35,25 @@ import ( | |
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| // SoftwareVersion reports to an electrum protocol compatible server | ||
| // its name and a version so that server owners can identify what kind of | ||
| // clients are connected. | ||
| // It is set at the app startup in the backend and never changes during the runtime. | ||
| var SoftwareVersion = "BitBoxApp/uninitialized" | ||
|
|
||
| // supportedProtocolVersion reports to the servers the minimal supported electrum | ||
| // protocol version during the initial connection phase. | ||
| const supportedProtocolVersion = "1.4" | ||
|
|
||
| // ElectrumClient is a high level API access to an Electrum protocol compatible server. | ||
| // See https://electrumx-spesmilo.readthedocs.io/en/latest/protocol-methods.html | ||
| // selecting the supportedProtocolVersion currently in use. | ||
| type ElectrumClient struct { | ||
| rpc *jsonrpc.RPCClient | ||
|
|
||
| scriptHashNotificationCallbacks map[string][]func(string) | ||
| scriptHashNotificationCallbacksLock sync.RWMutex | ||
|
|
||
| close bool | ||
| log *logrus.Entry | ||
| } | ||
|
|
@@ -91,11 +95,10 @@ func NewElectrumClient(rpcClient *jsonrpc.RPCClient, log *logrus.Entry) *Electru | |
| rpcClient.OnConnect(func() error { | ||
| // Sends the version and must be the first message, to establish which methods the server | ||
| // accepts. | ||
| version, err := electrumClient.negotiateProtocol() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| log.WithField("server-version", version).Debug("electrumx server version") | ||
| return nil | ||
| }) | ||
|
|
@@ -128,58 +131,45 @@ func (client *ElectrumClient) RegisterOnConnectionStatusChangedEvent(onConnectio | |
| }) | ||
| } | ||
|
|
||
| // serverVersion is returned by serverVersion(). | ||
| type serverVersion struct { | ||
| software string | ||
| protocol *semver.SemVer | ||
| } | ||
|
|
||
| func (v serverVersion) String() string { | ||
| return fmt.Sprintf("%s;%s", v.software, v.protocol) | ||
| } | ||
|
|
||
| // negotiateProtocol performs client/server protocol negotiation using the | ||
| // server.version RPC call. | ||
| // ElectrumX will reply with a success only once. Subsequent calls return | ||
| // a "server.version already sent" error. Electrs doesn't enforce the "only once" | ||
| // condition. | ||
| func (client *ElectrumClient) negotiateProtocol() (serverVersion, error) { | ||
| var resp [2]string // [software version, protocol version] | ||
| err := client.rpc.MethodSync(&resp, "server.version", SoftwareVersion, supportedProtocolVersion) | ||
| if err != nil { | ||
| return serverVersion{}, err | ||
| } | ||
| semv, err := semver.NewSemVerFromString(resp[1]) | ||
| if err != nil { | ||
| semv, err = semver.NewSemVerFromString(resp[1] + ".0") | ||
| } | ||
| if err != nil { | ||
| semv = &semver.SemVer{} // don't really care; nice to have | ||
|
Contributor
There was a problem hiding this comment. why nice to have? if not needed, we could drop the response? should we check the server version and drop the connection if it is newer than 1.4?
Contributor
Author
There was a problem hiding this comment. I don't think we as a client should drop the connection. This is clear from the protocol spec:
In other words, if the server accepts our client version, it means our client is compatible with whatever protocol the server is running. Hence, "nice to have" - we don't make use of it except for logging during the connection. Maybe in the future, if say there's a protocol v1.5 which has some new method we want to use, but we also want to support v1.4 protocol anyway, then it'll be a different story. For now, the pragmatic in me says that's really just nice-to-have, for logging basically. |
||
| } | ||
| return serverVersion{software: resp[0], protocol: semv}, nil | ||
| } | ||
|
|
||
| // CheckConnection reports whether the server returns a succesfull response | ||
| // to a server.ping RPC method. | ||
| // It is different when compared to a raw socket connection check. | ||
| // A client seemingly connected at a transport level is not indicative of | ||
| // a functioning application layer connection. This reports the latter. | ||
| func (client *ElectrumClient) CheckConnection() error { | ||
| var empty struct{} | ||
| return client.rpc.MethodSync(&empty, "server.ping") | ||
| } | ||
|
|
||
| // Balance is returned by ScriptHashGetBalance(). | ||
|
|
@@ -188,8 +178,7 @@ type Balance struct { | |
| Unconfirmed int64 `json:"unconfirmed"` | ||
| } | ||
|
|
||
| // ScriptHashGetBalance does the blockchain.scripthash.get_balance RPC call. | ||
| func (client *ElectrumClient) ScriptHashGetBalance( | ||
| scriptHashHex string, | ||
| success func(*Balance) error, | ||
|
|
@@ -210,8 +199,7 @@ func (client *ElectrumClient) ScriptHashGetBalance( | |
| scriptHashHex) | ||
| } | ||
|
|
||
| // ScriptHashGetHistory does the blockchain.scripthash.get_history RPC call. | ||
| func (client *ElectrumClient) ScriptHashGetHistory( | ||
| scriptHashHex blockchain.ScriptHashHex, | ||
| success func(blockchain.TxHistory), | ||
|
|
@@ -234,8 +222,7 @@ func (client *ElectrumClient) ScriptHashGetHistory( | |
| string(scriptHashHex)) | ||
| } | ||
|
|
||
| // ScriptHashSubscribe does the blockchain.scripthash.subscribe RPC call. | ||
| func (client *ElectrumClient) ScriptHashSubscribe( | ||
| setupAndTeardown func() func(error), | ||
| scriptHashHex blockchain.ScriptHashHex, | ||
|
|
@@ -281,8 +268,7 @@ func parseTX(rawTXHex string) (*wire.MsgTx, error) { | |
| return tx, nil | ||
| } | ||
|
|
||
| // TransactionGet downloads a transaction using the blockchain.transaction.get RPC method. | ||
| func (client *ElectrumClient) TransactionGet( | ||
| txHash chainhash.Hash, | ||
| success func(*wire.MsgTx), | ||
|
|
@@ -308,26 +294,14 @@ func (client *ElectrumClient) TransactionGet( | |
| txHash.String()) | ||
| } | ||
|
|
||
|
x1ddos marked this conversation as resolved.
|
||
| // HeadersSubscribe does the blockchain.headers.subscribe RPC call. | ||
| func (client *ElectrumClient) HeadersSubscribe( | ||
| setupAndTeardown func() func(error), | ||
| success func(*blockchain.Header), | ||
| ) { | ||
| type header struct { | ||
| Height int | ||
| } | ||
| client.rpc.SubscribeNotifications("blockchain.headers.subscribe", func(responseBytes []byte) { | ||
| response := []json.RawMessage{} | ||
| if err := json.Unmarshal(responseBytes, &response); err != nil { | ||
|
|
@@ -338,20 +312,20 @@ func (client *ElectrumClient) HeadersSubscribe( | |
| client.log.Error("could not handle header notification") | ||
| return | ||
| } | ||
| var h header | ||
| if err := json.Unmarshal(response[0], &h); err != nil { | ||
| client.log.WithError(err).Error("could not handle header notification") | ||
| return | ||
| } | ||
| success(&blockchain.Header{BlockHeight: h.Height}) | ||
| }) | ||
| client.rpc.Method( | ||
| func(responseBytes []byte) error { | ||
| var h header | ||
| if err := json.Unmarshal(responseBytes, &h); err != nil { | ||
| return errp.WithStack(err) | ||
| } | ||
| success(&blockchain.Header{BlockHeight: h.Height}) | ||
| return nil | ||
| }, | ||
| setupAndTeardown, | ||
|
|
@@ -393,8 +367,7 @@ type UTXO struct { | |
| Height int `json:"height"` | ||
| } | ||
|
|
||
| // ScriptHashListUnspent does the blockchain.address.listunspent RPC call. | ||
| func (client *ElectrumClient) ScriptHashListUnspent(scriptHashHex string) ([]*UTXO, error) { | ||
| response := []*UTXO{} | ||
| if err := client.rpc.MethodSync(&response, "blockchain.scripthash.listunspent", scriptHashHex); err != nil { | ||
|
|
@@ -403,8 +376,7 @@ func (client *ElectrumClient) ScriptHashListUnspent(scriptHashHex string) ([]*UT | |
| return response, nil | ||
| } | ||
|
|
||
| // TransactionBroadcast does the blockchain.transaction.broadcast RPC call. | ||
| func (client *ElectrumClient) TransactionBroadcast(transaction *wire.MsgTx) error { | ||
| rawTx := &bytes.Buffer{} | ||
| _ = transaction.BtcEncode(rawTx, 0, wire.WitnessEncoding) | ||
|
|
@@ -422,8 +394,7 @@ func (client *ElectrumClient) TransactionBroadcast(transaction *wire.MsgTx) erro | |
| return nil | ||
| } | ||
|
|
||
| // RelayFee does the blockchain.relayfee RPC call. | ||
| func (client *ElectrumClient) RelayFee( | ||
| success func(btcutil.Amount), | ||
| cleanup func(error), | ||
|
|
@@ -443,9 +414,9 @@ func (client *ElectrumClient) RelayFee( | |
| } | ||
|
|
||
| // EstimateFee estimates the fee rate (unit/kB) needed to be confirmed within the given number of | ||
| // blocks using the blockchain.estimatefee RPC method. | ||
| // If the fee rate could not be estimated by the blockchain node, nil is passed to the | ||
| // success callback. | ||
| func (client *ElectrumClient) EstimateFee( | ||
| number int, | ||
| success func(*btcutil.Amount), | ||
|
|
@@ -491,8 +462,7 @@ func parseHeaders(reader io.Reader) ([]*wire.BlockHeader, error) { | |
| return headers, nil | ||
| } | ||
|
|
||
| // Headers does the blockchain.block.headers RPC call. | ||
| func (client *ElectrumClient) Headers( | ||
| startHeight int, count int, | ||
| success func(headers []*wire.BlockHeader, max int), | ||
|
|
@@ -527,8 +497,7 @@ func (client *ElectrumClient) Headers( | |
| startHeight, count) | ||
| } | ||
|
|
||
| // GetMerkle does the blockchain.transaction.get_merkle RPC call. | ||
| func (client *ElectrumClient) GetMerkle( | ||
| txHash chainhash.Hash, height int, | ||
| success func(merkle []blockchain.TXHash, pos int), | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there are a lot more such references in client.go to replace
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, the initial plan was to make a minimal change but then it escalated a bit :)
ok, I removed all other references except this one.