jmwallet.wallet.coin_selection
jmwallet.wallet.coin_selection
Coin selection algorithms for wallet spending.
Provides UTXO selection strategies for CoinJoin transactions and sweeps.
Classes
CoinSelectionMixin
Mixin providing coin selection capabilities.
Expects the host class to provide utxo_cache (dict[int, list[UTXOInfo]]).
Source code in jmwallet/src/jmwallet/wallet/coin_selection.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 | |
Attributes
utxo_cache: dict[int, list[UTXOInfo]]
instance-attribute
Functions
get_all_utxos(mixdepth: int, min_confirmations: int = 1, include_fidelity_bonds: bool = False) -> list[UTXOInfo]
Get all UTXOs from a mixdepth for sweep operations.
Unlike select_utxos(), this returns ALL eligible UTXOs regardless of target amount. Used for sweep mode to ensure no change output.
Args: mixdepth: Mixdepth to get UTXOs from min_confirmations: Minimum confirmations required include_fidelity_bonds: If True, include fidelity bond UTXOs. Defaults to False to prevent accidentally spending bonds in sweeps.
Returns: List of all eligible UTXOs in the mixdepth
Source code in jmwallet/src/jmwallet/wallet/coin_selection.py
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | |
select_utxos(mixdepth: int, target_amount: int, min_confirmations: int = 1, include_utxos: list[UTXOInfo] | None = None, include_fidelity_bonds: bool = False, *, restrict_md0: bool = True) -> list[UTXOInfo]
Select UTXOs for spending from a mixdepth. Uses simple greedy selection strategy.
Args:
mixdepth: Mixdepth to select from
target_amount: Target amount in satoshis
min_confirmations: Minimum confirmations required
include_utxos: List of UTXOs that MUST be included in selection
include_fidelity_bonds: If True, include fidelity bond UTXOs in automatic
selection. Defaults to False to prevent accidentally
spending bonds.
restrict_md0: When True (default), mixdepth 0 non-CJ-output UTXOs are
restricted to a single UTXO. CoinJoin outputs (label
"cj-out") are exempt and can be merged. Set to False
to disable the restriction.
Source code in jmwallet/src/jmwallet/wallet/coin_selection.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
select_utxos_with_merge(mixdepth: int, target_amount: int, min_confirmations: int = 1, merge_algorithm: str = 'default', include_fidelity_bonds: bool = False, *, restrict_md0: bool = True) -> list[UTXOInfo]
Select UTXOs with merge algorithm for maker UTXO consolidation.
Unlike regular select_utxos(), this method can select MORE UTXOs than strictly necessary based on the merge algorithm. Since takers pay tx fees, makers can add extra inputs "for free" to consolidate their UTXOs.
Args:
mixdepth: Mixdepth to select from
target_amount: Minimum target amount in satoshis
min_confirmations: Minimum confirmations required
merge_algorithm: Selection strategy:
- "default": Minimum UTXOs needed (same as select_utxos)
- "gradual": +1 additional UTXO beyond minimum
- "greedy": ALL eligible UTXOs from the mixdepth
- "random": +0 to +2 additional UTXOs randomly
include_fidelity_bonds: If True, include fidelity bond UTXOs.
Defaults to False since they should never be
automatically spent in CoinJoins.
restrict_md0: When True (default), mixdepth 0 non-CJ-output UTXOs are
restricted to a single UTXO. CoinJoin outputs (label
"cj-out") are exempt and can be merged. Set to False
to disable the restriction.
Returns: List of selected UTXOs
Raises: ValueError: If insufficient funds
Source code in jmwallet/src/jmwallet/wallet/coin_selection.py
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | |