lbcd/wire
2022-05-24 00:01:46 -07:00
..
testdata wire: Add large tx deserialize benchmark. (#678) 2016-04-25 16:51:27 -05:00
bench_test.go [lbry] test: fixed all current tests and delete three. 2022-05-24 00:01:46 -07:00
blockheader.go [lbry] test: fixed all current tests and delete three. 2022-05-24 00:01:46 -07:00
blockheader_test.go [lbry] test: fixed all current tests and delete three. 2022-05-24 00:01:46 -07:00
common.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
common_test.go [lbry] test: fixed all current tests and delete three. 2022-05-24 00:01:46 -07: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 BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
fixedIO_test.go simplify s[:] to s where s is a slice 2020-11-20 15:43:12 -05:00
invvect.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
invvect_test.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
message.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
message_test.go [lbry] align port settings between lbcd, lbcctl, and lbcwallet 2022-05-24 00:01:46 -07:00
msgaddr.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgaddr_test.go [lbry] align port settings between lbcd, lbcctl, and lbcwallet 2022-05-24 00:01:46 -07:00
msgalert.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgalert_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgblock.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgblock_test.go [lbry] test: fixed all current tests and delete three. 2022-05-24 00:01:46 -07:00
msgcfcheckpt.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgcfheaders.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgcfilter.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgfeefilter.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgfeefilter_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgfilteradd.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgfilteradd_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgfilterclear.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgfilterclear_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgfilterload.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgfilterload_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msggetaddr.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msggetaddr_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msggetblocks.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msggetblocks_test.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msggetcfcheckpt.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msggetcfheaders.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msggetcfilters.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msggetdata.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msggetdata_test.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msggetheaders.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msggetheaders_test.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgheaders.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgheaders_test.go [lbry] test: fixed all current tests and delete three. 2022-05-24 00:01:46 -07:00
msginv.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msginv_test.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgmempool.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgmempool_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgmerkleblock.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgmerkleblock_test.go [lbry] test: fixed all current tests and delete three. 2022-05-24 00:01:46 -07:00
msgnotfound.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgnotfound_test.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgping.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgping_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgpong.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgpong_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgreject.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgreject_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgsendaddrv2.go Add support for receiving sendaddrv2 message from a peer 2020-12-02 12:10:43 +02:00
msgsendheaders.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgsendheaders_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgtx.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgtx_test.go [lbry] rename btcd to lbcd 2022-05-23 23:53:30 -07:00
msgverack.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgverack_test.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgversion.go BIP0144+wire: add a MessageEncoding variant for serialization/deserialization 2017-08-13 23:17:40 -05:00
msgversion_test.go [lbry] align port settings between lbcd, lbcctl, and lbcwallet 2022-05-24 00:01:46 -07:00
netaddress.go wire: Treat NetAddress more like immutable 2016-12-06 20:48:02 +01:00
netaddress_test.go [lbry] align port settings between lbcd, lbcctl, and lbcwallet 2022-05-24 00:01:46 -07:00
protocol.go [lbry] wire: update protocol NetIDs 2022-05-23 21:46:22 -07:00
protocol_test.go wire: update service bits for xthin, bit 5, cfilters, and segwit2x 2018-05-23 16:46:15 -07:00
README.md [lbry] docs: update docs for LBRY 2022-05-24 00:01:46 -07:00

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 been augmented from the original btcd implementation. The block header was modified to contain the claimtrie hash.

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
	}