lbcd/wire
Dave Collins 6bb8d297a6
wire: Remove unused NewMsgVersionFromConn.
This function is a legacy function from way back during initial
development.  Nothing actually uses it and it's not very useful anyways
since it requires the connection to be a specific type (net.TCPConn) and
therefore doesn't work right with things that typically provide their
own net.Conn implementation like proxies.
2016-11-03 20:14:16 -05:00
..
testdata wire: Add large tx deserialize benchmark. (#678) 2016-04-25 16:51:27 -05:00
bench_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
blockheader.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
blockheader_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
common.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
common_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
doc.go wire: implement feefilter message (bip0133) 2016-10-17 13:33:16 -04:00
error.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
fakemessage_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
fixedIO_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
invvect.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
invvect_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
message.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
message_test.go wire: Make NewMsgTx accept the tx version. 2016-10-27 14:09:29 -05:00
msgaddr.go wire: Reduce allocs with contiguous slices. 2016-06-03 17:08:31 -05:00
msgaddr_test.go multi: Correct misspellings detected by misspell. 2016-10-28 09:43:38 -05:00
msgalert.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msgalert_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgblock.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msgblock_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msgfeefilter.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msgfeefilter_test.go wire: implement feefilter message (bip0133) 2016-10-17 13:33:16 -04:00
msgfilteradd.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msgfilteradd_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgfilterclear.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
msgfilterclear_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgfilterload.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msgfilterload_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msggetaddr.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
msggetaddr_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msggetblocks.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msggetblocks_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msggetdata.go wire: Reduce allocs with contiguous slices. 2016-06-03 17:08:31 -05:00
msggetdata_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msggetheaders.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msggetheaders_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msgheaders.go wire: Reduce allocs with contiguous slices. 2016-06-03 17:08:31 -05:00
msgheaders_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msginv.go wire: Reduce allocs with contiguous slices. 2016-06-03 17:08:31 -05:00
msginv_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msgmempool.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
msgmempool_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgmerkleblock.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msgmerkleblock_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msgnotfound.go wire: Reduce allocs with contiguous slices. 2016-06-03 17:08:31 -05:00
msgnotfound_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msgping.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
msgping_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgpong.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msgpong_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgreject.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
msgreject_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgsendheaders.go wire: Implement sendheaders command (BIP0130) 2016-02-05 12:41:39 -05:00
msgsendheaders_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgtx.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
msgtx_test.go wire: Make NewMsgTx accept the tx version. 2016-10-27 14:09:29 -05:00
msgverack.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
msgverack_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
msgversion.go wire: Remove unused NewMsgVersionFromConn. 2016-11-03 20:14:16 -05:00
msgversion_test.go wire: Remove unused NewMsgVersionFromConn. 2016-11-03 20:14:16 -05:00
netaddress.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
netaddress_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
protocol.go wire: implement feefilter message (bip0133) 2016-10-17 13:33:16 -04:00
protocol_test.go wire: Consolidate tests into the wire pkg. (#728) 2016-08-08 11:42:54 -05:00
README.md docs: Make various README.md files consistent. 2015-10-23 14:51:36 -05:00

wire

[Build Status] (https://travis-ci.org/btcsuite/btcd) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [GoDoc] (http://godoc.org/github.com/btcsuite/btcd/wire)

Package wire implements the bitcoin wire protocol. A comprehensive suite of tests with 100% test coverage is provided to ensure proper functionality.

There is an associated blog post about the release of this package here.

This package has intentionally been designed so it can be used as a standalone package for any projects needing to interface with bitcoin peers at the wire protocol level.

Installation and Updating

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

Bitcoin Message Overview

The bitcoin protocol consists of exchanging messages between peers. Each message is preceded by a header which identifies information about it such as which bitcoin network it is a part of, its type, how big it is, and a checksum to verify validity. All encoding and decoding of message headers is handled by this package.

To accomplish this, there is a generic interface for bitcoin messages named Message which allows messages of any type to be read, written, or passed around through channels, functions, etc. In addition, concrete implementations of most of the currently supported bitcoin messages are provided. For these supported messages, all of the details of marshalling and unmarshalling to and from the wire using bitcoin encoding are handled so the caller doesn't have to concern themselves with the specifics.

Reading Messages Example

In order to unmarshal bitcoin messages from the wire, use the ReadMessage function. It accepts any io.Reader, but typically this will be a net.Conn to a remote node running a bitcoin peer. Example syntax is:

	// Use the most recent protocol version supported by the package and the
	// main bitcoin network.
	pver := wire.ProtocolVersion
	btcnet := wire.MainNet

	// Reads and validates the next bitcoin message from conn using the
	// protocol version pver and the bitcoin network btcnet.  The returns
	// are a wire.Message, a []byte which contains the unmarshalled
	// raw payload, and a possible error.
	msg, rawPayload, err := wire.ReadMessage(conn, pver, btcnet)
	if err != nil {
		// Log and handle the error
	}

See the package documentation for details on determining the message type.

Writing Messages Example

In order to marshal bitcoin messages to the wire, use the WriteMessage function. It accepts any io.Writer, but typically this will be a net.Conn to a remote node running a bitcoin peer. Example syntax to request addresses from a remote peer is:

	// Use the most recent protocol version supported by the package and the
	// main bitcoin network.
	pver := wire.ProtocolVersion
	btcnet := wire.MainNet

	// Create a new getaddr bitcoin message.
	msg := wire.NewMsgGetAddr()

	// Writes a bitcoin message msg to conn using the protocol version
	// pver, and the bitcoin network btcnet.  The return is a possible
	// error.
	err := wire.WriteMessage(conn, msg, pver, btcnet)
	if err != nil {
		// Log and handle the error
	}

GPG Verification Key

All official release tags are signed by Conformal so users can ensure the code has not been tampered with and is coming from the btcsuite developers. To verify the signature perform the following:

  • Download the public key from the Conformal website at https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt

  • Import the public key into your GPG keyring:

    gpg --import GIT-GPG-KEY-conformal.txt
    
  • Verify the release tag with the following command where TAG_NAME is a placeholder for the specific tag:

    git tag -v TAG_NAME
    

License

Package wire is licensed under the copyfree ISC License.