wire
Package wire implements the c4ex wire protocol.
Kaspa Message Overview
The c4ex protocol consists of exchanging messages between peers. Each message is preceded by a header which identifies information about it such as which c4ex 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 c4ex 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 all c4ex messages are provided. All of the details of marshalling and
unmarshalling to and from the wire using c4ex encoding are handled so the
caller doesn't have to concern themselves with the specifics.
Reading Messages Example
In order to unmarshal c4ex 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 c4ex peer. Example syntax is:
// Use the most recent protocol version supported by the package and the
// main c4ex network.
pver := wire.ProtocolVersion
c4exnet := wire.Mainnet
// Reads and validates the next c4ex message from conn using the
// protocol version pver and the c4ex network c4exnet. The returns
// are a appmessage.Message, a []byte which contains the unmarshalled
// raw payload, and a possible error.
msg, rawPayload, err := wire.ReadMessage(conn, pver, c4exnet)
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 c4ex 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 c4ex 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
c4exnet := wire.Mainnet
// Create a new getaddr c4ex message.
msg := wire.NewMsgGetAddr()
// Writes a c4ex message msg to conn using the protocol version
// pver, and the c4ex network c4exnet. The return is a possible
// error.
err := wire.WriteMessage(conn, msg, pver, c4exnet)
if err != nil {
// Log and handle the error
}