xrpl-rust 1.1.0

A 100% Rust library to interact with the XRPL
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

use crate::{
    core::exceptions::XRPLCoreException,
    models::transactions::{account_set::AccountSetFlag, payment::PaymentFlag},
};
use alloc::string::String;
use thiserror_no_std::Error;

#[derive(Debug, PartialEq, Error)]
pub enum XRPLTransactionException {
    #[error("{0}")]
    XRPLAccountSetError(#[from] XRPLAccountSetException),
    #[error("{0}")]
    XRPLNFTokenCancelOfferError(#[from] XRPLNFTokenCancelOfferException),
    #[error("{0}")]
    XRPLNFTokenCreateOfferError(#[from] XRPLNFTokenCreateOfferException),
    #[error("{0}")]
    XRPLPaymentError(#[from] XRPLPaymentException),
    #[error("{0}")]
    XRPLSignerListSetError(#[from] XRPLSignerListSetException),
    #[error("{0}")]
    XRPLXChainClaimError(#[from] XRPLXChainClaimException),
    #[error("{0}")]
    XRPLXChainCreateBridgeError(#[from] XRPLXChainCreateBridgeException),
    #[error("{0}")]
    XRPLXChainCreateClaimIDError(#[from] XRPLXChainCreateClaimIDException),
    #[error("{0}")]
    XRPLXChainModifyBridgeError(#[from] XRPLXChainModifyBridgeException),
    #[error("{0}")]
    XRPLAMMCreateError(#[from] XRPLAMMCreateException),
    #[error("{0}")]
    XRPLCoreError(#[from] XRPLCoreException),
    #[error("The transaction must be signed")]
    TxMustBeSigned,
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLTransactionException {}

#[derive(Debug, PartialEq, Error)]
pub enum XRPLTransactionFieldException {
    #[error("There is no transaction common field `{0:?}`")]
    InvalidCommonField(String),
    #[error("There is no account field named `{0:?}`")]
    UnknownAccountField(String),
}

#[derive(Debug, PartialEq, Error)]
pub enum XRPLAccountSetException {
    /// A field can only be defined if a transaction flag is set.
    #[error("For the field `{field:?}` to be defined it is required to set the flag `{flag:?}`")]
    FieldRequiresFlag { field: String, flag: AccountSetFlag },
    /// An account set flag can only be set if a field is defined.
    #[error("For the flag `{flag:?}` to be set it is required to define the field `{field:?}`")]
    FlagRequiresField { flag: AccountSetFlag, field: String },
    /// Am account set flag can not be set and unset at the same time.
    #[error("A flag cannot be set and unset at the same time (found {found:?})")]
    SetAndUnsetSameFlag { found: AccountSetFlag },
    /// A field was defined and an account set flag that is required for that field was unset.
    #[error(
        "The field `{field:?}` cannot be defined if its required flag `{flag:?}` is being unset"
    )]
    SetFieldWhenUnsetRequiredFlag { field: String, flag: AccountSetFlag },
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLAccountSetException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum XRPLNFTokenCancelOfferException {
    /// A collection was defined to be empty.
    #[error("The value of the field `{field:?}` is not allowed to be empty (type `{r#type:?}`). If the field is optional, define it to be `None`")]
    CollectionEmpty { field: String, r#type: String },
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLNFTokenCancelOfferException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum XRPLNFTokenCreateOfferException {
    /// An optional value must be defined in a certain context.
    #[error("The optional field `{field:?}` is required to be defined for {context:?}")]
    OptionRequired { field: String, context: String },
    /// An optional value is not allowed to be defined in a certain context.
    #[error("The optional field `{field:?}` is not allowed to be defined for {context:?}")]
    IllegalOption { field: String, context: String },
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLNFTokenCreateOfferException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum XRPLPaymentException {
    /// An optional value must be defined in a certain context.
    #[error("The optional field `{field:?}` is required to be defined for {context:?}")]
    OptionRequired { field: String, context: String },
    /// An optional value is not allowed to be defined in a certain context.
    #[error("The optional field `{field:?}` is not allowed to be defined for {context:?}")]
    IllegalOption { field: String, context: String },
    /// A fields value is not allowed to be the same as another fields value, in a certain context.
    #[error("The value of the field `{field1:?}` is not allowed to be the same as the value of the field `{field2:?}`, for {context:?}")]
    ValueEqualsValueInContext {
        field1: String,
        field2: String,
        context: String,
    },
    /// An account set flag can only be set if a field is defined.
    #[error("For the flag `{flag:?}` to be set it is required to define the field `{field:?}`")]
    FlagRequiresField { flag: PaymentFlag, field: String },
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLPaymentException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[non_exhaustive]
pub enum XRPLSignerListSetException {
    /// A field was defined that another field definition would delete.
    #[error("The value of the field `{field1:?}` can not be defined with the field `{field2:?}` because it would cause the deletion of `{field1:?}`")]
    ValueCausesValueDeletion { field1: String, field2: String },
    /// A field is expected to have a certain value to be deleted.
    #[error("The field `{field:?}` has the wrong value to be deleted (expected {expected:?}, found {found:?})")]
    InvalidValueForValueDeletion {
        field: String,
        expected: u32,
        found: u32,
    },
    /// A collection has too few items in it.
    #[error(
        "The value of the field `{field:?}` has too few items in it (min {min:?}, found {found:?})"
    )]
    CollectionTooFewItems {
        field: String,
        min: usize,
        found: usize,
    },
    /// A collection has too many items in it.
    #[error("The value of the field `{field:?}` has too many items in it (max {max:?}, found {found:?})")]
    CollectionTooManyItems {
        field: String,
        max: usize,
        found: usize,
    },
    /// A collection is not allowed to have duplicates in it.
    #[error("The value of the field `{field:?}` has a duplicate in it (found {found:?})")]
    CollectionItemDuplicate { field: String, found: String },
    /// A collection contains an invalid value.
    #[error("The field `{field:?}` contains an invalid value (found {found:?})")]
    CollectionInvalidItem { field: String, found: String },
    #[error("The field `signer_quorum` must be below or equal to the sum of `signer_weight` in `signer_entries` (max {max}, found {found})")]
    SignerQuorumExceedsSignerWeight { max: u32, found: u32 },
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLSignerListSetException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[non_exhaustive]
pub enum XRPLXChainClaimException {
    #[error("`amount` must match either `locking_chain_issue` or `issuing_chain_issue`")]
    AmountMismatch,
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLXChainClaimException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[non_exhaustive]
pub enum XRPLXChainCreateBridgeException {
    #[error("Cannot have the same door accounts on the locking and issuing chain")]
    SameDoorAccounts,
    #[error(
        "The `account` field must either match the `locking_chain_door` or `issuing_chain_door`"
    )]
    AccountDoorMismatch,
    #[error("Bridge must be XRP-XRP or IOU-IOU")]
    CrossCurrencyBridgeNotAllowed,
    #[error("Cannot have MinAccountCreateAmount if bridge is IOU-IOU")]
    MinAccountCreateAmountForIOU,
    #[error("`signature_reward` must be numeric")]
    SignatureRewartMustBeNumberic,
    #[error("`min_account_create_amount` must be numeric")]
    MinAccountCreateAmountMustBeNumberic,
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLXChainCreateBridgeException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[non_exhaustive]
pub enum XRPLXChainCreateClaimIDException {
    #[error("`other_chain_source` must be a valid XRPL address")]
    OtherChainSourceIsInvalid,
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLXChainCreateClaimIDException {}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[non_exhaustive]
pub enum XRPLXChainModifyBridgeException {
    #[error("Must either change `signature_reward`, change `min_account_create_amount`, or clear `min_account_create_amount`")]
    MustChangeOrClear,
    #[error("`account` must be either `locking_chain_door` or `issuing_chain_door`")]
    AccountDoorMismatch,
    #[error("Cannot have MinAccountCreateAmount if bridge is IOU-IOU")]
    CannotHaveMinAccountCreateAmount,
}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum XRPLAMMCreateException {
    #[error("The trading fee must be between 0 and {max:?} (found {found:?})")]
    TradingFeeOutOfRange { max: u16, found: u16 },
}

#[cfg(feature = "std")]
impl alloc::error::Error for XRPLAMMCreateException {}