style(errors): unify ordering and comments across errors.go

Author: banasa44

address-codec/errors.go

@@ -6,23 +6,23 @@ import (
 )
 
 var (
-	// Static errors
+	// address
 
 	// ErrInvalidClassicAddress indicates an invalid classic address.
 	ErrInvalidClassicAddress = errors.New("invalid classic address")
 	// ErrInvalidSeed indicates an invalid seed; could not determine encoding algorithm.
 	ErrInvalidSeed = errors.New("invalid seed; could not determine encoding algorithm")
-
 	// ErrInvalidXAddress indicates an invalid x-address.
 	ErrInvalidXAddress = errors.New("invalid x-address")
 	// ErrInvalidTag indicates an invalid tag.
 	ErrInvalidTag = errors.New("invalid tag")
 	// ErrInvalidAccountID indicates an invalid account ID.
-	ErrInvalidAccountID = errors.New("invalid accountId")
-
+	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")

binary-codec/definitions/errors.go

@@ -6,7 +6,7 @@ import (
 )
 
 var (
-	// Static errors
+	// definitions
 
 	// ErrUnableToCastFieldInfo is returned when the field info cannot be cast.
 	ErrUnableToCastFieldInfo = errors.New("unable to cast to field info")

pkg/crypto/errors.go

@@ -3,21 +3,21 @@ package crypto
 import "errors"
 
 var (
+	// keypair
+
 	// ErrValidatorKeypairDerivation is returned when a validator keypair is attempted to be derived
 	ErrValidatorKeypairDerivation = errors.New("validator keypair derivation not supported")
 	// ErrInvalidPrivateKey is returned when a private key is invalid
 	ErrInvalidPrivateKey = errors.New("invalid private key")
 	// ErrInvalidMessage is returned when a message is required but not provided
 	ErrInvalidMessage = errors.New("message is required")
-
 	// ErrValidatorNotSupported is returned when a validator keypair is used with the ED25519 algorithm.
 	ErrValidatorNotSupported = errors.New("validator keypairs can not use Ed25519")
 
 	// der
 
 	// ErrInvalidHexString is returned when the hex string is invalid.
 	ErrInvalidHexString = errors.New("invalid hex string")
-
 	// ErrInvalidDERNotEnoughData is returned when the DER data is not enough.
 	ErrInvalidDERNotEnoughData = errors.New("invalid DER: not enough data")
 	// ErrInvalidDERIntegerTag is returned when the DER integer tag is invalid.

xrpl/hash/errors.go

@@ -3,9 +3,10 @@ package hash
 import "errors"
 
 var (
+	// transaction signature
+
 	// ErrNonSignedTransaction indicates that a transaction lacks the required signature fields.
 	ErrNonSignedTransaction = errors.New("transaction must have at least one of TxnSignature, Signers, or SigningPubKey")
-
 	// ErrMissingSignature is returned when a transaction lacks the required signature fields.
 	// A transaction must have at least one of: TxnSignature, Signers, or SigningPubKey,
 	// unless it's an inner batch transaction (has TfInnerBatchTxn flag set).

xrpl/rpc/errors.go

@@ -2,88 +2,83 @@ package rpc
 
 import "errors"
 
-// Static errors
 var (
+	// transaction
+
 	// ErrMissingTxSignatureOrSigningPubKey is returned when a transaction lacks both TxSignature and SigningPubKey.
 	ErrMissingTxSignatureOrSigningPubKey = errors.New("transaction must include either TxSignature or SigningPubKey")
-
 	// ErrSignerDataIsEmpty is returned when signer data is empty or missing.
 	ErrSignerDataIsEmpty = errors.New("signer data must not be empty")
-
-	// ErrCannotFundWalletWithoutClassicAddress is returned when attempting to fund a wallet without a classic address.
-	ErrCannotFundWalletWithoutClassicAddress = errors.New("cannot fund wallet without a classic address")
-
 	// ErrMissingLastLedgerSequenceInTransaction is returned when LastLedgerSequence is missing from a transaction.
 	ErrMissingLastLedgerSequenceInTransaction = errors.New("missing LastLedgerSequence in transaction")
-
 	// ErrMissingWallet is returned when a wallet is required but not provided for an unsigned transaction.
 	ErrMissingWallet = errors.New("wallet must be provided when submitting an unsigned transaction")
+	// ErrMissingAccountInTransaction is returned when the Account field is missing from a transaction.
+	ErrMissingAccountInTransaction = errors.New("missing Account in transaction")
+	// ErrTransactionTypeMissing is returned when the transaction type is missing from a transaction.
+	ErrTransactionTypeMissing = errors.New("transaction type is missing in transaction")
+	// ErrTransactionNotFound is returned when a transaction cannot be found.
+	ErrTransactionNotFound = errors.New("transaction not found")
+	// ErrInvalidFulfillmentLength is returned when the fulfillment length is invalid.
+	ErrInvalidFulfillmentLength = errors.New("invalid fulfillment length")
+	// ErrMismatchedTag is returned when a transaction tag field does not match the expected value.
+	ErrMismatchedTag = errors.New("transaction tag mismatch")
+
+	// fields
 
 	// ErrRawTransactionsFieldIsNotAnArray is returned when the RawTransactions field is not an array type.
 	ErrRawTransactionsFieldIsNotAnArray = errors.New("field RawTransactions must be an array")
-
 	// ErrRawTransactionFieldIsNotAnObject is returned when the RawTransaction field is not an object type.
 	ErrRawTransactionFieldIsNotAnObject = errors.New("field RawTransaction must be an object")
-
 	// ErrSigningPubKeyFieldMustBeEmpty is returned when the signingPubKey field should be empty but isn't.
 	ErrSigningPubKeyFieldMustBeEmpty = errors.New("field SigningPubKey must be empty")
-
 	// ErrTxnSignatureFieldMustBeEmpty is returned when the txnSignature field should be empty but isn't.
 	ErrTxnSignatureFieldMustBeEmpty = errors.New("field TxnSignature must be empty")
-
 	// ErrSignersFieldMustBeEmpty is returned when the signers field should be empty but isn't.
 	ErrSignersFieldMustBeEmpty = errors.New("field Signers must be empty")
-
 	// ErrAccountFieldIsNotAString is returned when the account field is not a string type.
 	ErrAccountFieldIsNotAString = errors.New("field Account must be a string")
+	// ErrRawTransactionsFieldMissing is returned when the RawTransactions field is missing from a Batch transaction.
+	ErrRawTransactionsFieldMissing = errors.New("RawTransactions field missing from Batch transaction")
+	// ErrRawTransactionFieldMissing is returned when the RawTransaction field is missing from a wrapper.
+	ErrRawTransactionFieldMissing = errors.New("RawTransaction field missing from wrapper")
+	// ErrFeeFieldMissing is returned when the fee field is missing after calculation.
+	ErrFeeFieldMissing = errors.New("fee field missing after calculation")
 
-	// helpers
+	// wallet
 
-	// ErrMissingAccountInTransaction is returned when the Account field is missing from a transaction.
-	ErrMissingAccountInTransaction = errors.New("missing Account in transaction")
+	// ErrCannotFundWalletWithoutClassicAddress is returned when attempting to fund a wallet without a classic address.
+	ErrCannotFundWalletWithoutClassicAddress = errors.New("cannot fund wallet without a classic address")
+
+	// fees
 
 	// ErrCouldNotGetBaseFeeXrp is returned when BaseFeeXrp cannot be retrieved from ServerInfo.
-	ErrCouldNotGetBaseFeeXrp = errors.New("getFeeXrp: could not get BaseFeeXrp from ServerInfo")
+	ErrCouldNotGetBaseFeeXrp = errors.New("get fee xrp: could not get BaseFeeXrp from ServerInfo")
+	// ErrCouldNotFetchOwnerReserve is returned when the owner reserve fee cannot be fetched.
+	ErrCouldNotFetchOwnerReserve = errors.New("could not fetch Owner Reserve")
+	// ErrFailedToParseFee is returned when fee parsing fails.
+	ErrFailedToParseFee = errors.New("failed to parse fee")
+
+	// account
 
 	// ErrAccountCannotBeDeleted is returned when an account cannot be deleted due to associated objects.
 	ErrAccountCannotBeDeleted = errors.New("account cannot be deleted; there are Escrows, PayChannels, RippleStates, or Checks associated with the account")
 
+	// payment
+
 	// ErrAmountAndDeliverMaxMustBeIdentical is returned when Amount and DeliverMax fields are not identical.
 	ErrAmountAndDeliverMaxMustBeIdentical = errors.New("payment transaction: Amount and DeliverMax fields must be identical when both are provided")
 
-	// ErrTransactionTypeMissing is returned when the transaction type is missing from a transaction.
-	ErrTransactionTypeMissing = errors.New("transaction type is missing in transaction")
-
-	// ErrTransactionNotFound is returned when a transaction cannot be found.
-	ErrTransactionNotFound = errors.New("transaction not found")
-
-	// ErrCouldNotFetchOwnerReserve is returned when the owner reserve fee cannot be fetched.
-	ErrCouldNotFetchOwnerReserve = errors.New("could not fetch Owner Reserve")
-
-	// ErrRawTransactionsFieldMissing is returned when the RawTransactions field is missing from a Batch transaction.
-	ErrRawTransactionsFieldMissing = errors.New("RawTransactions field missing from Batch transaction")
-
-	// ErrRawTransactionFieldMissing is returned when the RawTransaction field is missing from a wrapper.
-	ErrRawTransactionFieldMissing = errors.New("RawTransaction field missing from wrapper")
-
-	// ErrFeeFieldMissing is returned when the fee field is missing after calculation.
-	ErrFeeFieldMissing = errors.New("fee field missing after calculation")
-
-	// ErrInvalidFulfillmentLength is returned when the fulfillment length is invalid.
-	ErrInvalidFulfillmentLength = errors.New("invalid fulfillment length")
+	// tags
 
 	// ErrTagMustEqualAddressTag is returned when a tag must equal the address tag.
 	ErrTagMustEqualAddressTag = errors.New("tag, if present, must be equal to the tag of the address")
 
+	// json rpc
+
 	// ErrFailedToMarshalJSONRPCRequest is returned when JSON-RPC request marshaling fails.
 	ErrFailedToMarshalJSONRPCRequest = errors.New("failed to marshal JSON-RPC request")
 
-	// ErrFailedToParseFee is returned when fee parsing fails.
-	ErrFailedToParseFee = errors.New("failed to parse fee")
-
-	// ErrMismatchedTag is returned when a transaction tag field does not match the expected value.
-	ErrMismatchedTag = errors.New("transaction tag mismatch")
-
 	// config
 
 	// ErrEmptyURL is returned when the provided URL is empty (no port or IP specified).

xrpl/transaction/errors.go

@@ -42,9 +42,9 @@ var (
 	// xchain
 
 	// ErrInvalidDestinationAddress is returned when the destination address is invalid.
-	ErrInvalidDestinationAddress = errors.New("xchainClaim: invalid destination address")
+	ErrInvalidDestinationAddress = errors.New("xchain claim: invalid destination address")
 	// ErrMissingXChainClaimID is returned when the XChainClaimID is missing.
-	ErrMissingXChainClaimID = errors.New("xchainClaim: missing XChainClaimID")
+	ErrMissingXChainClaimID = errors.New("xchain claim: missing XChainClaimID")
 
 	// ErrInvalidXChainClaimID is returned when the XChainClaimID is invalid or missing.
 	ErrInvalidXChainClaimID = errors.New("invalid XChainClaimID")
@@ -132,7 +132,7 @@ var (
 	// ErrInvalidSignerEntries is returned when the number of signer entries is outside the allowed range.
 	ErrInvalidSignerEntries = errors.New("invalid number of signer entries")
 	// ErrInvalidWalletLocator is returned when a SignerEntry's WalletLocator is not a valid hexadecimal string.
-	ErrInvalidWalletLocator = errors.New("invalid WalletLocator in SignerEntry, must be an hexadecimal string")
+	ErrInvalidWalletLocator = errors.New("invalid WalletLocator in SignerEntry, must be a hexadecimal string")
 	// ErrSignerQuorumGreaterThanSumOfSignerWeights is returned when SignerQuorum exceeds sum of all SignerWeights.
 	ErrSignerQuorumGreaterThanSumOfSignerWeights = errors.New("signerQuorum must be less than or equal to the sum of all SignerWeights")
 	// ErrInvalidQuorumAndEntries is returned when SignerEntries is non-empty while SignerQuorum is zero.
@@ -193,8 +193,8 @@ var (
 	// ErrEmptyNFTokenOffers is returned when the NFTokenOffers array contains no entries.
 	ErrEmptyNFTokenOffers = errors.New("the NFTokenOffers array must have at least one entry")
 
-	// ErrInvalidNFTokenID is returned when the NFTokenID is not an hexadecimal.
-	ErrInvalidNFTokenID = errors.New("invalid NFTokenID, must be an hexadecimal string")
+	// ErrInvalidNFTokenID is returned when the NFTokenID is not a hexadecimal.
+	ErrInvalidNFTokenID = errors.New("invalid NFTokenID, must be a hexadecimal string")
 
 	// ErrNFTokenBrokerFeeZero is returned when NFTokenBrokerFee is zero.
 	ErrNFTokenBrokerFeeZero = errors.New("nftoken accept offer: NFTokenBrokerFee cannot be zero")
@@ -296,9 +296,9 @@ var (
 	// check
 
 	// ErrAmountOrDeliverMinNotProvided is returned when neither Amount nor DeliverMin is provided.
-	ErrAmountOrDeliverMinNotProvided = errors.New("checkCash - either Amount or DeliverMin must be provided")
+	ErrAmountOrDeliverMinNotProvided = errors.New("check cash: either Amount or DeliverMin must be provided")
 	// ErrMutuallyExclusiveAmountDeliverMin is returned when both Amount and DeliverMin are provided.
-	ErrMutuallyExclusiveAmountDeliverMin = errors.New("checkCash - both Amount and DeliverMin cannot be provided")
+	ErrMutuallyExclusiveAmountDeliverMin = errors.New("check cash: both Amount and DeliverMin cannot be provided")
 
 	// batch
 
@@ -314,26 +314,10 @@ var (
 	// Each element in the RawTransactions array must be a valid transaction object.
 	ErrBatchRawTransactionNotObject = errors.New("batch RawTransaction element is not an object")
 
-	// ErrBatchRawTransactionMissing is returned when the RawTransaction field is missing from an array element.
-	// Each RawTransactions array element must contain a RawTransaction field.
-	ErrBatchRawTransactionMissing = errors.New("batch RawTransaction field is missing")
-
 	// ErrBatchRawTransactionFieldNotObject is returned when the RawTransaction field is not an object.
 	// The RawTransaction field must contain a valid transaction object structure.
 	ErrBatchRawTransactionFieldNotObject = errors.New("batch RawTransaction field is not an object")
 
-	// ErrBatchNestedTransaction is returned when trying to include a Batch transaction within another Batch.
-	// Nested batch transactions are not allowed to prevent infinite recursion and complexity.
-	ErrBatchNestedTransaction = errors.New("batch cannot contain nested Batch transactions")
-
-	// ErrBatchMissingInnerFlag is returned when an inner transaction lacks the TfInnerBatchTxn flag.
-	// All transactions within a batch must have the TfInnerBatchTxn flag set to indicate they are inner transactions.
-	ErrBatchMissingInnerFlag = errors.New("batch RawTransaction must contain the TfInnerBatchTxn flag")
-
-	// ErrBatchInnerTransactionInvalid is returned when an inner transaction fails its own validation.
-	// Each inner transaction must pass its individual validation rules.
-	ErrBatchInnerTransactionInvalid = errors.New("batch inner transaction validation failed")
-
 	// ErrBatchSignerNotObject is returned when a BatchSigner array element is not an object.
 	// Each element in the BatchSigners array must be a valid signer object.
 	ErrBatchSignerNotObject = errors.New("batch BatchSigner element is not an object")
@@ -346,10 +330,6 @@ var (
 	// The BatchSigner field must contain a valid signer object structure.
 	ErrBatchSignerFieldNotObject = errors.New("batch BatchSigner field is not an object")
 
-	// ErrBatchSignerAccountMissing is returned when a BatchSigner lacks the required Account field.
-	// Each BatchSigner must specify an Account for the signing operation.
-	ErrBatchSignerAccountMissing = errors.New("batch BatchSigner Account is missing")
-
 	// ErrBatchSignerAccountNotString is returned when a BatchSigner Account field is not a string.
 	// The Account field must be a valid string representing an XRPL account address.
 	ErrBatchSignerAccountNotString = errors.New("batch BatchSigner Account must be a string")
@@ -393,7 +373,7 @@ var (
 	// account
 
 	// ErrAccountSetInvalidSetFlag is returned when SetFlag is outside the valid range (1 to 16).
-	ErrAccountSetInvalidSetFlag = errors.New("accountSet: SetFlag must be an integer between asfRequireDest (1) and asfAllowTrustLineClawback (16)")
+	ErrAccountSetInvalidSetFlag = errors.New("account set: SetFlag must be an integer between asfRequireDest (1) and asfAllowTrustLineClawback (16)")
 	// ErrAccountSetInvalidTickSize is returned when TickSize is outside the valid range (0 to 15 inclusive).
-	ErrAccountSetInvalidTickSize = errors.New("accountSet: TickSize must be an integer between 0 and 15 inclusive")
+	ErrAccountSetInvalidTickSize = errors.New("account set: TickSize must be an integer between 0 and 15 inclusive")
 )

xrpl/transaction/types/errors.go

@@ -6,28 +6,24 @@ var (
 	// xchain bridge
 
 	// ErrInvalidIssuingChainDoorAddress is returned when the issuing chain door address is invalid.
-	ErrInvalidIssuingChainDoorAddress = errors.New("xchainBridge: invalid issuing chain door address")
+	ErrInvalidIssuingChainDoorAddress = errors.New("xchain bridge: invalid issuing chain door address")
 	// ErrInvalidIssuingChainIssueAddress is returned when the issuing chain issue address is invalid.
-	ErrInvalidIssuingChainIssueAddress = errors.New("xchainBridge: invalid issuing chain issue address")
+	ErrInvalidIssuingChainIssueAddress = errors.New("xchain bridge: invalid issuing chain issue address")
 	// ErrInvalidLockingChainDoorAddress is returned when the locking chain door address is invalid.
-	ErrInvalidLockingChainDoorAddress = errors.New("xchainBridge: invalid locking chain door address")
+	ErrInvalidLockingChainDoorAddress = errors.New("xchain bridge: invalid locking chain door address")
 	// ErrInvalidLockingChainIssueAddress is returned when the locking chain issue address is invalid.
-	ErrInvalidLockingChainIssueAddress = errors.New("xchainBridge: invalid locking chain issue address")
+	ErrInvalidLockingChainIssueAddress = errors.New("xchain bridge: invalid locking chain issue address")
 
 	// raw tx
 
 	// ErrBatchRawTransactionMissing is returned when the RawTransaction field is missing from an array element.
 	ErrBatchRawTransactionMissing = errors.New("batch RawTransaction field is missing")
-
 	// ErrBatchRawTransactionFieldNotObject is returned when the RawTransaction field is not an object.
 	ErrBatchRawTransactionFieldNotObject = errors.New("batch RawTransaction field is not an object")
-
 	// ErrBatchNestedTransaction is returned when trying to include a Batch transaction within another Batch.
 	ErrBatchNestedTransaction = errors.New("batch cannot contain nested Batch transactions")
-
 	// ErrBatchMissingInnerFlag is returned when an inner transaction lacks the TfInnerBatchTxn flag.
 	ErrBatchMissingInnerFlag = errors.New("batch RawTransaction must contain the TfInnerBatchTxn flag")
-
 	// ErrBatchInnerTransactionInvalid is returned when an inner transaction fails its own validation.
 	ErrBatchInnerTransactionInvalid = errors.New("batch inner transaction validation failed")
 
@@ -40,18 +36,15 @@ var (
 
 	// ErrBatchSignerAccountMissing is returned when a BatchSigner lacks the required Account field.
 	ErrBatchSignerAccountMissing = errors.New("batch BatchSigner Account is missing")
-
 	// ErrBatchSignerSigningPubKeyMissing is returned when a BatchSigner lacks the required SigningPubKey field.
 	ErrBatchSignerSigningPubKeyMissing = errors.New("batch BatchSigner SigningPubKey is missing")
-
 	// ErrBatchSignerInvalidTxnSignature is returned when a BatchSigner has an invalid TxnSignature field.
 	ErrBatchSignerInvalidTxnSignature = errors.New("batch BatchSigner TxnSignature is invalid")
 
 	// credential
 
 	// ErrInvalidCredentialType is returned when the credential type is invalid; it must be a hexadecimal string between 1 and 64 bytes.
 	ErrInvalidCredentialType = errors.New("invalid credential type, must be a hexadecimal string between 1 and 64 bytes")
-
 	// ErrInvalidCredentialIssuer is returned when the credential Issuer field is missing.
 	ErrInvalidCredentialIssuer = errors.New("credential type: missing field Issuer")
 

xrpl/wallet/errors.go

@@ -3,6 +3,8 @@ package wallet
 import "errors"
 
 var (
+	// address
+
 	// ErrAddressTagNotZero is returned when the address tag is not zero.
 	ErrAddressTagNotZero = errors.New("address tag is not zero")