iotaledger / iota / 24972442756

67%

Build Type

push

github

Committed by web-flow

Commit Message

feat: Move `schemars` impls from `iota-types` to `iota-json-rpc-types` (#10508)

[run-ci]

### Summary

This PR removes all `schemars` / `JsonSchema` dependencies from
`iota-types` (the core domain crate) and re-implements JSON schema
generation exclusively within `iota-json-rpc-types` (the RPC boundary
crate). The result is a cleaner separation of concerns: core types no
longer carry RPC-specific schema annotations, and the JSON-RPC layer
owns all serialisation and schema logic through a new `serde_utils`
module.

As a side-effect, the generated `openrpc.json` spec is substantially
simplified — many opaque wrapper schemas have been replaced by their
concrete primitive representations, and several schema types that were
never needed by external clients have been removed entirely.

---

### Motivation

`iota-types` previously derived `JsonSchema` directly on many core types
(addresses, digests, sequence numbers, signatures, etc.). This pulled
the `schemars` crate — a purely RPC-concern — into the core domain crate
as a hard dependency, causing unnecessary coupling. It also meant that
schema shape was dictated by the derive macro rather than by deliberate
API design choices.

---

### Changes

#### New: `crates/iota-json-rpc-types/src/serde_utils.rs`

A new module introduces purpose-built `serde_with` adapter types that
implement both serialisation/deserialisation **and** `JsonSchema` for
commonly shared primitives. These adapters are used with `#[serde_as]`
throughout the RPC types layer.

| Adapter | Schema produced | Notes |
|---|---|---|
| `serde_utils::IotaAddress` | `string` | Wraps native `IotaAddress` |
| `serde_utils::ObjectID` | `string` | Wraps native `ObjectID` |
| `serde_utils::SequenceNumberString` | `string` | `u64` serialised as a
decimal string |
| `serde_utils::SequenceNumberU64` | `integer (uint64)` | Used where a
raw integer is appropriate |
| `serde_utils::ProtocolVersion` | `string` | Wraps
`iota_protocol_config::ProtocolVersion` |... (continued)

Coverage Stats

736 of 1056 new or added lines in 36 files covered. (69.7%)

211 existing lines in 39 files now uncovered.

176638 of 269310 relevant lines covered (65.59%)

432744.5 hits per line