mirror/lnd
1
0 Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup comments & removed notes on escrow

Browse Source
This commit is contained in:
Joseph Poon committed 2016-01-16 17:14:35 -08:00
1 parent 84c0f56330
commit f2a1c0368a
36 files changed
+648 -769
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

lnwire/message.go
+45 -45
View File
@@ -1,4 +1,4 @@
//Code derived from https://github.com/btcsuite/btcd/blob/master/wire/message.go
// Code derived from https:// github.com/btcsuite/btcd/blob/master/wire/message.go
package lnwire
import (
@@ -9,7 +9,7 @@ import (
"github.com/btcsuite/btcd/wire"
)
// message type identifyer bytes
// message type identifyer bytes
const (
MSGID_FUNDREQUEST = 0x30
MSGID_FUNDRESPONSE = 0x31
@@ -23,52 +23,52 @@ const (
MSGID_FWDAUTHREQ = 0x21
)
//4-byte network + 4-byte message id + payload-length 4-byte
// 4-byte network + 4-byte message id + payload-length 4-byte
const MessageHeaderSize = 12
const MaxMessagePayload = 1024 * 1024 * 32 // 32MB
const MaxMessagePayload = 1024 * 1024 * 32 // 32MB
const (
//Funding channel open
// Funding channel open
CmdFundingRequest = uint32(200)
CmdFundingResponse = uint32(210)
CmdFundingSignAccept = uint32(220)
CmdFundingSignComplete = uint32(230)
//Close channel
// Close channel
CmdCloseRequest = uint32(300)
CmdCloseComplete = uint32(310)
//TODO Renumber to 1100
//HTLC payment
// TODO Renumber to 1100
// HTLC payment
CmdHTLCAddRequest = uint32(1000)
CmdHTLCAddAccept = uint32(1010)
CmdHTLCAddReject = uint32(1020)
//TODO Renumber to 1200
//HTLC settlement
// TODO Renumber to 1200
// HTLC settlement
CmdHTLCSettleRequest = uint32(1100)
CmdHTLCSettleAccept = uint32(1110)
//HTLC timeout
// HTLC timeout
CmdHTLCTimeoutRequest = uint32(1300)
CmdHTLCTimeoutAccept = uint32(1310)
//Commitments
// Commitments
CmdCommitSignature = uint32(2000)
CmdCommitRevocation = uint32(2010)
//Error
// Error
CmdErrorGeneric = uint32(4000)
)
//Every message has these functions:
// Every message has these functions:
type Message interface {
Decode(io.Reader, uint32) error //(io, protocol version)
Encode(io.Writer, uint32) error //(io, protocol version)
Command() uint32 //returns ID of the message
MaxPayloadLength(uint32) uint32 //(version) maxpayloadsize
Validate() error //Validates the data struct
Decode(io.Reader, uint32) error // (io, protocol version)
Encode(io.Writer, uint32) error // (io, protocol version)
Command() uint32 // returns ID of the message
MaxPayloadLength(uint32) uint32 // (version) maxpayloadsize
Validate() error // Validates the data struct
String() string
}
@@ -116,10 +116,10 @@ func makeEmptyMessage(command uint32) (Message, error) {
}
type messageHeader struct {
//NOTE(j): We don't need to worry about the magic overlapping with
//bitcoin since this is inside encrypted comms anyway, but maybe we
//should use the XOR (^wire.TestNet3) just in case???
magic wire.BitcoinNet //which Blockchain Technology(TM) to use
// NOTE(j): We don't need to worry about the magic overlapping with
// bitcoin since this is inside encrypted comms anyway, but maybe we
// should use the XOR (^wire.TestNet3) just in case???
magic wire.BitcoinNet // which Blockchain Technology(TM) to use
command uint32
length uint32
}
@@ -145,12 +145,12 @@ func readMessageHeader(r io.Reader) (int, *messageHeader, error) {
return n, &hdr, nil
}
// discardInput reads n bytes from reader r in chunks and discards the read
// bytes. This is used to skip payloads when various errors occur and helps
// prevent rogue nodes from causing massive memory allocation through forging
// header length.
// discardInput reads n bytes from reader r in chunks and discards the read
// bytes. This is used to skip payloads when various errors occur and helps
// prevent rogue nodes from causing massive memory allocation through forging
// header length.
func discardInput(r io.Reader, n uint32) {
maxSize := uint32(10 * 1024) //10k at a time
maxSize := uint32(10 * 1024) // 10k at a time
numReads := n / maxSize
bytesRemaining := n % maxSize
if n > 0 {
@@ -170,7 +170,7 @@ func WriteMessage(w io.Writer, msg Message, pver uint32, btcnet wire.BitcoinNet)
cmd := msg.Command()
//Encode the message payload
// Encode the message payload
var bw bytes.Buffer
err := msg.Encode(&bw, pver)
if err != nil {
@@ -179,37 +179,37 @@ func WriteMessage(w io.Writer, msg Message, pver uint32, btcnet wire.BitcoinNet)
payload := bw.Bytes()
lenp := len(payload)
//Enforce maximum overall message payload
// Enforce maximum overall message payload
if lenp > MaxMessagePayload {
return totalBytes, fmt.Errorf("message payload is too large - encoded %d bytes, but maximum message payload is %d bytes", lenp, MaxMessagePayload)
}
//Enforce maximum message payload on the message type
// Enforce maximum message payload on the message type
mpl := msg.MaxPayloadLength(pver)
if uint32(lenp) > mpl {
return totalBytes, fmt.Errorf("message payload is too large - encoded %d bytes, but maximum message payload of type %x is %d bytes", lenp, cmd, mpl)
}
//Create header for the message
// Create header for the message
hdr := messageHeader{}
hdr.magic = btcnet
hdr.command = cmd
hdr.length = uint32(lenp)
// Encode the header for the message. This is done to a buffer
// rather than directly to the writer since writeElements doesn't
// return the number of bytes written.
// Encode the header for the message. This is done to a buffer
// rather than directly to the writer since writeElements doesn't
// return the number of bytes written.
hw := bytes.NewBuffer(make([]byte, 0, MessageHeaderSize))
writeElements(hw, hdr.magic, hdr.command, hdr.length)
//Write header
// Write header
n, err := w.Write(hw.Bytes())
totalBytes += n
if err != nil {
return totalBytes, err
}
//Write payload
// Write payload
n, err = w.Write(payload)
totalBytes += n
if err != nil {
@@ -227,18 +227,18 @@ func ReadMessage(r io.Reader, pver uint32, btcnet wire.BitcoinNet) (int, Message
return totalBytes, nil, nil, err
}
//Enforce maximum message payload
// Enforce maximum message payload
if hdr.length > MaxMessagePayload {
return totalBytes, nil, nil, fmt.Errorf("message payload is too large - header indicates %d bytes, but max message payload is %d bytes.", hdr.length, MaxMessagePayload)
}
//Check for messages in the wrong bitcoin network
// Check for messages in the wrong bitcoin network
if hdr.magic != btcnet {
discardInput(r, hdr.length)
return totalBytes, nil, nil, fmt.Errorf("message from other network [%v]", hdr.magic)
}
//Create struct of appropriate message type based on the command
// Create struct of appropriate message type based on the command
command := hdr.command
msg, err := makeEmptyMessage(command)
if err != nil {
@@ -246,14 +246,14 @@ func ReadMessage(r io.Reader, pver uint32, btcnet wire.BitcoinNet) (int, Message
return totalBytes, nil, nil, fmt.Errorf("ReadMessage %s", err.Error())
}
//Check for maximum length based on the message type
// Check for maximum length based on the message type
mpl := msg.MaxPayloadLength(pver)
if hdr.length > mpl {
discardInput(r, hdr.length)
return totalBytes, nil, nil, fmt.Errorf("payload exceeds max length. indicates %v bytes, but max of message type %v is %v.", hdr.length, command, mpl)
}
//Read payload
// Read payload
payload := make([]byte, hdr.length)
n, err = io.ReadFull(r, payload)
totalBytes += n
@@ -261,19 +261,19 @@ func ReadMessage(r io.Reader, pver uint32, btcnet wire.BitcoinNet) (int, Message
return totalBytes, nil, nil, err
}
//Unmarshal message
// Unmarshal message
pr := bytes.NewBuffer(payload)
err = msg.Decode(pr, pver)
if err != nil {
return totalBytes, nil, nil, err
}
//Validate the data
// Validate the data
err = msg.Validate()
if err != nil {
return totalBytes, nil, nil, err
}
//We're good!
// We're good!
return totalBytes, msg, payload, nil
}