Skip to content

Document BIP77 v1 fallback behavior in create_post_request #1593

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

Merged
DanGould merged 2 commits into from
Jun 5, 2026
Merged

Document BIP77 v1 fallback behavior in create_post_request #1593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5b4e2f
docs(v2): Clarify create_post_request branches
DanGould Jun 1, 2026
5d70e3f
docs(ffi): Clarify create_post_request branches
DanGould Jun 1, 2026
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
15 changes: 14 additions & 1 deletion payjoin-ffi/src/receive/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1239,7 +1239,20 @@ impl PayjoinProposal {
.to_string()
}

/// Construct an OHTTP Encapsulated HTTP POST request for the Proposal PSBT
/// Construct an OHTTP-encapsulated HTTP request carrying the Proposal PSBT.
///
/// The inner HTTP method, body encoding, and target mailbox depend on
/// whether the original sender used Payjoin v2 (BIP 77) or Payjoin v1
/// (BIP 78), as recorded in the session context:
///
/// - v2 sender (reply key present): POST an HPKE-encrypted `PjV2MsgB`
/// payload to the sender's reply mailbox.
/// - v1 sender (no reply key): PUT the base64-encoded PSBT as cleartext
/// UTF-8 bytes to the receiver's own mailbox, per the
/// [BIP 77](https://github.com/bitcoin/bips/blob/master/bip-0077.md)
/// Backwards compatibility section.
///
/// Both paths are then OHTTP-encapsulated to the directory's OHTTP Gateway.
pub fn create_post_request(
&self,
ohttp_relay: String,
Expand Down
15 changes: 14 additions & 1 deletion payjoin/src/core/receive/v2/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1137,7 +1137,20 @@ impl Receiver<PayjoinProposal> {
/// The Payjoin Proposal PSBT.
pub fn psbt(&self) -> &Psbt { &self.psbt_context.payjoin_psbt }

/// Construct an OHTTP Encapsulated HTTP POST request for the Proposal PSBT
/// Construct an OHTTP-encapsulated HTTP request carrying the Proposal PSBT.

@xstoicunicornx xstoicunicornx Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

small nit:

Suggested change
/// Construct an OHTTP-encapsulated HTTP request carrying the Proposal PSBT.
/// Construct an OHTTP-encapsulated HTTP request carrying the Proposal PSBT to be sent to the payjoin directory.

Maybe this is already obvious, but as someone who is not as familiar with BIP 77 scheme I think it adds clarity that both sender and receiver mailbox live at the same payjoin directory.

///
/// The inner HTTP method, body encoding, and target mailbox depend on
/// whether the original sender used Payjoin v2 (BIP 77) or Payjoin v1
/// (BIP 78), as recorded in the session context:
///
/// - v2 sender (reply key present): POST an HPKE-encrypted `PjV2MsgB`
/// payload to the sender's reply mailbox.
/// - v1 sender (no reply key): PUT the base64-encoded PSBT as cleartext
/// UTF-8 bytes to the receiver's own mailbox, per the
/// [BIP 77](https://github.com/bitcoin/bips/blob/master/bip-0077.md)
/// Backwards compatibility section.
///
/// Both paths are then OHTTP-encapsulated to the directory's OHTTP Gateway.
pub fn create_post_request(
&self,
ohttp_relay: impl IntoUrl,
Expand Down
Loading