From 89e4eb9a89548da9eb0dfb4b019ec5fac7c6aae4 Mon Sep 17 00:00:00 2001 From: Hash Engineering Solutions Date: Fri, 21 Oct 2022 08:16:12 -0700 Subject: [PATCH 01/55] feat: prepare coinjoin foundation: dip9 keychain, add denominating methods (#181) * fix: use correct constructor to create hardened children with identity keychain Signed-off-by: HashEngineering * feat: improve CoinJoin message classes * feat: add CoinJoin helper and base classes * feat: add CoinJoin coin selector classes * feat: add DIP9 derivation path for CoinJoin keys * feat: add CoinJoin related network parameters * feat: add TransactionDestination classes * feat: add CoinJoin support to Wallet (keychain, balance, etc) * tests: fix CoinJoin coin selection tests * feat: add getScript to TransactionDestination subclasses * refactor: fix spelling on CoinJoinConstants * feat: add Coin methods for <= and >= * feat: add isTrusted and isEmpty to Transaction * feat: add PendingDsaRequest class * refactor: fix naming of CoinJoinConstants in CoinJoinQueue * feat: add CoinControl and CoinType classes * feat: add KeyHolder, KeyHolderStorage, ReservedDestination, ReserveScript, NoDestination classes * feat: add more support classes for CoinJoin * add CompactTallyItem * add InputCoin * add TransactionBuilder * add TransactionBuilderOutput * feat: add Balance and Recipient classes * feat: add CoinJoinClientSession classes * feat: add CoinJoinTransactionInput class * feat: add CoinJoinClientManager class * feat: add CoinJoinClientManager object to Context * feat: add to method that takes a list of recipients * feat: add more CoinJoin helper methods to Wallet * tests: add tests for CoinJoin taken from Dash Core source * fix: simplify some coinjoin logging * chore: remove commented code * chore: remove invalid author comments Signed-off-by: HashEngineering --- .../java/org/bitcoinj/coinjoin/CoinJoin.java | 286 +++++++ .../coinjoin/CoinJoinBaseSession.java | 199 +++++ .../coinjoin/CoinJoinBroadcastTx.java | 41 + .../coinjoin/CoinJoinClientManager.java | 255 ++++++ .../coinjoin/CoinJoinClientOptions.java | 80 ++ .../coinjoin/CoinJoinClientSession.java | 758 ++++++++++++++++++ .../coinjoin/CoinJoinCoinSelector.java | 52 ++ .../bitcoinj/coinjoin/CoinJoinConstants.java | 66 ++ .../org/bitcoinj/coinjoin/CoinJoinQueue.java | 18 + .../coinjoin/CoinJoinTransactionInput.java | 45 ++ .../coinjoin/DenominatedCoinSelector.java | 58 ++ .../bitcoinj/coinjoin/PendingDsaRequest.java | 69 ++ .../org/bitcoinj/coinjoin/ValidInOuts.java | 38 + .../coinjoin/utils/CompactTallyItem.java | 28 + .../bitcoinj/coinjoin/utils/InputCoin.java | 75 ++ .../bitcoinj/coinjoin/utils/KeyHolder.java | 44 + .../coinjoin/utils/KeyHolderStorage.java | 84 ++ .../bitcoinj/coinjoin/utils/Recipient.java | 43 + .../coinjoin/utils/ReserveDestination.java | 83 ++ .../coinjoin/utils/ReserveScript.java | 24 + .../coinjoin/utils/TransactionBuilder.java | 321 ++++++++ .../utils/TransactionBuilderOutput.java | 42 + .../src/main/java/org/bitcoinj/core/Coin.java | 16 + .../main/java/org/bitcoinj/core/Context.java | 6 +- .../main/java/org/bitcoinj/core/KeyId.java | 68 +- .../org/bitcoinj/core/NetworkParameters.java | 11 + .../java/org/bitcoinj/core/NoDestination.java | 43 + .../main/java/org/bitcoinj/core/ScriptId.java | 46 ++ .../java/org/bitcoinj/core/Transaction.java | 32 +- .../org/bitcoinj/core/TransactionBag.java | 9 + .../bitcoinj/core/TransactionDestination.java | 104 +++ .../org/bitcoinj/core/TransactionOutput.java | 31 + .../org/bitcoinj/params/DevNetParams.java | 4 + .../org/bitcoinj/params/MainNetParams.java | 4 + .../org/bitcoinj/params/RegTestParams.java | 4 + .../org/bitcoinj/params/TestNet3Params.java | 4 + .../org/bitcoinj/params/UnitTestParams.java | 4 + .../java/org/bitcoinj/wallet/Balance.java | 112 +++ .../java/org/bitcoinj/wallet/CoinControl.java | 192 +++++ .../java/org/bitcoinj/wallet/CoinType.java | 32 + .../wallet/DerivationPathFactory.java | 28 + .../main/java/org/bitcoinj/wallet/Protos.java | 321 +++++++- .../java/org/bitcoinj/wallet/SendRequest.java | 19 +- .../main/java/org/bitcoinj/wallet/Wallet.java | 723 ++++++++++++++++- .../wallet/WalletProtobufSerializer.java | 19 + .../bitcoinj/wallet/ZeroConfCoinSelector.java | 2 +- core/src/main/proto/wallet.proto | 1 + .../bitcoinj/coinjoin/CoinJoinAcceptTest.java | 35 + .../coinjoin/CoinJoinClientOptionsTest.java | 50 ++ .../coinjoin/CoinJoinCoinSelectorTest.java | 67 ++ .../coinjoin/CoinJoinStatusUpdateTest.java | 36 + .../org/bitcoinj/coinjoin/CoinJoinTest.java | 40 + .../CoinJoinTransactionInputTest.java | 22 + .../coinjoin/DenominatedCoinSelectorTest.java | 63 ++ .../coinjoin/PendingDSARequestTest.java | 60 ++ .../utils/TransactionBuilderTest.java | 21 + .../wallet/DerivationPathFactoryTest.java | 12 + .../java/org/bitcoinj/wallet/WalletTest.java | 20 +- 58 files changed, 4870 insertions(+), 100 deletions(-) create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoin.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoinBaseSession.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoinClientManager.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoinClientOptions.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoinClientSession.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoinCoinSelector.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoinConstants.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/CoinJoinTransactionInput.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/DenominatedCoinSelector.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/PendingDsaRequest.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/ValidInOuts.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/CompactTallyItem.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/InputCoin.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/KeyHolder.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/KeyHolderStorage.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/Recipient.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/ReserveDestination.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/ReserveScript.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/TransactionBuilder.java create mode 100644 core/src/main/java/org/bitcoinj/coinjoin/utils/TransactionBuilderOutput.java create mode 100644 core/src/main/java/org/bitcoinj/core/NoDestination.java create mode 100644 core/src/main/java/org/bitcoinj/core/ScriptId.java create mode 100644 core/src/main/java/org/bitcoinj/core/TransactionDestination.java create mode 100644 core/src/main/java/org/bitcoinj/wallet/Balance.java create mode 100644 core/src/main/java/org/bitcoinj/wallet/CoinControl.java create mode 100644 core/src/main/java/org/bitcoinj/wallet/CoinType.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/CoinJoinAcceptTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/CoinJoinClientOptionsTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/CoinJoinCoinSelectorTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/CoinJoinStatusUpdateTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/CoinJoinTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/CoinJoinTransactionInputTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/DenominatedCoinSelectorTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/PendingDSARequestTest.java create mode 100644 core/src/test/java/org/bitcoinj/coinjoin/utils/TransactionBuilderTest.java diff --git a/core/src/main/java/org/bitcoinj/coinjoin/CoinJoin.java b/core/src/main/java/org/bitcoinj/coinjoin/CoinJoin.java new file mode 100644 index 0000000000..526c8be57c --- /dev/null +++ b/core/src/main/java/org/bitcoinj/coinjoin/CoinJoin.java @@ -0,0 +1,286 @@ +/* + * Copyright (c) 2022 Dash Core Group + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.bitcoinj.coinjoin; + +import com.google.common.collect.Lists; +import org.bitcoinj.core.Block; +import org.bitcoinj.core.Coin; +import org.bitcoinj.core.NetworkParameters; +import org.bitcoinj.core.Sha256Hash; +import org.bitcoinj.core.StoredBlock; +import org.bitcoinj.core.Transaction; +import org.bitcoinj.core.TransactionOutput; +import org.bitcoinj.script.ScriptPattern; +import org.bitcoinj.utils.Threading; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.concurrent.locks.ReentrantLock; + +import static org.bitcoinj.coinjoin.CoinJoinConstants.COINJOIN_ENTRY_MAX_SIZE; + +public class CoinJoin { + private static final Logger log = LoggerFactory.getLogger(CoinJoin.class); + private static final List standardDenominations = Lists.newArrayList( + Coin.COIN.multiply(10).add(Coin.valueOf(10000)), + Coin.COIN.add(Coin.valueOf(1000)), + Coin.COIN.div(10).add(Coin.valueOf(100)), + Coin.COIN.div(100).add(Coin.valueOf(10)), + Coin.COIN.div(1000).add(Coin.valueOf(1)) + ); + + private static final HashMap mapDSTX = new HashMap<>(); + private ReentrantLock mapdstx = Threading.lock("mapdstx"); + + public static List getStandardDenominations() { + return standardDenominations; + } + + public static Coin getSmallestDenomination() { + return standardDenominations.get(standardDenominations.size() -1); + } + + public static boolean isDenominatedAmount(Coin nInputAmount) { return amountToDenomination(nInputAmount) > 0; } + public static boolean isValidDenomination(int nDenom) { return denominationToAmount(nDenom).isPositive(); } + + + /** + Return a bitshifted integer representing a denomination in vecStandardDenominations + or 0 if none was found + */ + public static int amountToDenomination(Coin nInputAmount) { + for (int i = 0; i < standardDenominations.size(); ++i) { + if (nInputAmount.equals(standardDenominations.get(i))) { + return 1 << i; + } + } + return 0; + } + + /** + Returns: + - one of standard denominations from vecStandardDenominations based on the provided bitshifted integer + - 0 for non-initialized sessions (denom = 0) + - a value below 0 if an error occurred while converting from one to another + */ + public static Coin denominationToAmount(int denom) + { + if (denom == 0) { + // not initialized + return Coin.ZERO; + } + + int maxDenoms = standardDenominations.size(); + + if (denom >= (1 << maxDenoms) || denom < 0) { + // out of bounds + return Coin.valueOf(-1); + } + + if ((denom & (denom - 1)) != 0) { + // non-denom + return Coin.valueOf(-2); + } + + Coin denomAmount = Coin.valueOf(-3); + + for (int i = 0; i < maxDenoms; ++i) { + if ((denom & (1 << i)) != 0) { + denomAmount = standardDenominations.get(i); + break; + } + } + + return denomAmount; + } + + public static String denominationToString(int denom) { + Coin denomAmount = denominationToAmount(denom); + + switch ((int)denomAmount.value) { + case 0: return "N/A"; + case -1: return "out-of-bounds"; + case -2: return "non-denom"; + case -3: return "to-amount-error"; + default: return denomAmount.toPlainString(); + } + } + + /// Get the minimum/maximum number of participants for the pool + public static int getMinPoolParticipants(NetworkParameters params) { + return params.getPoolMinParticipants(); + } + public static int getMaxPoolParticipants(NetworkParameters params) { + return params.getPoolMaxParticipants(); + } + + public static Coin getMaxPoolAmount() { return standardDenominations.get(0).multiply(COINJOIN_ENTRY_MAX_SIZE); } + + + /// If the collateral is valid given by a client + public static boolean isCollateralValid(Transaction txCollateral) { + if (txCollateral.getOutputs().isEmpty()) return false; + if (txCollateral.getUpdateTime().getTime() != 0) return false; + + Coin nValueIn = Coin.ZERO; + Coin nValueOut = Coin.ZERO; + + for (TransactionOutput txout : txCollateral.getOutputs()) { + nValueOut = nValueOut.add(txout.getValue()); + + if (!ScriptPattern.isP2PKH(txout.getScriptPubKey()) && !txout.getScriptPubKey().isUnspendable()) { + log.info("coinjoin: Invalid Script, txCollateral={}", txCollateral); /* Continued */ + return false; + } + } + + //collateral transactions are required to pay out a small fee to the miners + if (nValueIn.minus(nValueOut).isLessThan(getCollateralAmount())) { + log.info("coinjoin: did not include enough fees in transaction: fees: {}, txCollateral={}", nValueOut.minus(nValueIn), txCollateral); /* Continued */ + return false; + } + + log.info("coinjoin: -- {}", txCollateral); /* Continued */ + + return true; + } + public static Coin getCollateralAmount() { return getSmallestDenomination().div(10); } + public static Coin getMaxCollateralAmount() { return getCollateralAmount().multiply(4); } + + + public static boolean isCollateralAmount(Coin nInputAmount) { + // collateral input can be anything between 1x and "max" (including both) + return nInputAmount.isGreaterThanOrEqualTo(getCollateralAmount()) && + nInputAmount.isLessThanOrEqualTo(getMaxCollateralAmount()); + } + + public static long calculateAmountPriority(Coin inputAmount) { + Coin optDenom = null; + for (Coin denom : getStandardDenominations()) { + if (inputAmount == denom) { + optDenom = denom; + } + } + + if (optDenom != null) { + return (int) ((float)Coin.COIN.value / optDenom.value * 10000); + } + + if (inputAmount.isLessThan(Coin.COIN)) { + return 20000; + } + + //nondenom return largest first + return -1L * inputAmount.div(Coin.COIN.value).value; + } + + private void checkDSTXes(StoredBlock block) { + mapdstx.lock(); + try { + Iterator> it = mapDSTX.entrySet().iterator(); + while (it.hasNext()) { + Map.Entry entry = it.next(); + if (entry.getValue().isExpired(block)) { + it.remove(); + } + } + log.info("checkDSTXes -- mapDSTX.size()={}", mapDSTX.size()); + } finally { + mapdstx.unlock(); + } + } + + public static void addDSTX(CoinJoinBroadcastTx dstx) { + mapDSTX.put(dstx.getHash(), dstx); + } + public static CoinJoinBroadcastTx getDSTX(Sha256Hash hash) { + return mapDSTX.get(hash); + } + + public static void UpdatedBlockTip(StoredBlock block){ + + } + public static void NotifyChainLock(StoredBlock block) { + + } + + public static void UpdateDSTXConfirmedHeight(Transaction tx, int nHeight) { + + } + public static void TransactionAddedToMempool(Transaction tx) { + + } + public static void BlockConnected(Block block, StoredBlock storedBlock, List vtxConflicted) { + + } + public static void BlockDisconnected(Block block, StoredBlock storedBlock) { + + } + + public static String getMessageByID(PoolMessage nMessageID) { + switch (nMessageID) { + case ERR_ALREADY_HAVE: + return "Already have that input."; + case ERR_DENOM: + return "No matching denominations found for mixing."; + case ERR_ENTRIES_FULL: + return "Entries are full."; + case ERR_EXISTING_TX: + return "Not compatible with existing transactions."; + case ERR_FEES: + return "Transaction fees are too high."; + case ERR_INVALID_COLLATERAL: + return "Collateral not valid."; + case ERR_INVALID_INPUT: + return "Input is not valid."; + case ERR_INVALID_SCRIPT: + return "Invalid script detected."; + case ERR_INVALID_TX: + return "Transaction not valid."; + case ERR_MAXIMUM: + return "Entry exceeds maximum size."; + case ERR_MN_LIST: + return "Not in the Masternode list."; + case ERR_MODE: + return "Incompatible mode."; + case ERR_QUEUE_FULL: + return "Masternode queue is full."; + case ERR_RECENT: + return "Last queue was created too recently."; + case ERR_SESSION: + return "Session not complete!"; + case ERR_MISSING_TX: + return "Missing input transaction information."; + case ERR_VERSION: + return "Incompatible version."; + case MSG_NOERR: + return "No errors detected."; + case MSG_SUCCESS: + return "Transaction created successfully."; + case MSG_ENTRIES_ADDED: + return "Your entries added successfully."; + case ERR_SIZE_MISMATCH: + return "Inputs vs outputs size mismatch."; + default: + return "Unknown response."; + } + } +} diff --git a/core/src/main/java/org/bitcoinj/coinjoin/CoinJoinBaseSession.java b/core/src/main/java/org/bitcoinj/coinjoin/CoinJoinBaseSession.java new file mode 100644 index 0000000000..7e961e01c3 --- /dev/null +++ b/core/src/main/java/org/bitcoinj/coinjoin/CoinJoinBaseSession.java @@ -0,0 +1,199 @@ +/* + * Copyright (c) 2022 Dash Core Group + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.bitcoinj.coinjoin; + +import com.google.common.collect.Lists; +import org.bitcoinj.core.Coin; +import org.bitcoinj.core.Transaction; +import org.bitcoinj.core.TransactionInput; +import org.bitcoinj.core.TransactionOutput; +import org.bitcoinj.core.Utils; +import org.bitcoinj.script.Script; +import org.bitcoinj.script.ScriptPattern; +import org.bitcoinj.utils.Threading; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.annotation.concurrent.GuardedBy; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicLong; +import java.util.concurrent.atomic.AtomicReference; +import java.util.concurrent.locks.ReentrantLock; + +import static org.bitcoinj.coinjoin.PoolMessage.ERR_ALREADY_HAVE; +import static org.bitcoinj.coinjoin.PoolMessage.ERR_DENOM; +import static org.bitcoinj.coinjoin.PoolMessage.ERR_FEES; +import static org.bitcoinj.coinjoin.PoolMessage.ERR_INVALID_INPUT; +import static org.bitcoinj.coinjoin.PoolMessage.ERR_INVALID_SCRIPT; +import static org.bitcoinj.coinjoin.PoolMessage.ERR_SIZE_MISMATCH; +import static org.bitcoinj.coinjoin.PoolMessage.MSG_NOERR; +import static org.bitcoinj.coinjoin.PoolState.POOL_STATE_IDLE; + +public class CoinJoinBaseSession { + private final Logger log = LoggerFactory.getLogger(CoinJoinBaseSession.class); + + protected ReentrantLock lock = Threading.lock("coinjoin_base_session"); + @GuardedBy("lock") + protected ArrayList entries; // Masternode/clients entries + + protected AtomicReference state = new AtomicReference<>(POOL_STATE_IDLE); // should be one of the POOL_STATE_XXX values + protected AtomicLong timeLastSuccessfulStep = new AtomicLong(0); // the time when last successful mixing step was performed + protected AtomicInteger sessionID = new AtomicInteger(0); // 0 if no mixing session is active + + @GuardedBy("lock") + protected Transaction finalMutableTransaction; // the finalized transaction ready for signing + + protected void setNull() { + // Both sides + lock.lock(); + try { + state.set(POOL_STATE_IDLE); + sessionID.set(0); + sessionDenom = 0; + entries.clear(); + finalMutableTransaction.getInputs().clear(); + finalMutableTransaction.getOutputs().clear(); + timeLastSuccessfulStep.set(Utils.currentTimeSeconds()); + } finally { + lock.unlock(); + } + } + + interface CheckTxOutputs { + ValidInOuts check(TransactionOutput txout); + } + + protected ValidInOuts isValidInOuts(List vin, List vout, PoolMessage messageIDRet, boolean consumeCollateral) { + + HashSet