mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2025-03-13 03:17:07 +01:00
Code Issues Projects Releases Wiki Activity
btcd/rpcclient
History
Olaoluwa Osuntokun 4ec8f016b9
rpcclient: fix race condition in doDisconnect 
In this commit, we fix the following race condition:
```
==================
WARNING: DATA RACE
Write at 0x00c000216018 by goroutine 31:
  github.com/btcsuite/btcd/rpcclient.(*Client).wsReconnectHandler()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:736 +0x2aa
  github.com/btcsuite/btcd/rpcclient.New·dwrap·13()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:1496 +0x39

Previous read at 0x00c000216018 by goroutine 29:
  github.com/btcsuite/btcd/rpcclient.(*Client).doDisconnect()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:1079 +0x247
  github.com/btcsuite/btcd/rpcclient.(*Client).Disconnect()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:1111 +0x47
  github.com/btcsuite/btcd/rpcclient.(*Client).wsInHandler()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:491 +0x1eb
  github.com/btcsuite/btcd/rpcclient.(*Client).start·dwrap·11()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:1181 +0x39

Goroutine 31 (running) created at:
  github.com/btcsuite/btcd/rpcclient.New()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:1496 +0xd77
  github.com/btcsuite/btcd/rpcclient.makeClient()
      /home/runner/work/btcd/btcd/rpcclient/chain_test.go:268 +0x1f9
  github.com/btcsuite/btcd/rpcclient.TestClientConnectedToWSServerRunner.func2()
      /home/runner/work/btcd/btcd/rpcclient/chain_test.go:164 +0x47
  testing.tRunner()
      /opt/hostedtoolcache/go/1.17.5/x64/src/testing/testing.go:1259 +0x22f
  testing.(*T).Run·dwrap·21()
      /opt/hostedtoolcache/go/1.17.5/x64/src/testing/testing.go:1306 +0x47

Goroutine 29 (finished) created at:
  github.com/btcsuite/btcd/rpcclient.(*Client).start()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:1181 +0x2e4
  github.com/btcsuite/btcd/rpcclient.New()
      /home/runner/work/btcd/btcd/rpcclient/infrastructure.go:1493 +0xc51
  github.com/btcsuite/btcd/rpcclient.makeClient()
      /home/runner/work/btcd/btcd/rpcclient/chain_test.go:268 +0x1f9
  github.com/btcsuite/btcd/rpcclient.TestClientConnectedToWSServerRunner.func2()
      /home/runner/work/btcd/btcd/rpcclient/chain_test.go:164 +0x47
  testing.tRunner()
      /opt/hostedtoolcache/go/1.17.5/x64/src/testing/testing.go:1259 +0x22f
  testing.(*T).Run·dwrap·21()
      /opt/hostedtoolcache/go/1.17.5/x64/src/testing/testing.go:1306 +0x47
```

This arises as in `wsReconnectHandler`, the mutex isn't held while the
`conn` pointer is modified.
2023-12-30 16:43:07 -08:00
..
examples multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
chain.go rpcclient, integration: Add test for getchaintips call 2023-07-16 16:03:50 +09:00
chain_test.go added tests for GetBestBlockHashAsync 2023-11-06 15:56:24 -05:00
CONTRIBUTORS Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
cookiefile.go rpcclient: Read first line of cookie instead of trimming space 2020-06-08 09:51:09 -04:00
doc.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
example_test.go rpcclient: implement createwallet with functional options 2020-10-26 14:54:05 -04:00
extensions.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
infrastructure.go rpcclient: fix race condition in doDisconnect 2023-12-30 16:43:07 -08:00
log.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
mining.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
net.go rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
notify.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
rawrequest.go rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
rawtransactions.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00
wallet.go multi: remove repetitive the 2023-06-26 15:40:51 +08:00
zmq.go rpcclient: add getzmqnotifications RPC 2022-04-09 07:46:07 -04:00

README.md

rpcclient

Build Status ISC License GoDoc

rpcclient implements a Websocket-enabled Bitcoin JSON-RPC client package written in Go. It provides a robust and easy to use client for interfacing with a Bitcoin RPC server that uses a btcd/bitcoin core compatible Bitcoin JSON-RPC API.

Status

This package is currently under active development. It is already stable and the infrastructure is complete. However, there are still several RPCs left to implement and the API is not stable yet.

Documentation

  • API Reference
  • btcd Websockets Example Connects to a btcd RPC server using TLS-secured websockets, registers for block connected and block disconnected notifications, and gets the current block count
  • btcwallet Websockets Example Connects to a btcwallet RPC server using TLS-secured websockets, registers for notifications about changes to account balances, and gets a list of unspent transaction outputs (utxos) the wallet can sign
  • Bitcoin Core HTTP POST Example Connects to a bitcoin core RPC server using HTTP POST mode with TLS disabled and gets the current block count

Major Features

  • Supports Websockets (btcd/btcwallet) and HTTP POST mode (bitcoin core)
  • Provides callback and registration functions for btcd/btcwallet notifications
  • Supports btcd extensions
  • Translates to and from higher-level and easier to use Go types
  • Offers a synchronous (blocking) and asynchronous API
  • When running in Websockets mode (the default):
    • Automatic reconnect handling (can be disabled)
    • Outstanding commands are automatically reissued
    • Registered notifications are automatically reregistered
    • Back-off support on reconnect attempts

Installation

$ go get -u github.com/btcsuite/btcd/rpcclient

License

Package rpcclient is licensed under the copyfree ISC License.