refactor(models): unify TransactionMetadata into single strongly-typed model#153
Open
refactor(models): unify TransactionMetadata into single strongly-typed model#153
Conversation
…d model Remove duplicate TransactionMetadata from results/metadata.rs and consolidate into transactions/metadata.rs with strongly-typed fields: - Add DeliveredAmount enum handling "unavailable" string vs Amount - Add strongly-typed AffectedNode enum (Created/Modified/Deleted) - Add strongly-typed Fields struct with all known ledger fields - Fix transaction_result type from Amount to Cow<str> - Add NFToken, offer, and MPToken metadata fields - Add comprehensive test suite (99.7% line coverage) Resolves #152
1 task
Preserve the pre-existing public import path `xrpl::models::results::metadata::TransactionMetadata` as a `#[deprecated]` re-export so downstream crates compiled against 1.1.0 keep building. New code should import from `xrpl::models::transactions::metadata` directly. Bump crate version to 1.2.0 (additive public surface, no removals) and document the move in CHANGELOG.md.
The rippleci/rippled:develop image updated after 2026-04-01 and broke integration tests across all PRs (container exits before becoming healthy, causing Connection refused on localhost:5005). Pin to the last known-good digest and replace the simple until loop with a bounded retry that checks container liveness, prints status per attempt, and dumps container logs on failure.
3 tasks
pdp2121
pushed a commit
that referenced
this pull request
Apr 21, 2026
… #3270) (#291) ## Summary The `rippled` binary was renamed to `xrpld` upstream, and the `rippleci/rippled` image stopped receiving updates. Our integration tests across every open PR started failing because the published `develop` image exited before becoming healthy (`Connection refused` on `localhost:5005`, **0 passed / 41 failed**). This PR mirrors the upstream fix in xrpl.js: [XRPLF/xrpl.js#3270](XRPLF/xrpl.js#3270). Switching to `rippleci/xrpld:develop` is the **actual root-cause fix** rather than pinning an old digest of the deprecated image. ## Changes `.github/workflows/integration_test.yml`: - `RIPPLED_DOCKER_IMAGE` -> `XRPLD_DOCKER_IMAGE: rippleci/xrpld:develop`. - `docker run` simplified to `${IMAGE} --standalone` (the `xrpld` image handles `mkdir` + launch internally; no more `bash -c "mkdir -p /var/lib/rippled/db/ && rippled -a"` wrapper). - Volume mount changed from `/etc/opt/ripple/` to `/etc/opt/xrpld/`. - Container name: `rippled-service` -> `xrpld-service`. - Removed the docker `--health-cmd` (which shelled out to the renamed `rippled` CLI and always failed) in favour of a direct JSON-RPC poll against `http://localhost:5005/`. - Always dump container logs on the stop step for post-mortem visibility. `.ci-config/rippled.cfg` -> `.ci-config/xrpld.cfg`: - `path=/var/lib/rippled/db/nudb` -> `path=/var/lib/xrpld/db/nudb`. - `[database_path] /var/lib/rippled/db` -> `/var/lib/xrpld/db`. - `[debug_logfile] /var/log/rippled/debug.log` -> `/var/log/xrpld/debug.log`. ## Verification Validated on throwaway PR #292 (now closed): **Integration Test green in 2m53s** on this exact workflow. Unit tests, Build & Lint, Quality Check also pass. ## Related follow-up The 7 in-flight PRs (#130, #131, #151, #153, #156, #157, #158) currently carry a stopgap commit pinning `rippleci/rippled:develop` to a specific digest. After this PR merges to `main`, those branches should: 1. Rebase on `main` to pick up the xrpld switch, or 2. Cherry-pick this commit and drop the stopgap digest pin. ## Test plan - [x] Validated end-to-end on PR #292 - [x] Build & Lint, Unit Test, Integration Test, Quality Check all pass - [ ] Merge and confirm subsequent PRs inherit the fix without manual cherry-pick ## Credit Approach lifted from @ckeshava's [xrpl.js#3270](XRPLF/xrpl.js#3270).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
There were two
TransactionMetadatastructs — one inresults/metadata.rs, one intransactions/metadata.rs. This removes the duplicate and keeps everything intransactions/metadata.rs.While I was in there, fixed and extended the model:
transaction_resultwas typed asAmountbut it's a result code string like"tesSUCCESS"— nowCow<str>DeliveredAmountis now an enum that handles both real amounts and the literal"unavailable"string (pre-2014 partial payments)AffectedNodeis a proper enum (CreatedNode/ModifiedNode/DeletedNode) instead of raw JSONnftoken_id,nftoken_ids,offer_id,mpt_issuance_id)Supersedes #110. Resolves #152.
Test plan