Skip to content

Commit 7a41623

Browse files
committed
Bikeshed defaults, update release notes, cleanup whitespace
1 parent 7b4b36a commit 7a41623

File tree

10 files changed

+176
-177
lines changed

10 files changed

+176
-177
lines changed

doc/release-notes-0.1.0.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Notable changes
2222
Throttling to avoid IRC flood
2323
------------------------------------
2424

25-
See [366](https://github.com/joinmarket-org/joinmarket/issues/366). Introduced a 1 line/second limit and a secondary 3kB/10s limit to data
25+
See [366](https://github.com/joinmarket-org/joinmarket/issues/366). Introduced a 1 line/second limit and a secondary 3kB/10s limit to data
2626
sending. It is hoped that this will reduce or remove the possibility of bots getting
2727
kicked from the server when engaging in large transactions. PING messages bypass
28-
the limits, and responses to orderbook requests must wait for other messages (i.e.
28+
the limits, and responses to orderbook requests must wait for other messages (i.e.
2929
have lowest priority.) In case of very large transactions, takers should bump their
3030
maker_timeout_sec variable in the config file from the new default of 60s to something
3131
higher.
@@ -36,15 +36,15 @@ Dynamic fee calculation
3636
See [346](https://github.com/joinmarket-org/joinmarket/issues/346). Before these changes, the default fee was set statically at 10,000 satoshis, but this
3737
is clearly insufficient on the Bitcoin network as of now, unless the transaction is
3838
very small (and Joinmarket transactions are perforce larger than normal). An emergency
39-
fix of 30,000 satoshis was applied to the master branch, but in this update the
39+
fix of 30,000 satoshis was applied to the master branch, but in this update the
4040
transaction fee is determined from the output of estimatefee, if running Core, or from
4141
the API at blockcypher.com if running from blockr. Due to the joinmarket protocol, we
4242
cannot know in advance the exact size of the transaction when we create it. Hence,
4343
some reasonable heuristics are applied to estimate the size of the transaction, then
4444
use the value returned from estimatefee, combined with a user-configured choice of
4545
how many blocks to target combination for, to get to a reasonable transaction fee.
46-
The user can reset the value of `tx_fees` in the joinmarket.cfg file from the default
47-
value of 3 (i.e. targetting confirmation within 3 blocks) to make confirmation likely
46+
The user can reset the value of `tx_fees` in the joinmarket.cfg file from the default
47+
value of 3 (i.e. targetting confirmation within 3 blocks) to make confirmation likely
4848
to be faster or slower.
4949

5050
Users should be aware that in case of sweep transactions or large N transactions - whereever
@@ -62,25 +62,25 @@ heavily tested to that end.
6262
Code refactoring
6363
-----------------------------------
6464

65-
See [340](https://github.com/joinmarket-org/joinmarket/issues/340) and
66-
[345](https://github.com/joinmarket-org/joinmarket/issues/345).
65+
See [340](https://github.com/joinmarket-org/joinmarket/issues/340) and
66+
[345](https://github.com/joinmarket-org/joinmarket/issues/345).
6767
This is considered an initial (but quite significant) step in cleaning
6868
up the codebase, making formatting standardised, and enabling better analysis of the code.
69-
The set of commits created preserves blame in git, and the diff can be verified using
70-
the yapf tool, combined with diff. See [340](https://github.com/joinmarket-org/joinmarket/issues/340)
69+
The set of commits created preserves blame in git, and the diff can be verified using
70+
the yapf tool, combined with diff. See [340](https://github.com/joinmarket-org/joinmarket/issues/340)
7171
for details. A manual review of these changes
7272
was undertaken also. There were no functional changes to the code as a result of this.
7373

7474
New yield-generator scripts.
7575
-----------------------------------
7676

77-
See [353](https://github.com/joinmarket-org/joinmarket/issues/353),
77+
See [353](https://github.com/joinmarket-org/joinmarket/issues/353),
7878
[357](https://github.com/joinmarket-org/joinmarket/issues/357),
79-
[371](https://github.com/joinmarket-org/joinmarket/issues/371).
79+
[371](https://github.com/joinmarket-org/joinmarket/issues/371).
8080
The updates are spread over a few PRs due to refactoring
81-
and bugfix changes.
81+
and bugfix changes.
8282

83-
The main yield-generator.py script has been renamed to
83+
The main yield-generator.py script has been renamed to
8484
`yield-generator-basic.py`, the new-yieldgen-algo variant which was previously on a different
8585
git branch has been renamed to `yield-generator-mixdepth.py` and a third variant called
8686
`yield-generator-deluxe.py` has been created.
@@ -94,11 +94,11 @@ be seen from reading the top of the script.
9494
Change to 'internal/external' branches from 'for change/receive'
9595
-----------------------------------
9696

97-
See [368](https://github.com/joinmarket-org/joinmarket/issues/368) fixing
98-
[283](https://github.com/joinmarket-org/joinmarket/issues/283).
97+
See [368](https://github.com/joinmarket-org/joinmarket/issues/368) fixing
98+
[283](https://github.com/joinmarket-org/joinmarket/issues/283).
9999
There is a possibility of address reuse if coins are added
100100
to a mixdepth in the receive branch, while that address is also chosen by a bot for use.
101-
This led to this improvement of the design: 'external' branch is only added to by the
101+
This led to this improvement of the design: 'external' branch is only added to by the
102102
user from outside sources, while the bot itself will only choose new addresses from the
103103
'internal' branch. The user merely has to bear in mind that they should only add coins
104104
to the 'external' branch, just as before they were advised only to add coins to the
@@ -120,19 +120,19 @@ with any script except `wallet-tool.py`.
120120
=================
121121

122122
For the first release, this will be a list of the notable changes since
123-
[the last significant update to the master branch](https://github.com/JoinMarket-Org/joinmarket/commit/2ef37996f90d3c4ea3ca7880a1619a182e710e67).
123+
[the last significant update to the master branch](https://github.com/JoinMarket-Org/joinmarket/commit/2ef37996f90d3c4ea3ca7880a1619a182e710e67).
124124
Minor string fixes or test updates are not included. In future, this section will be
125125
a list of all functional changes since the previous release.
126126

127127
- #345 `77cf5fa` Complete code refactoring. See #340 #345 for details on verification.
128128
- #346 `3b3c05d` dynamic fee calculation, including sweep, and tumbler, and test updates
129129
- #356 `0d7f14b` refactoring for yieldgens: new variants, see also #353 #357 #371
130130
- #361 `f71b2db` reduce DOS possibility via orderbook calls, see issue 298
131-
- #366 `a33a851` throttling with Queue
132-
- #367 `5322791` add confirmation-spendability knob for bitcoind-rpc
133-
- #368 `f90e992` Restructure for_change HD branch as {in,ex}ternal
131+
- #366 `a33a851` throttling with Queue
132+
- #367 `5322791` add confirmation-spendability knob for bitcoind-rpc
133+
- #368 `f90e992` Restructure for_change HD branch as {in,ex}ternal
134134
- #369 `1537d3e` Handle pushtx failures. Catch jsonrpcerror exception and retry for tumbler
135-
- #372 `9b809db` Add gaplimit option for sendpayment.py.
135+
- #372 `9b809db` Add gaplimit option for sendpayment.py.
136136

137137

138138
Credits
@@ -148,5 +148,3 @@ Thanks to everyone who directly contributed to this release:
148148
- @domob1812
149149

150150
And those who contributed additional code review, ideas and comments.
151-
152-

doc/release-notes-0.1.1.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Preventing failure on receipt of invalid orders
2828

2929
See [391](https://github.com/joinmarket-org/joinmarket/issues/391) and
3030
[390](https://github.com/joinmarket-org/joinmarket/issues/390).
31-
Makers publishing orders with non-integer amounts for an `absorder` were causing
32-
a ValueError exception to be raised, preventing Takers from running successfully.
31+
Makers publishing orders with non-integer amounts for an `absorder` were causing
32+
a ValueError exception to be raised, preventing Takers from running successfully.
3333
This fix prevents that.
3434

3535

@@ -38,5 +38,3 @@ This fix prevents that.
3838

3939

4040
- #391 `7f5e06e` Disallow non-integer absorder in on_order_seen.
41-
42-

doc/release-notes-0.1.2.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Returning the alert system to JoinMarket after it was mistakenly removed in a re
3030
------------------------------------
3131

3232
See [400](https://github.com/joinmarket-org/joinmarket/issues/400)
33-
Anybody announcing a command to cancel an order without an order id would cause
33+
Anybody announcing a command to cancel an order without an order id would cause
3434
all bots to crash
3535
This fix prevents that.
3636

@@ -43,4 +43,3 @@ This fix prevents that.
4343
- #387 `77ef4b4` clump coins differently in yieldgenerator to increase privacy
4444
- #397 `6ced862` fix issue 395 about accidental negative fees in yieldgenerator deluxe
4545
- #392 `00ef236` fix issue #392
46-

doc/release-notes-0.1.4.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ case it cannot be installed, joinmarket should continue to run exactly as before
3131

3232
On Linux it can be installed with
3333

34-
pip install secp256k1
34+
pip install secp256k1
3535

3636
For past discussion on this feature which may be helpful, see this reddit thread
3737

@@ -69,11 +69,11 @@ work out the effective annual interest rate, as though yield-generator was a sav
6969
To use, configure JoinMarket to use a Bitcoin node as a method of accessing the blockchain
7070
and run:
7171

72-
python wallet-tool.py wallet.json history
72+
python wallet-tool.py wallet.json history
7373

7474
A csv file can be created for opening with spreadsheet software too:
7575

76-
python wallet-tool.py --csv wallet.json history > history.csv
76+
python wallet-tool.py --csv wallet.json history > history.csv
7777

7878

7979
0.1.4 Change log
@@ -83,35 +83,35 @@ Tumbler Stability:
8383
- `671edcc` Restored debug_silence, so tumbler Insert New Address prompt can be seen
8484
- `76d9071` Increased scope of timeout_thread_lock to stop a rare race condition
8585
- `440357a` Fee calculation for sweep orders excludes miner fees, fixing #441
86-
- `e47f47d` Fix not enough funds exception catch in tumbler
86+
- `e47f47d` Fix not enough funds exception catch in tumbler
8787
- `8af1376` Caught exception around getrawtransaction in the case of wallet conflicts
8888
- `2dc3437` Create the confirm timeout feature of blockchaininterface, modified tumbler.py to use it
8989
- `04c277e` Added sync_unspent() to tumbler create_tx() to reduce likelyhood of wallet being out of sync
9090
- `fc3b6a3` Made tumbler update wallet file index cache, so wallet-tool display will reach the right mixdepths
9191
- `00ac1a1` Clear irc.built_privmsg on reconnect, which prevents crashes from junk being passed to base64 decode
92-
- `e4ff93d` Added check to make sure tumbler coins reach every destination address
92+
- `e4ff93d` Added check to make sure tumbler coins reach every destination address
9393

9494
Features:
9595
- `42917f5` Always load default config with initial values first, then load potential config file afterwards
9696
- `0f0631d` Created script broadcast-tx.py for broadcasting transactions via makers
9797
- `22adabc` Gave names to all the threads so they appear in debug logs
9898
- `4c08910` Adjuste IRC throttle parameters, experimentally derived
9999
- `d82668d` maker_timeout_sec is readjusted for the second stage (!tx sending) based on transaction size, and IRC throttling variables are module vars
100-
- `98db29f` Add yield-generator-oscillator
100+
- `98db29f` Add yield-generator-oscillator
101101
- `bf140fa` Bump default makercount to randint(2,4)
102102
- `99ea24f` New re-integration of secp256k1 via ludbb binding
103103
- `c70214d` Wallet history
104104
- `1c20bfc` Options for broadcasting transactions via makers, issue #56
105105
- `e7c1bf1` Show xpub keys in wallet-tool display, issue #493
106106

107107
Bugfixes:
108-
- `d2be6c2` Recover from selection of spent utxos
108+
- `d2be6c2` Recover from selection of spent utxos
109109
- `184f2fe` Stop yield-generator-mixdepth announcing absorders if they havent been modified
110110
- `96cff63` Fix crash in yield generator mixdepth when no unconfirm notify arrives
111111
- `b814d3f` BitcoinCoreInterface now guarentees that unconfirmfun() will always be invoked, issue #436
112112
- `388d833` Wrapped close() in try: except to stop it crashing the throttle thread
113113
- `e7cb86d` Prevent offer minsize from going below DUST_THRESHOLD, issue #382
114-
- `b9a673b` Added explaination to patientsendpayment in case anyone uses it
114+
- `b9a673b` Added explaination to patientsendpayment in case anyone uses it
115115
- `d650be6` Add length check to address validation; should be 20 bytes for both p2pkh and p2sh after stripping checksum and version
116116

117117

@@ -123,8 +123,8 @@ Thanks to everyone who directly contributed to this release
123123
- @AdamISZ
124124
- @adlai
125125
- @chris-belcher
126-
- @OverlordQ
127-
- @raedah
126+
- @OverlordQ
127+
- @raedah
128128
- @veqtrus
129129

130130
And those who contributed additional code review, ideas, debug logs and comments.

0 commit comments

Comments
 (0)