encoding/json: Add custom JSON package with build tag support for Sonic

.github/workflows/tests.yml

@@ -13,22 +13,32 @@ jobs:
             goarch: amd64
             psql: true
             skip_wrapper_tests: false
+            sonic: true
           - os: ubuntu-latest
             goarch: 386
             psql: true
             skip_wrapper_tests: true
+            sonic: true # sonic is disabled for 386 this ensures fall back to legacy code
           - os: macos-latest
             goarch: amd64
             psql: true
             skip_wrapper_tests: true
+            sonic: true
           - os: macos-13 # beta
             goarch: amd64
             psql: true
             skip_wrapper_tests: true
+            sonic: true
           - os: windows-latest
             goarch: amd64
             psql: true
             skip_wrapper_tests: true
+            sonic: true
+          - os: ubuntu-latest
+            goarch: amd64
+            psql: true
+            skip_wrapper_tests: false
+            sonic: false
 
     runs-on: ${{ matrix.os }}
 
@@ -84,6 +94,13 @@ jobs:
         echo "CGO_ENABLED=1" >> $GITHUB_ENV
       shell: bash
 
+    - name: Set GOFLAGS
+      run: |
+        if [ "${{ matrix.sonic }}" = "false" ]; then
+          echo "GOFLAGS=${GOFLAGS} -tags=sonic_off" >> $GITHUB_ENV
+        fi
+      shell: bash
+
     - name: Test
       run: | # PGSERVICEFILE isn't supported by lib/pq and will cause a panic if set
         unset PGSERVICEFILE
@@ -169,4 +186,4 @@ jobs:
         cd web/
         npm install
         npm run lint
-        npm run build
+        npm run build

.golangci.yml

@@ -25,7 +25,7 @@ linters:
     - copyloopvar
 #   - cyclop
     - decorder
-#   - depguard
+    - depguard
     - dogsled
 #   - dupl
     - dupword
@@ -117,6 +117,17 @@ linters:
 #   - zerologlint
 
 linters-settings:
+  depguard:
+    rules:
+      prevent_json_package_use:
+        list-mode: lax # allow unless explicitely denied
+        files:
+          - $all
+        allow:
+          - github.com/thrasher-corp/gocryptotrader/encoding/json
+        deny:
+          - pkg: encoding/json
+            desc: "Please use the custom JSON package github.com/thrasher-corp/gocryptotrader/encoding/json instead of encoding/json to allow sonic/json switching."
   govet:
     enable: 
       - shadow
@@ -141,7 +152,6 @@ linters-settings:
       - float-compare
       # We deliberately use Equal over Len to avoid spamming the contents of large Slices
       - len
-
 issues:
   max-issues-per-linter: 0
   max-same-issues: 0

Makefile

@@ -78,3 +78,7 @@ endef
 check-jq:
 	@printf "Checking if jq is installed... "
 	@command -v jq >/dev/null 2>&1 && { printf "OK\n"; } || { printf "FAILED. Please install jq to proceed.\n"; exit 1; }
+
+.PHONY: no_sonic
+no_sonic:
+	go build $(LDFLAGS) -tags "sonic_off" 

README.md

@@ -77,6 +77,7 @@ However, we welcome pull requests for any exchange which does not match this cri
 + WebGUI (discontinued).
 + Exchange HTTP mock testing. See [mock](/exchanges/mock/README.md).
 + Exchange multichain deposits and withdrawals for specific exchanges. See [multichain transfer support](/docs/MULTICHAIN_TRANSFER_SUPPORT.md).
++ Sonic JSON Integration. Revert back to the default Go 'encoding/json' package from the sonic library using go build tags `-tags=sonic_off`, by using the make file `make no_sonic`, or when compiling for a 32-bit architecture (GOARCH=386).
 
 ## Development Tracking
 
