joinmarket/scripts
AdamISZ 28abddf062
Implement payjoin (p2ep) direct payment joins
- update mktx() to allow optional locktime setting (and sequence)
- add a mk_shuffled_tx method to the wallet module
- add a P2EPTaker and P2EPMaker class (inherit from Taker, Maker)
- add a -T option to sendpayment script for doing payjoins
- add a receive_payjoin script for receivers.
- add payjoin tests in jmclient/test/test_payjoin.py
- add a custom utxo selection method select_one_utxo to support.py
- support bech32 wallets (SegwitWallet, p2wpkh) with native=true
  in config POLICY for PayJoin and direct send (not Joinmarket CJ)
- add a PayJoin.md usage guide in docs/
- include version bytes in pubkey message for forward compat
- taker pays fees but controls size (utxo number and fee/kB)
- add P2WPKH fee estimator
- Enforce INFO level logging in payjoin
- refactors regtest config settings into one place
- bugfix: script_to_address vbyte argument is bytes not integer
2019-01-19 16:46:40 +01:00
..
cmtdata Add commitments tools 2016-11-25 20:44:01 +02:00
logs Ignore *.egg-info, and scripts/logs/*.schedule 2017-05-02 22:19:22 -04:00
obwatch Remove btc.py 2018-12-19 14:37:26 +01:00
wallets schedules read from files; joinmarketd state bugfix on ioauth receipt 2016-11-25 15:49:18 +02:00
add-utxo.py Include chromalog package for colorized logs 2019-01-14 15:25:59 +01:00
cli_options.py Implement payjoin (p2ep) direct payment joins 2019-01-19 16:46:40 +01:00
convert_old_wallet.py Fix bug in convert_old_wallet after Py3 upgrade 2018-12-16 23:08:51 +01:00
joinmarket-qt.py version bump and release notes 0.5.1 2019-01-07 16:27:57 +01:00
joinmarketd.py Convert jmclient to py3 style 2018-12-06 02:40:36 +08:00
qtsupport.py Convert JoinmarketQt to PySide2 2018-12-11 17:13:40 +01:00
README.md change default wallet name 2018-08-07 14:17:13 +02:00
receive-payjoin.py Implement payjoin (p2ep) direct payment joins 2019-01-19 16:46:40 +01:00
sample-schedule-for-testnet extra features for test running (ygrunner) 2017-07-20 14:50:50 +03:00
sendpayment.py Implement payjoin (p2ep) direct payment joins 2019-01-19 16:46:40 +01:00
sendtomany.py Implement payjoin (p2ep) direct payment joins 2019-01-19 16:46:40 +01:00
tumbler.py Implement payjoin (p2ep) direct payment joins 2019-01-19 16:46:40 +01:00
wallet-tool.py Implement payjoin (p2ep) direct payment joins 2019-01-19 16:46:40 +01:00
yg-privacyenhanced.py Include chromalog package for colorized logs 2019-01-14 15:25:59 +01:00
yield-generator-basic.py Include chromalog package for colorized logs 2019-01-14 15:25:59 +01:00

Command line scripts for Joinmarket

(If upgrading to version 0.3.0+, don't forget to read this on upgrading the wallet.)

All user level scripts here.

(The phrase "normal Joinmarket" in the below refers to the existing repo.

The subdirectories logs and wallets have the same role as in normal Joinmarket. The subdirectory cmtdata contains only your commitments.json storage of your used commitments (ignored by github of course!). The filename is set in joinmarket.cfg.

The joinmarket.cfg will be created and maintained in this directory.

Brief explanation of the function of each of the scripts:

sendpayment.py

Either use the same syntax as for normal Joinmarket:

`python sendpayment.py --fast -N 3 -m 1 -P wallet.jmdat 50000000 <address>`

or use the new schedule approach. For an example, see the sample schedule file. Do:

`python sendpayment.py --fast -S sample-schedule-for-testnet wallet.jmdat`

Note that the magic string INTERNAL in the file creates a payment to a new address in the next mixdepth (wrapping around to zero if you reach the maximum mixdepth).

To pay a fraction of the total in a mixdepth you can simply make the amount field in the schedule a decimal instead of an integer (0.0 < amt < 1.0 of course).

The schedule file can have any name, and is a comma separated value file, the lists must follow that format; see the comment in the sample file above (each list is length 5 items).

*This part can be ignored for a first run:

Additional fields in config: in the config section [DAEMON] you can specify whether to run the daemon as a separate process or not. By default, the daemon will run in the same Python process, for maximum convenience, so you needn't separately start joinmarketd.py (see below).

You can run the daemon separately by setting nodaemon=0 in [DAEMON]. You can choose to use ssl within this single-process configuration with use_ssl=true (again, see below for more on this).*

tumbler.py

This is an extension of the functionality of sendpayment.py in that it auto-generates a schedule of payments to internal and external addresses, following the same algo as in normal Joinmarket and described here.

For detailed information on how to use this, please read this.

wallet-tool.py

This is the same as in normal Joinmarket.

joinmarketd.py

This file is to be considered experimental for now. It only takes two arguments, the port it serves on (default 27183), and whether to use TLS for client-server communication (default 0=no tls, 1=tls):

`python joinmarketd.py [port number] [1/0]`

To use tls you must create a key.pem and cert.pem in a subdirectory /ssl, representing a self-signed certificate. This needs some work to be cleaned up, but does work already.

add-utxo.py

This works exactly as in normal Joinmarket, with the exception of the location of the commitments.json file, explained above.

sendtomany.py

As above.