[TA-3384]: Refactor project structure

.github/workflows/xrpl-go-ci.yml

@@ -0,0 +1,29 @@
+name: XRPL-GO CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main, 'v*' ]
+jobs:
+  build:
+    name: Lint and Test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+    - name: Build Docker image
+      uses: docker/build-push-action@v2
+      with:
+        context: .
+        file: ./Dockerfile
+        push: false
+        load: true
+        tags: xrpl-go-ci:latest
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+    - name: Run linter
+      run: docker run --rm xrpl-go-ci:latest sh -c "make lint"
+    - name: Run tests
+      run: docker run --rm xrpl-go-ci:latest sh -c "make test-ci"

.go-version

@@ -1 +1 @@
-1.21.0
+1.22.0

Dockerfile

@@ -0,0 +1,14 @@
+FROM golang:1.22 AS install
+
+WORKDIR /app
+COPY go.mod go.sum ./
+
+RUN go mod download
+COPY . .
+
+FROM install AS lint
+RUN curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin
+RUN make lint
+
+FROM lint AS test
+RUN make test

Makefile

@@ -5,9 +5,35 @@ lint:
 	@golangci-lint run
 	@echo "Linting complete!"
 
-test:
+test-all:
 	@echo "Running Go tests..."
-	@go test $(shell go list ./... | grep -v /faucet | grep -v /examples)
+	@go test -v $(shell go list ./... | grep -v /faucet | grep -v /examples)
+	@echo "Tests complete!"
+
+test-binary-codec:
+	@echo "Running Go tests for binary codec package..."
+	@go test -v ./codec/binary/...
+	@echo "Tests complete!"
+
+test-address-codec:
+	@echo "Running Go tests for address codec package..."
+	@go test -v ./codec/address/...
+	@echo "Tests complete!"
+
+test-keypairs:
+	@echo "Running Go tests for keypairs package..."
+	@go test -v ./keypairs/...
+	@echo "Tests complete!"
+
+test-xrpl:
+	@echo "Running Go tests for xrpl package..."
+	@go test -v ./xrpl/...
+	@echo "Tests complete!"
+
+test-ci:
+	@echo "Running Go tests..."
+	@go clean -testcache
+	@go test -v $(shell go list ./... | grep -v /faucet | grep -v /examples)
 	@echo "Tests complete!"
 
 benchmark:

examples/jsonrpc-client/jsonrpc_client_example.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/Peersyst/xrpl-go/xrpl/model/requests/account"
+	"github.com/Peersyst/xrpl-go/xrpl/queries/account"
 	"github.com/Peersyst/xrpl-go/xrpl/rpc"
 )
 

examples/transactions/payment/main.go

@@ -5,8 +5,8 @@ import (
 
 	"github.com/Peersyst/xrpl-go/xrpl"
 	"github.com/Peersyst/xrpl-go/xrpl/faucet"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	transactions "github.com/Peersyst/xrpl-go/xrpl/transaction"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
 )
 

examples/wallet/generate_wallet_and_sign_tx.go

