fix(xrpl): add metadata typed fields

Author: GuillemGarciaDev

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Refactored
 
-- `TxResponse` `meta` field type changed to `TxMetadataBuilder`, enabling custom parsing for specific transactions metadata such as `Payment`, `NFTokenMint`, etc.
+- `TxResponse` `Meta` field type changed to `TxMetadataBuilder`, enabling custom parsing for specific transactions metadata such as `Payment`, `NFTokenMint`, etc.
 
 ## [v0.1.13]
 

xrpl/transaction/metadata.go

@@ -2,6 +2,7 @@ package transaction
 
 import (
 	"github.com/Peersyst/xrpl-go/xrpl/ledger-entry-types"
+	"github.com/Peersyst/xrpl-go/xrpl/transaction/types"
 )
 
 // TxMeta represents the metadata interface for a transaction.
@@ -21,7 +22,7 @@ type TxObjMeta struct {
 	DeliveredAmount any `json:"delivered_amount,omitempty"`
 
 	// ParentBatchID is the hash of the parent Batch transaction when this transaction is executed as part of a batch.
-	ParentBatchID *string `json:"ParentBatchID,omitempty"`
+	ParentBatchID *types.BatchID `json:"ParentBatchID,omitempty"`
 }
 
 // TxMeta implements the TxMeta interface for TxObjMeta.

xrpl/transaction/metadata_builder.go

@@ -15,22 +15,22 @@ type TxMetadataBuilder struct {
 	DeliveredAmount any `json:"delivered_amount,omitempty"`
 
 	// ParentBatchID is the hash of the parent Batch transaction when this transaction is executed as part of a batch.
-	ParentBatchID *string `json:"ParentBatchID,omitempty"`
+	ParentBatchID *types.BatchID `json:"ParentBatchID,omitempty"`
 
 	// rippled 1.11.0 or later.
 	// Only available in: NFTokenMintMetadata, NFTokenAcceptOfferMetadata
 	NFTokenID *types.NFTokenID `json:"nftoken_id,omitempty"`
 
 	// OfferID is a string of Amount is present.
 	// Only available in: NFTokenMintMetadata, NFTokenCreateOfferMetadata
-	OfferID *string `json:"offer_id,omitempty"`
+	OfferID *types.OfferID `json:"offer_id,omitempty"`
 
 	// rippled 1.11.0 or later.
 	// Only available in: NFTokenCancelOfferMetadata
 	NFTokenIDs []types.NFTokenID `json:"nftoken_ids,omitempty"`
 
 	// Only available in: MPTokenIssuanceCreate
-	MPTIssuanceID *string `json:"mpt_issuance_id,omitempty"`
+	MPTIssuanceID *types.MPTIssuanceID `json:"mpt_issuance_id,omitempty"`
 }
 
 // AsPaymentMetadata returns the PaymentMetadata.

xrpl/transaction/metadata_builder_test.go

