Merge bitcoin#16900: doc: Fix doxygen comment for SignTransaction in rpc/rawtransaction_util

fanquake · fanquake · commit 630ec7bf41fe · 2019-09-20T16:25:59.000+08:00
fa8d65f doc: Fix doxygen comment for SignTransaction in rpc/rawtransaction_util (MarcoFalke) Pull request description: The param `coins` to `SignTransaction` is final and can thus not be extended (as suggested by the doc). ACKs for top commit: practicalswift: ACK fa8d65f -- const correctness is good and diff looks correct fanquake: ACK fa8d65f Tree-SHA512: 041e159f2c3cf96e296173c31f3e5f35bbc7711cc888aa4bf08aaa8c65c95ee7f7672f65396690a9af45795a618eea0fadde7fb02d29ec85f1b4df5e6d9e0c7a
diff --git a/src/rpc/rawtransaction_util.cpp b/src/rpc/rawtransaction_util.cpp
@@ -268,7 +268,7 @@ void ParsePrevouts(const UniValue& prevTxsUnival, FillableSigningProvider* keyst
     }
 }
 
-UniValue SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, std::map<COutPoint, Coin>& coins, const UniValue& hashType)
+UniValue SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, const std::map<COutPoint, Coin>& coins, const UniValue& hashType)
 {
     int nHashType = ParseSighashString(hashType);
 
diff --git a/src/rpc/rawtransaction_util.h b/src/rpc/rawtransaction_util.h
@@ -19,11 +19,11 @@ class SigningProvider;
  *
  * @param  mtx           The transaction to-be-signed
  * @param  keystore      Temporary keystore containing signing keys
- * @param  coins         Map of unspent outputs - coins in mempool and current chain UTXO set, may be extended by previous txns outputs after call
+ * @param  coins         Map of unspent outputs
  * @param  hashType      The signature hash type
  * @returns JSON object with details of signed transaction
  */
-UniValue SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, std::map<COutPoint, Coin>& coins, const UniValue& hashType);
+UniValue SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, const std::map<COutPoint, Coin>& coins, const UniValue& hashType);
 
 /**
   * Parse a prevtxs UniValue array and get the map of coins from it

Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ void ParsePrevouts(const UniValue& prevTxsUnival, FillableSigningProvider* keyst`
`268`	`268`	`}`
`269`	`269`	`}`
`270`	`270`
`271`		`-UniValue SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, std::map<COutPoint, Coin>& coins, const UniValue& hashType)`
	`271`	`+UniValue SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, const std::map<COutPoint, Coin>& coins, const UniValue& hashType)`
`272`	`272`	`{`
`273`	`273`	`int nHashType = ParseSighashString(hashType);`
`274`	`274`