from_xrpl should not accept snake_case dict keys

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [[Unreleased]]
 - Included `ctid` field in the `tx` request.
+- `from_xrpl` method accepts input dictionary keys exclusively in the proper XRPL format.
 
 ### Fixed
 - Added support for `XChainModifyBridge` flag maps (fixing an issue with `NFTokenCreateOffer` flag names)

tests/unit/models/test_base_model.py

@@ -388,6 +388,48 @@ def test_from_dict_submit(self):
  actual = Request.from_dict(request)
  self.assertEqual(actual, expected)
 
+ # Note: BaseModel.from_xrpl and its overridden methods accept only camelCase or
+ # PascalCase inputs (i.e. snake_case is not accepted)
+ def test_from_xrpl_accepts_only_camel_case_inputs(self):
+ request = {
+ "method": "submit",
+ "tx_json": {
+ "Account": "rnD6t3JF9RTG4VgNLoc4i44bsQLgJUSi6h",
+ "transaction_type": "TrustSet",
+ "Fee": "10",
+ "Sequence": 17896798,
+ "Flags": 131072,
+ "signing_pub_key": "",
+ "limit_amount": {
+ "currency": "USD",
+ "issuer": "rH5gvkKxGHrFAMAACeu9CB3FMu7pQ9jfZm",
+ "value": "10",
+ },
+ },
+ "fail_hard": False,
+ }
+
+ with self.assertRaises(XRPLModelException):
+ Request.from_xrpl(request)
+
+ # verify that Transaction.from_xrpl method does not accept snake_case JSON keys
+ tx_snake_case_keys = {
+ "Account": "rnoGkgSpt6AX1nQxZ2qVGx7Fgw6JEcoQas",
+ "transaction_type": "TrustSet",
+ "Fee": "10",
+ "Sequence": 17892983,
+ "Flags": 131072,
+ "signing_pub_key": "",
+ "limit_amount": {
+ "currency": "USD",
+ "issuer": "rBPvTKisx7UCGLDtiUZ6mDssXNREuVuL8Y",
+ "value": "10",
+ },
+ }
+
+ with self.assertRaises(XRPLModelException):
+ Transaction.from_xrpl(tx_snake_case_keys)
+
  def test_from_xrpl(self):
  dirname = os.path.dirname(__file__)
  full_filename = "x-codec-fixtures.json"

xrpl/models/base_model.py

@@ -15,6 +15,7 @@
 from xrpl.models.required import REQUIRED
 from xrpl.models.types import XRPL_VALUE_TYPE
 
+_PASCAL_OR_CAMEL_CASE: Final[Pattern[str]] = re.compile("^[A-Za-z]+(?:[A-Z][a-z]+)*$")
 # this regex splits words based on one of three cases:
 #
 # 1. 1-or-more non-capital chars at the beginning of the string. Handles cases
@@ -54,7 +55,15 @@ def _key_to_json(field: str) -> str:
  1. 'TransactionType' becomes 'transaction_type'
  2. 'value' remains 'value'
  3. 'URI' becomes 'uri'
+
+ This function accepts inputs in PascalCase or camelCase only
+
+ Raises:
+ XRPLModelException: If the input is invalid
  """
+ if not re.fullmatch(pattern=_PASCAL_OR_CAMEL_CASE, string=field):
+ raise XRPLModelException(f"Key {field} is not in the proper XRPL format.")
+
  # convert all special CamelCase substrings to capitalized strings
  for spec_str in ABBREVIATIONS.values():
  if spec_str in field: