From 5cd718ed7a065258a42bf6f7c781a1e7219ba014 Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sat, 25 Jul 2026 17:44:47 +0200 Subject: [PATCH 1/8] chore(docs): remove Citadel citadel is not actively developed anymore --- docs/FAQ.md | 6 ++---- docs/privacy/02-best-practices.md | 2 +- docs/software/installation.md | 14 -------------- 3 files changed, 3 insertions(+), 19 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 976141b..86ccac5 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -129,7 +129,7 @@ it is always a good idea to inspect the log files for warning and error messages ### How do I view the log file? If you are running Jam with one of the supported integrations (RaspiBlitz, -Citadel, Umbrel, etc.) chances are you can view the logs inside the app +Start9, Umbrel, etc.) chances are you can view the logs inside the app (See Settings > Show logs). If the option is not displayed, or if you run the `standalone` docker image @@ -303,9 +303,7 @@ BerkeleyDB (BDB) wallet creation was deprecated in Bitcoin Core v26.0 which is n _For now, the fix is to add `deprecatedrpc=create_bdb` to your bitcoin.conf file._
-Step-by-step instructions on how to do this on Umbrel/Citadel -The example commands are for Umbrel, if you're using Citadel simply replace `umbrel` with `citadel`. -
+Step-by-step instructions on how to do this on Umbrel
1. Open the terminal and login to your node using ssh: diff --git a/docs/privacy/02-best-practices.md b/docs/privacy/02-best-practices.md index 8b20748..4065815 100644 --- a/docs/privacy/02-best-practices.md +++ b/docs/privacy/02-best-practices.md @@ -96,7 +96,7 @@ both your privacy as well as your fee footprint. Looking up addresses in public block explorers will link those addresses with your IP, which, in turn, can be linked to your real identity. Software packages -like Umbrel, Citadel, RaspiBlitz, and BTCPay Server make it easy to run your own +like Umbrel, Start9, RaspiBlitz, and BTCPay Server make it easy to run your own block explorer. If you have to use a public block explorer, make sure to mask your IP by connecting to them via [Tor](https://www.torproject.org/download/), or at least use a VPN. diff --git a/docs/software/installation.md b/docs/software/installation.md index 8dfaaef..73a6ec6 100644 --- a/docs/software/installation.md +++ b/docs/software/installation.md @@ -3,7 +3,6 @@ Jam comes packaged with the following full-node solutions: - [Umbrel](#with-umbrel) -- [Citadel](#with-citadel) - [RaspiBlitz](#with-raspiblitz) - [MyNode](#with-mynode) - [Start9](#with-start9) @@ -38,19 +37,6 @@ Jam can be installed directly from the [Umbrel](https://umbrel.com/) app store: - Click install - Done! -### ...with Citadel - -Jam can be installed directly from the [Citadel](https://runcitadel.space/) app store: - -- Open the interface of your Citadel node
(type `citadel.local` in your browser) -- Find "Jam" in the Citadel app store -- Click install -- Done! - -!!! info - If you are asked to enter a username and password after installation, enter - "citadel" as the username and the password that Citadel provides for you. - ### ...with RaspiBlitz Jam can be installed directly from the [Raspiblitz](https://github.com/raspiblitz/raspiblitz) WebUI since RaspiBlitz v1.9.0. From b4d4b5e199b641e4d2d4130d4d90902765248797 Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sat, 25 Jul 2026 17:49:05 +0200 Subject: [PATCH 2/8] chore(build): update markdown extensions --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 9d83b4e..010f26d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,8 +32,8 @@ markdown_extensions: - attr_list - footnotes - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg extra_javascript: - https://kit.fontawesome.com/090ca49637.js From 8c261b18983356e24c0c987aadf4dbe79043f5fb Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sat, 25 Jul 2026 17:58:50 +0200 Subject: [PATCH 3/8] build(deps): update checkout action to v6 --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0070528..4b92e75 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout main - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Deploy docs uses: mhausenblas/mkdocs-deploy-gh-pages@master From c7750da7b3d31f6b073c1d6307b69b265b6ddd79 Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sat, 25 Jul 2026 18:00:14 +0200 Subject: [PATCH 4/8] chore: init justfile --- .env | 1 + justfile | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 .env create mode 100644 justfile diff --git a/.env b/.env new file mode 100644 index 0000000..adfc128 --- /dev/null +++ b/.env @@ -0,0 +1 @@ +# .gitkeep diff --git a/justfile b/justfile new file mode 100644 index 0000000..026af43 --- /dev/null +++ b/justfile @@ -0,0 +1,46 @@ +# This justfile requires https://github.com/casey/just + +# Load environment variables from `.env` file. +set dotenv-load +# Fail the script if the env file is not found. +set dotenv-required + +project_dir := justfile_directory() + +regtest_bitcoin_container_name := 'jam_docker_bitcoind' +regtest_bitcoin_container_rpcport := '43782' + +# print available targets +[group("project-agnostic")] +default: + @just --list --justfile {{justfile()}} + +# evaluate and print all just variables +[group("project-agnostic")] +evaluate: + @just --evaluate + +# print system information such as OS and architecture +[group("project-agnostic")] +system-info: + @echo "architecture: {{arch()}}" + @echo "os: {{os()}}" + @echo "os family: {{os_family()}}" + + +[group("mkdocs")] +install: + pip install mkdocs + pip install mkdocs-material + +[group("mkdocs")] +update: + pip install -U mkdocs + +[group("mkdocs")] +serve: + mkdocs serve + +[group("mkdocs")] +build: + mkdocs build From 7b2eead85f4402d528b6a67aece75d317a3e0e32 Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sun, 26 Jul 2026 13:36:55 +0200 Subject: [PATCH 5/8] chore: update license page --- docs/software/license.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/software/license.md b/docs/software/license.md index 16ddf29..46fa2b4 100644 --- a/docs/software/license.md +++ b/docs/software/license.md @@ -1,6 +1,6 @@ # License -Both Jam and JoinMarket are released under free and open-source software licenses. +Both Jam and JoinMarket NG are released under free and open-source software licenses. [:octicons-arrow-right-24: Philosophy: Free Software][free-software] @@ -8,16 +8,16 @@ Both Jam and JoinMarket are released under free and open-source software license ## Jam -Jam and is licensed under the [MIT License](https://directory.fsf.org/wiki/License:Expat). +Jam and is licensed under the [MIT License](https://mit-license.org). The Jam documentation is licensed under the [GNU FDL](https://www.gnu.org/licenses/fdl-1.3.en.html). - Jam [LICENSE](https://github.com/joinmarket-webui/jam/blob/master/LICENSE) -- JamDocs [LICENSE](https://github.com/joinmarket-webui/jamdocs/blob/master/LICENSE) +- Jam documentation [LICENSE](https://github.com/joinmarket-webui/jamdocs/blob/master/LICENSE) --- -## JoinMarket +## JoinMarket NG -JoinMarket is released under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html). +JoinMarket NG is released under the [MIT License](https://mit-license.org). -- JoinMarket [LICENSE](https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/LICENSE) +- JoinMarket NG [LICENSE](https://github.com/joinmarket-ng/joinmarket-ng/blob/main/LICENSE) From 18a8501b5aa067d0baa10c091e2a84b8f3aa28df Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sun, 26 Jul 2026 13:41:57 +0200 Subject: [PATCH 6/8] chore: update about page --- docs/about.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/about.md b/docs/about.md index b56ca73..0300cc7 100644 --- a/docs/about.md +++ b/docs/about.md @@ -20,11 +20,11 @@ and thus more easily accessible for more people. ## About JoinMarket -[JoinMarket][jmcs] is a special kind of software that is aimed at improving the privacy +[JoinMarket][jmng] is a special kind of software that is aimed at improving the privacy and fungibility of bitcoin transactions. The main way to improve privacy and fungibility on-chain is via collaborative transactions. -[jmcs]: https://github.com/JoinMarket-Org/joinmarket-clientserver +[jmng]: https://github.com/joinmarket-ng/joinmarket-ng A collaborative transaction requires the coordination of multiple parties. The right resources ([UTXOs][glossary]) have to be available in the right quantity From e0834e882b3dfc47274fc8dd83d443c93f08ebd7 Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sun, 26 Jul 2026 13:49:39 +0200 Subject: [PATCH 7/8] chore: update faq page --- docs/FAQ.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 86ccac5..fe62ce7 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -11,7 +11,7 @@ Have a question that is not listed here? [Let us know!][contribute] This FAQ compiles questions that relate to Jam in particular. For things related to JoinMarket in general, please refer to the [JoinMarket documentation][jm-docs]. -[jm-docs]: https://github.com/JoinMarket-Org/joinmarket-clientserver/tree/master/docs +[jm-docs]: https://github.com/joinmarket-ng/joinmarket-ng/blob/main/docs/index.md ### How much can I earn? @@ -53,9 +53,9 @@ mempool or use a public site like [mempool.space][ms] to do a fee estimation. It is recommended that you [run your own mempool.space instance][ms-install] on your full node. -See also "[a note on fees][fee-note]" from the JoinMarket documentation. +See also "[Fees and safety][fee-note]" from the JoinMarket documentation. -[fee-note]: https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/tumblerguide.md#a-note-on-fees +[fee-note]: https://github.com/joinmarket-ng/joinmarket-ng/blob/main/docs/README-tumbler.md#fees-and-safety [fees]: market/fees.md [orderbook]: market/orderbook.md [glossary]: glossary.md From 849bc51d496cb45266f8ef138fc8a7f0b737dbbc Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sun, 26 Jul 2026 13:51:06 +0200 Subject: [PATCH 8/8] chore: update motivation page --- docs/philosophy/00-motivation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/philosophy/00-motivation.md b/docs/philosophy/00-motivation.md index 042f7e5..ae6d2e8 100644 --- a/docs/philosophy/00-motivation.md +++ b/docs/philosophy/00-motivation.md @@ -80,13 +80,13 @@ written by Gigi and released under CC BY-SA 4.0 license." ## Why Jam? -Jam is a front-end for [JoinMarket][jmcs], a privacy-focused bitcoin software +Jam is a front-end for [JoinMarket][jmng], a privacy-focused bitcoin software that uses a peer-to-peer marketplace to facilitate collaborative transactions, also called "CoinJoins."[^fn-glossary] [^fn-glossary]: We prefer to refer to them as [collaborative transactions](../glossary.md), which is more concise and explanatory. -[jmcs]: https://github.com/JoinMarket-Org/joinmarket-clientserver +[jmng]: https://github.com/joinmarket-ng/joinmarket-ng A collaborative transaction, as the name implies, is a bitcoin transaction that is done collaboratively by multiple parties. The tricky part of getting a