lbcd/wire
Dave Collins f5cdf2d6a8 Minor hashing-related optimizations.
This commit contains three classes of optimizations:
 - Reducing the number of unnecessary hash copies
 - Improve the performance of the DoubleSha256 function
 - A couple of minor optimizations of the ShaHash functions

The first class is a result of the Bytes function on a ShaHash making a
copy of the bytes before returning them.  It really should have been named
CloneBytes, but that would break the API now.

To address this, a comment has been added to the function which explicitly
calls out the copy behavior.  In addition, all call sites of .Bytes on a
ShaHash in the code base have been updated to simply slice the array when
a copy is not needed.  This saves a significant amount of data copying.

The second optimization modifies the DoubleSha256 function to directly use
fastsha256.Sum256 instead of the hasher interface.  This reduces the
number of allocations needed.  A benchmark for the function has been added
as well.

old: BenchmarkDoubleSha256  500000   3691 ns/op   192 B/op   3 allocs/op
new: BenchmarkDoubleSha256  500000   3081 ns/op    32 B/op   1 allocs/op

The final optimizations are for the ShaHash IsEqual and SetBytes functions
which have been modified to make use of the fact the type is an array and
remove an unneeded subslice.
2015-04-06 11:33:58 -05:00
..
bench_test.go Minor hashing-related optimizations. 2015-04-06 11:33:58 -05:00
blockheader.go Implement BIP0066 changeover logic for v3 blocks. 2015-02-26 09:54:29 -06:00
blockheader_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
common.go Minor hashing-related optimizations. 2015-04-06 11:33:58 -05:00
common_test.go wire: Display correct RandomUint64 test failures. 2015-02-25 15:32:00 -05:00
doc.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
error.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
fakeconn_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
fakemessage_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
fixedIO_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
internal_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
invvect.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
invvect_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
message.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
message_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgaddr.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgaddr_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgalert.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgalert_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgblock.go wire: Add func to get pkscript locs from a tx. 2015-03-09 22:09:09 -05:00
msgblock_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgfilteradd.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgfilteradd_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgfilterclear.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgfilterclear_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgfilterload.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgfilterload_test.go Run gofmt on wire directory. 2015-02-05 13:07:51 -06:00
msggetaddr.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msggetaddr_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msggetblocks.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msggetblocks_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msggetdata.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msggetdata_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msggetheaders.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msggetheaders_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgheaders.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgheaders_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msginv.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msginv_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgmempool.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgmempool_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgmerkleblock.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgmerkleblock_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgnotfound.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgnotfound_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgping.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgping_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgpong.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgpong_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgreject.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgreject_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgtx.go wire: Add func to get pkscript locs from a tx. 2015-03-09 22:09:09 -05:00
msgtx_test.go wire: Add func to get pkscript locs from a tx. 2015-03-09 22:09:09 -05:00
msgverack.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgverack_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
msgversion.go Run gofmt on wire directory. 2015-02-05 13:07:51 -06:00
msgversion_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
netaddress.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
netaddress_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
protocol.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
protocol_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
README.md Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00
shahash.go Minor hashing-related optimizations. 2015-04-06 11:33:58 -05:00
shahash_test.go Import btcwire repo into wire directory. 2015-01-31 14:59:57 -06:00

wire

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

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.

Documentation

[GoDoc] (http://godoc.org/github.com/btcsuite/btcd/wire)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/btcsuite/btcd/wire

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/btcsuite/btcd/wire

Installation

$ go get 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 Conformal. 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.