Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rewrite send::error::ResponseError docs #307

Merged
merged 2 commits into from
Jul 1, 2024
Merged

Rewrite send::error::ResponseError docs #307

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
098881e
Dont display `ResponseError::Validation` error..
jbesraa Jul 1, 2024
68c2e4f
Rewrite `send::error::ResponseError` docs
jbesraa Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions payjoin/src/send/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,19 +269,24 @@ impl From<InternalCreateRequestError> for CreateRequestError {
fn from(value: InternalCreateRequestError) -> Self { CreateRequestError(value) }
}

/// Represent an error returned by the receiver.
/// Represent an error returned by Payjoin receiver.
pub enum ResponseError {
/// `WellKnown` errors following the BIP78 spec
/// https://github.com/bitcoin/bips/blob/master/bip-0078.mediawiki#user-content-Receivers_well_known_errors
/// These errors are displayed to end users.
/// `WellKnown` Errors are defined in the [`BIP78::ReceiverWellKnownError`] spec.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find the use of :: to identify the receiver spec a bit odd since it's not referencing a rust module element but it does get the point across

///
/// The `WellKnownError` represents `errorCode` and `message`.
/// It is safe to display `WellKnown` errors to end users.
///
/// [`BIP78::ReceiverWellKnownError`]: https://github.com/bitcoin/bips/blob/master/bip-0078.mediawiki#user-content-Receivers_well_known_errors
WellKnown(WellKnownError),
/// `Unrecognized` errors are errors that are not well known and are only displayed in debug logs.
/// They are not displayed to end users.
/// `Unrecognized` Errors are NOT defined in the [`BIP78::ReceiverWellKnownError`] spec.
///
/// Its not safe to display `Unrecognized` errors to end users as they could be used
/// maliciously to phish a non technical user. Only display them in debug logs.
///
/// [`BIP78::ReceiverWellKnownError`]: https://github.com/bitcoin/bips/blob/master/bip-0078.mediawiki#user-content-Receivers_well_known_errors
Unrecognized { error_code: String, message: String },
/// `Validation` errors are errors that are caused by malformed responses.
/// They are only displayed in debug logs.
/// Errors caused by malformed responses.
///
/// These errors are only displayed in debug logs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment change is fine but "These errors are only displayed in debug logs" is false statement impl Display for ResponseError writes the ValidationError in the match arm for ResponseError::Validation

Consider fixing the Display implementation to only write a fixed string.

rust-payjoin/payjoin/src/send/error.rs

Line 354 in 1f87e82

Self::Validation(e) => write!(f, "The receiver sent an invalid response: {}", e),

Validation(ValidationError),
}

Expand Down Expand Up @@ -351,7 +356,7 @@ impl Display for ResponseError {
Self::WellKnown(e) => e.fmt(f),
// Don't display unknowns to end users, only debug logs
Self::Unrecognized { .. } => write!(f, "The receiver sent an unrecognized error."),
Self::Validation(e) => write!(f, "The receiver sent an invalid response: {}", e),
Self::Validation(_) => write!(f, "The receiver sent an invalid response."),
}
}
}
Expand Down Expand Up @@ -445,7 +450,7 @@ mod tests {
});
assert_eq!(
ResponseError::from_json(invalid_json_error).to_string(),
"The receiver sent an invalid response: couldn't decode as PSBT or JSON"
"The receiver sent an invalid response."
);
}
}
Loading