Skip to content

feat(binarycodec): add DefinitionsRegistry with contextvars support #899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sublimator wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(binarycodec): add DefinitionsRegistry with contextvars support #899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
605a6c2
feat(binarycodec): add update_definitions() for runtime monkey-patching
sublimator Jan 26, 2026
aa00c69
feat(binarycodec): add DefinitionsRegistry class with contextvars sup…
sublimator Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions tests/unit/core/binarycodec/test_definition_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,23 @@ def setUp(self):
self.test_field_name = "Sequence"

def test_load_definitions(self):
loaded = definitions.load_definitions()
expected_keys = ["TYPES", "FIELDS", "TRANSACTION_RESULTS", "TRANSACTION_TYPES"]
for key in expected_keys:
self.assertIn(key, definitions._DEFINITIONS)
self.assertIn(key, loaded)

def test_inverse_transaction_type_map(self):
transaction_type_code = 8
expected_transaction_type = "OfferCancel"
transaction_type = definitions._TRANSACTION_TYPE_CODE_TO_STR_MAP[
transaction_type_code
]
transaction_type = definitions.get_transaction_type_name(transaction_type_code)
self.assertEqual(expected_transaction_type, transaction_type)

def test_inverse_transaction_result_map(self):
transaction_result_code = 0
expected_transaction_result = "tesSUCCESS"
transaction_result = definitions._TRANSACTION_RESULTS_CODE_TO_STR_MAP[
transaction_result = definitions.get_transaction_result_name(
transaction_result_code
]
)
self.assertEqual(expected_transaction_result, transaction_result)

def test_get_field_type_name(self):
Expand Down
12 changes: 12 additions & 0 deletions xrpl/core/binarycodec/definitions/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
"""Handles the XRPL type and definition specifics."""

from xrpl.core.binarycodec.definitions.definitions import (
DEFAULT_GRANULAR_PERMISSIONS,
DefinitionsRegistry,
get_field_header_from_name,
get_field_instance,
get_field_name_from_header,
Expand All @@ -13,19 +15,29 @@
get_transaction_type_code,
get_transaction_type_name,
load_definitions,
set_default_registry,
using_definitions,
)
from xrpl.core.binarycodec.definitions.field_header import FieldHeader
from xrpl.core.binarycodec.definitions.field_info import FieldInfo
from xrpl.core.binarycodec.definitions.field_instance import FieldInstance

__all__ = [
# Classes
"DefinitionsRegistry",
"FieldHeader",
"FieldInfo",
"FieldInstance",
# Registry management
"load_definitions",
"set_default_registry",
"using_definitions",
"DEFAULT_GRANULAR_PERMISSIONS",
# Field lookups
"get_field_header_from_name",
"get_field_name_from_header",
"get_field_instance",
# Type lookups
"get_ledger_entry_type_code",
"get_ledger_entry_type_name",
"get_transaction_result_code",
Expand Down
Loading