Merge pull request #96 from florent-uzio/fix/quorum

Updated SignerQuorum in SignerListSet to be an interface{} with uint32 type assertion instead of a value (uint32).

Author: florent-uzio

CHANGELOG.md

@@ -5,7 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [v0.1.4]
+
+### Fixed
+
+#### xrpl
+
+- Updated SignerQuorum in SignerListSet to be an interface{} with uint32 type assertion instead of a value (uint32).
+  - This allows distinguishing between an unset (nil) and an explicitly set value, including 0 to delete a signer list.
+  - Ensures SignerQuorum is only included in the Flatten() output when explicitly defined.
+  - Updates the `Validate` method to make sure `SignerEntries` is not set when `SignerQuorum` is set to 0
+
+## [v0.1.3]
 
 ### Added
 

examples/multisigning/rpc/main.go

@@ -70,7 +70,7 @@ func main() {
 		BaseTx: transaction.BaseTx{
 			Account: master.GetAddress(),
 		},
-		SignerQuorum: 2,
+		SignerQuorum: uint32(2),
 		SignerEntries: []ledger.SignerEntryWrapper{
 			{
 				SignerEntry: ledger.SignerEntry{

examples/multisigning/ws/main.go

@@ -81,7 +81,7 @@ func main() {
 		BaseTx: transaction.BaseTx{
 			Account: master.GetAddress(),
 		},
-		SignerQuorum: 2,
+		SignerQuorum: uint32(2),
 		SignerEntries: []ledger.SignerEntryWrapper{
 			{
 				SignerEntry: ledger.SignerEntry{

xrpl/transaction/signer_list_set.go

@@ -13,6 +13,7 @@ var (
 	ErrInvalidSignerEntries                      = fmt.Errorf("signerEntries must have at least %d entry and no more than %d entries", MinSigners, MaxSigners)
 	ErrInvalidWalletLocator                      = errors.New("invalid WalletLocator in SignerEntry, must be an hexadecimal string")
 	ErrSignerQuorumGreaterThanSumOfSignerWeights = errors.New("signerQuorum must be less than or equal to the sum of all SignerWeights")
+	ErrInvalidQuorumAndEntries                   = errors.New("signerEntries must be empty when the SignerQuorum is set to 0 to delete a signer list")
 )
 
 const (
@@ -61,8 +62,8 @@ const (
 type SignerListSet struct {
 	BaseTx
 	// A target number for the signer weights. A multi-signature from this list is valid only if the sum weights of the signatures provided is greater than or equal to this value.
-	// To delete a signer list, use the value 0.
-	SignerQuorum uint32
+	// To delete a signer list, use the value 0. Needs to be an uint32.
+	SignerQuorum interface{}
 	// (Omitted when deleting) Array of SignerEntry objects, indicating the addresses and weights of signers in this list.
 	// This signer list must have at least 1 member and no more than 32 members.
 	// No address may appear more than once in the list, nor may the Account submitting the transaction appear in the list.
@@ -80,7 +81,7 @@ func (s *SignerListSet) Flatten() FlatTransaction {
 
 	flattened["TransactionType"] = "SignerListSet"
 
-	if s.SignerQuorum != 0 {
+	if s.SignerQuorum != nil {
 		flattened["SignerQuorum"] = s.SignerQuorum
 	}
 
@@ -105,11 +106,18 @@ func (s *SignerListSet) Validate() (bool, error) {
 		return false, err
 	}
 
+	sq, ok := s.SignerQuorum.(uint32)
+	zeroQuorum := ((ok && sq == uint32(0)) || s.SignerQuorum == nil)
+
 	// All other checks are for if SignerQuorum is greater than 0
-	if s.SignerQuorum == 0 {
+	if zeroQuorum && len(s.SignerEntries) == 0 {
 		return true, nil
 	}
 
+	if zeroQuorum && len(s.SignerEntries) > 0 {
+		return false, ErrInvalidQuorumAndEntries
+	}
+
 	// Check if SignerEntries has at least 1 entry and no more than 32 entries
 	if len(s.SignerEntries) < MinSigners || len(s.SignerEntries) > MaxSigners {
 		return false, ErrInvalidSignerEntries
@@ -132,7 +140,7 @@ func (s *SignerListSet) Validate() (bool, error) {
 	for _, signerEntry := range s.SignerEntries {
 		sumSignerWeights += signerEntry.SignerEntry.SignerWeight
 	}
-	if s.SignerQuorum > uint32(sumSignerWeights) {
+	if sq > uint32(sumSignerWeights) {
 		return false, ErrSignerQuorumGreaterThanSumOfSignerWeights
 	}
 

xrpl/transaction/signer_list_set_test.go

@@ -28,7 +28,7 @@ func TestSignerListSet_Flatten(t *testing.T) {
 					Account: "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
 					Fee:     types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 3,
+				SignerQuorum: uint32(3),
 				SignerEntries: []ledger.SignerEntryWrapper{
 					{
 						SignerEntry: ledger.SignerEntry{
@@ -84,12 +84,13 @@ func TestSignerListSet_Flatten(t *testing.T) {
 					Account: "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
 					Fee:     types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 0,
+				SignerQuorum: uint32(0),
 			},
 			expected: `{
 				"TransactionType": "SignerListSet",
 				"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
-				"Fee": "12"
+				"Fee": "12",
+				"SignerQuorum": 0
 			}`,
 		},
 		{
@@ -132,7 +133,7 @@ func TestSignerListSet_Validate(t *testing.T) {
 					TransactionType: SignerListSetTx,
 					Fee:             types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 3,
+				SignerQuorum: uint32(3),
 				SignerEntries: []ledger.SignerEntryWrapper{
 					{
 						SignerEntry: ledger.SignerEntry{
@@ -167,7 +168,7 @@ func TestSignerListSet_Validate(t *testing.T) {
 					Account: "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
 					Fee:     types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 3,
+				SignerQuorum: uint32(3),
 				SignerEntries: []ledger.SignerEntryWrapper{
 					{
 						SignerEntry: ledger.SignerEntry{
@@ -194,7 +195,7 @@ func TestSignerListSet_Validate(t *testing.T) {
 					TransactionType: SignerListSetTx,
 					Fee:             types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 3,
+				SignerQuorum: uint32(3),
 			},
 			wantValid: false,
 			wantErr:   true,
@@ -207,7 +208,7 @@ func TestSignerListSet_Validate(t *testing.T) {
 					TransactionType: SignerListSetTx,
 					Fee:             types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 3,
+				SignerQuorum: uint32(3),
 				SignerEntries: func() []ledger.SignerEntryWrapper {
 					entries := make([]ledger.SignerEntryWrapper, 33)
 					for i := range entries {
@@ -232,7 +233,7 @@ func TestSignerListSet_Validate(t *testing.T) {
 					TransactionType: SignerListSetTx,
 					Fee:             types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 3,
+				SignerQuorum: uint32(3),
 				SignerEntries: []ledger.SignerEntryWrapper{
 					{
 						SignerEntry: ledger.SignerEntry{
@@ -254,7 +255,7 @@ func TestSignerListSet_Validate(t *testing.T) {
 					TransactionType: SignerListSetTx,
 					Fee:             types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 5,
+				SignerQuorum: uint32(5),
 				SignerEntries: []ledger.SignerEntryWrapper{
 					{
 						SignerEntry: ledger.SignerEntry{
@@ -281,7 +282,7 @@ func TestSignerListSet_Validate(t *testing.T) {
 					TransactionType: SignerListSetTx,
 					Fee:             types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 2,
+				SignerQuorum: uint32(2),
 				SignerEntries: []ledger.SignerEntryWrapper{
 					{
 						SignerEntry: ledger.SignerEntry{
@@ -308,11 +309,38 @@ func TestSignerListSet_Validate(t *testing.T) {
 					TransactionType: SignerListSetTx,
 					Fee:             types.XRPCurrencyAmount(12),
 				},
-				SignerQuorum: 0,
+				SignerQuorum: uint32(0),
 			},
 			wantValid: true,
 			wantErr:   false,
 		},
+		{
+			name: "fail - invalid SignerListSet with SignerQuorum 0 but a SignerEntries not empty",
+			entry: &SignerListSet{
+				BaseTx: BaseTx{
+					Account:         "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+					TransactionType: SignerListSetTx,
+					Fee:             types.XRPCurrencyAmount(12),
+				},
+				SignerQuorum: uint32(0),
+				SignerEntries: []ledger.SignerEntryWrapper{
+					{
+						SignerEntry: ledger.SignerEntry{
+							Account:      "invalid",
+							SignerWeight: 2,
+						},
+					},
+					{
+						SignerEntry: ledger.SignerEntry{
+							Account:      "rUpy3eEg8rqjqfUoLeBnZkscbKbFsKXC3v",
+							SignerWeight: 1,
+						},
+					},
+				},
+			},
+			wantValid: false,
+			wantErr:   true,
+		},
 	}
 
 	for _, tt := range tests {