Fix lint errors

mtproto/connection_options.go

@@ -11,8 +11,10 @@ import (
 // by the user.
 type ConnectionType uint8
 
+// ConnectionProtocol is a type of IP protocol to use.
 type ConnectionProtocol uint8
 
+// Hacks is a simple structure to store flags for packet transmission.
 type Hacks struct {
 	SimpleAck bool
 	QuickAck  bool
@@ -24,9 +26,12 @@ type ConnectionOpts struct {
 	DC              int16
 	ConnectionType  ConnectionType
 	ConnectionProto ConnectionProtocol
-	ReadHacks       Hacks
-	WriteHacks      Hacks
-	ClientAddr      *net.TCPAddr
+	// Read and Write means direction related to the client.
+	// ReadHacks are meant to be flushed on client read
+	// WriteHacks are meant to be flushed on client write.
+	ReadHacks  Hacks
+	WriteHacks Hacks
+	ClientAddr *net.TCPAddr
 }
 
 // Different connection types which user requests from Telegram.
@@ -36,6 +41,8 @@ const (
 	ConnectionTypeIntermediate
 )
 
+// ConnectionProtocol* define which connection protocols to use.
+// ConnectionProtocolAny means that any is suitable.
 const (
 	ConnectionProtocolIPv4 ConnectionProtocol = 1
 	ConnectionProtocolIPv6                    = ConnectionProtocolIPv4 << 1

mtproto/rpc/handshake_request.go

@@ -2,9 +2,12 @@ package rpc
 
 import "bytes"
 
+// HandshakeRequest is the data type which is responsible for
+// constructing of correct handshake request.
 type HandshakeRequest struct {
 }
 
+// Bytes returns serialized handshake request.
 func (r *HandshakeRequest) Bytes() []byte {
 	buf := &bytes.Buffer{}
 	buf.Grow(len(TagHandshake) + len(HandshakeFlags) + len(HandshakeSenderPID) + len(HandshakePeerPID))
@@ -17,6 +20,7 @@ func (r *HandshakeRequest) Bytes() []byte {
 	return buf.Bytes()
 }
 
+// NewHandshakeRequest creates new HandshakeRequest instance.
 func NewHandshakeRequest() *HandshakeRequest {
 	return &HandshakeRequest{}
 }

mtproto/rpc/handshake_response.go

@@ -6,6 +6,8 @@ import (
 	"github.com/juju/errors"
 )
 
+// HandshakeResponse defines data structure which is used for storage of
+// handshake response.
 type HandshakeResponse struct {
 	Type      []byte
 	Flags     []byte
@@ -13,6 +15,7 @@ type HandshakeResponse struct {
 	PeerPID   []byte
 }
 
+// Bytes returns a serialized handshake response.
 func (r *HandshakeResponse) Bytes() []byte {
 	buf := &bytes.Buffer{}
 
@@ -24,6 +27,7 @@ func (r *HandshakeResponse) Bytes() []byte {
 	return buf.Bytes()
 }
 
+// Valid checks that handshake response compliments request.
 func (r *HandshakeResponse) Valid(req *HandshakeRequest) error {
 	if !bytes.Equal(r.Type, TagHandshake) {
 		return errors.New("Unexpected handshake tag")
@@ -35,6 +39,8 @@ func (r *HandshakeResponse) Valid(req *HandshakeRequest) error {
 	return nil
 }
 
+// NewHandshakeResponse constructs new handshake response from the given
+// data.
 func NewHandshakeResponse(data []byte) (*HandshakeResponse, error) {
 	if len(data) != 32 {
 		return nil, errors.New("Incorrect handshake response length")

mtproto/rpc/nonce_request.go

@@ -9,12 +9,15 @@ import (
 	"github.com/juju/errors"
 )
 
+// NonceRequest is the data type which contains all the data for correct
+// nonce request.
 type NonceRequest struct {
 	KeySelector []byte
 	CryptoTS    []byte
 	Nonce       []byte
 }
 
+// Bytes returns serialized nonce request.
 func (r *NonceRequest) Bytes() []byte {
 	buf := &bytes.Buffer{}
 
@@ -27,6 +30,7 @@ func (r *NonceRequest) Bytes() []byte {
 	return buf.Bytes()
 }
 
+// NewNonceRequest builds new none request based on proxy secret.
 func NewNonceRequest(proxySecret []byte) (*NonceRequest, error) {
 	nonce := make([]byte, 16)
 	keySelector := make([]byte, 4)

mtproto/rpc/nonce_response.go

@@ -6,6 +6,7 @@ import (
 	"github.com/juju/errors"
 )
 
+// NonceResponse is the data type which contains data of nonce response.
 type NonceResponse struct {
 	NonceRequest
 
@@ -13,6 +14,7 @@ type NonceResponse struct {
 	Crypto []byte
 }
 
+// Bytes returns serialized form of the nonce response.
 func (r *NonceResponse) Bytes() []byte {
 	buf := &bytes.Buffer{}
 
@@ -25,6 +27,7 @@ func (r *NonceResponse) Bytes() []byte {
 	return buf.Bytes()
 }
 
+// Valid checks that nonce response compliments nonce request.
 func (r *NonceResponse) Valid(req *NonceRequest) error {
 	if !bytes.Equal(r.Type, TagNonce) {
 		return errors.New("Unexpected RPC type")
@@ -39,6 +42,7 @@ func (r *NonceResponse) Valid(req *NonceRequest) error {
 	return nil
 }
 
+// NewNonceResponse build new nonce response based on the given data.
 func NewNonceResponse(data []byte) (*NonceResponse, error) {
 	if len(data) != 32 {
 		return nil, errors.New("Unexpected message length")

mtproto/rpc/proxy_request.go

@@ -12,6 +12,8 @@ import (
 	"github.com/9seconds/mtg/mtproto"
 )
 
+// ProxyRequest is the data type for storing data required to compose
+// RPC_PROXY_REQ request.
 type ProxyRequest struct {
 	Flags        proxyRequestFlags
 	ConnectionID []byte
@@ -21,6 +23,8 @@ type ProxyRequest struct {
 	Options      *mtproto.ConnectionOpts
 }
 
+// MakeHeader makes RPC_PROXY_REQ header. We need only to append the
+// data for it.
 func (r *ProxyRequest) MakeHeader(message []byte) (*bytes.Buffer, fmt.Stringer) {
 	bufferLength := len(TagProxyRequest) +
 		4 + // len(flags)
@@ -59,6 +63,7 @@ func (r *ProxyRequest) MakeHeader(message []byte) (*bytes.Buffer, fmt.Stringer)
 	return buf, flags
 }
 
+// NewProxyRequest build new ProxyRequest data structure.
 func NewProxyRequest(clientAddr, ownAddr *net.TCPAddr, opts *mtproto.ConnectionOpts, adTag []byte) (*ProxyRequest, error) {
 	flags := proxyRequestFlagsHasAdTag | proxyRequestFlagsMagic | proxyRequestFlagsExtMode2
 

mtproto/rpc/rpc.go

@@ -1,10 +1,13 @@
 package rpc
 
+// SeqNo* is the number of the sequence which have special meaning for
+// the Telegram.
 const (
 	SeqNoNonce     = -2
 	SeqNoHandshake = -1
 )
 
+// Different constants for RPC protocol
 var (
 	TagCloseExt     = []byte{0xa2, 0x34, 0xb6, 0x5e}
 	TagProxyAns     = []byte{0x0d, 0xda, 0x03, 0x44}