//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vta/webvh/dids/get`. Version: `1.0`.
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
/// Error from a `TryFrom` or `FromStr` implementation.
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
///Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ext",
/// "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
/// "type": "object",
/// "minProperties": 1,
/// "additionalProperties": true,
/// "propertyNames": {
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
/// }
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Ext(pub ::std::collections::HashMap<ExtKey, ::serde_json::Value>);
impl ::std::ops::Deref for Ext {
type Target = ::std::collections::HashMap<ExtKey, ::serde_json::Value>;
fn deref(&self) -> &::std::collections::HashMap<ExtKey, ::serde_json::Value> {
&self.0
}
}
impl ::std::convert::From<Ext> for ::std::collections::HashMap<ExtKey, ::serde_json::Value> {
fn from(value: Ext) -> Self {
value.0
}
}
impl ::std::convert::From<::std::collections::HashMap<ExtKey, ::serde_json::Value>> for Ext {
fn from(value: ::std::collections::HashMap<ExtKey, ::serde_json::Value>) -> Self {
Self(value)
}
}
///`ExtKey`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ExtKey(::std::string::String);
impl ::std::ops::Deref for ExtKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ExtKey> for ::std::string::String {
fn from(value: ExtKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for ExtKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for ExtKey {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///`Payload`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/vta/webvh/dids/get/1.0",
/// "title": "Payload",
/// "type": "object",
/// "required": [
/// "did"
/// ],
/// "properties": {
/// "did": {
/// "type": "string",
/// "minLength": 1
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "includeLog": {
/// "description": "Return the DID's log as well as the record. The log is the DID's whole history and can be large; it is also the only thing a verifier can check the current document against, so a consumer auditing a DID asks for it.",
/// "default": false,
/// "type": "boolean"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
pub did: PayloadDid,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Return the DID's log as well as the record. The log is the DID's whole history and can be large; it is also the only thing a verifier can check the current document against, so a consumer auditing a DID asks for it.
#[serde(rename = "includeLog", default)]
pub include_log: bool,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///`PayloadDid`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadDid(::std::string::String);
impl ::std::ops::Deref for PayloadDid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadDid> for ::std::string::String {
fn from(value: PayloadDid) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadDid {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadDid {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadDid {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadDid {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for PayloadDid {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Success response to vta/webvh/dids/get. Type https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "Success response to vta/webvh/dids/get. Type https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response.",
/// "type": "object",
/// "required": [
/// "record"
/// ],
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "log": {
/// "description": "The DID log, present only when `includeLog` was true. Its absence means it was not asked for — never that the DID has no history.",
/// "type": "string"
/// },
/// "record": {
/// "$ref": "#/definitions/WebvhDidRecord"
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///The DID log, present only when `includeLog` was true. Its absence means it was not asked for — never that the DID has no history.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub log: ::std::option::Option<::std::string::String>,
pub record: WebvhDidRecord,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "WebvhDidRecord",
/// "description": "A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.",
/// "type": "object",
/// "required": [
/// "contextId",
/// "createdAt",
/// "did",
/// "logEntryCount",
/// "mnemonic",
/// "portable",
/// "scid",
/// "serverId",
/// "updatedAt"
/// ],
/// "properties": {
/// "contextId": {
/// "description": "Context this DID belongs to. Deleting that context destroys this DID.",
/// "type": "string"
/// },
/// "createdAt": {
/// "type": "string",
/// "format": "date-time"
/// },
/// "did": {
/// "description": "The DID, e.g. `did:webvh:<scid>:example.com:alice`.",
/// "type": "string"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "logEntryCount": {
/// "description": "Number of entries in the log.",
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "mnemonic": {
/// "description": "The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical.",
/// "type": "string"
/// },
/// "nextFragmentId": {
/// "description": "Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key.",
/// "default": 1,
/// "type": "integer",
/// "minimum": 1.0
/// },
/// "portable": {
/// "description": "Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry.",
/// "type": "boolean"
/// },
/// "preRotationCount": {
/// "description": "Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance.",
/// "default": 0,
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "scid": {
/// "description": "Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place.",
/// "type": "string"
/// },
/// "serverId": {
/// "description": "Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with.",
/// "type": "string"
/// },
/// "updatedAt": {
/// "type": "string",
/// "format": "date-time"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct WebvhDidRecord {
///Context this DID belongs to. Deleting that context destroys this DID.
#[serde(rename = "contextId")]
pub context_id: ::std::string::String,
#[serde(rename = "createdAt")]
pub created_at: ::chrono::DateTime<::chrono::offset::Utc>,
///The DID, e.g. `did:webvh:<scid>:example.com:alice`.
pub did: ::std::string::String,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Number of entries in the log.
#[serde(rename = "logEntryCount")]
pub log_entry_count: u64,
///The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical.
pub mnemonic: ::std::string::String,
///Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key.
#[serde(
rename = "nextFragmentId",
default = "defaults::default_nzu64::<::std::num::NonZeroU64, 1>"
)]
pub next_fragment_id: ::std::num::NonZeroU64,
///Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry.
pub portable: bool,
///Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance.
#[serde(rename = "preRotationCount", default)]
pub pre_rotation_count: u64,
///Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place.
pub scid: ::std::string::String,
///Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with.
#[serde(rename = "serverId")]
pub server_id: ::std::string::String,
#[serde(rename = "updatedAt")]
pub updated_at: ::chrono::DateTime<::chrono::offset::Utc>,
}
impl WebvhDidRecord {
pub fn builder() -> builder::WebvhDidRecord {
Default::default()
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct Payload {
did: ::std::result::Result<super::PayloadDid, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
include_log: ::std::result::Result<bool, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
did: Err("no value supplied for did".to_string()),
ext: Ok(Default::default()),
include_log: Ok(Default::default()),
}
}
}
impl Payload {
pub fn did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PayloadDid>,
T::Error: ::std::fmt::Display,
{
self.did = value
.try_into()
.map_err(|e| format!("error converting supplied value for did: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn include_log<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.include_log = value
.try_into()
.map_err(|e| format!("error converting supplied value for include_log: {e}"));
self
}
}
impl ::std::convert::TryFrom<Payload> for super::Payload {
type Error = super::error::ConversionError;
fn try_from(value: Payload) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
did: value.did?,
ext: value.ext?,
include_log: value.include_log?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
did: Ok(value.did),
ext: Ok(value.ext),
include_log: Ok(value.include_log),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
log: ::std::result::Result<
::std::option::Option<::std::string::String>,
::std::string::String,
>,
record: ::std::result::Result<super::WebvhDidRecord, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
log: Ok(Default::default()),
record: Err("no value supplied for record".to_string()),
}
}
}
impl Response {
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn log<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<::std::string::String>>,
T::Error: ::std::fmt::Display,
{
self.log = value
.try_into()
.map_err(|e| format!("error converting supplied value for log: {e}"));
self
}
pub fn record<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::WebvhDidRecord>,
T::Error: ::std::fmt::Display,
{
self.record = value
.try_into()
.map_err(|e| format!("error converting supplied value for record: {e}"));
self
}
}
impl ::std::convert::TryFrom<Response> for super::Response {
type Error = super::error::ConversionError;
fn try_from(value: Response) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
ext: value.ext?,
log: value.log?,
record: value.record?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
ext: Ok(value.ext),
log: Ok(value.log),
record: Ok(value.record),
}
}
}
#[derive(Clone, Debug)]
pub struct WebvhDidRecord {
context_id: ::std::result::Result<::std::string::String, ::std::string::String>,
created_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
did: ::std::result::Result<::std::string::String, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
log_entry_count: ::std::result::Result<u64, ::std::string::String>,
mnemonic: ::std::result::Result<::std::string::String, ::std::string::String>,
next_fragment_id: ::std::result::Result<::std::num::NonZeroU64, ::std::string::String>,
portable: ::std::result::Result<bool, ::std::string::String>,
pre_rotation_count: ::std::result::Result<u64, ::std::string::String>,
scid: ::std::result::Result<::std::string::String, ::std::string::String>,
server_id: ::std::result::Result<::std::string::String, ::std::string::String>,
updated_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
}
impl ::std::default::Default for WebvhDidRecord {
fn default() -> Self {
Self {
context_id: Err("no value supplied for context_id".to_string()),
created_at: Err("no value supplied for created_at".to_string()),
did: Err("no value supplied for did".to_string()),
ext: Ok(Default::default()),
log_entry_count: Err("no value supplied for log_entry_count".to_string()),
mnemonic: Err("no value supplied for mnemonic".to_string()),
next_fragment_id: Ok(super::defaults::default_nzu64::<::std::num::NonZeroU64, 1>()),
portable: Err("no value supplied for portable".to_string()),
pre_rotation_count: Ok(Default::default()),
scid: Err("no value supplied for scid".to_string()),
server_id: Err("no value supplied for server_id".to_string()),
updated_at: Err("no value supplied for updated_at".to_string()),
}
}
}
impl WebvhDidRecord {
pub fn context_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::string::String>,
T::Error: ::std::fmt::Display,
{
self.context_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for context_id: {e}"));
self
}
pub fn created_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.created_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for created_at: {e}"));
self
}
pub fn did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::string::String>,
T::Error: ::std::fmt::Display,
{
self.did = value
.try_into()
.map_err(|e| format!("error converting supplied value for did: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn log_entry_count<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<u64>,
T::Error: ::std::fmt::Display,
{
self.log_entry_count = value
.try_into()
.map_err(|e| format!("error converting supplied value for log_entry_count: {e}"));
self
}
pub fn mnemonic<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::string::String>,
T::Error: ::std::fmt::Display,
{
self.mnemonic = value
.try_into()
.map_err(|e| format!("error converting supplied value for mnemonic: {e}"));
self
}
pub fn next_fragment_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::num::NonZeroU64>,
T::Error: ::std::fmt::Display,
{
self.next_fragment_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for next_fragment_id: {e}"));
self
}
pub fn portable<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.portable = value
.try_into()
.map_err(|e| format!("error converting supplied value for portable: {e}"));
self
}
pub fn pre_rotation_count<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<u64>,
T::Error: ::std::fmt::Display,
{
self.pre_rotation_count = value.try_into().map_err(|e| {
format!("error converting supplied value for pre_rotation_count: {e}")
});
self
}
pub fn scid<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::string::String>,
T::Error: ::std::fmt::Display,
{
self.scid = value
.try_into()
.map_err(|e| format!("error converting supplied value for scid: {e}"));
self
}
pub fn server_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::string::String>,
T::Error: ::std::fmt::Display,
{
self.server_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for server_id: {e}"));
self
}
pub fn updated_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.updated_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for updated_at: {e}"));
self
}
}
impl ::std::convert::TryFrom<WebvhDidRecord> for super::WebvhDidRecord {
type Error = super::error::ConversionError;
fn try_from(
value: WebvhDidRecord,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
context_id: value.context_id?,
created_at: value.created_at?,
did: value.did?,
ext: value.ext?,
log_entry_count: value.log_entry_count?,
mnemonic: value.mnemonic?,
next_fragment_id: value.next_fragment_id?,
portable: value.portable?,
pre_rotation_count: value.pre_rotation_count?,
scid: value.scid?,
server_id: value.server_id?,
updated_at: value.updated_at?,
})
}
}
impl ::std::convert::From<super::WebvhDidRecord> for WebvhDidRecord {
fn from(value: super::WebvhDidRecord) -> Self {
Self {
context_id: Ok(value.context_id),
created_at: Ok(value.created_at),
did: Ok(value.did),
ext: Ok(value.ext),
log_entry_count: Ok(value.log_entry_count),
mnemonic: Ok(value.mnemonic),
next_fragment_id: Ok(value.next_fragment_id),
portable: Ok(value.portable),
pre_rotation_count: Ok(value.pre_rotation_count),
scid: Ok(value.scid),
server_id: Ok(value.server_id),
updated_at: Ok(value.updated_at),
}
}
}
}
/// Generation of default values for serde.
pub mod defaults {
pub(super) fn default_nzu64<T, const V: u64>() -> T
where
T: ::std::convert::TryFrom<::std::num::NonZeroU64>,
<T as ::std::convert::TryFrom<::std::num::NonZeroU64>>::Error: ::std::fmt::Debug,
{
T::try_from(::std::num::NonZeroU64::try_from(V).unwrap()).unwrap()
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/webvh/dids/get/1.0";
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"Ext\": {\n \"additionalProperties\": true,\n \"description\": \"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Success response to vta/webvh/dids/get. Type https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"log\": {\n \"description\": \"The DID log, present only when `includeLog` was true. Its absence means it was not asked for — never that the DID has no history.\",\n \"type\": \"string\"\n },\n \"record\": {\n \"$ref\": \"#/$defs/WebvhDidRecord\"\n }\n },\n \"required\": [\n \"record\"\n ],\n \"title\": \"VTA WebVH DIDs Get — response payload\",\n \"type\": \"object\"\n },\n \"WebvhDidRecord\": {\n \"additionalProperties\": false,\n \"description\": \"A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.\",\n \"properties\": {\n \"contextId\": {\n \"description\": \"Context this DID belongs to. Deleting that context destroys this DID.\",\n \"type\": \"string\"\n },\n \"createdAt\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"did\": {\n \"description\": \"The DID, e.g. `did:webvh:<scid>:example.com:alice`.\",\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"logEntryCount\": {\n \"description\": \"Number of entries in the log.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"mnemonic\": {\n \"description\": \"The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical.\",\n \"type\": \"string\"\n },\n \"nextFragmentId\": {\n \"default\": 1,\n \"description\": \"Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key.\",\n \"minimum\": 1,\n \"type\": \"integer\"\n },\n \"portable\": {\n \"description\": \"Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry.\",\n \"type\": \"boolean\"\n },\n \"preRotationCount\": {\n \"default\": 0,\n \"description\": \"Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"scid\": {\n \"description\": \"Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place.\",\n \"type\": \"string\"\n },\n \"serverId\": {\n \"description\": \"Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with.\",\n \"type\": \"string\"\n },\n \"updatedAt\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"did\",\n \"serverId\",\n \"mnemonic\",\n \"scid\",\n \"contextId\",\n \"portable\",\n \"logEntryCount\",\n \"createdAt\",\n \"updatedAt\"\n ],\n \"title\": \"WebvhDidRecord\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/vta/webvh/dids/get/1.0\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"properties\": {\n \"did\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"includeLog\": {\n \"default\": false,\n \"description\": \"Return the DID's log as well as the record. The log is the DID's whole history and can be large; it is also the only thing a verifier can check the current document against, so a consumer auditing a DID asks for it.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"did\"\n ],\n \"title\": \"VTA WebVH DIDs Get — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response";
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"Ext\": {\n \"additionalProperties\": true,\n \"description\": \"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Success response to vta/webvh/dids/get. Type https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"log\": {\n \"description\": \"The DID log, present only when `includeLog` was true. Its absence means it was not asked for — never that the DID has no history.\",\n \"type\": \"string\"\n },\n \"record\": {\n \"$ref\": \"#/$defs/WebvhDidRecord\"\n }\n },\n \"required\": [\n \"record\"\n ],\n \"title\": \"VTA WebVH DIDs Get — response payload\",\n \"type\": \"object\"\n },\n \"WebvhDidRecord\": {\n \"additionalProperties\": false,\n \"description\": \"A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.\",\n \"properties\": {\n \"contextId\": {\n \"description\": \"Context this DID belongs to. Deleting that context destroys this DID.\",\n \"type\": \"string\"\n },\n \"createdAt\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"did\": {\n \"description\": \"The DID, e.g. `did:webvh:<scid>:example.com:alice`.\",\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"logEntryCount\": {\n \"description\": \"Number of entries in the log.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"mnemonic\": {\n \"description\": \"The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical.\",\n \"type\": \"string\"\n },\n \"nextFragmentId\": {\n \"default\": 1,\n \"description\": \"Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key.\",\n \"minimum\": 1,\n \"type\": \"integer\"\n },\n \"portable\": {\n \"description\": \"Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry.\",\n \"type\": \"boolean\"\n },\n \"preRotationCount\": {\n \"default\": 0,\n \"description\": \"Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"scid\": {\n \"description\": \"Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place.\",\n \"type\": \"string\"\n },\n \"serverId\": {\n \"description\": \"Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with.\",\n \"type\": \"string\"\n },\n \"updatedAt\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"did\",\n \"serverId\",\n \"mnemonic\",\n \"scid\",\n \"contextId\",\n \"portable\",\n \"logEntryCount\",\n \"createdAt\",\n \"updatedAt\"\n ],\n \"title\": \"WebvhDidRecord\",\n \"type\": \"object\"\n }\n },\n \"$ref\": \"#/$defs/Response\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\"\n}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
#[cfg(test)]
mod conformance {
//! Round-trip tests harvested from the spec's `spec.md`,
//! plus a `rejects_invalid_examples` test for any fixtures
//! in `payload.invalid-examples.json` (validate feature).
#[test]
fn request_example_1() {
const JSON: &str = "{\n \"id\": \"1a2b3c4d-0000-4000-8000-000000000001\",\n \"type\": \"https://trusttasks.org/spec/vta/webvh/dids/get/1.0\",\n \"issuer\": \"did:key:z6MkOperator\",\n \"recipient\": \"did:web:vta.example\",\n \"issuedAt\": \"2026-08-19T11:00:00Z\",\n \"payload\": {\n \"did\": \"did:webvh:QmScidAbCdEfGh:example.com:alice\",\n \"includeLog\": true\n }\n}\n";
let doc: crate::TrustTask<super::Payload> =
serde_json::from_str(JSON).expect("deserialize request example");
let rendered = serde_json::to_value(&doc).expect("re-serialize");
let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
assert_eq!(rendered, expected, "request example failed round-trip");
}
#[test]
fn response_example_1() {
const JSON: &str = "{\n \"id\": \"2b3c4d5e-0000-4000-8000-000000000002\",\n \"type\": \"https://trusttasks.org/spec/vta/webvh/dids/get/1.0#response\",\n \"issuer\": \"did:web:vta.example\",\n \"recipient\": \"did:key:z6MkOperator\",\n \"issuedAt\": \"2026-08-19T11:00:01Z\",\n \"threadId\": \"1a2b3c4d-0000-4000-8000-000000000001\",\n \"payload\": {\n \"record\": {\n \"did\": \"did:webvh:QmScidAbCdEfGh:example.com:alice\",\n \"serverId\": \"prod\",\n \"mnemonic\": \"alice\",\n \"scid\": \"QmScidAbCdEfGh\",\n \"contextId\": \"personal\",\n \"portable\": true,\n \"logEntryCount\": 4,\n \"preRotationCount\": 3,\n \"nextFragmentId\": 5,\n \"createdAt\": \"2026-08-19T11:00:01Z\",\n \"updatedAt\": \"2026-08-19T12:30:00Z\"\n },\n \"log\": \"{\\\"versionId\\\":\\\"1-QmScid…\\\"}\\n{\\\"versionId\\\":\\\"2-…\\\"}\\n\"\n }\n}\n";
let doc: crate::TrustTask<super::Response> =
serde_json::from_str(JSON).expect("deserialize response example");
let rendered = serde_json::to_value(&doc).expect("re-serialize");
let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
assert_eq!(rendered, expected, "response example failed round-trip");
}
}