*: add/fix godoc comments to satisfy golint

Fixes things like:
 * exported type/method/function X should have comment or be unexported
 * comment on exported type/method/function X should be of the form "X ..."
   (with optional leading article)

Refs. #213.
This commit is contained in:
Roman Khimov 2019-09-03 17:51:37 +03:00
parent de84e074a2
commit a9b9c9226d
47 changed files with 89 additions and 20 deletions

View file

@ -194,6 +194,7 @@ func testInvoke(ctx *cli.Context) error {
return nil
}
// ContractDetails contains contract metadata.
type ContractDetails struct {
Author string
Email string

View file

@ -15,10 +15,13 @@ import (
const (
userAgentFormat = "/NEO-GO:%s/"
// Valid NetMode constants.
// ModeMainNet contains magic code used in the NEO main official network.
ModeMainNet NetMode = 0x00746e41 // 7630401
// ModeTestNet contains magic code used in the NEO testing network.
ModeTestNet NetMode = 0x74746e41 // 1953787457
// ModePrivNet contains magic code usually used for NEO private networks.
ModePrivNet NetMode = 56753 // docker privnet
// ModeUnitTestNet is a stub magic code used for testing purposes.
ModeUnitTestNet NetMode = 0
)
@ -91,8 +94,8 @@ func (c Config) GenerateUserAgent() string {
return fmt.Sprintf(userAgentFormat, Version)
}
// Loadattempts to load the config from the give
// path and netMode.
// Load attempts to load the config from the given
// path for the given netMode.
func Load(path string, netMode NetMode) (Config, error) {
configPath := fmt.Sprintf("%s/protocol.%s.yml", path, netMode)
if _, err := os.Stat(configPath); os.IsNotExist(err) {

View file

@ -5,6 +5,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/interop/runtime"
)
// Main is that famous Main() function, you know.
func Main() bool {
tx := engine.GetScriptContainer()
runtime.Notify(tx)

View file

@ -6,6 +6,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/interop/storage"
)
// Main is Main(), really.
func Main() bool {
iter := storage.Find(storage.GetContext(), []byte("foo"))
values := iterator.Values(iter)

View file

@ -8,6 +8,7 @@ import (
// Check if the invoker of the contract is the specified owner
var owner = util.FromAddress("Aej1fe4mUgou48Zzup5j8sPrE3973cJ5oz")
// Main is something to be ran from outside.
func Main(operation string, args []interface{}) bool {
trigger := runtime.GetTrigger()

View file

@ -4,6 +4,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/interop/storage"
)
// Main is a very useful function.
func Main(operation string, args []interface{}) interface{} {
ctx := storage.GetContext()

View file

@ -83,7 +83,7 @@ func NewBlockchain(ctx context.Context, s storage.Store, cfg config.ProtocolConf
return bc, nil
}
// GetBlockchainLevelDB returns blockchain based on configuration
// NewBlockchainLevelDB initializes new blockchain DB store based on configuration
func NewBlockchainLevelDB(ctx context.Context, cfg config.Config) (*Blockchain, error) {
store, err := storage.NewLevelDBStore(
ctx,
@ -502,6 +502,7 @@ func (bc *Blockchain) GetBlock(hash util.Uint256) (*Block, error) {
return block, nil
}
// GetHeader returns data block header identified with the given hash value.
func (bc *Blockchain) GetHeader(hash util.Uint256) (*Header, error) {
b, err := bc.Get(storage.AppendPrefix(storage.DataBlock, hash.BytesReverse()))
if err != nil {

View file

@ -43,6 +43,7 @@ func (tx *ClaimTX) EncodeBinary(w io.Writer) error {
return nil
}
// Size returns serialized binary size for this transaction.
func (tx *ClaimTX) Size() int {
sz := util.GetVarSize(uint64(len(tx.Claims)))
for _, claim := range tx.Claims {

View file

@ -8,6 +8,7 @@ import (
// This TX has not special attributes.
type ContractTX struct{}
// NewContractTX creates Transaction of ContractType type.
func NewContractTX() *Transaction {
return &Transaction{
Type: ContractType,
@ -24,6 +25,7 @@ func (tx *ContractTX) EncodeBinary(w io.Writer) error {
return nil
}
// Size returns serialized binary size for this transaction.
func (tx *ContractTX) Size() int {
return 0
}

View file

@ -6,7 +6,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/crypto/keys"
)
// A Enrollment transaction represents an enrollment form, which indicates
// EnrollmentTX transaction represents an enrollment form, which indicates
// that the sponsor of the transaction would like to sign up as a validator.
// The way to sign up is: To construct an EnrollmentTransaction type of transaction,
// and send a deposit to the address of the PublicKey.
@ -27,6 +27,7 @@ func (tx *EnrollmentTX) EncodeBinary(w io.Writer) error {
return tx.PublicKey.EncodeBinary(w)
}
// Size returns serialized binary size for this transaction.
func (tx *EnrollmentTX) Size() int {
return len(tx.PublicKey.Bytes())
}

View file

@ -54,6 +54,7 @@ func (tx *InvocationTX) EncodeBinary(w io.Writer) error {
return bw.Err
}
// Size returns serialized binary size for this transaction.
func (tx *InvocationTX) Size() int {
sz := util.GetVarSize(tx.Script)
if (tx.Version >= 1) {

View file

@ -18,6 +18,7 @@ func (tx *IssueTX) EncodeBinary(w io.Writer) error {
return nil
}
// Size returns serialized binary size for this transaction.
func (tx *IssueTX) Size() int {
return 0
}

View file

@ -21,6 +21,7 @@ func (tx *MinerTX) EncodeBinary(w io.Writer) error {
return binary.Write(w, binary.LittleEndian, tx.Nonce)
}
// Size returns serialized binary size for this transaction.
func (tx *MinerTX) Size() int {
return 4 // Nonce
}

View file

@ -74,6 +74,7 @@ func (tx *PublishTX) EncodeBinary(w io.Writer) error {
return bw.Err
}
// Size returns serialized binary size for this transaction.
func (tx *PublishTX) Size() int {
sz := util.GetVarSize(tx.Script) + util.GetVarSize(uint64(len(tx.ParamList)))
sz += 1 * len(tx.ParamList)

View file

@ -63,6 +63,7 @@ func (tx *RegisterTX) EncodeBinary(w io.Writer) error {
return bw.Err
}
// Size returns serialized binary size for this transaction.
func (tx *RegisterTX) Size() int {
return 1 + util.GetVarSize(tx.Name) + tx.Amount.Size() + 1 + len(tx.Owner.Bytes()) + tx.Admin.Size()
}

View file

@ -44,6 +44,7 @@ func (tx *StateTX) EncodeBinary(w io.Writer) error {
return nil
}
// Size returns serialized binary size for this transaction.
func (tx *StateTX) Size() int {
sz := util.GetVarSize(uint64(len(tx.Descriptors)))
for _, desc := range tx.Descriptors {

View file

@ -45,6 +45,7 @@ func (s *StateDescriptor) EncodeBinary(w io.Writer) error {
return bw.Err
}
// Size returns serialized binary size for state descriptor.
func (s *StateDescriptor) Size() int {
return 1 + util.GetVarSize(s.Key) + util.GetVarSize(s.Value) + util.GetVarSize(s.Field)
}

View file

@ -251,7 +251,7 @@ func (t *Transaction) createHash() error {
return nil
}
// GroupTXInputsByPrevHash groups all TX inputs by their previous hash.
// GroupInputsByPrevHash groups all TX inputs by their previous hash.
func (t *Transaction) GroupInputsByPrevHash() map[util.Uint256][]*Input {
m := make(map[util.Uint256][]*Input)
for _, in := range t.Inputs {

View file

@ -3,6 +3,7 @@ package transaction
// TXType is the type of a transaction.
type TXType uint8
// Constants for all valid transaction types.
const (
MinerType TXType = 0x00
IssueType TXType = 0x01

View file

@ -109,7 +109,7 @@ func Base58CheckDecode(s string) (b []byte, err error) {
return b, nil
}
// Base58checkEncode encodes b into a base-58 check encoded string.
// Base58CheckEncode encodes b into a base-58 check encoded string.
func Base58CheckEncode(b []byte) string {
b = append(b, hash.Checksum(b)...)

View file

@ -24,12 +24,14 @@ const (
var nepHeader = []byte{0x01, 0x42}
// ScryptParams is a json-serializable container for scrypt KDF parameters.
type ScryptParams struct {
N int `json:"n"`
R int `json:"r"`
P int `json:"p"`
}
// NEP2ScryptParams returns scrypt parameters specified in the NEP-2.
func NEP2ScryptParams() ScryptParams {
return ScryptParams{
N: n,

View file

@ -22,6 +22,7 @@ type PrivateKey struct {
b []byte
}
// NewPrivateKey creates a new random private key.
func NewPrivateKey() (*PrivateKey, error) {
c := crypto.NewEllipticCurve()
b := make([]byte, c.N.BitLen()/8+8)

View file

@ -168,6 +168,7 @@ func (p *PublicKey) EncodeBinary(w io.Writer) error {
return binary.Write(w, binary.LittleEndian, p.Bytes())
}
// Signature returns a NEO-specific hash of the key.
func (p *PublicKey) Signature() []byte {
b := p.Bytes()
b = append([]byte{0x21}, b...)
@ -178,6 +179,7 @@ func (p *PublicKey) Signature() []byte {
return sig.Bytes()
}
// Address returns a base58-encoded NEO-specific address based on the key hash.
func (p *PublicKey) Address() string {
var b []byte = p.Signature()

View file

@ -91,6 +91,7 @@ func WIFDecode(wif string, version byte) (*WIF, error) {
return w, nil
}
// GetVerificationScript returns NEO VM bytecode with checksig command for the public key.
func (wif WIF) GetVerificationScript() ([]byte, error) {
const (
pushbytes33 = 0x21

View file

@ -8,7 +8,6 @@ import (
)
// MerkleTree implementation.
type MerkleTree struct {
root *MerkleTreeNode
depth int

View file

@ -1,5 +1,6 @@
package keytestcases
// Ktype represents key testcase values (different encodings of the key).
type Ktype struct {
Address,
PrivateKey,
@ -9,6 +10,7 @@ type Ktype struct {
EncryptedWif string
}
// Arr contains a set of known keys in Ktype format.
var Arr = []Ktype{
{
Address: "ALq7AWrhAueN6mJNqk6FHJjnsEoPRytLdW",

View file

@ -6,7 +6,7 @@ package account
// Account stubs a NEO account type.
type Account struct{}
// GetScripHash returns the script hash of the given account.
// GetScriptHash returns the script hash of the given account.
func GetScriptHash(a Account) []byte {
return nil
}

View file

@ -11,8 +11,8 @@ func Create(items []interface{}) Iterator {
return Iterator{}
}
// TODO: Better description for this.
// Key returns the iterator key.
// TODO: Better description for this.
func Key(it Iterator) interface{} {
return nil
}

View file

@ -27,14 +27,14 @@ func GetAttributes(t Transaction) []attribute.Attribute {
return []attribute.Attribute{}
}
// FIXME: What is the correct return type for this?
// GetReferences returns a slice of references for the given transaction.
// FIXME: What is the correct return type for this?
func GetReferences(t Transaction) []interface{} {
return []interface{}{}
}
// FIXME: What is the correct return type for this?
// GetUnspentCoins returns the unspent coins for the given transaction.
// FIXME: What is the correct return type for this?
func GetUnspentCoins(t Transaction) interface{} {
return 0
}

View file

@ -7,6 +7,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/util"
)
// MerkleBlock represents a merkle block packet payload.
type MerkleBlock struct {
*core.BlockBase
TxCount int
@ -14,6 +15,7 @@ type MerkleBlock struct {
Flags []byte
}
// DecodeBinary implements the Payload interface.
func (m *MerkleBlock) DecodeBinary(r io.Reader) error {
m.BlockBase = &core.BlockBase{}
if err := m.BlockBase.DecodeBinary(r); err != nil {
@ -31,6 +33,7 @@ func (m *MerkleBlock) DecodeBinary(r io.Reader) error {
return br.Err
}
// EncodeBinary implements the Payload interface.
func (m *MerkleBlock) EncodeBinary(w io.Writer) error {
return nil
}

View file

@ -5,6 +5,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/util"
)
// Peer represents a network node neo-go is connected to.
type Peer interface {
Endpoint() util.Endpoint
Disconnect(error)

View file

@ -23,6 +23,7 @@ type TCPPeer struct {
wg sync.WaitGroup
}
// NewTCPPeer returns a TCPPeer structure based on the given connection.
func NewTCPPeer(conn net.Conn) *TCPPeer {
return &TCPPeer{
conn: conn,

View file

@ -93,6 +93,7 @@ func NewClient(ctx context.Context, endpoint string, opts ClientOptions) (*Clien
}, nil
}
// WIF returns WIF structure associated with the client.
func (c *Client) WIF() keys.WIF {
c.wifMu.Lock()
defer c.wifMu.Unlock()
@ -117,12 +118,14 @@ func (c *Client) SetWIF(wif string) error {
return nil
}
// Balancer is a getter for balance field.
func (c *Client) Balancer() BalanceGetter {
c.balancerMu.Lock()
defer c.balancerMu.Unlock()
return c.balancer
}
// SetBalancer is a setter for balance field.
func (c *Client) SetBalancer(b BalanceGetter) {
c.balancerMu.Lock()
defer c.balancerMu.Unlock()
@ -132,12 +135,14 @@ func (c *Client) SetBalancer(b BalanceGetter) {
}
}
// Client is a getter for client field.
func (c *Client) Client() *http.Client {
c.cliMu.Lock()
defer c.cliMu.Unlock()
return c.cli
}
// SetClient is a setter for client field.
func (c *Client) SetClient(cli *http.Client) {
c.cliMu.Lock()
defer c.cliMu.Unlock()

View file

@ -11,6 +11,7 @@ import (
errs "github.com/pkg/errors"
)
// GetBalance performs a request to get balance for the address specified.
func (s NeoScanServer) GetBalance(address string) ([]*Unspent, error) {
var (
err error
@ -49,6 +50,7 @@ func filterSpecificAsset(asset string, balance []*Unspent, assetBalance *Unspent
}
}
// CalculateInputs creates input transactions for the specified amount of given asset belonging to specified address.
func (s NeoScanServer) CalculateInputs(address string, assetIdUint util.Uint256, cost util.Fixed8) ([]transaction.Input, util.Fixed8, error) {
var (
err error

View file

@ -9,35 +9,37 @@ import "github.com/CityOfZion/neo-go/pkg/util"
*/
type (
// NeoScanServer stores NEOSCAN URL and API path
NeoScanServer struct {
URL string // "protocol://host:port/"
Path string // path to API endpoint without wallet address
}
// UTXO stores unspent TX output for some transaction.
UTXO struct {
Value util.Fixed8
TxID util.Uint256
N uint16
}
// Unspents is a slice of UTXOs (TODO: drop it?).
Unspents []UTXO
// unspent per asset
// Unspent stores Unspents per asset
Unspent struct {
Unspent Unspents
Asset string // "NEO" / "GAS"
Amount util.Fixed8 // total unspent of this asset
}
// struct of NeoScan response to 'get_balance' request
// NeoScanBalance is a struct of NeoScan response to 'get_balance' request
NeoScanBalance struct {
Balance []*Unspent
Address string
}
)
// NeoScan returns asset IDs as strings ("NEO"/"GAS");
// strings might be converted to uint256 assets IDs using this map
// GlobalAssets stores a map of asset IDs to user-friendly strings ("NEO"/"GAS");
var GlobalAssets = map[string]string{
"c56f33fc6ecfcd0c225c4ab356fee59390af8560be0e930faebe74a6daff7c9b": "NEO",
"602c79718b16e442de58778e148d0b1084e3b2dffd5de6b7b16cee7969282de7": "GAS",

View file

@ -65,7 +65,7 @@ func (c *Client) InvokeFunction(script, operation string, params []smartcontract
return resp, nil
}
// InvokeFunction return the results after calling a the smart contract scripthash
// Invoke returns the results after calling a the smart contract scripthash
// with the given parameters.
func (c *Client) Invoke(script string, params []smartcontract.Parameter) (*InvokeScriptResponse, error) {
var (

View file

@ -10,8 +10,10 @@ import (
"github.com/pkg/errors"
)
// StackParamType represents different types of stack values.
type StackParamType int
// All possible StackParamType values are listed here
const (
Unknown StackParamType = -1
Signature StackParamType = 0x00
@ -27,6 +29,7 @@ const (
Void StackParamType = 0xff
)
// String implements the stringer interface.
func (t StackParamType) String() string {
switch t {
case Signature:
@ -56,6 +59,7 @@ func (t StackParamType) String() string {
}
}
// StackParamTypeFromString converts string into the StackParamType.
func StackParamTypeFromString(s string) (StackParamType, error) {
switch s {
case "Signature":
@ -85,6 +89,7 @@ func StackParamTypeFromString(s string) (StackParamType, error) {
}
}
// UnmarshalJSON sets StackParamType from JSON-encoded data.
func (t *StackParamType) UnmarshalJSON(data []byte) (err error) {
var (
s = string(data)
@ -174,8 +179,10 @@ func (p *StackParam) UnmarshalJSON(data []byte) (err error) {
return
}
// StackParams in an array of StackParam (TODO: drop it?).
type StackParams []StackParam
// TryParseArray converts an array of StackParam into an array of more appropriate things.
func (p StackParams) TryParseArray(vals ...interface{}) error {
var (
err error
@ -193,6 +200,7 @@ func (p StackParams) TryParseArray(vals ...interface{}) error {
return nil
}
// TryParse converts one StackParam into something more appropriate.
func (p StackParam) TryParse(dest interface{}) error {
var (
err error

View file

@ -10,6 +10,7 @@ import (
errs "github.com/pkg/errors"
)
// CreateRawContractTransaction returns contract-type Transaction built from specified parameters.
func CreateRawContractTransaction(params ContractTxParams) (*transaction.Transaction, error) {
var (
err error
@ -67,6 +68,7 @@ func CreateRawContractTransaction(params ContractTxParams) (*transaction.Transac
return tx, nil
}
// GetInvocationScript returns NEO VM script containing transaction signature.
func GetInvocationScript(tx *transaction.Transaction, wif keys.WIF) ([]byte, error) {
const (
pushbytes64 = 0x40

View file

@ -12,7 +12,7 @@ import (
)
type (
// parameters for tx to transfer assets;
// ContractTxParams contains parameters for tx to transfer assets;
// includes parameters duplication `sendtoaddress` RPC call params
// and also some utility data;
ContractTxParams struct {
@ -26,6 +26,7 @@ type (
balancer BalanceGetter
}
// BalanceGetter is an interface supporting CalculateInputs() method.
BalanceGetter interface {
// parameters
// address: base58-encoded address assets would be transferred from

View file

@ -5,6 +5,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/vm"
)
// InvokeScriptResponse stores response for the invoke script call.
type InvokeScriptResponse struct {
responseHeader
Error *Error `json:"error,omitempty"`
@ -73,19 +74,21 @@ type response struct {
Result interface{} `json:"result"`
}
// SendToAddressResponse stores response for the sendtoaddress call.
type SendToAddressResponse struct {
responseHeader
Error *Error `json:"error"`
Result *TxResponse
}
// struct represents verbose output of `getrawtransaction` RPC call
// GetRawTxResponse struct represents verbose output of `getrawtransaction` RPC call.
type GetRawTxResponse struct {
responseHeader
Error *Error `json:"error"`
Result *RawTxResponse `json:"result"`
}
// RawTxResponse stores transaction with blockchain metadata to be sent as a response.
type RawTxResponse struct {
TxResponse
BlockHash string `json:"blockhash"`
@ -93,6 +96,7 @@ type RawTxResponse struct {
BlockTime uint `json:"blocktime"`
}
// TxResponse stores transaction to be sent as a response.
type TxResponse struct {
TxID string `json:"txid"`
Size int `json:"size"`
@ -106,11 +110,13 @@ type TxResponse struct {
Scripts []transaction.Witness `json:"scripts"`
}
// Vin represents JSON-serializable tx input.
type Vin struct {
TxId string `json:"txid"`
Vout int `json:"vout"`
}
// Vout represents JSON-serializable tx output.
type Vout struct {
N int `json:"n"`
Asset string `json:"asset"`

View file

@ -4,6 +4,7 @@ import (
"github.com/CityOfZion/neo-go/pkg/crypto"
)
// ValidateAddressResponse represents response to validate address call.
type ValidateAddressResponse struct {
Address interface{} `json:"address"`
IsValid bool `json:"isvalid"`

View file

@ -51,6 +51,7 @@ func (pt ParamType) String() string {
}
}
// MarshalJSON implements the json.Marshaler interface.
func (pt ParamType) MarshalJSON() ([]byte, error) {
return []byte(`"` + pt.String() + `"`), nil
}

View file

@ -95,6 +95,7 @@ func (i *BigIntegerItem) MarshalJSON() ([]byte, error) {
return json.Marshal(i.value)
}
// BoolItem represents a boolean StackItem.
type BoolItem struct {
value bool
}

View file

@ -17,10 +17,12 @@ const (
breakState
)
// HasFlag check for State flag presence.
func (s State) HasFlag(f State) bool {
return s&f != 0
}
// String implements the stringer interface.
func (s State) String() string {
if s == noneState {
return "NONE"
@ -39,6 +41,7 @@ func (s State) String() string {
return strings.Join(ss, ", ")
}
// StateFromString converts string into the VM State.
func StateFromString(s string) (st State, err error) {
if s = strings.TrimSpace(s); s == "NONE" {
return noneState, nil
@ -60,10 +63,12 @@ func StateFromString(s string) (st State, err error) {
return
}
// MarshalJSON implements the json.Marshaler interface
func (s State) MarshalJSON() (data []byte, err error) {
return []byte(`"` + s.String() + `"`), nil
}
// UnmarshalJSON implements the json.Marshaler interface
func (s *State) UnmarshalJSON(data []byte) (err error) {
l := len(data)
if l < 2 || data[0] != '"' || data[l-1] != '"' {

View file

@ -1,5 +1,6 @@
package bar
// Bar is something used for testing purposes (TODO: move somewhere?)
type Bar struct {
X int
Y int

View file

@ -133,6 +133,7 @@ func (v *VM) LoadFile(path string) error {
return nil
}
// Load initializes the VM with the program given.
func (v *VM) Load(prog []byte) {
// clear all stacks, it could be a reload.
v.istack.Clear()

View file

@ -74,7 +74,7 @@ func newWallet(rw io.ReadWriter) *Wallet {
}
}
// CreatAccount generates a new account for the end user and encrypts
// CreateAccount generates a new account for the end user and encrypts
// the private key with the given passphrase.
func (w *Wallet) CreateAccount(name, passphrase string) error {
acc, err := NewAccount()