@@ -100,15 +101,11 @@ When submitting a PR, please abide by our coding guidelines:
 + Code must adhere to our [coding style](https://github.com/thrasher-corp/gocryptotrader/blob/master/.github/CONTRIBUTING.md).
 + Pull requests need to be based on and opened against the `master` branch.
 
-## Compiling instructions
+## Compilation and run instructions
 
-Download and install Go from [Go Downloads](https://golang.org/dl/) for your
-platform.
+Download and install Go from [Go Downloads](https://golang.org/dl/) for your platform.
 
-### Linux/OSX
-
-GoCryptoTrader is built using [Go Modules](https://github.com/golang/go/wiki/Modules) and requires Go 1.11 or above
-Using Go Modules you now clone this repository **outside** your GOPATH
+### Linux/macOS
 
 ```bash
 git clone https://github.com/thrasher-corp/gocryptotrader.git
@@ -124,11 +121,18 @@ cp config_example.json ~/.gocryptotrader/config.json
 git clone https://github.com/thrasher-corp/gocryptotrader.git
 cd gocryptotrader
 go build
+mkdir %AppData%\GoCryptoTrader
 copy config_example.json %APPDATA%\GoCryptoTrader\config.json
 ```
 
+By default, GoCryptoTrader uses the [Sonic JSON](https://github.com/bytedance/sonic) library for improved performance. To disable Sonic and revert to Go's encoding/json, build with the sonic_off tag:
+
+```bash
+go build -tags=sonic_off
+```
+
 + Make any necessary changes to the `config.json` file.
-+ Run the `gocryptotrader` binary file inside your GOPATH bin folder.
++ Run the gocryptotrader binary file.
 
 ## Donations
 
@@ -149,10 +153,10 @@ Binaries will be published once the codebase reaches a stable condition.
 |User|Contribution Amount|
 |--|--|
 | [thrasher-](https://github.com/thrasher-) | 704 |
-| [shazbert](https://github.com/shazbert) | 358 |
+| [shazbert](https://github.com/shazbert) | 359 |
 | [dependabot[bot]](https://github.com/apps/dependabot) | 351 |
 | [gloriousCode](https://github.com/gloriousCode) | 236 |
-| [gbjk](https://github.com/gbjk) | 113 |
+| [gbjk](https://github.com/gbjk) | 115 |
 | [dependabot-preview[bot]](https://github.com/apps/dependabot-preview) | 88 |
 | [xtda](https://github.com/xtda) | 47 |
 | [lrascao](https://github.com/lrascao) | 27 |

backtester/btcli/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"log"
 	"os"
@@ -13,6 +12,7 @@ import (
 
 	"github.com/thrasher-corp/gocryptotrader/common"
 	"github.com/thrasher-corp/gocryptotrader/core"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"github.com/thrasher-corp/gocryptotrader/gctrpc/auth"
 	"github.com/thrasher-corp/gocryptotrader/signaler"
 	"github.com/urfave/cli/v2"

backtester/config/backtesterconfig.go

@@ -1,14 +1,14 @@
 package config
 
 import (
-	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
 
 	"github.com/thrasher-corp/gocryptotrader/backtester/common"
 	"github.com/thrasher-corp/gocryptotrader/common/file"
 	gctconfig "github.com/thrasher-corp/gocryptotrader/config"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 )
 
 // ReadBacktesterConfigFromPath will take a config from a path

backtester/config/batcktesterconfig_test.go

@@ -1,13 +1,13 @@
 package config
 
 import (
-	"encoding/json"
 	"errors"
 	"path/filepath"
 	"testing"
 
 	"github.com/thrasher-corp/gocryptotrader/backtester/common"
 	"github.com/thrasher-corp/gocryptotrader/common/file"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 )
 
 func TestLoadBacktesterConfig(t *testing.T) {

backtester/config/strategyconfig.go

@@ -1,7 +1,6 @@
 package config
 
 import (
-	"encoding/json"
 	"fmt"
 	"os"
 	"strings"
@@ -13,6 +12,7 @@ import (
 	"github.com/thrasher-corp/gocryptotrader/backtester/eventhandlers/strategies/base"
 	gctcommon "github.com/thrasher-corp/gocryptotrader/common"
 	"github.com/thrasher-corp/gocryptotrader/common/file"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
 	"github.com/thrasher-corp/gocryptotrader/log"
 )

backtester/config/strategyconfig_test.go

@@ -1,7 +1,6 @@
 package config
 
 import (
-	"encoding/json"
 	"errors"
 	"os"
 	"path/filepath"
@@ -17,6 +16,7 @@ import (
 	"github.com/thrasher-corp/gocryptotrader/currency"
 	"github.com/thrasher-corp/gocryptotrader/database"
 	"github.com/thrasher-corp/gocryptotrader/database/drivers"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"github.com/thrasher-corp/gocryptotrader/exchanges/account"
 	"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
 	"github.com/thrasher-corp/gocryptotrader/exchanges/kline"

backtester/config/strategyconfigbuilder/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"bufio"
-	"encoding/json"
 	"errors"
 	"fmt"
 	"log"
@@ -23,6 +22,7 @@ import (
 	"github.com/thrasher-corp/gocryptotrader/database"
 	dbPSQL "github.com/thrasher-corp/gocryptotrader/database/drivers/postgres"
 	dbsqlite3 "github.com/thrasher-corp/gocryptotrader/database/drivers/sqlite3"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
 	gctkline "github.com/thrasher-corp/gocryptotrader/exchanges/kline"
 )

backtester/eventhandlers/statistics/statistics.go

@@ -1,7 +1,6 @@
 package statistics
 
 import (
-	"encoding/json"
 	"fmt"
 	"time"
 
@@ -17,6 +16,7 @@ import (
 	gctcommon "github.com/thrasher-corp/gocryptotrader/common"
 	"github.com/thrasher-corp/gocryptotrader/common/key"
 	"github.com/thrasher-corp/gocryptotrader/currency"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"github.com/thrasher-corp/gocryptotrader/log"
 )
 

backtester/main.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"encoding/json"
 	"flag"
 	"fmt"
 	"net/http"
@@ -15,6 +14,7 @@ import (
 	"github.com/thrasher-corp/gocryptotrader/backtester/plugins/strategies"
 	"github.com/thrasher-corp/gocryptotrader/common/convert"
 	"github.com/thrasher-corp/gocryptotrader/common/file"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"github.com/thrasher-corp/gocryptotrader/engine"
 	"github.com/thrasher-corp/gocryptotrader/log"
 	"github.com/thrasher-corp/gocryptotrader/signaler"

cmd/apichecker/apicheck.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"encoding/json"
 	"errors"
 	"flag"
 	"fmt"
@@ -18,6 +17,7 @@ import (
 
 	"github.com/thrasher-corp/gocryptotrader/common"
 	gctfile "github.com/thrasher-corp/gocryptotrader/common/file"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	exchange "github.com/thrasher-corp/gocryptotrader/exchanges"
 	"github.com/thrasher-corp/gocryptotrader/exchanges/request"
 	"github.com/thrasher-corp/gocryptotrader/log"

cmd/apichecker/apicheck_test.go

@@ -1,12 +1,12 @@
 package main
 
 import (
-	"encoding/json"
 	"os"
 	"reflect"
 	"testing"
 
 	gctfile "github.com/thrasher-corp/gocryptotrader/common/file"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	exchange "github.com/thrasher-corp/gocryptotrader/exchanges"
 	"github.com/thrasher-corp/gocryptotrader/log"
 )

cmd/config_builder/builder.go

@@ -2,11 +2,11 @@ package main
 
 import (
 	"context"
-	"encoding/json"
 	"log"
 	"sync"
 
 	"github.com/thrasher-corp/gocryptotrader/config"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"github.com/thrasher-corp/gocryptotrader/engine"
 	exchange "github.com/thrasher-corp/gocryptotrader/exchanges"
 )

cmd/documentation/documentation.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"encoding/json"
 	"errors"
 	"flag"
 	"fmt"
@@ -17,6 +16,7 @@ import (
 	"github.com/thrasher-corp/gocryptotrader/common"
 	"github.com/thrasher-corp/gocryptotrader/common/file"
 	"github.com/thrasher-corp/gocryptotrader/core"
+	"github.com/thrasher-corp/gocryptotrader/encoding/json"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 )

cmd/documentation/root_templates/root_readme.tmpl

@@ -78,6 +78,7 @@ However, we welcome pull requests for any exchange which does not match this cri
 + WebGUI (discontinued).
 + Exchange HTTP mock testing. See [mock](/exchanges/mock/README.md).
 + Exchange multichain deposits and withdrawals for specific exchanges. See [multichain transfer support](/docs/MULTICHAIN_TRANSFER_SUPPORT.md).
++ Sonic JSON Integration. Revert back to the default Go 'encoding/json' package from the sonic library using go build tags `-tags=sonic_off`, by using the make file `make no_sonic`, or when compiling for a 32-bit architecture (GOARCH=386).
 
 ## Development Tracking
 
@@ -101,15 +102,11 @@ When submitting a PR, please abide by our coding guidelines:
 + Code must adhere to our [coding style](https://github.com/thrasher-corp/gocryptotrader/blob/master/.github/CONTRIBUTING.md).
 + Pull requests need to be based on and opened against the `master` branch.
 
-## Compiling instructions
+## Compilation and run instructions
 
-Download and install Go from [Go Downloads](https://golang.org/dl/) for your
-platform.
+Download and install Go from [Go Downloads](https://golang.org/dl/) for your platform.
 
-### Linux/OSX
-
-GoCryptoTrader is built using [Go Modules](https://github.com/golang/go/wiki/Modules) and requires Go 1.11 or above
-Using Go Modules you now clone this repository **outside** your GOPATH
+### Linux/macOS
 
 ```bash
 git clone https://github.com/thrasher-corp/gocryptotrader.git
@@ -125,11 +122,18 @@ cp config_example.json ~/.gocryptotrader/config.json
 git clone https://github.com/thrasher-corp/gocryptotrader.git
 cd gocryptotrader
 go build
+mkdir %AppData%\GoCryptoTrader
 copy config_example.json %APPDATA%\GoCryptoTrader\config.json
 ```
 
+By default, GoCryptoTrader uses the [Sonic JSON](https://github.com/bytedance/sonic) library for improved performance. To disable Sonic and revert to Go's encoding/json, build with the sonic_off tag:
+
+```bash
+go build -tags=sonic_off
+```
+
 + Make any necessary changes to the `config.json` file.
-+ Run the `gocryptotrader` binary file inside your GOPATH bin folder.
++ Run the gocryptotrader binary file.
 
 {{template "donations" .}}