mirror of
https://github.com/btcsuite/btcd.git
synced 2025-02-24 06:47:59 +01:00
The doc formatting changes introduced in the recent go version is increasing the diff for all of the new commits. Formatting it all in this commit will help the readability of future PRs by reducing the diff. |
||
---|---|---|
.. | ||
main.go | ||
README.md |
btcd Websockets Example
This example shows how to use the rpcclient package to connect to a btcd RPC server using TLS-secured websockets, register for block connected and block disconnected notifications, and get the current block count.
This example also sets a timer to shutdown the client after 10 seconds to demonstrate clean shutdown.
Running the Example
The first step is to use go get
to download and install the rpcclient package:
$ go get github.com/btcsuite/btcd/rpcclient
Next, modify the main.go
source to specify the correct RPC username and
password for the RPC server:
User: "yourrpcuser",
Pass: "yourrpcpass",
Finally, navigate to the example's directory and run it with:
$ cd $GOPATH/src/github.com/btcsuite/btcd/rpcclient/examples/btcdwebsockets
$ go run *.go
License
This example is licensed under the copyfree ISC License.