xrpl-ruby 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b0269ba7fe6c319fca687c0a063389a358260f4c84bb5ae293f1fb6f8215b0f
-  data.tar.gz: ca8099d5daaa7f3b4e3c89cd3ea13870da4f15b60cbaeb08809edb36547121f3
+  metadata.gz: e07e1a6fd2b134d36dbbdaaa977cc39e8e9176499a29e69bd84e69ddfd6f6979
+  data.tar.gz: bcca5b159608288c0cdeffc562a76332fe4e831e4dc9813676f66d46c53546ac
 SHA512:
-  metadata.gz: a63151ad5c6885136417783f1234d6af8e32ea8346ce514430c8c65458dae0a0917cae0f8c2f1f7111c623e7e8098cc0b96643fbebbfd60554cd86f9c3cbd847
-  data.tar.gz: f32401a94218f1ae9621c4ba21f64c994b08f3d3128f2e2b159175c2aad195d8f7050ca094454ad084ad5c4aef80a9e71750401462a541b1f346b12bb581a05b
+  metadata.gz: fffeb72058c2a328c01bda6e6bfd63718147fc12326385c18c304b9d0e92013e60ba9ad11424af2ee6bd72c69e016494113db5c05ed26e10ee2501bc0873288a
+  data.tar.gz: 3aa7f43f67c50faaf0139a5f42737a35c5fd59408dc3098144a7a0b3a57bab5dad3eac3fa68fb9819749ba2dd0b7f91460de5e87899279e49b6ab07fcae87c83

data/CHANGELOG.md

@@ -5,6 +5,79 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2026-08-26
+
+The binary codec now passes the full ripple-binary-codec reference fixture set
+(287 cases, both directions). It previously passed none of them on decode: the
+fixtures had been vendored in `spec/binary-codec/fixtures/` for a long time
+without any spec loading them, so the suite reported green while decoding
+0 of 261 ledger objects.
+
+### Breaking
+
+- **`binary_to_json` returns different types.** UInt8/16/32 fields come back as
+  numbers instead of zero-padded hex strings (`Sequence` is `1`, not
+  `"00000001"`), and native XRP amounts come back as strings instead of
+  integers (`Balance` is `"370000000"`, not `370000000`). This is what rippled
+  itself returns; the previous output matched no implementation.
+- **`STObject#to_json` returns a Hash**, not a JSON string. The string return
+  forced every nested value through a parse on the way out, which is what
+  turned native amounts into integers.
+- **Malformed input raises.** `STObject#to_json` and `STArray#to_json` caught
+  every parser error and returned a partially decoded object. A codec that
+  silently drops fields is worse than one that fails, so the rescues are gone.
+- `tecHOOK_REJECTED` is no longer a known transaction result. It is a Xahau
+  code and never belonged in the XRP Ledger definitions.
+
+### Added
+
+- **Transaction models** — `XRPL::Transaction::Payment`, `::EscrowCreate` and
+  80 more, generated at load time from `TRANSACTION_FORMATS` so they cannot
+  drift from the definitions. Fields are written in snake_case and stored under
+  the ledger's own names; `#validate!` reports missing required fields before a
+  round trip is spent, and each type carries its flags as constants
+  (`Payment::TF_PARTIAL_PAYMENT`). A plain Hash still works everywhere a
+  transaction is accepted.
+- **`BinaryCodec::Number`** — the STNumber type (12 bytes: int64 mantissa,
+  int32 exponent). 17 serialised fields reference it — the Vault and Lending
+  Protocol amounts — and no class existed, so those fields could not be
+  encoded at all. The gap predates this release.
+- **`Issue` supports MPT** (`mpt_issuance_id`), in both directions.
+- **Conformance spec** running `codec-fixtures.json`, and a definitions spec
+  that checks every type a serialised field uses resolves to a class.
+
+### Changed
+
+- **`definitions.json` synced verbatim with XRPLF.** FIELDS 343 → 381,
+  TRANSACTION_TYPES 76 → 83, LEDGER_ENTRY_TYPES 31 → 32, TRANSACTION_RESULTS
+  189 → 195. Adds the Sponsorship and Confidential MPT fields and transactions,
+  `TakerGetsMPT`, `TakerPaysMPT` and `ReferenceHolding`. Renames `UInt384`/
+  `UInt512` to `Hash384`/`Hash512` and `MutableFlags` to `ImmutableFlags`; the
+  type map keeps the old names resolving.
+- `Client#autofill`, `#submit` and `#submit_and_wait` accept a transaction
+  model as well as a Hash.
+- The gemspec packages everything under `lib/`, not only the `.rb` files. Data
+  files previously needed an entry of their own, and a forgotten one would have
+  broken the installed gem while every local run stayed green, because the
+  working copy has the file either way. `spec/packaging_spec.rb` checks it now.
+
+### Fixed
+
+- **`Issue` read a fixed 40 bytes.** An XRP issue is 20, so the rest came out
+  of the following field: `Asset` and `Asset2` decoded as `nil` and
+  `IssuingChainDoor` as the zero account.
+- **`STArray.from_parser` dropped the ArrayEndMarker** it is meant to restore.
+  The reconstructed bytes had no terminator, so re-parsing them ran the array
+  on into the fields that followed — `AMMBid` lost `Asset` and `Asset2` into
+  `AuthAccounts`.
+- **`Currency#to_json` took no arguments** while every type is called as
+  `to_json(definitions, field_name)`. It raised `ArgumentError` for every
+  nested Currency field, which the silent rescue then swallowed — that is how
+  `BaseAsset` and `QuoteAsset` disappeared from `PriceDataSeries`.
+- **`XChainBridge` omitted the `0x14` length prefix** before each account,
+  which is why all eight XChain fixtures failed to serialise.
+- **A zero IOU rendered as `"-0"`** instead of `"0"`.
+
 ## [0.6.1] - 2026-08-12
 
 ### Added

