Merge pull request #180 from XRPLF/v0.1.x

chore: sync main branch with v0.1.x

Author: AdriaCarrera

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

@@ -1,25 +1,25 @@
 name: XRPL-GO Lint and Test
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ '**' ]
+    branches: ["**"]
 jobs:
   build:
     name: Lint and Test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-go@v3
-      with:
-        go-version: '1.23'
-        cache: true
-    
-    - name: Install golangci-lint
-      run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.64.8
-      
-    - name: Run linter
-      run: make lint
-      
-    - name: Run tests
-      run: make test-ci
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: "1.24"
+          cache: true
+
+      - name: Install golangci-lint
+        run: go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.2.2
+
+      - name: Run linter.
+        run: make lint
+
+      - name: Run tests
+        run: make test-ci

.golangci.yml

@@ -1,39 +1,36 @@
+version: "2"
+
 linters:
   enable:
-    - gofmt
     - govet
-    # - dupl TODO: enable
-    - gocritic
     - errcheck
     - staticcheck
     - ineffassign
-    - typecheck
-    - gosimple
-    - misspell
-    - unparam
     - unused
+    - gocritic
     - gosec
+    - misspell
+    - unparam
     - revive
+  exclusions:
+    rules:
+      - path: examples/
+        linters:
+          - revive
+        text: "package-comments"
+
+formatters:
+  enable:
+    - gofmt
 
 run:
-  timeout: 1m
   tests: false
-
-issues:
-  exclude-rules:
-    - path: examples/
-      linters:
-        - gosec
-    - path: _test\.go
-      linters:
-        - errcheck
-    - path: _mock\.go
-      linters:
-        - errcheck
-        - unused
+  timeout: 1m
 
 output:
   formats:
-    - format: colored-line-number
-  print-issued-lines: true
-  print-linter-name: true
+    text:
+      path: stdout
+      color: true
+      print-linter-name: true
+      print-issued-lines: true

CHANGELOG.md

@@ -7,11 +7,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Refactored
+
+- `TxResponse` `Meta` field type changed to `TxMetadataBuilder`, enabling custom parsing for specific transactions metadata such as `Payment`, `NFTokenMint`, etc.
+
+## [v0.1.13]
+
+### Added
+
+#### binary-codec
+
+- `Number` and `AssetScale` fields to `definitions.json`.
+
+#### xrpl
+
+- `PermissionedDEX` support (XLS-81d).
+
+### Fixed
+
+#### xrpl
+
+- `OracleSet` transaction to Flatten correctly and `Oracle` PriceDataSeries array.
+
+#### binary-codec
+
+- `definitions.json` where `LastUpdatedTime` had a typo issue.
+
+### Refactored
+
+#### xrpl
+
+- Replaced `bip32` and `bip39` dependencies due to repository deletion and, therefore, dependency outdated.
+
+## [v0.1.12]
+
 ### Added
 
 #### xrpl
 
 - Adds `PermissionedDomain` ledger entry type (XLS-80d).
+- Adds `TokenEscrow` support (XLS-85).
+
+### Fixed
+
+- Flatten function in Escrow transaction types for Destination and Owner fields.
 
 ## [v0.1.11]
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.23-alpine AS install
+FROM golang:1.24-alpine AS install
 RUN apk add --no-cache make git ca-certificates
 
 WORKDIR /app
@@ -7,7 +7,7 @@ RUN go mod download
 COPY . .
 
 FROM install AS lint
-RUN go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.64.8
+RUN go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.2.2
 RUN make lint
 
 FROM lint AS test

Makefile

@@ -8,6 +8,9 @@ INTEGRATION_TEST_PACKAGES = ./xrpl/transaction/integration
 PARALLEL_TESTS = 4
 TEST_TIMEOUT = 5m
 
+GOLANGCI_LINT_MAJOR_VERSION = 2
+GOLANGCI_LINT_VERSION = v2.2.2
+
 RIPPLED_IMAGE = rippleci/rippled:2.3.0
 
 ################################################################################
@@ -16,11 +19,13 @@ RIPPLED_IMAGE = rippleci/rippled:2.3.0
 
 lint:
 	@echo "Linting Go code..."
+	@go install github.com/golangci/golangci-lint/v$(GOLANGCI_LINT_MAJOR_VERSION)/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
 	@golangci-lint run
 	@echo "Linting complete!"
 
 lint-fix:
 	@echo "Fixing Go code..."
+	@go install github.com/golangci/golangci-lint/v$(GOLANGCI_LINT_MAJOR_VERSION)/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
 	@gofmt -w -s .
 	@echo "Fixing complete!"
 

address-codec/alphabet.go

@@ -2,6 +2,8 @@
 // btcsuite base58 repo: https://github.com/btcsuite/btcd/tree/master/btcutil/base58
 //
 // AUTOGENERATED by gen_alphabet.go; do not edit.
