Merge pull request #86 from Peersyst/feat/project-reference

[TA-3821]: Project reference

Author: GuillemGarciaDev

address-codec/base58check.go

@@ -2,15 +2,6 @@ package addresscodec
 
 import (
 	"crypto/sha256"
-	"errors"
-)
-
-// ErrChecksum indicates that the checksum of a check-encoded string does not verify against
-// the checksum.
-// ErrInvalidFormat indicates that the check-encoded string has an invalid format.
-var (
-	ErrChecksum      = errors.New("checksum error")
-	ErrInvalidFormat = errors.New("invalid format: version and/or checksum bytes missing")
 )
 
 // checksum: first four bytes of sha256^2

address-codec/codec.go

@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"encoding/hex"
 	"errors"
-	"fmt"
 
 	"github.com/Peersyst/xrpl-go/address-codec/interfaces"
 	"github.com/Peersyst/xrpl-go/pkg/crypto"
@@ -27,24 +26,6 @@ const (
 	NodePublicKeyPrefix = 0x1C
 )
 
-var (
-	// Errors
-
-	// Invalid classic address
-	ErrInvalidClassicAddress = errors.New("invalid classic address")
-	ErrInvalidSeed           = errors.New("invalid seed; could not determine encoding algorithm")
-)
-
-type EncodeLengthError struct {
-	Instance string
-	Input    int
-	Expected int
-}
-
-func (e *EncodeLengthError) Error() string {
-	return fmt.Sprintf("`%v` length should be %v not %v", e.Instance, e.Expected, e.Input)
-}
-
 // Returns the base58 encoding of byte slice, with the given type prefix, whilst ensuring that the byte slice is the expected length.
 func Encode(b []byte, typePrefix []byte, expectedLength int) (string, error) {
 

address-codec/errors.go

@@ -0,0 +1,42 @@
+package addresscodec
+
+import (
+	"errors"
+	"fmt"
+)
+
+var (
+	// Static errors
+
+	// Invalid classic address
+	ErrInvalidClassicAddress = errors.New("invalid classic address")
+	// Invalid seed
+	ErrInvalidSeed = errors.New("invalid seed; could not determine encoding algorithm")
+
+	// Invalid x-address
+	ErrInvalidXAddress = errors.New("invalid x-address")
+	// Invalid tag
+	ErrInvalidTag = errors.New("invalid tag")
+	// Invalid accountId
+	ErrInvalidAccountID = errors.New("invalid accountId")
+
+	// ErrChecksum indicates that the checksum of a check-encoded string does not verify against
+	// the checksum.
+	ErrChecksum = errors.New("checksum error")
+	// ErrInvalidFormat indicates that the check-encoded string has an invalid format.
+	ErrInvalidFormat = errors.New("invalid format: version and/or checksum bytes missing")
+)
+
+// Dynamic errors
+
+// EncodeLengthError is an error that occurs when the length of the input does not match the expected length.
+type EncodeLengthError struct {
+	Instance string
+	Input    int
+	Expected int
+}
+
+// Error implements the error interface.
+func (e *EncodeLengthError) Error() string {
+	return fmt.Sprintf("`%v` length should be %v not %v", e.Instance, e.Expected, e.Input)
+}

address-codec/interfaces/crypto.go

@@ -1,5 +1,7 @@
 package interfaces
 
+// CryptoImplementation defines an interface for implementing cryptographic operations
+// required by address codec.
 type CryptoImplementation interface {
 	DeriveKeypair(decodedSeed []byte, validator bool) (string, string, error)
 	Sign(msg, privKey string) (string, error)

address-codec/x_codec.go

@@ -2,23 +2,13 @@ package addresscodec
 
 import (
 	"bytes"
-	"errors"
 )
 
 var (
 	MainnetXAddressPrefix = []byte{0x05, 0x44}
 	TestnetXAddressPrefix = []byte{0x04, 0x93}
 	// X-address length - value is 35
 	XAddressLength = 35
-
-	// Errors
-
-	// Invalid x-address
-	ErrInvalidXAddress = errors.New("invalid x-address")
-	// Invalid tag
-	ErrInvalidTag = errors.New("invalid tag")
-	// Invalid accountId
-	ErrInvalidAccountID = errors.New("invalid accountId")
 )
 
 // IsValidXAddress returns true if the x-address is valid. Otherwise, it returns false.

binary-codec/main.go binary-codec/codec.gobinary-codec/main.go renamed to binary-codec/codec.go

@@ -13,7 +13,10 @@ import (
 )
 
 var (
-	errSigningClaimFieldNotFound = errors.New("'Channel' & 'Amount' fields are both required, but were not found")
+	// Static errors
+
+	// ErrSigningClaimFieldNotFound is returned when the 'Channel' & 'Amount' fields are both required, but were not found.
+	ErrSigningClaimFieldNotFound = errors.New("'Channel' & 'Amount' fields are both required, but were not found")
 )
 
 const (
@@ -89,7 +92,7 @@ func EncodeForSigning(json map[string]any) (string, error) {
 func EncodeForSigningClaim(json map[string]any) (string, error) {
 
 	if json["Channel"] == nil || json["Amount"] == nil {
-		return "", errSigningClaimFieldNotFound
+		return "", ErrSigningClaimFieldNotFound
 	}
 
 	channel, err := types.NewHash256().FromJSON(json["Channel"])

binary-codec/main_test.go binary-codec/codec_test.gobinary-codec/main_test.go renamed to binary-codec/codec_test.go

@@ -565,15 +565,15 @@ func TestEncodeForSigningClaim(t *testing.T) {
 				"Amount": "1000",
 			},
 			output:      "",
-			expectedErr: errSigningClaimFieldNotFound,
+			expectedErr: ErrSigningClaimFieldNotFound,
 		},
 		{
 			description: "fail to encode claim - no amount",
 			input: map[string]any{
 				"Channel": "43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1",
 			},
 			output:      "",
-			expectedErr: errSigningClaimFieldNotFound,
+			expectedErr: ErrSigningClaimFieldNotFound,
 		},
 	}
 

binary-codec/definitions/definitions.go

@@ -2,56 +2,18 @@ package definitions
 
 import (
 	_ "embed"
-	"errors"
-	"fmt"
 
 	"github.com/ugorji/go/codec"
 )
 
 var (
+	//go:embed definitions.json
+	docBytes []byte
+
 	// definitions is the singleton instance of the Definitions struct.
 	definitions *Definitions
-
-	// Errors
-
-	// ErrUnableToCastFieldInfo is returned when the field info cannot be cast.
-	ErrUnableToCastFieldInfo = errors.New("unable to cast to field info")
 )
 
-//go:embed definitions.json
-var docBytes []byte
-
-func Get() *Definitions {
-	return definitions
-}
-
-type NotFoundError struct {
-	Instance string
-	Input    string
-}
-
-func (e *NotFoundError) Error() string {
-	return fmt.Sprintf("%v %v not found", e.Instance, e.Input)
-}
-
-type NotFoundErrorInt struct {
-	Instance string
-	Input    int32
-}
-
-func (e *NotFoundErrorInt) Error() string {
-	return fmt.Sprintf("%v %v not found", e.Instance, e.Input)
-}
-
-type NotFoundErrorFieldHeader struct {
-	Instance string
-	Input    FieldHeader
-}
-
-func (e *NotFoundErrorFieldHeader) Error() string {
-	return fmt.Sprintf("%v %v not found", e.Instance, e.Input)
-}
-
 type Definitions struct {
 	Types              map[string]int32
 	LedgerEntryTypes   map[string]int32
@@ -60,6 +22,11 @@ type Definitions struct {
 	TransactionTypes   map[string]int32
 	FieldIDNameMap     map[FieldHeader]string
 }
+
+func Get() *Definitions {
+	return definitions
+}
+
 type definitionsDoc struct {
 	Types              map[string]int32 `json:"TYPES"`
 	LedgerEntryTypes   map[string]int32 `json:"LEDGER_ENTRY_TYPES"`

binary-codec/definitions/errors.go

@@ -0,0 +1,48 @@
+package definitions
+
+import (
+	"errors"
+	"fmt"
+)
+
+var (
+	// Static errors
+
+	// ErrUnableToCastFieldInfo is returned when the field info cannot be cast.
+	ErrUnableToCastFieldInfo = errors.New("unable to cast to field info")
+)
+
+// Dynamic errors
+
+// NotFoundError is an error that occurs when a value is not found.
+type NotFoundError struct {
+	Instance string
+	Input    string
+}
+
+// Error implements the error interface.
+func (e *NotFoundError) Error() string {
+	return fmt.Sprintf("%v %v not found", e.Instance, e.Input)
+}
+
+// NotFoundErrorInt is an error that occurs when a value is not found.
+type NotFoundErrorInt struct {
+	Instance string
+	Input    int32
+}
+
+// Error implements the error interface.
+func (e *NotFoundErrorInt) Error() string {
+	return fmt.Sprintf("%v %v not found", e.Instance, e.Input)
+}
+
+// NotFoundErrorFieldHeader is an error that occurs when a value is not found.
+type NotFoundErrorFieldHeader struct {
+	Instance string
+	Input    FieldHeader
+}
+
+// Error implements the error interface.
+func (e *NotFoundErrorFieldHeader) Error() string {
+	return fmt.Sprintf("%v %v not found", e.Instance, e.Input)
+}

binary-codec/definitions/field_instance.go

@@ -2,13 +2,15 @@ package definitions
 
 import "github.com/ugorji/go/codec"
 
+// FieldInstance is a struct that represents a field instance.
 type FieldInstance struct {
 	FieldName string
 	*FieldInfo
 	FieldHeader *FieldHeader
 	Ordinal     int32
 }
 
+// FieldInfo is a struct that represents the field info.
 type FieldInfo struct {
 	Nth            int32
 	IsVLEncoded    bool
@@ -17,11 +19,13 @@ type FieldInfo struct {
 	Type           string
 }
 
+// FieldHeader is a struct that represents the field header.
 type FieldHeader struct {
 	TypeCode  int32
 	FieldCode int32
 }
 
+// CreateFieldHeader creates a new field header.
 func (d *Definitions) CreateFieldHeader(tc, fc int32) FieldHeader {
 	return FieldHeader{
 		TypeCode:  tc,