Merge branch 'master' into Renaming-changes

Author: 0xZaddyy

.cargo/mutants.toml

@@ -1,5 +1,5 @@
 additional_cargo_args = ["--all-features"]
-examine_globs = ["payjoin/src/uri/*.rs", "payjoin/src/receive/**/*.rs", "payjoin/src/send/**/*.rs"]
+examine_globs = ["payjoin/src/core/uri/*.rs", "payjoin/src/core/receive/**/*.rs", "payjoin/src/core/send/**/*.rs"]
 exclude_globs = []
 exclude_re = [
 	"impl Debug",

.github/ISSUE_TEMPLATE/bug-general.yml

@@ -0,0 +1,104 @@
+name: General Bug Report
+description: Submit a new bug report
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ### This issue tracker is only for technical issues related to the following crates:
+        - [`payjoin-cli`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-cli)
+        - [`payjoin-directory`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-directory)
+        - [`payjoin-test-utils`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-test-utils)
+        - [`payjoin-ffi`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-ffi)
+
+        ### For bugs relating to the [payjoin](https://github.com/payjoin/rust-payjoin/tree/master/payjoin) crate, [see here](./bug-payjoin-crate.yml).
+
+        ----
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: dropdown
+    attributes:
+      label: Which crate is this issue for?
+      multiple: false
+      options:
+        - payjoin-cli
+        - payjoin-directory
+        - payjoin-test-utils
+        - payjoin-ffi
+  - type: dropdown
+    attributes:
+      label: How did you obtain this crate?
+      multiple: false
+      options:
+        - Compiled from source
+        - Pre-built binaries
+        - Package manager
+        - Docker Image
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: features
+    attributes:
+      label: Features
+      description: |
+        If you selected "Compiled from source" what features did you use?
+    validations:
+      required: false
+  - type: input
+    id: pdk-version
+    attributes:
+      label: What version of the selected crate are you using?
+      description:
+        Run `payjoin-cli --version` or `payjoin-directory --version` for the binaries.
+        For the library crates (`payjoin-test-utils`, and `payjoin-ffi`),
+        check your respective package manager file to see which version you have installed.
+      placeholder: e.g. payjoin-0.23.0 or master@ceef77b
+    validations:
+      required: true
+  - type: textarea
+    id: current-behavior
+    attributes:
+      label: Current behavior
+      description: Tell us what went wrong
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: Tell us what you expected to happen
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce
+      description: |
+        Tell us how to reproduce your bug. Please attach related screenshots if necessary.
+        * Run-time or compile-time configuration options
+        * Actions taken
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output.
+
+        Please be aware that the log might contain personally identifying information.
+    validations:
+      required: false
+  - type: input
+    id: os
+    attributes:
+      label: Operating system and version
+      placeholder: e.g. "MacOS Ventura 13.2" or "Ubuntu 22.04 LTS"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/bug-payjoin-crate.yml

@@ -0,0 +1,83 @@
+name: payjoin crate bug report
+description: Submit a new bug report for the payjoin crate
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## This issue tracker is only for technical issues related to the [payjoin](https://github.com/payjoin/rust-payjoin/tree/master/payjoin) crate.
+
+        ## Bugs for all other crates should [this template](./bug-general.yml).
+
+        ----
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Are you using payjoin-ffi?
+      options:
+        - label: Yes I am
+          required: false
+  - type: dropdown
+    attributes:
+      label: If so, which host language?
+      multiple: false
+      options:
+        - python
+        - other
+    validations:
+      required: false
+  - type: textarea
+    id: features
+    attributes:
+      label: Did you enable any features on the crate?
+      description: e.g. `v2`
+    validations:
+      required: false
+  - type: input
+    id: pdk-version
+    attributes:
+      label: What version of the payjoin crate are you using?
+      description: Check your respective package manager file to see which version you have installed.
+      placeholder: e.g. payjoin-0.23.0 or master@ceef77b
+    validations:
+      required: true
+  - type: textarea
+    id: current-behavior
+    attributes:
+      label: Current behavior
+      description: Tell us what went wrong
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: Tell us what you expected to happen
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce
+      description: |
+        Tell us how to reproduce your bug. Please attach related screenshots if necessary.
+        * Run-time or compile-time configuration options
+        * Actions taken
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output. This can be enabled by prefixing `RUST_LOG=debug cargo run ...`
+
+        Please be aware that the log might contain personally identifying information.
+    validations:
+      required: false

Cargo-minimal.lock

@@ -1623,7 +1623,7 @@ dependencies = [
 
 [[package]]
 name = "payjoin-cli"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -1651,7 +1651,7 @@ dependencies = [
 
 [[package]]
 name = "payjoin-directory"
-version = "0.0.2"
+version = "0.0.3"
 dependencies = [
  "anyhow",
  "bhttp",
@@ -1674,7 +1674,7 @@ dependencies = [
 
 [[package]]
 name = "payjoin-test-utils"
-version = "0.0.0"
+version = "0.0.1"
 dependencies = [
  "bitcoin",
  "bitcoin-ohttp",

Cargo-recent.lock

@@ -1623,7 +1623,7 @@ dependencies = [
 
 [[package]]
 name = "payjoin-cli"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -1651,7 +1651,7 @@ dependencies = [
 
 [[package]]
 name = "payjoin-directory"
-version = "0.0.2"
+version = "0.0.3"
 dependencies = [
  "anyhow",
  "bhttp",
@@ -1674,7 +1674,7 @@ dependencies = [
 
 [[package]]
 name = "payjoin-test-utils"
-version = "0.0.0"
+version = "0.0.1"
 dependencies = [
  "bitcoin",
  "bitcoin-ohttp",

payjoin-cli/CHANGELOG.md

@@ -1,5 +1,18 @@
 # payjoin-cli Changelog
 
+## 0.2.0
+
+- Support sender and receiver being generic over their typestate ([#728](https://github.com/payjoin/rust-payjoin/pull/728), [#719](https://github.com/payjoin/rust-payjoin/pull/719))
+- Remove existing persistence strategy and replace with new SessionPersister trait ([#789](https://github.com/payjoin/rust-payjoin/pull/789), [#750](https://github.com/payjoin/rust-payjoin/pull/750))
+- Update references to BIP-77 ([#733](https://github.com/payjoin/rust-payjoin/pull/733))
+- Rename RelayState to RelayManager for clarity ([#727](https://github.com/payjoin/rust-payjoin/pull/727))
+- Refactor config to use proc macros over builder ([#703](https://github.com/payjoin/rust-payjoin/pull/703))
+- Create fallback ohttp-relay logic for payjoin-cli ([#607](https://github.com/payjoin/rust-payjoin/pull/607))
+- Separate v2 cli logic into mod and ohttp components ([#714](https://github.com/payjoin/rust-payjoin/pull/714))
+- Update Nigiri instructions ([#691](https://github.com/payjoin/rust-payjoin/pull/691), [#682](https://github.com/payjoin/rust-payjoin/pull/682))
+- Dedupe ImplementationError ([#669](https://github.com/payjoin/rust-payjoin/pull/669))
+- Add Quick Start, Configuration, Reference to CLI README ([#624](https://github.com/payjoin/rust-payjoin/pull/624))
+
 ## 0.1.0
 
 - Bump payjoin to 0.23.0 with stable wire protocol

payjoin-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "payjoin-cli"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["Dan Gould <d@ngould.dev>"]
 description = "A command-line Payjoin client for Bitcoin Core"
 repository = "https://github.com/payjoin/rust-payjoin"
@@ -49,4 +49,4 @@ url = { version = "2.3.1", features = ["serde"] }
 
 [dev-dependencies]
 nix = "0.26.4"
-payjoin-test-utils = { version = "0.0.0" }
+payjoin-test-utils = { version = "0.0.1" }

payjoin-directory/CHANGELOG.md

@@ -1,5 +1,11 @@
 # payjoin-directory Changelog
 
+## 0.0.3
+
+- Update links to reference BIP-77 document [#733](https://github.com/payjoin/rust-payjoin/pull/733)
+- Fix uninline format clippy violations [#667](https://github.com/payjoin/rust-payjoin/pull/667)
+- Serve a page on / for payjoin-directory [#824](https://github.com/payjoin/rust-payjoin/pull/824)
+
 ## 0.0.2
 
 - Do not log ERROR on directory validation errors [#628](https://github.com/payjoin/rust-payjoin/pull/628)

payjoin-directory/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "payjoin-directory"
-version = "0.0.2"
+version = "0.0.3"
 authors = ["Dan Gould <d@ngould.dev>"]
 description = "A store-and-forward and Oblivious Gateway Resource directory server for Async Payjoin"
 repository = "https://github.com/payjoin/rust-payjoin"

payjoin-directory/src/lib.rs

@@ -185,6 +185,7 @@ async fn serve_payjoin_directory(
         (Method::GET, ["", "ohttp-keys"]) => get_ohttp_keys(&ohttp).await,
         (Method::POST, ["", id]) => post_fallback_v1(id, query, body, pool).await,
         (Method::GET, ["", "health"]) => health_check().await,
+        (Method::GET, ["", ""]) => handle_directory_home_path().await,
         _ => Ok(not_found()),
     }
     .unwrap_or_else(|e| e.to_response());
@@ -267,6 +268,67 @@ async fn health_check() -> Result<Response<BoxBody<Bytes, hyper::Error>>, Handle
     Ok(Response::new(empty()))
 }
 
+async fn handle_directory_home_path() -> Result<Response<BoxBody<Bytes, hyper::Error>>, HandlerError>
+{
+    let mut res = Response::new(empty());
+    *res.status_mut() = StatusCode::OK;
+    res.headers_mut().insert(CONTENT_TYPE, HeaderValue::from_static("text/html"));
+
+    let html = r#"
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Payjoin Directory</title>
+    <style>
+        body {
+            background-color: #0f0f0f;
+            color: #eaeaea;
+            font-family:  Manrope, sans-serif;
+            padding: 2rem;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            height: 100vh;
+        }
+        .container {
+            background: #1a1a1a;
+            border: 1px solid #333;
+            border-radius: 8px;
+            padding: 2rem;
+            box-shadow: 0 0 10px rgba(0, 170, 255, 0.2);
+            text-align: center;
+        }
+        h1 {
+            color: black;
+            background-color: #C71585;
+            margin-bottom: 1rem;
+            padding: 0.5rem;
+            border-radius: 4px;
+        }
+        p {
+            color: #ccc;
+        }
+        a{
+            color: #F75394;
+            text-decoration: none;
+        }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <h1>Payjoin Directory</h1>
+        <p>The Payjoin Directory provides a rendezvous point for sender and receiver to meet. The directory stores Payjoin payloads to support asynchronous communication.</p>
+        <p>Learn more about how asynchronous payjoin works here: <a href="https://payjoin.org/docs/how-it-works/payjoin-v2-bip-77">Payjoin V2</a></p>
+    </div>
+</body>
+</html>
+"#;
+
+    *res.body_mut() = full(html);
+    Ok(res)
+}
+
 #[derive(Debug)]
 enum HandlerError {
     PayloadTooLarge,