Trait JsonConvertible

Source

pub trait JsonConvertible: Serialize + DeserializeOwned {
    // Provided methods
    fn to_json(&self) -> Result<JsonValue, ProtocolError> { ... }
    fn from_json(json: JsonValue) -> Result<Self, ProtocolError> { ... }
}

Expand description

Convert to/from JSON using human-readable serde (Identifier = base58, binary = base64).

This trait produces clean serde_json::Value with native number types. Any JS-boundary concerns (large number stringification) are handled by the WASM layer.

§⚠️ HR / non-HR divergence (Critical-1)

JsonConvertible calls serde_json::to_value, which uses a serializer that reports is_human_readable() == true. The mirror trait ValueConvertible uses platform_value::to_value, which reports false. Types whose Serialize impl branches on is_human_readable() produce structurally different output between the two paths:

Type	`to_json()` (HR)	`to_object()` (non-HR)
`platform_value::Identifier`	`"5bV6jUfh..."` (bs58 string)	`Value::Identifier([u8; 32])`
[`platform_value::BinaryData`]	`"sg=="` (base64 string)	`Value::Bytes(Vec<u8>)`
`Bytes20` / `Bytes32` / `Bytes36`	base64 string	`Value::Bytes32([u8; N])` etc.
`CoreScript`	`"dqkU..."` (base64 string)	`Value::Bytes(Vec<u8>)`

Do not assume self.to_object()?.try_into_json() ≡ self.to_json(). They render the same field as a string in one and a byte array in the other. Round-trip tests should exercise each path independently.

§⚠️ `ContentDeserializer` caveat

Manual Deserialize impls that branch on deserializer.is_human_readable() must also handle serde::__private::de::ContentDeserializer, used internally by #[serde(tag = "...")] enums. ContentDeserializer always reports is_human_readable: true regardless of the original source — so a non-HR platform_value::Value flowing into a tagged enum gets shape- inferred as if it were HR. Recipe: write a dual-shape visitor accepting both shapes in the HR branch via deserialize_any. See [platform_value::Bytes32::deserialize] for the canonical example, and rs-dpp/src/serialization/serde_bytes.rs for [u8; N] / Vec<u8>.

Provided Methods§

Source

fn to_json(&self) -> Result<JsonValue, ProtocolError>

Source

fn from_json(json: JsonValue) -> Result<Self, ProtocolError>

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

JsonConvertible

Trait JsonConvertible Copy item path

§⚠️ HR / non-HR divergence (Critical-1)

§⚠️ ContentDeserializer caveat

Provided Methods§

fn to_json(&self) -> Result<JsonValue, ProtocolError>

fn from_json(json: JsonValue) -> Result<Self, ProtocolError>

Dyn Compatibility§

Implementors§

impl JsonConvertible for AddressWitness

impl JsonConvertible for PlatformAddress

impl JsonConvertible for AddressFundsFeeStrategyStep

impl JsonConvertible for StoredAssetLockInfo

impl JsonConvertible for AssetLockValue

impl JsonConvertible for ExtendedBlockInfo

impl JsonConvertible for ExtendedEpochInfo

impl JsonConvertible for FinalizedEpochInfo

impl JsonConvertible for Validator

impl JsonConvertible for ValidatorSet

impl JsonConvertible for TokenConfiguration

impl JsonConvertible for TokenConfigurationPresetFeatures

impl JsonConvertible for TokenConfigurationConvention

impl JsonConvertible for TokenConfigurationChangeItem

impl JsonConvertible for TokenConfigurationLocalization

impl JsonConvertible for TokenDistributionInfo

impl JsonConvertible for TokenDistributionType

impl JsonConvertible for TokenDistributionTypeWithResolvedRecipient

impl JsonConvertible for TokenDistributionRules

impl JsonConvertible for TokenKeepsHistoryRules

impl JsonConvertible for TokenMarketplaceRules

impl JsonConvertible for TokenTradeMode

impl JsonConvertible for DistributionFunction

impl JsonConvertible for TokenDistributionRecipient

impl JsonConvertible for TokenDistributionResolvedRecipient

impl JsonConvertible for TokenPerpetualDistribution

impl JsonConvertible for RewardDistributionMoment

impl JsonConvertible for RewardDistributionType

impl JsonConvertible for TokenPreProgrammedDistribution

impl JsonConvertible for AuthorizedActionTakers

impl JsonConvertible for ChangeControlRules

impl JsonConvertible for DataContractConfig

impl JsonConvertible for ArrayItemType

impl JsonConvertible for ContestedIndexFieldMatch

impl JsonConvertible for ContestedIndexResolution

impl JsonConvertible for IndexCountability

impl JsonConvertible for OrderBy

impl JsonConvertible for Group

impl JsonConvertible for DataContractInSerializationFormat

impl JsonConvertible for StorageKeyRequirements

impl JsonConvertible for Document

impl JsonConvertible for GroupActionEvent

impl JsonConvertible for GroupAction

impl JsonConvertible for GroupActionStatus

impl JsonConvertible for Identity

impl JsonConvertible for ContractBounds

impl JsonConvertible for IdentityPublicKey

impl JsonConvertible for AssetLockProof

impl JsonConvertible for StateTransition

impl JsonConvertible for StateTransitionProofResult

impl JsonConvertible for AddressCreditWithdrawalTransition

impl JsonConvertible for AddressFundingFromAssetLockTransition

impl JsonConvertible for AddressFundsTransferTransition

impl JsonConvertible for BatchedTransition

impl JsonConvertible for DocumentPurchaseTransition

impl JsonConvertible for DocumentTransferTransition

impl JsonConvertible for DocumentTransition

impl JsonConvertible for DocumentUpdatePriceTransition

impl JsonConvertible for TokenTransition

impl JsonConvertible for DocumentBaseTransition

impl JsonConvertible for BatchTransition

impl JsonConvertible for DocumentCreateTransition

impl JsonConvertible for DocumentDeleteTransition

impl JsonConvertible for DocumentReplaceTransition

impl JsonConvertible for TokenBurnTransition

impl JsonConvertible for TokenClaimTransition

impl JsonConvertible for TokenConfigUpdateTransition

impl JsonConvertible for TokenDestroyFrozenFundsTransition

impl JsonConvertible for TokenDirectPurchaseTransition

impl JsonConvertible for TokenEmergencyActionTransition

impl JsonConvertible for TokenFreezeTransition

Trait JsonConvertible

§⚠️ `ContentDeserializer` caveat