fix(SPV-1069) fix lint errors for "models" package (#800)

chris-4chain · web-flow · commit 74c0717f4685 · 2024-12-10T12:44:27.000+01:00
diff --git a/models/bsv/satoshis.go b/models/bsv/satoshis.go
@@ -1,3 +1,4 @@
 package bsv
 
+// Satoshis specifies a type that should be used to store value in satoshis
 type Satoshis uint64
diff --git a/models/contact.go b/models/contact.go
@@ -5,11 +5,13 @@ import (
 	"github.com/bitcoin-sv/spv-wallet/models/response"
 )
 
+// CreateContactResponse is a model for response on contact creation.
 type CreateContactResponse struct {
 	Contact        *Contact          `json:"contact"`
 	AdditionalInfo map[string]string `json:"additionalInfo"`
 }
 
+// Contact is a model for contact.
 type Contact struct {
 	common.Model
 
@@ -25,6 +27,7 @@ type Contact struct {
 	Status response.ContactStatus `json:"status" example:"unconfirmed"`
 }
 
+// AddAdditionalInfo adds additional information (as key-value map) to the response.
 func (m *CreateContactResponse) AddAdditionalInfo(k, v string) {
 	if m.AdditionalInfo == nil {
 		m.AdditionalInfo = make(map[string]string)
diff --git a/models/filter/access_key_filter.go b/models/filter/access_key_filter.go
@@ -3,7 +3,7 @@ package filter
 // AccessKeyFilter is a struct for handling request parameters for destination search requests
 type AccessKeyFilter struct {
 	// ModelFilter is a struct for handling typical request parameters for search requests
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	ModelFilter `json:",inline,squash"`
 
 	// RevokedRange specifies the time range when a record was revoked.
diff --git a/models/filter/contact_filter.go b/models/filter/contact_filter.go
@@ -3,7 +3,7 @@ package filter
 // ContactFilter is a struct for handling request parameters for contact search requests
 type ContactFilter struct {
 	// ModelFilter is a struct for handling typical request parameters for search requests
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	ModelFilter `json:",inline,squash"`
 	ID          *string `json:"id" example:"ffdbe74e-0700-4710-aac5-611a1f877c7f"`
 	FullName    *string `json:"fullName" example:"Alice"`
diff --git a/models/filter/destination_filter.go b/models/filter/destination_filter.go
@@ -3,7 +3,7 @@ package filter
 // DestinationFilter is a struct for handling request parameters for destination search requests
 type DestinationFilter struct {
 	// ModelFilter is a struct for handling typical request parameters for search requests
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	ModelFilter   `json:",inline,squash"`
 	LockingScript *string `json:"lockingScript,omitempty" example:"76a9147b05764a97f3b4b981471492aa703b188e45979b88ac"`
 	Address       *string `json:"address,omitempty" example:"1CDUf7CKu8ocTTkhcYUbq75t14Ft168K65"`
diff --git a/models/filter/generics.go b/models/filter/generics.go
@@ -16,7 +16,7 @@ type SearchModel[TFilter any] struct {
 	QueryParams *QueryParams `json:"params,omitempty" swaggertype:"object,string" example:"page:1,page_size:10,order_by_field:created_at,order_by_direction:desc"`
 }
 
-// DefaultsIfNil fills empty but neccessary fields with default values
+// DefaultsIfNil fills empty but necessary fields with default values
 func (sm *SearchModel[TFilter]) DefaultsIfNil() {
 	if sm.QueryParams == nil {
 		sm.QueryParams = DefaultQueryParams()
diff --git a/models/filter/paymail_filter.go b/models/filter/paymail_filter.go
@@ -3,7 +3,7 @@ package filter
 // PaymailFilter is a struct for handling request parameters for paymail_addresses search requests
 type PaymailFilter struct {
 	// ModelFilter is a struct for handling typical request parameters for search requests
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	ModelFilter `json:",inline,squash"`
 
 	ID         *string `json:"id,omitempty" example:"ffb86c103d17d87c15aaf080aab6be5415c9fa885309a79b04c9910e39f2b542"`
@@ -28,13 +28,15 @@ func (d *PaymailFilter) ToDbConditions() map[string]interface{} {
 	return conditions
 }
 
+// AdminPaymailFilter wraps the PaymailFilter providing additional fields for admin paymail search requests
 type AdminPaymailFilter struct {
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	PaymailFilter `json:",inline,squash"`
 
 	XpubID *string `json:"xpubId,omitempty" example:"79f90a6bab0a44402fc64828af820e9465645658aea2d138c5205b88e6dabd00"`
 }
 
+// ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
 func (d *AdminPaymailFilter) ToDbConditions() map[string]interface{} {
 	if d == nil {
 		return nil
diff --git a/models/filter/search_params.go b/models/filter/search_params.go
@@ -1,14 +1,18 @@
 package filter
 
+// Page is a struct for handling paging parameters for search requests
 type Page struct {
 	Number int    `json:"page,omitempty"`
 	Size   int    `json:"size,omitempty"`
 	Sort   string `json:"sort,omitempty"`
 	SortBy string `json:"sortBy,omitempty"`
 }
 
+// SearchParams is a generic struct for handling request parameters for search requests
 type SearchParams[T any] struct {
-	Page       Page                   `json:"paging,squash"`
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
+	Page Page `json:"paging,squash"`
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	Conditions T                      `json:"conditions,squash"`
 	Metadata   map[string]interface{} `json:"metadata,omitempty"`
 }
diff --git a/models/filter/transaction_admin_filter.go b/models/filter/transaction_admin_filter.go
@@ -2,7 +2,7 @@ package filter
 
 // AdminTransactionFilter extends TransactionFilter for admin-specific use, including xpubid filtering
 type AdminTransactionFilter struct {
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	TransactionFilter `json:",inline,squash"`
 	XPubID            *string `json:"xpubid,omitempty" example:"623bc25ce1c0fc510dea72b5ee27b2e70384c099f1f3dce9e73dd987198c3486"`
 }
diff --git a/models/filter/transaction_filter.go b/models/filter/transaction_filter.go
@@ -3,7 +3,7 @@ package filter
 // TransactionFilter is a struct for handling request parameters for transactions search requests
 type TransactionFilter struct {
 	// ModelFilter is a struct for handling typical request parameters for search requests
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	ModelFilter     `json:",inline,squash"`
 	Id              *string `json:"id,omitempty" example:"d425432e0d10a46af1ec6d00f380e9581ebf7907f3486572b3cd561a4c326e14"`
 	Hex             *string `json:"hex,omitempty"`
diff --git a/models/filter/utxo_filter.go b/models/filter/utxo_filter.go
@@ -4,7 +4,7 @@ package filter
 type UtxoFilter struct {
 
 	// ModelFilter is a struct for handling typical request parameters for search requests
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	ModelFilter `json:",inline,squash"`
 
 	TransactionID *string `json:"transactionId,omitempty" example:"5e17858ea0ca4155827754ba82bdcfcce108d5bb5b47fbb3aa54bd14540683c6"`
diff --git a/models/filter/xpub_filter.go b/models/filter/xpub_filter.go
@@ -3,7 +3,7 @@ package filter
 // XpubFilter is a struct for handling request parameters for utxo search requests
 type XpubFilter struct {
 	// ModelFilter is a struct for handling typical request parameters for search requests
-	//lint:ignore SA5008 We want to reuse json tags also to mapstructure.
+	//nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.
 	ModelFilter `json:",inline,squash"`
 
 	ID             *string `json:"id,omitempty" example:"00b953624f78004a4c727cd28557475d5233c15f17aef545106639f4d71b712d"`
diff --git a/models/optional/optional.go b/models/optional/optional.go
@@ -1,7 +1,9 @@
 package optional
 
+// Param is a pointer to a value of type T.
 type Param[T any] *T
 
+// Of returns a pointer to a value of type T.
 func Of[T any](v T) Param[T] {
 	return &v
 }
diff --git a/models/request/opreturn/data_type.go b/models/request/opreturn/data_type.go
@@ -5,8 +5,10 @@ import (
 	"errors"
 )
 
+// DataType represents the type of data in the OP_RETURN output.
 type DataType int
 
+// Enum values for DataType
 const (
 	DataTypeDefault DataType = iota
 	DataTypeStrings
@@ -17,7 +19,7 @@ const (
 func (d *DataType) UnmarshalJSON(data []byte) error {
 	var dataType string
 	if err := json.Unmarshal(data, &dataType); err != nil {
-		return err
+		return err //nolint:wrapcheck // UnmarshalJSON is run internally by json.Unmarshal on "DataType" object, so we don't want to wrap the error
 	}
 
 	switch dataType {
@@ -44,5 +46,5 @@ func (d DataType) MarshalJSON() ([]byte, error) {
 	default:
 		return nil, errors.New("invalid data type")
 	}
-	return json.Marshal(dataType)
+	return json.Marshal(dataType) //nolint:wrapcheck // MarshalJSON is run internally by json.Marshal on "DataType" object, so we don't want to wrap the error
 }
diff --git a/models/request/opreturn/output.go b/models/request/opreturn/output.go
@@ -1,10 +1,12 @@
 package opreturn
 
+// Output is a struct that represents the output containing OP_RETURN script
 type Output struct {
 	DataType DataType `json:"dataType,omitempty"`
 	Data     []string `json:"data"`
 }
 
+// GetType returns the string typename of the output
 func (o Output) GetType() string {
 	return "op_return"
 }
diff --git a/models/request/paymail/paymail_output.go b/models/request/paymail/paymail_output.go
@@ -5,12 +5,14 @@ import (
 	"github.com/bitcoin-sv/spv-wallet/models/optional"
 )
 
+// Output represents a paymail output.
 type Output struct {
 	To       string                 `json:"to"`
 	Satoshis bsv.Satoshis           `json:"satoshis"`
 	From     optional.Param[string] `json:"from,omitempty"`
 }
 
+// GetType returns a string typename of the output.
 func (o Output) GetType() string {
 	return "paymail"
 }
diff --git a/models/request/transaction_specification.go b/models/request/transaction_specification.go
@@ -45,7 +45,7 @@ func (dt *TransactionSpecification) unmarshalPartials(data []byte) (rawOutputs [
 	}
 
 	if err := json.Unmarshal(data, &temp); err != nil {
-		return nil, err
+		return nil, err //nolint:wrapcheck // unmarshalPartials is run internally by json.Unmarshal, so we don't want to wrap the error
 	}
 
 	return temp.Outputs, nil
@@ -58,7 +58,7 @@ func unmarshalOutputs(outputs []json.RawMessage) ([]Output, error) {
 			Type string `json:"type"`
 		}
 		if err := json.Unmarshal(rawOutput, &typeField); err != nil {
-			return nil, err
+			return nil, err //nolint:wrapcheck // unmarshalOutputs is run internally by json.Unmarshal, so we don't want to wrap the error
 		}
 
 		output, err := unmarshalOutput(rawOutput, typeField.Type)
@@ -88,5 +88,5 @@ func (dt *TransactionSpecification) MarshalJSON() ([]byte, error) {
 		temp.Outputs = append(temp.Outputs, out)
 	}
 
-	return json.Marshal(temp)
+	return json.Marshal(temp) //nolint:wrapcheck // MarshalJSON is run internally by json.Marshal, so we don't want to wrap the error
 }
diff --git a/models/request/transaction_specification_json.go b/models/request/transaction_specification_json.go
@@ -15,21 +15,21 @@ func unmarshalOutput(rawOutput json.RawMessage, outputType string) (Output, erro
 	case "op_return":
 		var out opreturn.Output
 		if err := json.Unmarshal(rawOutput, &out); err != nil {
-			return nil, err
+			return nil, err //nolint:wrapcheck // unmarshalOutput is run internally by json.Unmarshal, so we don't want to wrap the error
 		}
 		return out, nil
 	case "paymail":
 		var out paymailreq.Output
 		if err := json.Unmarshal(rawOutput, &out); err != nil {
-			return nil, err
+			return nil, err //nolint:wrapcheck // unmarshalOutput is run internally by json.Unmarshal, so we don't want to wrap the error
 		}
 		return out, nil
 	default:
 		return nil, errors.New("unsupported output type")
 	}
 }
 
-// expandOutputForMarshaling used by TransactionSpecification marshalling to expand Output object before marshalling.
+// expandOutputForMarshaling used by TransactionSpecification marshaling to expand Output object before marshaling.
 // IMPORTANT: Every time a new output type is added, it must be handled here also.
 func expandOutputForMarshaling(output Output) (any, error) {
 	switch o := output.(type) {
diff --git a/models/response/contact.go b/models/response/contact.go
@@ -1,10 +1,12 @@
 package response
 
+// CreateContactResponse is a model for response on contact creation.
 type CreateContactResponse struct {
 	Contact        *Contact          `json:"contact"`
 	AdditionalInfo map[string]string `json:"additionalInfo"`
 }
 
+// Contact is a model for contact.
 type Contact struct {
 	Model
 
@@ -20,15 +22,18 @@ type Contact struct {
 	Status ContactStatus `json:"status" example:"unconfirmed"`
 }
 
+// ContactStatus is a type for contact status.
 type ContactStatus string
 
+// Enum values for ContactStatus.
 const (
 	ContactNotConfirmed ContactStatus = "unconfirmed"
 	ContactAwaitAccept  ContactStatus = "awaiting"
 	ContactConfirmed    ContactStatus = "confirmed"
 	ContactRejected     ContactStatus = "rejected"
 )
 
+// AddAdditionalInfo adds additional information (as key-value map) to the response.
 func (m *CreateContactResponse) AddAdditionalInfo(k, v string) {
 	if m.AdditionalInfo == nil {
 		m.AdditionalInfo = make(map[string]string)
diff --git a/models/swagger/access_key_params.go b/models/swagger/access_key_params.go
@@ -6,6 +6,7 @@ import (
 	"github.com/bitcoin-sv/spv-wallet/models/filter"
 )
 
+// CommonFilteringQueryParams is a model for common filtering query parameters.
 type CommonFilteringQueryParams struct {
 	filter.Page `json:",inline"`
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`package bsv`
`2`	`2`
	`3`	`+// Satoshis specifies a type that should be used to store value in satoshis`
`3`	`4`	`type Satoshis uint64`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,13 @@ import (`
`5`	`5`	`"github.com/bitcoin-sv/spv-wallet/models/response"`
`6`	`6`	`)`
`7`	`7`
	`8`	`+// CreateContactResponse is a model for response on contact creation.`
`8`	`9`	`type CreateContactResponse struct {`
`9`	`10`	Contact *Contact `json:"contact"`
`10`	`11`	AdditionalInfo map[string]string `json:"additionalInfo"`
`11`	`12`	`}`
`12`	`13`
	`14`	`+// Contact is a model for contact.`
`13`	`15`	`type Contact struct {`
`14`	`16`	`common.Model`
`15`	`17`
`@@ -25,6 +27,7 @@ type Contact struct {`
`25`	`27`	Status response.ContactStatus `json:"status" example:"unconfirmed"`
`26`	`28`	`}`
`27`	`29`
	`30`	`+// AddAdditionalInfo adds additional information (as key-value map) to the response.`
`28`	`31`	`func (m *CreateContactResponse) AddAdditionalInfo(k, v string) {`
`29`	`32`	`if m.AdditionalInfo == nil {`
`30`	`33`	`m.AdditionalInfo = make(map[string]string)`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ type SearchModel[TFilter any] struct {`
`16`	`16`	QueryParams *QueryParams `json:"params,omitempty" swaggertype:"object,string" example:"page:1,page_size:10,order_by_field:created_at,order_by_direction:desc"`
`17`	`17`	`}`
`18`	`18`
`19`		`-// DefaultsIfNil fills empty but neccessary fields with default values`
	`19`	`+// DefaultsIfNil fills empty but necessary fields with default values`
`20`	`20`	`func (sm *SearchModel[TFilter]) DefaultsIfNil() {`
`21`	`21`	`if sm.QueryParams == nil {`
`22`	`22`	`sm.QueryParams = DefaultQueryParams()`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ package filter`
`2`	`2`
`3`	`3`	`// AdminTransactionFilter extends TransactionFilter for admin-specific use, including xpubid filtering`
`4`	`4`	`type AdminTransactionFilter struct {`
`5`		`- //lint:ignore SA5008 We want to reuse json tags also to mapstructure.`
	`5`	`+ //nolint:staticcheck // SA5008 We want to reuse json tags also to mapstructure.`
`6`	`6`	TransactionFilter `json:",inline,squash"`
`7`	`7`	XPubID *string `json:"xpubid,omitempty" example:"623bc25ce1c0fc510dea72b5ee27b2e70384c099f1f3dce9e73dd987198c3486"`
`8`	`8`	`}`