data/README.md

@@ -69,6 +69,48 @@ puts result.dig('result', 'meta', 'TransactionResult') # => "tesSUCCESS"
 client.disconnect
 ```
 
+## Transactions
+
+A transaction can always be a plain Hash, as above. The transaction classes
+are an addition on top of that: they are generated from the field formats in
+`definitions.json`, so they know which fields a type accepts, which of them
+are required, and what its flags are called.
+
+```ruby
+payment = XRPL::Transaction::Payment.new(
+  account:     wallet.classic_address,
+  destination: receiver.classic_address,
+  amount:      '1000000',
+  flags:       XRPL::Transaction::Payment::TF_PARTIAL_PAYMENT
+)
+
+payment.validate!   # raises before a round trip is spent
+client.submit_and_wait(payment, wallet: wallet)
+```
+
+Fields are written in snake_case and stored under the ledger's own names, so
+`#to_h` produces exactly what the binary codec expects:
+
+```ruby
+payment.to_h
+# => {"TransactionType"=>"Payment", "Account"=>"r...", "Destination"=>"r...",
+#     "Amount"=>"1000000", "Flags"=>131072}
+```
+
+A field the type does not define is rejected when it is set, rather than by
+the server several seconds later:
+
+```ruby
+payment.limit_amount = {}   # NoMethodError
+XRPL::Transaction::Payment.new(limit_amount: {})
+# => XRPL::Transaction::ValidationError: Payment has no field LimitAmount
+```
+
+`XRPL::Transaction.from(hash)` builds the matching class from a transaction
+hash, which is useful for anything read back off the ledger. Note that
+`validate!` follows rippled's formats: it checks what the ledger requires for
+serialisation, which is not always what a transaction needs to be meaningful.
+
 The client is silent by default. To see diagnostic output, pass a logger:
 
 ```ruby