@@ -8,6 +8,8 @@ import (
 )
 
 func TestTxMetadataBuilder_AsTxObjMeta(t *testing.T) {
+	batchId := types.BatchID("ABCD1234")
+
 	tests := []struct {
 		name     string
 		builder  TxMetadataBuilder
@@ -28,7 +30,7 @@ func TestTxMetadataBuilder_AsTxObjMeta(t *testing.T) {
 				TransactionIndex:       42,
 				TransactionResult:      "tesSUCCESS",
 				DeliveredAmount:        "1000000",
-				ParentBatchID:          stringPtr("ABCD1234"),
+				ParentBatchID:          &batchId,
 			},
 			expected: TxObjMeta{
 				AffectedNodes: []AffectedNode{
@@ -43,7 +45,7 @@ func TestTxMetadataBuilder_AsTxObjMeta(t *testing.T) {
 				TransactionIndex:       42,
 				TransactionResult:      "tesSUCCESS",
 				DeliveredAmount:        "1000000",
-				ParentBatchID:          stringPtr("ABCD1234"),
+				ParentBatchID:          &batchId,
 			},
 		},
 		{
@@ -87,6 +89,8 @@ func TestTxMetadataBuilder_AsTxObjMeta(t *testing.T) {
 }
 
 func TestTxMetadataBuilder_AsPaymentMetadata(t *testing.T) {
+	batchID := types.BatchID("EFGH5678")
+
 	tests := []struct {
 		name     string
 		builder  TxMetadataBuilder
@@ -107,7 +111,7 @@ func TestTxMetadataBuilder_AsPaymentMetadata(t *testing.T) {
 				TransactionIndex:       10,
 				TransactionResult:      "tesSUCCESS",
 				DeliveredAmount:        "5000000",
-				ParentBatchID:          stringPtr("EFGH5678"),
+				ParentBatchID:          &batchID,
 			},
 			expected: PaymentMetadata{
 				TxObjMeta: TxObjMeta{
@@ -123,7 +127,7 @@ func TestTxMetadataBuilder_AsPaymentMetadata(t *testing.T) {
 					TransactionIndex:       10,
 					TransactionResult:      "tesSUCCESS",
 					DeliveredAmount:        "5000000",
-					ParentBatchID:          stringPtr("EFGH5678"),
+					ParentBatchID:          &batchID,
 				},
 			},
 		},
@@ -152,7 +156,7 @@ func TestTxMetadataBuilder_AsPaymentMetadata(t *testing.T) {
 
 func TestTxMetadataBuilder_AsNFTokenMintMetadata(t *testing.T) {
 	nftokenID := types.NFTokenID("000100001E962F495F07A990F4ED55ACCFEEF365DBAA76B6A048C0A200000007")
-	offerID := "9C92E061381C1EF37A8CDE0E8FC35188BFC30B1883825042A64309AC09F4C36D"
+	offerID := types.OfferID("9C92E061381C1EF37A8CDE0E8FC35188BFC30B1883825042A64309AC09F4C36D")
 
 	tests := []struct {
 		name     string
@@ -250,7 +254,7 @@ func TestTxMetadataBuilder_AsNFTokenMintMetadata(t *testing.T) {
 }
 
 func TestTxMetadataBuilder_AsNFTokenCreateOfferMetadata(t *testing.T) {
-	offerID := "68CD1F6F906494EA08C9CB5CAFA64DFA90D4E834B7151899B73231DE5A0C3B77"
+	offerID := types.OfferID("68CD1F6F906494EA08C9CB5CAFA64DFA90D4E834B7151899B73231DE5A0C3B77")
 
 	tests := []struct {
 		name     string
@@ -504,7 +508,7 @@ func TestTxMetadataBuilder_AsNFTokenCancelOfferMetadata(t *testing.T) {
 }
 
 func TestTxMetadataBuilder_AsMPTokenIssuanceCreateMetadata(t *testing.T) {
-	mptIssuanceID := "MPT1234567890ABCDEF"
+	mptIssuanceID := types.MPTIssuanceID("MPT1234567890ABCDEF")
 
 	tests := []struct {
 		name     string
@@ -581,8 +585,3 @@ func TestTxMetadataBuilder_AsMPTokenIssuanceCreateMetadata(t *testing.T) {
 		})
 	}
 }
-
-// Helper function to create string pointers
-func stringPtr(s string) *string {
-	return &s
-}

xrpl/transaction/mptoken_issuance_create.go

@@ -29,7 +29,7 @@ const (
 // It extends from TxObjMeta.
 type MPTokenIssuanceCreateMetadata struct {
 	TxObjMeta
-	MPTIssuanceID *string `json:"mpt_issuance_id,omitempty"`
+	MPTIssuanceID *types.MPTIssuanceID `json:"mpt_issuance_id,omitempty"`
 }
 
 // MPTokenIssuanceCreate represents a transaction to create a new MPTokenIssuance object.

xrpl/transaction/nftoken_create_offer.go

@@ -20,7 +20,7 @@ type NFTokenCreateOfferMetadata struct {
 	TxObjMeta
 
 	// OfferID is a string of Amount is present.
-	OfferID *string `json:"offer_id,omitempty"`
+	OfferID *types.OfferID `json:"offer_id,omitempty"`
 }
 
 // NFTokenCreateOffer creates either a new Sell offer for an NFToken owned by the account executing the transaction, or a new Buy offer for an NFToken owned by another account.

xrpl/transaction/nftoken_mint.go

@@ -15,7 +15,7 @@ type NFTokenMintMetadata struct {
 	NFTokenID *types.NFTokenID `json:"nftoken_id,omitempty"`
 
 	// OfferID is a string of Amount is present.
-	OfferID *string `json:"offer_id,omitempty"`
+	OfferID *types.OfferID `json:"offer_id,omitempty"`
 }
 
 // NFTokenMint transaction creates a non-fungible token and adds it to the relevant NFTokenPage object of the NFTokenMinter as an NFToken object.

xrpl/transaction/types/batch_id.go

@@ -0,0 +1,8 @@
+package types
+
+// BatchID represents a batch ID.
+type BatchID string
+
+func (b *BatchID) String() string {
+	return string(*b)
+}

xrpl/transaction/types/batch_id_test.go

@@ -0,0 +1,30 @@
+package types
+
+import "testing"
+
+func TestBatchIDString(t *testing.T) {
+	tests := []struct {
+		name    string
+		batchId BatchID
+		want    string
+	}{
+		{
+			name:    "Empty BatchID",
+			batchId: BatchID(""),
+			want:    "",
+		},
+		{
+			name:    "Non-empty BatchID",
+			batchId: BatchID("1234567890abcdef"),
+			want:    "1234567890abcdef",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := tt.batchId.String(); got != tt.want {
+				t.Errorf("BatchID.String(), got: %v but we want %v", got, tt.want)
+			}
+		})
+	}
+}

xrpl/transaction/types/mpt_issuance_id.go

@@ -0,0 +1,8 @@
+package types
+
+// MPTIssuanceID represents an MPT issuance ID.
+type MPTIssuanceID string
+
+func (mpt *MPTIssuanceID) String() string {
+	return string(*mpt)
+}