provenance-mark 0.23.1

A cryptographically-secured system for establishing and verifying the authenticity of works
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    /// Invalid Seed length
    #[error("invalid seed length: expected 32 bytes, got {actual} bytes")]
    InvalidSeedLength { actual: usize },

    /// Duplicate key
    #[error("duplicate key: {0}")]
    DuplicateKey(String),

    /// Missing key
    #[error("missing key: {0}")]
    MissingKey(String),

    /// Invalid key
    #[error("invalid key: {0}")]
    InvalidKey(String),

    /// Extra keys
    #[error("wrong number of keys: expected {0}, got {1}")]
    ExtraKeys(usize, usize),

    /// Invalid key length for the given resolution
    #[error("invalid key length: expected {expected}, got {actual}")]
    InvalidKeyLength { expected: usize, actual: usize },

    /// Invalid next key length for the given resolution
    #[error("invalid next key length: expected {expected}, got {actual}")]
    InvalidNextKeyLength { expected: usize, actual: usize },

    /// Invalid chain ID length for the given resolution
    #[error("invalid chain ID length: expected {expected}, got {actual}")]
    InvalidChainIdLength { expected: usize, actual: usize },

    /// Invalid message length for the given resolution
    #[error(
        "invalid message length: expected at least {expected}, got {actual}"
    )]
    InvalidMessageLength { expected: usize, actual: usize },

    /// Invalid CBOR data in info field
    #[error("invalid CBOR data in info field")]
    InvalidInfoCbor,

    /// Date out of range for serialization
    #[error("date out of range: {details}")]
    DateOutOfRange { details: String },

    /// Invalid date components
    #[error("invalid date: {details}")]
    InvalidDate { details: String },

    /// Missing required URL parameter
    #[error("missing required URL parameter: {parameter}")]
    MissingUrlParameter { parameter: String },

    /// Year out of range for 2-byte serialization
    #[error(
        "year out of range for 2-byte serialization: must be between 2023-2150, got {year}"
    )]
    YearOutOfRange { year: i32 },

    /// Invalid month or day
    #[error("invalid month ({month}) or day ({day}) for year {year}")]
    InvalidMonthOrDay { year: i32, month: u32, day: u32 },

    /// Resolution serialization error
    #[error("resolution serialization error: {details}")]
    ResolutionError { details: String },

    /// Bytewords encoding/decoding error
    #[error("bytewords error: {0}")]
    Bytewords(#[from] bc_ur::Error),

    /// CBOR encoding/decoding error
    #[error("CBOR error: {0}")]
    Cbor(#[from] dcbor::Error),

    /// URL parsing error
    #[error("URL parsing error: {0}")]
    Url(#[from] url::ParseError),

    /// Base64 decoding error
    #[error("base64 decoding error: {0}")]
    Base64(#[from] base64::DecodeError),

    /// JSON serialization error
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),

    /// Integer conversion error
    #[error("integer conversion error: {0}")]
    TryFromInt(#[from] std::num::TryFromIntError),

    #[cfg(feature = "envelope")]
    #[error("envelope error: {0}")]
    Envelope(#[from] bc_envelope::Error),

    /// Validation error
    #[error("validation error: {0}")]
    Validation(#[from] crate::validate::ValidationIssue),
}

pub type Result<T> = std::result::Result<T, Error>;

impl From<Error> for dcbor::Error {
    fn from(error: Error) -> dcbor::Error {
        match error {
            Error::Cbor(err) => err,
            _ => dcbor::Error::Custom(error.to_string()),
        }
    }
}