mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-05-28 01:36:42 +00:00
73 lines
2.6 KiB
Markdown
73 lines
2.6 KiB
Markdown
wire
|
|
====
|
|
|
|
[](https://choosealicense.com/licenses/isc/)
|
|
[](http://godoc.org/github.com/kaspanet/kaspad/wire)
|
|
=======
|
|
|
|
Package wire implements the kaspa wire protocol.
|
|
|
|
## Kaspa Message Overview
|
|
|
|
The kaspa protocol consists of exchanging messages between peers. Each message
|
|
is preceded by a header which identifies information about it such as which
|
|
kaspa 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 kaspa 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 kaspa messages are provided. All of the details of marshalling and
|
|
unmarshalling to and from the wire using kaspa encoding are handled so the
|
|
caller doesn't have to concern themselves with the specifics.
|
|
|
|
## Reading Messages Example
|
|
|
|
In order to unmarshal kaspa 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 kaspa peer. Example syntax is:
|
|
|
|
```Go
|
|
// Use the most recent protocol version supported by the package and the
|
|
// main kaspa network.
|
|
pver := wire.ProtocolVersion
|
|
kaspanet := wire.Mainnet
|
|
|
|
// Reads and validates the next kaspa message from conn using the
|
|
// protocol version pver and the kaspa network kaspanet. 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, kaspanet)
|
|
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 kaspa 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 kaspa peer. Example syntax to request addresses
|
|
from a remote peer is:
|
|
|
|
```Go
|
|
// Use the most recent protocol version supported by the package and the
|
|
// main bitcoin network.
|
|
pver := wire.ProtocolVersion
|
|
kaspanet := wire.Mainnet
|
|
|
|
// Create a new getaddr kaspa message.
|
|
msg := wire.NewMsgGetAddr()
|
|
|
|
// Writes a kaspa message msg to conn using the protocol version
|
|
// pver, and the kaspa network kaspanet. The return is a possible
|
|
// error.
|
|
err := wire.WriteMessage(conn, msg, pver, kaspanet)
|
|
if err != nil {
|
|
// Log and handle the error
|
|
}
|
|
```
|