Merge pull request #403 from sonicfromnewyoke/sonic/chore-add-golangci-lint

chore: add golangci lint

Author: HealthyBuilder

.github/workflows/lint.yml

@@ -0,0 +1,32 @@
+on:
+  push:
+    paths:
+      - "**.go"
+      - "go.mod"
+      - "go.sum"
+      - ".golangci.yml"
+      - ".github/workflows/lint.yml"
+  pull_request:
+    paths:
+      - "**.go"
+      - "go.mod"
+      - "go.sum"
+      - ".golangci.yml"
+      - ".github/workflows/lint.yml"
+name: lint
+jobs:
+  golangci-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.24.x"
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v7
+        with:
+          version: v2.11.4
+          args: --timeout=10m

.golangci.yml

@@ -0,0 +1,121 @@
+version: "2"
+
+run:
+  timeout: 10m
+
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+
+linters:
+  default: none
+  enable:
+    - errcheck
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    - errorlint
+    - misspell
+  settings:
+    errcheck:
+      check-type-assertions: false
+      check-blank: false
+      exclude-functions:
+        - (io.Closer).Close
+        - (*os.File).Close
+        - (net.Listener).Close
+        - (*net.TCPConn).Close
+        - (*net.UDPConn).Close
+        - (*bytes.Buffer).WriteString
+        - (*bytes.Buffer).WriteByte
+        - (*bytes.Buffer).Write
+        - (*strings.Builder).WriteString
+        - (*strings.Builder).WriteByte
+        - (*strings.Builder).WriteRune
+        - (*strings.Builder).Write
+        - (*go.uber.org/zap/buffer.Buffer).Write
+        - (*github.com/gorilla/websocket.Conn).SetReadDeadline
+        - (*github.com/gorilla/websocket.Conn).SetWriteDeadline
+        - fmt.Fprint
+        - fmt.Fprintln
+        - fmt.Fprintf
+        - github.com/gagliardetto/binary.EncodeCompactU16Length
+    errorlint:
+      errorf: true
+      asserts: true
+      comparison: true
+    staticcheck:
+      checks:
+        - all
+        # Known follow-ups — tracked separately, not in scope for the lint rollout:
+        - -SA1019 # deprecated API usage (logging package, ssh/terminal -> x/term, cloudkms.New)
+        - -ST1001 # dot imports (text/format, zap-box) — refactor-scale change
+        - -ST1003 # underscore naming in exported consts/params — breaking API change
+        - -ST1016 # receiver name consistency — ws pkg mixes "c"/"cl", refactor-scale
+        - -ST1019 # duplicate imports (same files)
+        - -QF1008 # could remove embedded field selector — stylistic, keep for legibility
+        - -SA9003 # empty branches — scaffolding in rpc/ws/examples/
+    misspell:
+      locale: US
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      # Test files: allow unchecked errors and legacy error comparisons.
+      - path: _test\.go
+        linters:
+          - errcheck
+          - errorlint
+      # CLI / cmd binaries: unchecked errors on stdout prints are fine.
+      - path: cmd/
+        linters:
+          - errcheck
+      - path: cli/
+        linters:
+          - errcheck
+      # WS subscription examples are demo code using `if false {}` to show
+      # multiple patterns side by side. Exclude from lint.
+      - path: rpc/ws/examples/
+        linters:
+          - govet
+          - staticcheck
+      # Unused identifiers that are either intentionally kept (lookup tables
+      # reserved for future work, logging-side-effect registrations) or live
+      # in code paths pending refactor. Tracked as follow-up.
+      - path: base58/tables\.go
+        linters:
+          - unused
+      - path: logging\.go
+        linters:
+          - unused
+      - path: diff/
+        linters:
+          - unused
+          - staticcheck
+      - path: text/encoder\.go
+        linters:
+          - staticcheck
+      - path: zap-box/
+        linters:
+          - unused
+      - path: programs/token(-2022)?/json\.go
+        linters:
+          - unused
+      - path: rpc/client\.go
+        linters:
+          - unused
+      - path: rpc/ws/client\.go
+        linters:
+          - unused
+
+formatters:
+  enable:
+    - gofmt
+    - goimports
+  exclusions:
+    generated: lax

CONTRIBUTING.md

@@ -8,6 +8,7 @@ We encourage everyone to contribute — submit issues, PRs, and discuss. Every k
 2. Make sure you have Go 1.24+ installed
 3. Run `go mod download` to fetch dependencies
 4. Run the tests to verify everything works: `go test ./... -count=1`
