joinmarket-webui / jamdocs

Jam docs

⚠️ Jam is beta software. Use with caution. ⚠️

Installation · Features · Contribute · Development

---

Jam is a web interface for JoinMarket focusing on user-friendliness and ease-of-use. It aims to provide sensible defaults and be easy to use for beginners while still having the features advanced users expect.

• 💬 Join our Matrix room to get help and contribute!
• 📚 Check out the documentation and the wiki for resources such as meeting notes, call recordings, ideas, and discussions.

📸

📦 Installation

We're aiming to make Jam available for different node systems to make installation as painless as possible. If your node system of choice is missing, feel free to integrate it and let us know so we can add it here.

RaspiBlitz: v1.7.2*	Umbrel: v0.4.15	Citadel: v0.0.1	MyNode: v0.3.05	Start9: v0.3.3	RaspiBolt: v3

Refer to the installation docs for more information on integrations as well as manual installation instructions.

🍊 Features

• Spending from the wallet
• Spending from the wallet via collaborative transactions
• Running the yield generator
• Scheduled transactions
• Viewing the orderbook
• Support for fidelity bonds
• PayJoin support

Refer to the milestones for a rough roadmap. Feature requests are tracked as issues.

🧑‍💻 Contribute

This is a free and open-source software project and we love receiving pull-requests, bug reports, ideas, and feedback from everyone.

There are many ways you can contribute: testing, sharing ideas, writing documentation, creating tutorials, and—of course—writing code. Refer to the general contribution guidelines to get started.

🛠️ Development

Want to get your hands dirty with code? Great! CONTRIBUTING.md and docs/developing.md are where it's at.

🏛️ History

This project builds upon the jm-web-client which was developed by Shobhitaa, Abhishek, and waxwing himself. Many people contributed over time, some of which are listed here.

Jam and JoinMarket are separate projects. For more information on JoinMarket, see the JoinMarket GitHub Page.

jamdocs's Issues

Add info about bitcoin-cli rescanblockchain when importing a wallet

There is information in the docs about importing a wallet and the information is good, but is missing details about what to do if all balances are 0 after import. I found the info that I needed in the original joinmarket GitHub repo after seeing that wallet-tool.py is from the joinmarket project. Here: https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/USAGE.md#creating-a-wallet

restart Bitcoin Core with -rescan or use bitcoin-cli rescanblockchain if you're recovering an existing wallet from backup seed Otherwise just restart this joinmarket application.

I followed the instructions on Jam Docs and then did the following for my Start9 node:

• SSH to Start9 node
• Run sudo docker exec -it jam.ebassy bash to get into the jam container
• Follow the instructions here: Can I import an existing wallet?
• Exit the jam container with exit
• Get into the bitcoind container: sudo docker exec -it bitcoind.embassy bash
• Rescan he blockchain for the jam wallet: bitcoin-cli -rpcwallet=embassy_jam_wallet rescanblockchain <starting-block-#> <ending-block-#.

Sharing to save others some frustration. Thanks!

Add 'coinbase' to glossary

See #36

Update screenshots for v0.1 release

Screenshots are outdated already.

feat(docs): Other Languages

I am excited to see that we are actively translating the JAM UI into other languages.

The question is, do we also intend to translate the documentation? If that is the case, could someone please add it to Transifex?

Thanks

Using timechain as a substitute for blockchain and emotional definition for blockchain

In the docs we find the term timechain as a substitute for blockchain.

This is problematic for 3 reasons:

1. it's more like an inside joke, which requires users to dig through the comments of the old bitcoin code to know that Satoshi initially called it so - very few know this
2. It causes confusion - for a newcomer its just another new term he never heard, and apparently it's at the base of the blockchain
3. it is incorrect - there is good reason for satoshi to change from block to time, as he realized blockchains are not good at timekeeping. Its a glorified mistake. "I've been imitated so well I've heard people copy my mistakes." - Jimi Hendrix

The term blockchain on the other hand is described as meaningless.
While I do agree with the conclusion, I don't think this has any place in the documentation, and furthermore, it just causes more confusion.

I propose moving the definition of timechain to blockchain and removing timechain all together.

Complete Glossary

https://jamdocs.org/glossary/

Still some TODOs to be filled in.

joinmarket capitalization

I believe the "official" spelling is all in lower case, unless it's the beginning of a sentence, so "joinmarket" or "Joinmarket".