@@ -6,8 +6,8 @@ import (
 
 	addresscodec "github.com/Peersyst/xrpl-go/address-codec"
 	"github.com/Peersyst/xrpl-go/xrpl"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	transactions "github.com/Peersyst/xrpl-go/xrpl/transaction"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 )
 
 const (

examples/websocket/account-info/main.go

@@ -5,8 +5,8 @@ import (
 
 	"github.com/Peersyst/xrpl-go/xrpl"
 	"github.com/Peersyst/xrpl-go/xrpl/faucet"
-	"github.com/Peersyst/xrpl-go/xrpl/model/requests/account"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	"github.com/Peersyst/xrpl-go/xrpl/queries/account"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
 )
 

examples/websocket/account-objects/main.go

@@ -5,8 +5,8 @@ import (
 
 	"github.com/Peersyst/xrpl-go/xrpl"
 	"github.com/Peersyst/xrpl-go/xrpl/faucet"
-	"github.com/Peersyst/xrpl-go/xrpl/model/requests/account"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	"github.com/Peersyst/xrpl-go/xrpl/queries/account"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
 )
 

examples/websocket/autofill/main.go

@@ -5,8 +5,8 @@ import (
 	"fmt"
 
 	"github.com/Peersyst/xrpl-go/xrpl"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	transactions "github.com/Peersyst/xrpl-go/xrpl/transaction"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
 )
 

examples/websocket/clawback/main.go

@@ -6,8 +6,8 @@ import (
 	addresscodec "github.com/Peersyst/xrpl-go/address-codec"
 	"github.com/Peersyst/xrpl-go/xrpl"
 	"github.com/Peersyst/xrpl-go/xrpl/faucet"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	transactions "github.com/Peersyst/xrpl-go/xrpl/transaction"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
 )
 

examples/websocket/send-payment/main.go

@@ -6,10 +6,10 @@ import (
 	"strconv"
 
 	"github.com/Peersyst/xrpl-go/xrpl"
+	"github.com/Peersyst/xrpl-go/xrpl/currency"
 	"github.com/Peersyst/xrpl-go/xrpl/faucet"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
-	"github.com/Peersyst/xrpl-go/xrpl/utils"
+	transactions "github.com/Peersyst/xrpl-go/xrpl/transaction"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
 )
 
@@ -48,7 +48,7 @@ func main() {
 
 	fmt.Println("Balance: ", balance)
 
-	amount, err := utils.XrpToDrops("1")
+	amount, err := currency.XrpToDrops("1")
 	if err != nil {
 		fmt.Println(err)
 		return

examples/websocket/token-issuance/main.go

@@ -6,8 +6,8 @@ import (
 	addresscodec "github.com/Peersyst/xrpl-go/address-codec"
 	"github.com/Peersyst/xrpl-go/xrpl"
 	"github.com/Peersyst/xrpl-go/xrpl/faucet"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions"
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	transactions "github.com/Peersyst/xrpl-go/xrpl/transaction"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
 )
 

go.mod

@@ -1,6 +1,6 @@
 module github.com/Peersyst/xrpl-go
 
-go 1.21
+go 1.22
 
 toolchain go1.22.5
 
@@ -16,7 +16,6 @@ require (
 require (
 	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
-	github.com/stretchr/objx v0.5.2 // indirect
 )
 
 require (

go.sum

@@ -26,8 +26,6 @@ github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjY
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
-github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=

xrpl/utils/xrp_drops.go → xrpl/currency/native.go

@@ -1,4 +1,4 @@
-package utils
+package currency
 
 import (
 	"errors"

xrpl/utils/xrp_drops_test.go → xrpl/currency/native_test.go

@@ -1,4 +1,4 @@
-package utils
+package currency
 
 import (
 	"errors"

xrpl/utils/currency_converters.go → xrpl/currency/non-standard.go

@@ -1,4 +1,4 @@
-package utils
+package currency
 
 import (
 	"encoding/hex"

xrpl/utils/currency_converters_test.go → xrpl/currency/non-standard_test.go

@@ -1,4 +1,4 @@
-package utils
+package currency
 
 import (
 	"testing"

xrpl/hash/tx.go

@@ -10,10 +10,10 @@ import (
 	"github.com/Peersyst/xrpl-go/keypairs"
 )
 
-// HashSignedTx hashes a signed transaction blob
+// HashTxBlob hashes a signed transaction blob
 // It takes a transaction blob and returns the hash of the signed transaction.
 // It returns an error if the transaction blob is invalid.
-func HashSignedTx(txBlob string) (string, error) {
+func HashTxBlob(txBlob string) (string, error) {
 	tx, err := binarycodec.Decode(txBlob)
 	if err != nil {
 		return "", err

xrpl/hash/tx_test.go

@@ -2,7 +2,7 @@ package hash
 
 import "testing"
 
-func TestHashSignedTx(t *testing.T) {
+func TestHashTxBlob(t *testing.T) {
 	testCases := []struct {
 		name    string
 		txBlob  string
@@ -25,7 +25,7 @@ func TestHashSignedTx(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			got, err := HashSignedTx(tc.txBlob)
+			got, err := HashTxBlob(tc.txBlob)
 			if (err != nil) != tc.wantErr {
 				t.Errorf("HashSignedTx() error = %v, wantErr %v", err, tc.wantErr)
 				return

xrpl/model/ledger/account_root.go → xrpl/ledger-entry-types/account_root.go

@@ -1,7 +1,7 @@
 package ledger
 
 import (
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 )
 
 type AccountRoot struct {

xrpl/model/ledger/account_root_test.go → xrpl/ledger-entry-types/account_root_test.go

@@ -3,8 +3,8 @@ package ledger
 import (
 	"testing"
 
-	"github.com/Peersyst/xrpl-go/xrpl/model/transactions/types"
-	"github.com/Peersyst/xrpl-go/xrpl/test"
+	"github.com/Peersyst/xrpl-go/xrpl/testutil"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 )
 
 func TestAccountRoot(t *testing.T) {
@@ -39,7 +39,7 @@ func TestAccountRoot(t *testing.T) {
 	"TransferRate": 1004999999
 }`
 
-	if err := test.SerializeAndDeserialize(t, s, j); err != nil {
+	if err := testutil.SerializeAndDeserialize(t, s, j); err != nil {
 		t.Error(err)
 	}
 }