+5. Install [`golangci-lint`](https://golangci-lint.run/welcome/install/) (v2.11+) and run `golangci-lint run` to verify the linters pass
 
 ## Development Workflow
 
@@ -17,6 +18,36 @@ We encourage everyone to contribute — submit issues, PRs, and discuss. Every k
 4. Commit using [Conventional Commits](#commit-messages) format
 5. Open a pull request against `main`
 
+## Linting
+
+This project uses [golangci-lint](https://golangci-lint.run/) with the config at [`.golangci.yml`](.golangci.yml). The enabled linters are:
+
+| Linter         | Purpose                                                       |
+| -------------- | ------------------------------------------------------------- |
+| `errcheck`     | Flags unchecked errors                                        |
+| `govet`        | Go's standard static analyzer (composites, unusedresult, etc.) |
+| `ineffassign`  | Catches ineffectual assignments                               |
+| `staticcheck`  | Detects bugs, performance issues, and style violations        |
+| `unused`       | Finds unused constants, variables, functions, and types       |
+| `errorlint`    | Enforces `%w` wrapping and `errors.Is` / `errors.As`          |
+| `misspell`     | Catches common misspellings (US English)                      |
+| `gofmt`        | Standard Go formatting                                        |
+| `goimports`    | Import ordering and grouping                                  |
+
+Run locally:
+
+```bash
+# Run all linters
+golangci-lint run
+
+# Auto-fix where possible (errorlint, gofmt, goimports, misspell)
+golangci-lint run --fix
+```
+
+The `lint` CI check must pass before a PR can merge. If you need to disable a rule for a specific line, use `//nolint:<linter> // reason` and include a reason — unjustified nolint directives will be flagged in review.
+
+A small number of deprecation warnings (`SA1019`), stylistic checks (`ST1003` naming, `ST1001` dot imports), and known-refactor items are disabled in config and tracked as follow-up work — not as accepted debt. See [`.golangci.yml`](.golangci.yml) for the current exclusion list.
+
 ## Commit Messages
 
 This project uses [Conventional Commits](https://www.conventionalcommits.org/). All commit messages must follow this format:
@@ -95,6 +126,7 @@ Every pull request runs the following checks:
 | Check            | What it does                                                                                                                                             |
 | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **tests**        | Runs `go test ./...` across Go 1.24.x on ubuntu, macos, and windows. Only triggered when `.go`, `go.mod`, `go.sum`, or the workflow file itself changes. |
+| **lint**         | Runs `golangci-lint` on ubuntu-latest with the config at `.golangci.yml`. See [Linting](#linting) above.                                                 |
 | **semver-check** | Runs `gorelease` to compare the public API against the latest release tag. Fails if breaking changes are detected without a major version bump.          |
 | **commit-lint**  | Validates that all commits in the PR follow Conventional Commits format.                                                                                 |
 

README.md

@@ -3,6 +3,7 @@
 [![GoDoc](https://pkg.go.dev/badge/github.com/gagliardetto/solana-go?status.svg)](https://pkg.go.dev/github.com/gagliardetto/solana-go@v1.16.0?tab=doc)
 [![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/gagliardetto/solana-go?include_prereleases&label=release-tag)](https://github.com/gagliardetto/solana-go/releases)
 [![Build Status](https://github.com/gagliardetto/solana-go/workflows/tests/badge.svg?branch=main)](https://github.com/gagliardetto/solana-go/actions?query=branch%3Amain)
+[![Lint Status](https://github.com/gagliardetto/solana-go/workflows/lint/badge.svg?branch=main)](https://github.com/gagliardetto/solana-go/actions?query=branch%3Amain+workflow%3Alint)
 [![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/gagliardetto/solana-go/main)](https://www.tickgit.com/browse?repo=github.com/gagliardetto/solana-go&branch=main)
 [![Go Report Card](https://goreportcard.com/badge/github.com/gagliardetto/solana-go)](https://goreportcard.com/report/github.com/gagliardetto/solana-go)
 
@@ -831,7 +832,16 @@ Each subscription has a testable example in [`rpc/ws/example_test.go`](rpc/ws/ex
 
 We encourage everyone to contribute, submit issues, PRs, discuss. Every kind of help is welcome.
 
-Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on commit messages, semver policy, and CI checks.
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on commit messages, semver policy, linting, and CI checks.
+
+Before opening a PR, run:
+
+```bash
+go test ./... -count=1
+golangci-lint run
+```
+
+Both must pass in CI.
 
 ## License
 

base58/fuzz_test.go

@@ -10,10 +10,10 @@ import (
 // --- Encode fuzz: our output must match mr-tron for every input ---
 
 func FuzzEncode32_MatchesMrTron(f *testing.F) {
-	f.Add(make([]byte, 32))                // all zeros
-	f.Add(bytes.Repeat([]byte{0xff}, 32))  // all 0xFF
-	f.Add(append([]byte{1}, make([]byte, 31)...))  // single leading byte
-	f.Add(append(make([]byte, 31), 1))     // trailing 1
+	f.Add(make([]byte, 32))                       // all zeros
+	f.Add(bytes.Repeat([]byte{0xff}, 32))         // all 0xFF
+	f.Add(append([]byte{1}, make([]byte, 31)...)) // single leading byte
+	f.Add(append(make([]byte, 31), 1))            // trailing 1
 
 	f.Fuzz(func(t *testing.T, data []byte) {
 		if len(data) != 32 {
@@ -119,14 +119,14 @@ func FuzzDecode64_MatchesMrTron(f *testing.F) {
 
 func FuzzDecode32_NoPanic(f *testing.F) {
 	f.Add([]byte(""))
-	f.Add([]byte("0"))                        // invalid char
-	f.Add([]byte("O"))                        // invalid char
-	f.Add([]byte("I"))                        // invalid char
-	f.Add([]byte("l"))                        // invalid char
-	f.Add([]byte("\x00"))                     // null byte
-	f.Add([]byte("\xff"))                     // high byte
-	f.Add(bytes.Repeat([]byte("z"), 45))     // too long
-	f.Add(bytes.Repeat([]byte("1"), 50))     // way too long
+	f.Add([]byte("0"))                   // invalid char
+	f.Add([]byte("O"))                   // invalid char
+	f.Add([]byte("I"))                   // invalid char
+	f.Add([]byte("l"))                   // invalid char
+	f.Add([]byte("\x00"))                // null byte
+	f.Add([]byte("\xff"))                // high byte
+	f.Add(bytes.Repeat([]byte("z"), 45)) // too long
+	f.Add(bytes.Repeat([]byte("1"), 50)) // way too long
 
 	f.Fuzz(func(t *testing.T, data []byte) {
 		var dst [32]byte

base58/matmul_amd64.s

@@ -339,7 +339,7 @@ TEXT ·decodeMatMul32(SB), NOSPLIT|NOFRAME, $0-16
 	IMULQ	BX, AX
 	ADDQ	AX, R15
 
-	// Row 8: table[8] = {0,0,0,0,0,0,0,1} → bin[7] += intermediate[8]
+	// Row 8: table[8] = {0,0,0,0,0,0,0,1} -> bin[7] += intermediate[8]
 	MOVQ	64(SI), BX
 	ADDQ	BX, R15
 

base58/matmul_arm64.s

@@ -8,7 +8,7 @@
 // All intermediate values kept in registers to avoid memory traffic.
 // Fully unrolled, zero entries skipped.
 //
-// ARM64 MADD semantics in Go asm: MADD Rm, Ra, Rn, Rd → Rd = Ra + Rn * Rm
+// ARM64 MADD semantics in Go asm: MADD Rm, Ra, Rn, Rd -> Rd = Ra + Rn * Rm
 TEXT ·encodeMatMul32(SB), NOSPLIT|NOFRAME, $0-16
 	MOVD	src+0(FP), R0
 	MOVD	intermediate+8(FP), R2
@@ -258,7 +258,7 @@ TEXT ·decodeMatMul32(SB), NOSPLIT|NOFRAME, $0-16
 	MOVWU	252(R1), R20
 	MADD	R10, R19, R20, R19
 
-	// Row 8: table[8] = {0,0,0,0,0,0,0,1} → bin[7] += intermediate[8]
+	// Row 8: table[8] = {0,0,0,0,0,0,0,1} -> bin[7] += intermediate[8]
 	ADD	R21, R19, R19
 
 	// Store bin[0..7].

cli/cli.go

@@ -23,20 +23,20 @@ import (
 func GetDecryptPassphrase() (string, error) {
 	passphrase, err := GetPassword("Enter passphrase to decrypt your vault: ")
 	if err != nil {
-		return "", fmt.Errorf("reading password: %s", err)
+		return "", fmt.Errorf("reading password: %w", err)
 	}
 
 	return passphrase, nil
 }
 func GetEncryptPassphrase() (string, error) {
 	passphrase, err := GetPassword("Enter passphrase to encrypt your vault: ")
 	if err != nil {
-		return "", fmt.Errorf("reading password: %s", err)
+		return "", fmt.Errorf("reading password: %w", err)
 	}
 
 	passphraseConfirm, err := GetPassword("Confirm passphrase: ")
 	if err != nil {
-		return "", fmt.Errorf("reading confirmation password: %s", err)
+		return "", fmt.Errorf("reading confirmation password: %w", err)
 	}
 
 	if passphrase != passphraseConfirm {

cmd/slnc/cmd/root.go

@@ -30,7 +30,7 @@ import (
 // Version represents the cmd command version
 var Version string
 
-//const defaultRPCURL = "http://localhost:8899"
+// const defaultRPCURL = "http://localhost:8899"
 const defaultRPCURL = "http://api.mainnet-beta.solana.com"
 
 // RootCmd represents the eosc command

cmd/slnc/cmd/token_list_mints.go

@@ -43,12 +43,12 @@ var tokenListMintsCmd = &cobra.Command{
 				fmt.Sprintf("%d", m.Decimals),
 			}
 			if m.MintAuthority != nil {
-				line = append(line, fmt.Sprintf("%s", m.MintAuthority))
+				line = append(line, m.MintAuthority.String())
 			} else {
 				line = append(line, "No mint authority")
 			}
 			if m.FreezeAuthority != nil {
-				line = append(line, fmt.Sprintf("%s", m.FreezeAuthority))
+				line = append(line, m.FreezeAuthority.String())
 			} else {
 				line = append(line, "No freeze authority")
 			}