Manual Installation on Ubuntu 22.04.1 LTS: "a different version of babel-jest"

So I was trying to manually install Jam on my Ubuntu 22.04.1 and to connect it to an existing JM instance running on another machine on my LAN.

After doing:
ssh 192.168.1.8 -v -o GatewayPorts=true -N -L 28183:127.0.0.1:28183 -L 28283:127.0.0.1:28283 -L 62601:127.0.0.1:62601

I try to run it:

npm start

[email protected] start
react-scripts start

There might be a problem with the project dependency tree.
It is likely not a bug in Create React App, but something you need to fix locally.

The react-scripts package provided by Create React App requires a dependency:

"babel-jest": "23.6.0"

Don't try to install it manually: your package manager does it automatically.
However, a different version of babel-jest was detected higher up in the tree:

/home/xx/jam/node_modules/babel-jest (version: 27.5.1)

Manually installing incompatible versions is known to cause hard-to-debug issues.

If you would prefer to ignore this check, add SKIP_PREFLIGHT_CHECK=true to an .env file in your project.
That will permanently disable this message but you might encounter other issues.

To fix the dependency tree, try following the steps below in the exact order:

1. Delete package-lock.json (not package.json!) and/or yarn.lock in your project folder.
2. Delete node_modules in your project folder.
3. Remove "babel-jest" from dependencies and/or devDependencies in the package.json file in your project folder.
4. Run npm install or yarn, depending on the package manager you use.

In most cases, this should be enough to fix the problem.

I tried 1,2,4 but there's no "babel-jest" in the package.json file:

"devDependencies": {
"@emotion/react": "^11.9.3",
"@popperjs/core": "^2.11.5",
"@table-library/react-table-library": "^4.0.10",
"@testing-library/jest-dom": "^5.16.4",
"@testing-library/react": "^12.1.4",
"@testing-library/user-event": "^13.5.0",
"@types/jest": "^27.5.1",
"@types/node": "^17.0.35",
"@types/react": "^17.0.43",
"@types/react-dom": "^17.0.14",
"bootstrap": "^5.2.0",
"buffer": "^6.0.3",
"classnames": "^2.3.1",
"conventional-changelog": "^3.1.25",
"formik": "^2.2.9",
"http-proxy-middleware": "^2.0.6",
"husky": "^8.0.1",
"i18next": "^21.8.4",
"i18next-browser-languagedetector": "^6.1.4",
"jest-watch-typeahead": "^0.6.5",
"jest-websocket-mock": "^2.3.0",
"lint-staged": "^12.4.2",
"prettier": "^2.6.2",
"qrcode": "^1.5.0",
"react": "^17.0.2",
"react-bootstrap": "^2.5.0-beta.1",
"react-dom": "^17.0.2",
"react-i18next": "^11.16.9",
"react-router-bootstrap": "^0.26.2",
"react-router-dom": "^6.3.0",
"react-scripts": "^2.1.3",
"typescript": "^4.7.2",
"web-vitals": "^2.1.4"
},
"dependencies": {
"serve": "13.0.2"
},

Manual installation

Add an initial "Manual installation" section - https://jamdocs.org/software/installation/#manual-installation

Should contain information about running Jam locally connecting to an already existing JM daemon.

If motivated, even start from the beginning and describe a complete installation process from scratch, ie. with installing jm, tor and starting the necessary daemons. Short description about running it with different network settings (mainnet, testnet, etc.)

Add myNode integration

https://twitter.com/mynodebtc/status/1587821848141651974

Update FAQ

The FAQ is still incomplete (and also just a first version).

• Get rid of TODOs
• Add more entries, based on user feedback

Error Creating Fidelity Bond

Hi,
I'm trying to configure a fidelity bond, so I chose a jar, select the cj-out UTXO, review the configuration, but when I confirm I receive the following error:

• Invalid request format. Could not load time-locked address. (in the Web UI)
• Error: not a fidelity bond wallet (in the command line)

Any suggestion?

Thanks

Update application flow to scheduler changes

From

Receive -> Jam -> Earn -> Send

to

Receive -> Send -> Earn -> Jam

...since "Jam" will now always sweep to external. Maybe even rename it to sweep? 🤔

No doxxic change?

Not sure what that means?
Joinmarket does have non equal amount change outputs.