fix: fixes golint errors

apis/arc/fee_quote.go

@@ -1,4 +1,4 @@
-// arc package provides the API structures for the ARC service
+// Package arc provides the API structures for the ARC service
 package arc
 
 import "github.com/libsv/go-bt/v2"

apis/arc/tx_status.go

@@ -3,49 +3,49 @@ package arc
 // TxStatus is the status of the transaction
 type TxStatus string
 
+// List of statuses available here: https://github.com/bitcoin-sv/arc
 const (
-	// List of statuses available here: https://github.com/bitcoin-sv/arc
-	UNKNOWN              TxStatus = "UNKNOWN"              // 0
-	QUEUED               TxStatus = "QUEUED"               // 1
-	RECEIVED             TxStatus = "RECEIVED"             // 2
-	STORED               TxStatus = "STORED"               // 3
-	ANNOUNCED_TO_NETWORK TxStatus = "ANNOUNCED_TO_NETWORK" // 4
-	REQUESTED_BY_NETWORK TxStatus = "REQUESTED_BY_NETWORK" // 5
-	SENT_TO_NETWORK      TxStatus = "SENT_TO_NETWORK"      // 6
-	ACCEPTED_BY_NETWORK  TxStatus = "ACCEPTED_BY_NETWORK"  // 7
-	SEEN_ON_NETWORK      TxStatus = "SEEN_ON_NETWORK"      // 8
-	MINED                TxStatus = "MINED"                // 9
-	CONFIRMED            TxStatus = "CONFIRMED"            // 108
-	REJECTED             TxStatus = "REJECTED"             // 109
+	// Unknown contains value for unknown status
+	Unknown TxStatus = "UNKNOWN" // 0
+	// Queued contains value for queued status
+	Queued TxStatus = "QUEUED" // 1
+	// Received contains value for received status
+	Received TxStatus = "RECEIVED" // 2
+	// Stored contains value for stored status
+	Stored TxStatus = "STORED" // 3
+	// AnnouncedToNetwork contains value for announced to network status
+	AnnouncedToNetwork TxStatus = "ANNOUNCED_TO_NETWORK" // 4
+	// RequestedByNetwork contains value for requested by network status
+	RequestedByNetwork TxStatus = "REQUESTED_BY_NETWORK" // 5
+	// SentToNetwork contains value for sent to network status
+	SentToNetwork TxStatus = "SENT_TO_NETWORK" // 6
+	// AcceptedByNetwork contains value for accepted by network status
+	AcceptedByNetwork TxStatus = "ACCEPTED_BY_NETWORK" // 7
+	// SeenOnNetwork contains value for seen on network status
+	SeenOnNetwork TxStatus = "SEEN_ON_NETWORK" // 8
+	// Mined contains value for mined status
+	Mined TxStatus = "MINED" // 9
+	// Confirmed contains value for confirmed status
+	Confirmed TxStatus = "CONFIRMED" // 108
+	// Rejected contains value for rejected status
+	Rejected TxStatus = "REJECTED" // 109
 )
 
 // String returns the string representation of the TxStatus
 func (s TxStatus) String() string {
 	statuses := map[TxStatus]string{
-		// UNKNOWN contains value for unknown status
-		UNKNOWN: "UNKNOWN",
-		// QUEUED contains value for queued status
-		QUEUED: "QUEUED",
-		// RECEIVED contains value for received status
-		RECEIVED: "RECEIVED",
-		// STORED contains value for stored status
-		STORED: "STORED",
-		// ANNOUNCED_TO_NETWORK contains value for announced to network status
-		ANNOUNCED_TO_NETWORK: "ANNOUNCED_TO_NETWORK",
-		// REQUESTED_BY_NETWORK contains value for requested by network status
-		REQUESTED_BY_NETWORK: "REQUESTED_BY_NETWORK",
-		// SENT_TO_NETWORK contains value for sent to network status
-		SENT_TO_NETWORK: "SENT_TO_NETWORK",
-		// ACCEPTED_BY_NETWORK contains value for accepted by network status
-		ACCEPTED_BY_NETWORK: "ACCEPTED_BY_NETWORK",
-		// SEEN_ON_NETWORK contains value for seen on network status
-		SEEN_ON_NETWORK: "SEEN_ON_NETWORK",
-		// MINED contains value for mined status
-		MINED: "MINED",
-		// CONFIRMED contains value for confirmed status
-		CONFIRMED: "CONFIRMED",
-		// REJECTED contains value for rejected status
-		REJECTED: "REJECTED",
+		Unknown:            "UNKNOWN",
+		Queued:             "QUEUED",
+		Received:           "RECEIVED",
+		Stored:             "STORED",
+		AnnouncedToNetwork: "ANNOUNCED_TO_NETWORK",
+		RequestedByNetwork: "REQUESTED_BY_NETWORK",
+		SentToNetwork:      "SENT_TO_NETWORK",
+		AcceptedByNetwork:  "ACCEPTED_BY_NETWORK",
+		SeenOnNetwork:      "SEEN_ON_NETWORK",
+		Mined:              "MINED",
+		Confirmed:          "CONFIRMED",
+		Rejected:           "REJECTED",
 	}
 
 	if status, ok := statuses[s]; ok {
@@ -58,18 +58,18 @@ func (s TxStatus) String() string {
 // MapTxStatusToInt maps the TxStatus to an int value
 func MapTxStatusToInt(status TxStatus) (int, bool) {
 	waitForStatusMap := map[TxStatus]int{
-		UNKNOWN:              0,
-		QUEUED:               1,
-		RECEIVED:             2,
-		STORED:               3,
-		ANNOUNCED_TO_NETWORK: 4,
-		REQUESTED_BY_NETWORK: 5,
-		SENT_TO_NETWORK:      6,
-		ACCEPTED_BY_NETWORK:  7,
-		SEEN_ON_NETWORK:      8,
-		MINED:                9,
-		CONFIRMED:            108,
-		REJECTED:             109,
+		Unknown:            0,
+		Queued:             1,
+		Received:           2,
+		Stored:             3,
+		AnnouncedToNetwork: 4,
+		RequestedByNetwork: 5,
+		SentToNetwork:      6,
+		AcceptedByNetwork:  7,
+		SeenOnNetwork:      8,
+		Mined:              9,
+		Confirmed:          108,
+		Rejected:           109,
 	}
 
 	value, ok := waitForStatusMap[status]

apis/mapi/fee_quote.go

@@ -1,3 +1,4 @@
+// Package mapi provides the API structures for the mAPI service
 package mapi
 
 import (
@@ -105,7 +106,7 @@ type (
 		Bytes    int `json:"bytes"`    // Number of bytes that the Fee covers
 	}
 
-	// feeObj displays the MiningFee as well as the RelayFee for a specific
+	// FeeObj displays the MiningFee as well as the RelayFee for a specific
 	// FeeType, for example 'standard' or 'data'
 	// see https://github.com/bitcoin-sv-specs/brfc-merchantapi#expanded-payload-1
 	FeeObj struct {

client.go

@@ -1,10 +1,11 @@
 package minercraft
 
 import (
+	"crypto/rand"
 	"encoding/json"
 	"errors"
 	"fmt"
-	"math/rand"
+	"math/big"
 	"net"
 	"net/http"
 	"strings"
@@ -134,6 +135,8 @@ func MinerByID(miners []*Miner, minerID string) *Miner {
 	}
 	return nil
 }
+
+// MinerAPIByMinerID will return a miner's API given a miner id and API type
 func (c *Client) MinerAPIByMinerID(minerID string, apiType APIType) (*API, error) {
 	for _, minerAPI := range c.minerAPIs {
 		if minerAPI.MinerID == minerID {
@@ -369,16 +372,16 @@ func (c *Client) isUniqueMinerID(minerID string) bool {
 
 // generateUniqueMinerID will generate a unique miner ID
 func generateUniqueMinerID() string {
-	// Implement your logic to generate a unique miner ID
-	// Here's a simple example that generates a random ID
 	const idLength = 8
 	const letters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
 
-	rand.Seed(time.Now().UnixNano())
-
 	id := make([]byte, idLength)
 	for i := range id {
-		id[i] = letters[rand.Intn(len(letters))]
+		num, err := rand.Int(rand.Reader, big.NewInt(int64(len(letters))))
+		if err != nil {
+			return ""
+		}
+		id[i] = letters[num.Int64()]
 	}
 
 	return string(id)

config.go

@@ -138,9 +138,9 @@ const KnownMiners = `
 ]
 `
 
+// KnownMinersAPIs is a pre-filled list of known miners with their APIs
 // Any pre-filled tokens are for free use only
 // update your custom token with client.MinerUpdateToken("name", "token")
-// KnownMinersAPIs is a pre-filled list of known miners with their APIs
 const KnownMinersAPIs = `
 [
 	{

definitions.go

@@ -54,7 +54,7 @@ type APISpecificRoute struct {
 type JSONEnvelope struct {
 	Miner     *Miner  `json:"miner"`     // Custom field for our internal Miner configuration
 	Validated bool    `json:"validated"` // Custom field if the signature has been validated
-	ApiType   APIType `json:"apiType"`   // Custom field for the API type
+	APIType   APIType `json:"apiType"`   // Custom field for the API type
 	envelope.JSONEnvelope
 }
 

policy_quote.go

@@ -11,18 +11,22 @@ import (
 	"github.com/tonicpow/go-minercraft/apis/mapi"
 )
 
+// PolicyQuoteModelAdapter is the interface for the adapter to get the policy quote response
 type PolicyQuoteModelAdapter interface {
 	GetPolicyData() *PolicyPayload
 }
 
+// PolicyQuoteMapiAdapter is the adapter for the mAPI response
 type PolicyQuoteMapiAdapter struct {
 	*mapi.PolicyQuoteModel
 }
 
+// PolicyQuoteArcAdapter is the adapter for the Arc response
 type PolicyQuoteArcAdapter struct {
 	*arc.PolicyQuoteModel
 }
 
+// UnifiedPolicy is the unmarshalled version of the policy
 type UnifiedPolicy struct {
 	AcceptNonStdOutputs             bool              `json:"acceptnonstdoutputs"`
 	DataCarrier                     bool              `json:"datacarrier"`
@@ -45,6 +49,7 @@ type UnifiedPolicy struct {
 	MaxTxSigOpsCount uint32 `json:"maxtxsigopscount"`
 }
 
+// UnifiedFeePayload is the unmarshalled version of the payload envelope
 type UnifiedFeePayload struct {
 	mapi.FeePayloadFields
 	Fees []*bt.Fee `json:"fees"`
@@ -95,7 +100,7 @@ func (c *Client) PolicyQuote(ctx context.Context, miner *Miner) (*PolicyQuoteRes
 
 	quoteResponse := &PolicyQuoteResponse{
 		JSONEnvelope: JSONEnvelope{
-			ApiType: c.apiType,
+			APIType: c.apiType,
 			Miner:   result.Miner,
 		},
 	}
@@ -105,7 +110,7 @@ func (c *Client) PolicyQuote(ctx context.Context, miner *Miner) (*PolicyQuoteRes
 	switch c.apiType {
 	case MAPI:
 		model := &mapi.PolicyQuoteModel{}
-		err := quoteResponse.process(result.Miner, result.Response.BodyContents)
+		err = quoteResponse.process(result.Miner, result.Response.BodyContents)
 		if err != nil || len(quoteResponse.Payload) <= 0 {
 			return nil, err
 		}
@@ -118,7 +123,7 @@ func (c *Client) PolicyQuote(ctx context.Context, miner *Miner) (*PolicyQuoteRes
 		modelAdapter = &PolicyQuoteMapiAdapter{PolicyQuoteModel: model}
 	case Arc:
 		model := &arc.PolicyQuoteModel{}
-		err := json.Unmarshal(result.Response.BodyContents, model)
+		err = json.Unmarshal(result.Response.BodyContents, model)
 		if err != nil {
 			return nil, err
 		}
@@ -146,6 +151,7 @@ func (c *Client) PolicyQuote(ctx context.Context, miner *Miner) (*PolicyQuoteRes
 	return quoteResponse, nil
 }
 
+// GetPolicyData will return the policy data from the mapi adapter
 func (a *PolicyQuoteMapiAdapter) GetPolicyData() *PolicyPayload {
 	// Tworzenie instancji UnifiedFeePayload
 	feePayload := UnifiedFeePayload{
@@ -171,6 +177,7 @@ func (a *PolicyQuoteMapiAdapter) GetPolicyData() *PolicyPayload {
 
 	callbacks := make([]*mapi.PolicyCallback, len(a.Callbacks))
 	for i, cb := range a.Callbacks {
+		//nolint:gosec,exportloopref // ignore those linter errors
 		callbacks[i] = &cb
 	}
 
@@ -201,6 +208,7 @@ func (a *PolicyQuoteMapiAdapter) GetPolicyData() *PolicyPayload {
 	return policyPayload
 }
 
+// GetPolicyData will return the policy data from the arc adapter
 func (a *PolicyQuoteArcAdapter) GetPolicyData() *PolicyPayload {
 
 	feePayload := UnifiedFeePayload{

query_transaction.go

@@ -23,14 +23,17 @@ const QueryTransactionFailure = "failure"
 // QueryTransactionInMempoolFailure in mempool but not in a block yet
 const QueryTransactionInMempoolFailure = "Transaction in mempool but not yet in block"
 
+// QueryTxModelAdapter is the interface for the adapter to get the query tx response
 type QueryTxModelAdapter interface {
 	GetQueryTxResponse() *QueryTxResponse
 }
 
+// QueryTxMapiAdapter is the adapter for the mAPI response
 type QueryTxMapiAdapter struct {
 	*mapi.QueryTxModel
 }
 
+// QueryTxArcAdapter is the adapter for the Arc response
 type QueryTxArcAdapter struct {
 	*arc.QueryTxModel
 }
@@ -183,7 +186,7 @@ func (c *Client) QueryTransaction(ctx context.Context, miner *Miner, txID string
 
 	queryResponse := &QueryTransactionResponse{
 		JSONEnvelope: JSONEnvelope{
-			ApiType: c.apiType,
+			APIType: c.apiType,
 			Miner:   result.Miner,
 		},
 	}
@@ -281,6 +284,7 @@ func queryTransaction(ctx context.Context, client *Client, miner *Miner, txHash
 	return
 }
 
+// GetQueryTxResponse will return the query tx response from mapi adapter
 func (m *QueryTxMapiAdapter) GetQueryTxResponse() *QueryTxResponse {
 	response := &QueryTxResponse{
 		TxID:        m.TxID,
@@ -301,6 +305,7 @@ func (m *QueryTxMapiAdapter) GetQueryTxResponse() *QueryTxResponse {
 	return response
 }
 
+// GetQueryTxResponse will return the query tx response from arc adapter
 func (m *QueryTxArcAdapter) GetQueryTxResponse() *QueryTxResponse {
 	response := &QueryTxResponse{
 		TxID:        m.TxID,