+
+// Package addresscodec provides base58 encoding and decoding functionality for XRPL addresses and keys.
 package addresscodec
 
 const (

address-codec/base58.go

@@ -20,7 +20,7 @@ var bigRadix = [...]*big.Int{
 
 var bigRadix10 = big.NewInt(58 * 58 * 58 * 58 * 58 * 58 * 58 * 58 * 58 * 58)
 
-// Encodes a byte slice to a base58 string encoded with the XRP alphabet.
+// EncodeBase58 encodes a byte slice to a base58 string using the XRP alphabet.
 func EncodeBase58(b []byte) string {
 
 	x := new(big.Int)
@@ -76,7 +76,7 @@ func EncodeBase58(b []byte) string {
 
 }
 
-// Decodes a modified base58 string to a byte slice.
+// DecodeBase58 decodes a modified base58 string to a byte slice.
 func DecodeBase58(b string) []byte {
 	answer := big.NewInt(0)
 	scratch := new(big.Int)

address-codec/base58check.go

@@ -12,8 +12,8 @@ func checksum(input []byte) (cksum [4]byte) {
 	return cksum
 }
 
-// CheckEncode prepends a version byte, appends a four byte checksum and returns
-// a base58 encoding of the byte slice.
+// Base58CheckEncode prepends a version byte, appends a four-byte checksum, and returns
+// the Base58Check encoding of the input byte slice.
 func Base58CheckEncode(input []byte, prefix ...byte) string {
 	b := make([]byte, 0, 1+len(input)+4)
 	b = append(b, prefix...)
@@ -24,7 +24,7 @@ func Base58CheckEncode(input []byte, prefix ...byte) string {
 	return EncodeBase58(b)
 }
 
-// CheckDecode decodes a string that was encoded with CheckEncode and verifies the checksum.
+// Base58CheckDecode decodes a Base58Check encoded string and verifies the checksum.
 func Base58CheckDecode(input string) (result []byte, err error) {
 	decoded := DecodeBase58(input)
 	if len(decoded) < 5 {

address-codec/codec.go

@@ -10,23 +10,33 @@ import (
 )
 
 const (
-	// Lengths in bytes
-	AccountAddressLength   = 20
+	// AccountAddressLength is the length in bytes of a classic account address.
+	AccountAddressLength = 20
+
+	// AccountPublicKeyLength is the length in bytes of an account public key.
 	AccountPublicKeyLength = 33
-	FamilySeedLength       = 16
-	NodePublicKeyLength    = 33
 
-	// Account/classic address prefix - value is 0
+	// FamilySeedLength is the length in bytes of a family seed.
+	FamilySeedLength = 16
+
+	// NodePublicKeyLength is the length in bytes of a node/validation public key.
+	NodePublicKeyLength = 33
+
+	// AccountAddressPrefix is the classic address prefix (0x00).
 	AccountAddressPrefix = 0x00
-	// Account public key prefix - value is 35
+
+	// AccountPublicKeyPrefix is the prefix for account public keys (0x23).
 	AccountPublicKeyPrefix = 0x23
-	// Family seed prefix - value is 33
+
+	// FamilySeedPrefix is the prefix for family seeds (0x21).
 	FamilySeedPrefix = 0x21
-	// Node/validation public key prefix - value is 28
+
+	// NodePublicKeyPrefix is the prefix for node/validation public keys (0x1C).
 	NodePublicKeyPrefix = 0x1C
 )
 
-// Returns the base58 encoding of byte slice, with the given type prefix, whilst ensuring that the byte slice is the expected length.
+// Encode returns the Base58Check encoding of a byte slice with the given type prefix,
+// ensuring the byte slice has the expected length.
 func Encode(b []byte, typePrefix []byte, expectedLength int) (string, error) {
 
 	if len(b) != expectedLength {
@@ -36,7 +46,7 @@ func Encode(b []byte, typePrefix []byte, expectedLength int) (string, error) {
 	return Base58CheckEncode(b, typePrefix...), nil
 }
 
-// Returns the byte slice decoding of the base58-encoded string and prefix.
+// Decode returns the decoded byte slice of the base58-encoded string for the given prefix.
 func Decode(b58string string, typePrefix []byte) ([]byte, error) {
 
 	prefixLength := len(typePrefix)
@@ -51,7 +61,7 @@ func Decode(b58string string, typePrefix []byte) ([]byte, error) {
 	return result, err
 }
 
-// Returns the classic address from public key hex string.
+// EncodeClassicAddressFromPublicKeyHex returns the classic address from a public key hex string.
 func EncodeClassicAddressFromPublicKeyHex(pubkeyhex string) (string, error) {
 
 	pubkey, err := hex.DecodeString(pubkeyhex)
@@ -76,7 +86,7 @@ func EncodeClassicAddressFromPublicKeyHex(pubkeyhex string) (string, error) {
 	return address, nil
 }
 
-// Returns the decoded 'accountID' byte slice of the classic address.
+// DecodeClassicAddressToAccountID returns the prefix and accountID byte slice from a classic address.
 func DecodeClassicAddressToAccountID(cAddress string) (typePrefix, accountID []byte, err error) {
 	if len(DecodeBase58(cAddress)) != 25 {
 		return nil, nil, ErrInvalidClassicAddress
@@ -94,7 +104,7 @@ func EncodeAccountIDToClassicAddress(accountID []byte) (string, error) {
 	return Base58CheckEncode(accountID, AccountAddressPrefix), nil
 }
 
-// Returns a base58 encoding of a seed.
+// EncodeSeed returns a base58 encoding of a seed using the specified encoding type.
 func EncodeSeed(entropy []byte, encodingType interfaces.CryptoImplementation) (string, error) {
 
 	if len(entropy) != FamilySeedLength {
@@ -112,7 +122,7 @@ func EncodeSeed(entropy []byte, encodingType interfaces.CryptoImplementation) (s
 
 }
 
-// Returns decoded seed and its algorithm.
+// DecodeSeed returns the decoded seed and its corresponding algorithm.
 func DecodeSeed(seed string) ([]byte, interfaces.CryptoImplementation, error) {
 
 	// decoded := DecodeBase58(seed)
@@ -130,7 +140,7 @@ func DecodeSeed(seed string) ([]byte, interfaces.CryptoImplementation, error) {
 
 }
 
-// Returns the node public key encoding of the byte slice as a base58 string.
+// EncodeNodePublicKey returns the base58 encoding of a node public key byte slice.
 func EncodeNodePublicKey(b []byte) (string, error) {
 
 	if len(b) != NodePublicKeyLength {
@@ -142,7 +152,7 @@ func EncodeNodePublicKey(b []byte) (string, error) {
 	return npk, nil
 }
 
-// Returns the decoded node public key encoding as a byte slice from a base58 string.
+// DecodeNodePublicKey returns the decoded node public key byte slice from a base58 string.
 func DecodeNodePublicKey(key string) ([]byte, error) {
 
 	decodedNodeKey, err := Decode(key, []byte{NodePublicKeyPrefix})
@@ -153,7 +163,7 @@ func DecodeNodePublicKey(key string) ([]byte, error) {
 	return decodedNodeKey, nil
 }
 
-// Returns the account public key encoding of the byte slice as a base58 string.
+// EncodeAccountPublicKey returns the base58 encoding of an account public key byte slice.
 func EncodeAccountPublicKey(b []byte) (string, error) {
 
 	if len(b) != AccountPublicKeyLength {
@@ -165,7 +175,7 @@ func EncodeAccountPublicKey(b []byte) (string, error) {
 	return apk, nil
 }
 
-// Returns the decoded account public key encoding as a byte slice from a base58 string.
+// DecodeAccountPublicKey returns the decoded account public key byte slice from a base58 string.
 func DecodeAccountPublicKey(key string) ([]byte, error) {
 
 	decodedAccountKey, err := Decode(key, []byte{AccountPublicKeyPrefix})

address-codec/errors.go

@@ -6,23 +6,23 @@ import (
 )
 
 var (
-	// Static errors
+	// address
 
-	// Invalid classic address
+	// ErrInvalidClassicAddress indicates an invalid classic address.
 	ErrInvalidClassicAddress = errors.New("invalid classic address")
-	// Invalid seed
+	// ErrInvalidSeed indicates an invalid seed; could not determine encoding algorithm.
 	ErrInvalidSeed = errors.New("invalid seed; could not determine encoding algorithm")
-
-	// Invalid x-address
+	// ErrInvalidXAddress indicates an invalid x-address.
 	ErrInvalidXAddress = errors.New("invalid x-address")
-	// Invalid tag
+	// ErrInvalidTag indicates an invalid tag.
 	ErrInvalidTag = errors.New("invalid tag")
-	// Invalid accountId
-	ErrInvalidAccountID = errors.New("invalid accountId")
-
-	// Invalid xrpl address, general error
+	// ErrInvalidAccountID indicates an invalid account ID.
+	ErrInvalidAccountID = errors.New("invalid account ID")
+	// ErrInvalidAddressFormat indicates a general invalid XRPL address format.
 	ErrInvalidAddressFormat = errors.New("invalid address format")
 
+	// checksum
+
 	// ErrChecksum indicates that the checksum of a check-encoded string does not verify against
 	// the checksum.
 	ErrChecksum = errors.New("checksum error")