From b0d17f4dc10218d0d52e2dae9f2b351490879e3e Mon Sep 17 00:00:00 2001 From: Daniel Connolly Date: Thu, 28 Dec 2017 16:30:48 +0100 Subject: [PATCH] fix a whole bunch of broken links in javadocs (#5) --- core/pom.xml | 2 +- .../java/org/bitcoin/NativeSecp256k1.java | 6 ++--- .../java/org/bitcoinj/core/ChildMessage.java | 2 +- .../main/java/org/bitcoinj/core/Context.java | 8 +++--- .../org/bitcoinj/core/NetworkParameters.java | 8 +++--- .../java/org/bitcoinj/core/PeerGroup.java | 2 +- .../java/org/bitcoinj/core/Transaction.java | 7 ++--- .../bitcoinj/core/TransactionConfidence.java | 2 +- .../core/listeners/NewBestBlockListener.java | 6 +++-- .../listeners/PeerConnectedEventListener.java | 2 +- .../PeerConnectionEventListener.java | 4 +-- .../PeerDisconnectedEventListener.java | 4 +-- .../PeerDiscoveredEventListener.java | 2 +- .../TransactionReceivedInBlockListener.java | 2 +- .../bitcoinj/crypto/TransactionSignature.java | 2 +- .../java/org/bitcoinj/kits/WalletAppKit.java | 2 +- .../bitcoinj/net/ClientConnectionManager.java | 2 +- .../main/java/org/bitcoinj/net/NioServer.java | 2 +- .../org/bitcoinj/net/ProtobufConnection.java | 2 +- .../bitcoinj/net/discovery/DnsDiscovery.java | 2 +- .../bitcoinj/net/discovery/PeerDiscovery.java | 2 +- .../channels/IPaymentChannelClient.java | 4 +-- .../channels/PaymentChannelClient.java | 4 +-- .../PaymentChannelClientConnection.java | 4 +-- .../channels/PaymentChannelClientState.java | 8 +++--- .../channels/PaymentChannelServer.java | 4 +-- .../channels/PaymentChannelServerState.java | 2 +- .../channels/PaymentChannelV1ClientState.java | 2 +- .../channels/PaymentChannelV1ServerState.java | 11 ++++---- .../channels/PaymentChannelV2ServerState.java | 1 - .../protocols/payments/PaymentProtocol.java | 8 +++--- .../protocols/payments/PaymentSession.java | 26 +++++++++---------- .../main/java/org/bitcoinj/script/Script.java | 2 -- .../org/bitcoinj/script/ScriptBuilder.java | 8 +++--- .../signers/LocalTransactionSigner.java | 2 +- .../java/org/bitcoinj/utils/BtcFormat.java | 1 - .../org/bitcoinj/wallet/KeyChainGroup.java | 1 - .../java/org/bitcoinj/wallet/SendRequest.java | 2 +- .../main/java/org/bitcoinj/wallet/Wallet.java | 12 ++++----- .../wallet/WalletProtobufSerializer.java | 4 +-- .../WalletCoinsReceivedEventListener.java | 2 +- 41 files changed, 87 insertions(+), 92 deletions(-) diff --git a/core/pom.xml b/core/pom.xml index a256c4a32ba..c32ff64ac6d 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -150,7 +150,7 @@ - http://docs.guava-libraries.googlecode.com/git-history/release/javadoc/ + http://google.github.io/guava/releases/18.0/api/docs/ true diff --git a/core/src/main/java/org/bitcoin/NativeSecp256k1.java b/core/src/main/java/org/bitcoin/NativeSecp256k1.java index 40ae76d7ce0..940b5ad70a0 100644 --- a/core/src/main/java/org/bitcoin/NativeSecp256k1.java +++ b/core/src/main/java/org/bitcoin/NativeSecp256k1.java @@ -78,7 +78,7 @@ public static boolean verify(byte[] data, byte[] signature, byte[] pub) throws A * libsecp256k1 Create an ECDSA signature. * * @param data Message hash, 32 bytes - * @param key Secret key, 32 bytes + * @param sec Secret key, 32 bytes * @return sig byte array of signature */ public static byte[] sign(byte[] data, byte[] sec) throws AssertFailException { @@ -200,7 +200,7 @@ public static long cloneContext() { * libsecp256k1 PrivKey Tweak-Mul - Tweak privkey by multiplying to it * * @param tweak some bytes to tweak with - * @param seckey 32-byte seckey + * @param privkey 32-byte seckey */ public static byte[] privKeyTweakMul(byte[] privkey, byte[] tweak) throws AssertFailException { Preconditions.checkArgument(privkey.length == 32); @@ -239,7 +239,7 @@ public static byte[] privKeyTweakMul(byte[] privkey, byte[] tweak) throws Assert * libsecp256k1 PrivKey Tweak-Add - Tweak privkey by adding to it * * @param tweak some bytes to tweak with - * @param seckey 32-byte seckey + * @param privkey 32-byte seckey */ public static byte[] privKeyTweakAdd(byte[] privkey, byte[] tweak) throws AssertFailException { Preconditions.checkArgument(privkey.length == 32); diff --git a/core/src/main/java/org/bitcoinj/core/ChildMessage.java b/core/src/main/java/org/bitcoinj/core/ChildMessage.java index 87576d311a6..0c34d0f81d3 100644 --- a/core/src/main/java/org/bitcoinj/core/ChildMessage.java +++ b/core/src/main/java/org/bitcoinj/core/ChildMessage.java @@ -29,7 +29,7 @@ public abstract class ChildMessage extends Message { @Nullable protected Message parent; /** - * @deprecated Use {@link #ChildMessage(NetworkParameters) instead. + * @deprecated Use {@link #ChildMessage(NetworkParameters)} instead. */ @Deprecated protected ChildMessage() { diff --git a/core/src/main/java/org/bitcoinj/core/Context.java b/core/src/main/java/org/bitcoinj/core/Context.java index f41a01f9e47..c967e038f4d 100644 --- a/core/src/main/java/org/bitcoinj/core/Context.java +++ b/core/src/main/java/org/bitcoinj/core/Context.java @@ -67,8 +67,8 @@ public Context(NetworkParameters params) { * * @param params The network parameters that will be associated with this context. * @param eventHorizon Number of blocks after which the library will delete data and be unable to always process reorgs (see {@link #getEventHorizon()}. - * @param feePerKb The default fee per 1000 bytes of transaction data to pay when completing transactions. For details, see {@link SendRequest#feePerKb}. - * @param ensureMinRequiredFee Whether to ensure the minimum required fee by default when completing transactions. For details, see {@link SendRequest#ensureMinRequiredFee}. + * @param feePerKb The default fee per 1000 bytes of transaction data to pay when completing transactions. For details, see {@link org.bitcoinj.wallet.SendRequest#feePerKb}. + * @param ensureMinRequiredFee Whether to ensure the minimum required fee by default when completing transactions. For details, see {@link org.bitcoinj.wallet.SendRequest#ensureMinRequiredFee}. */ public Context(NetworkParameters params, int eventHorizon, Coin feePerKb, boolean ensureMinRequiredFee) { this(params); @@ -177,14 +177,14 @@ public int getEventHorizon() { } /** - * The default fee per 1000 bytes of transaction data to pay when completing transactions. For details, see {@link SendRequest#feePerKb}. + * The default fee per 1000 bytes of transaction data to pay when completing transactions. For details, see {@link org.bitcoinj.wallet.SendRequest#feePerKb}. */ public Coin getFeePerKb() { return feePerKb; } /** - * Whether to ensure the minimum required fee by default when completing transactions. For details, see {@link SendRequest#ensureMinRequiredFee}. + * Whether to ensure the minimum required fee by default when completing transactions. For details, see {@link org.bitcoinj.wallet.SendRequest#ensureMinRequiredFee}. */ public boolean isEnsureMinRequiredFee() { return ensureMinRequiredFee; diff --git a/core/src/main/java/org/bitcoinj/core/NetworkParameters.java b/core/src/main/java/org/bitcoinj/core/NetworkParameters.java index 4750f6bffd8..26b7c49b4d7 100644 --- a/core/src/main/java/org/bitcoinj/core/NetworkParameters.java +++ b/core/src/main/java/org/bitcoinj/core/NetworkParameters.java @@ -421,8 +421,8 @@ public int getBip32HeaderPriv() { public abstract boolean hasMaxMoney(); /** - * Return the default serializer for this network. This is a shared serializer. - * @return + * the default {@link MessageSerializer} for this network. This is a shared serializer. + * @return the default {@link MessageSerializer} for this network. This is a shared serializer. */ public final MessageSerializer getDefaultSerializer() { // Construct a default serializer if we don't have one @@ -448,7 +448,7 @@ public final MessageSerializer getDefaultSerializer() { public abstract BitcoinSerializer getSerializer(boolean parseRetain); /** - * The number of blocks in the last {@link getMajorityWindow()} blocks + * The number of blocks in the last {@link #getMajorityWindow()} blocks * at which to trigger a notice to the user to upgrade their client, where * the client does not understand those blocks. */ @@ -457,7 +457,7 @@ public int getMajorityEnforceBlockUpgrade() { } /** - * The number of blocks in the last {@link getMajorityWindow()} blocks + * The number of blocks in the last {@link #getMajorityWindow()} blocks * at which to enforce the requirement that all new blocks are of the * newer type (i.e. outdated blocks are rejected). */ diff --git a/core/src/main/java/org/bitcoinj/core/PeerGroup.java b/core/src/main/java/org/bitcoinj/core/PeerGroup.java index 40b49880a0f..49ec10047af 100644 --- a/core/src/main/java/org/bitcoinj/core/PeerGroup.java +++ b/core/src/main/java/org/bitcoinj/core/PeerGroup.java @@ -803,7 +803,7 @@ public void addDisconnectedEventListener(Executor executor, PeerDisconnectedEven peer.addDisconnectedEventListener(executor, listener); } - /** See {@link Peer#addDiscoveredEventListener(PeerDiscoveredEventListener)} */ + /** See {@link #addDiscoveredEventListener(Executor, PeerDiscoveredEventListener)} */ public void addDiscoveredEventListener(PeerDiscoveredEventListener listener) { addDiscoveredEventListener(Threading.USER_THREAD, listener); } diff --git a/core/src/main/java/org/bitcoinj/core/Transaction.java b/core/src/main/java/org/bitcoinj/core/Transaction.java index df18cf5d509..2bedb67a63a 100644 --- a/core/src/main/java/org/bitcoinj/core/Transaction.java +++ b/core/src/main/java/org/bitcoinj/core/Transaction.java @@ -224,9 +224,6 @@ public Transaction(NetworkParameters params, byte[] payload, int offset) throws * @param params NetworkParameters object. * @param payload Bitcoin protocol formatted byte array containing message content. * @param offset The location of the first payload byte within the array. - * @param parseRetain Whether to retain the backing byte array for quick reserialization. - * If true and the backing byte array is invalidated due to modification of a field then - * the cached bytes may be repopulated and retained if the message is serialized again in the future. * @param length The length of message if known. Usually this is provided when deserializing of the wire * as the length will be provided as part of the header. If unknown then set to Message.UNKNOWN_LENGTH * @throws ProtocolException @@ -761,8 +758,8 @@ public void clearInputs() { /** * Adds an input to this transaction that imports value from the given output. Note that this input is not - * complete and after every input is added with {@link #addInput()} and every output is added with - * {@link #addOutput()}, a {@link TransactionSigner} must be used to finalize the transaction and finish the inputs + * complete and after every input is added with {@code addInput()} and every output is added with + * {@code addOutput()}, a {@link TransactionSigner} must be used to finalize the transaction and finish the inputs * off. Otherwise it won't be accepted by the network. * @return the newly created input. */ diff --git a/core/src/main/java/org/bitcoinj/core/TransactionConfidence.java b/core/src/main/java/org/bitcoinj/core/TransactionConfidence.java index 6d0a7dec3d2..792aa80f1dd 100644 --- a/core/src/main/java/org/bitcoinj/core/TransactionConfidence.java +++ b/core/src/main/java/org/bitcoinj/core/TransactionConfidence.java @@ -217,7 +217,7 @@ public void addEventListener(Executor executor, Listener listener) { *

Note that this is NOT called when every block arrives. Instead it is called when the transaction * transitions between confidence states, ie, from not being seen in the chain to being seen (not necessarily in * the best chain). If you want to know when the transaction gets buried under another block, implement a - * {@link BlockChainListener}, attach it to a {@link BlockChain} and then use the getters on the + * {@link org.bitcoinj.core.listeners.BlockChainListener}, attach it to a {@link BlockChain} and then use the getters on the * confidence object to determine the new depth.

*/ public void addEventListener(Listener listener) { diff --git a/core/src/main/java/org/bitcoinj/core/listeners/NewBestBlockListener.java b/core/src/main/java/org/bitcoinj/core/listeners/NewBestBlockListener.java index 178b3470329..96eec8229fe 100644 --- a/core/src/main/java/org/bitcoinj/core/listeners/NewBestBlockListener.java +++ b/core/src/main/java/org/bitcoinj/core/listeners/NewBestBlockListener.java @@ -16,7 +16,9 @@ package org.bitcoinj.core.listeners; +import org.bitcoinj.core.AbstractBlockChain; import org.bitcoinj.core.StoredBlock; +import org.bitcoinj.core.Transaction; import org.bitcoinj.core.VerificationException; /** @@ -26,8 +28,8 @@ public interface NewBestBlockListener { /** * Called when a new block on the best chain is seen, after relevant * transactions are extracted and sent to us via either - * {@link TransactionReceivedInBlockListener#receiveFromBlock(org.bitcoinj.core.Transaction, org.bitcoinj.core.StoredBlock, org.bitcoinj.core.BlockChain.NewBlockType, int relativityOffset)} - * or {@link TransactionReceivedInBlockListener#notifyTransactionIsInBlock(org.bitcoinj.core.Sha256Hash, org.bitcoinj.core.StoredBlock, org.bitcoinj.core.BlockChain.NewBlockType, int)}. + * {@link TransactionReceivedInBlockListener#receiveFromBlock(Transaction, StoredBlock, AbstractBlockChain.NewBlockType, int)} + * or {@link TransactionReceivedInBlockListener#notifyTransactionIsInBlock(org.bitcoinj.core.Sha256Hash, StoredBlock, AbstractBlockChain.NewBlockType, int)}. * If this block is causing a re-organise to a new chain, this method is NOT * called even though the block may be the new best block: your reorganize * implementation is expected to do whatever would normally be done do for a diff --git a/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectedEventListener.java b/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectedEventListener.java index c41722038ca..5cca257a545 100644 --- a/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectedEventListener.java +++ b/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectedEventListener.java @@ -24,7 +24,7 @@ public interface PeerConnectedEventListener { /** - * Called when a peer is connected. If this listener is registered to a {@link Peer} instead of a {@link PeerGroup}, + * Called when a peer is connected. If this listener is registered to a {@link Peer} instead of a {@link org.bitcoinj.core.PeerGroup}, * peerCount will always be 1. * * @param peer diff --git a/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectionEventListener.java b/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectionEventListener.java index ed5e9d9014c..503b6981e1c 100644 --- a/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectionEventListener.java +++ b/core/src/main/java/org/bitcoinj/core/listeners/PeerConnectionEventListener.java @@ -29,8 +29,8 @@ public interface PeerConnectionEventListener extends PeerConnectedEventListener, /** * Called when a peer is disconnected. Note that this won't be called if the listener is registered on a - * {@link PeerGroup} and the group is in the process of shutting down. If this listener is registered to a - * {@link Peer} instead of a {@link PeerGroup}, peerCount will always be 0. This handler can be called without + * {@link org.bitcoinj.core.PeerGroup} and the group is in the process of shutting down. If this listener is registered to a + * {@link Peer} instead of a {@link org.bitcoinj.core.PeerGroup}, peerCount will always be 0. This handler can be called without * a corresponding invocation of onPeerConnected if the initial connection is never successful. * * @param peer diff --git a/core/src/main/java/org/bitcoinj/core/listeners/PeerDisconnectedEventListener.java b/core/src/main/java/org/bitcoinj/core/listeners/PeerDisconnectedEventListener.java index 7565b2c8c23..c9d00157d9a 100644 --- a/core/src/main/java/org/bitcoinj/core/listeners/PeerDisconnectedEventListener.java +++ b/core/src/main/java/org/bitcoinj/core/listeners/PeerDisconnectedEventListener.java @@ -25,8 +25,8 @@ public interface PeerDisconnectedEventListener { /** * Called when a peer is disconnected. Note that this won't be called if the listener is registered on a - * {@link PeerGroup} and the group is in the process of shutting down. If this listener is registered to a - * {@link Peer} instead of a {@link PeerGroup}, peerCount will always be 0. This handler can be called without + * {@link org.bitcoinj.core.PeerGroup} and the group is in the process of shutting down. If this listener is registered to a + * {@link Peer} instead of a {@link org.bitcoinj.core.PeerGroup}, peerCount will always be 0. This handler can be called without * a corresponding invocation of onPeerConnected if the initial connection is never successful. * * @param peer diff --git a/core/src/main/java/org/bitcoinj/core/listeners/PeerDiscoveredEventListener.java b/core/src/main/java/org/bitcoinj/core/listeners/PeerDiscoveredEventListener.java index 45d6f24737b..87ff78f2773 100644 --- a/core/src/main/java/org/bitcoinj/core/listeners/PeerDiscoveredEventListener.java +++ b/core/src/main/java/org/bitcoinj/core/listeners/PeerDiscoveredEventListener.java @@ -25,7 +25,7 @@ */ public interface PeerDiscoveredEventListener { /** - *

Called when peers are discovered, this happens at startup of {@link PeerGroup} or if we run out of + *

Called when peers are discovered, this happens at startup of {@link org.bitcoinj.core.PeerGroup} or if we run out of * suitable {@link Peer}s to connect to.

* * @param peerAddresses the set of discovered {@link PeerAddress}es diff --git a/core/src/main/java/org/bitcoinj/core/listeners/TransactionReceivedInBlockListener.java b/core/src/main/java/org/bitcoinj/core/listeners/TransactionReceivedInBlockListener.java index c1b1865c7b3..40da0c6677b 100644 --- a/core/src/main/java/org/bitcoinj/core/listeners/TransactionReceivedInBlockListener.java +++ b/core/src/main/java/org/bitcoinj/core/listeners/TransactionReceivedInBlockListener.java @@ -44,7 +44,7 @@ void receiveFromBlock(Transaction tx, StoredBlock block, BlockChain.NewBlockType blockType, int relativityOffset) throws VerificationException; /** - *

Called by the {@link BlockChain} when we receive a new {@link FilteredBlock} that contains the given + *

Called by the {@link BlockChain} when we receive a new {@link org.bitcoinj.core.FilteredBlock} that contains the given * transaction hash in its merkle tree.

* *

A transaction may be received multiple times if is included into blocks in parallel chains. The blockType diff --git a/core/src/main/java/org/bitcoinj/crypto/TransactionSignature.java b/core/src/main/java/org/bitcoinj/crypto/TransactionSignature.java index 07877f3fc35..2abc38736f9 100644 --- a/core/src/main/java/org/bitcoinj/crypto/TransactionSignature.java +++ b/core/src/main/java/org/bitcoinj/crypto/TransactionSignature.java @@ -186,7 +186,7 @@ public ECKey.ECDSASignature toCanonicalised() { * @param requireCanonicalEncoding if the encoding of the signature must * be canonical. * @throws RuntimeException if the signature is invalid or unparseable in some way. - * @deprecated use {@link #decodeFromBitcoin(byte[], boolean, boolean} instead}. + * @deprecated use {@link #decodeFromBitcoin(byte[], boolean, boolean)} instead. */ @Deprecated public static TransactionSignature decodeFromBitcoin(byte[] bytes, diff --git a/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java b/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java index a05767a4526..fe2372007d8 100644 --- a/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java +++ b/core/src/main/java/org/bitcoinj/kits/WalletAppKit.java @@ -130,7 +130,7 @@ public WalletAppKit setAutoSave(boolean value) { /** * If you want to learn about the sync process, you can provide a listener here. For instance, a - * {@link org.bitcoinj.core.DownloadProgressTracker} is a good choice. This has no effect unless setBlockingStartup(false) has been called + * {@link org.bitcoinj.core.listeners.DownloadProgressTracker} is a good choice. This has no effect unless setBlockingStartup(false) has been called * too, due to some missing implementation code. */ public WalletAppKit setDownloadListener(DownloadProgressTracker listener) { diff --git a/core/src/main/java/org/bitcoinj/net/ClientConnectionManager.java b/core/src/main/java/org/bitcoinj/net/ClientConnectionManager.java index 23d493436d9..c16aec56ed5 100644 --- a/core/src/main/java/org/bitcoinj/net/ClientConnectionManager.java +++ b/core/src/main/java/org/bitcoinj/net/ClientConnectionManager.java @@ -25,7 +25,7 @@ *

A generic interface for an object which keeps track of a set of open client connections, creates new ones and * ensures they are serviced properly.

* - *

When the service is {@link com.google.common.util.concurrent.Service#stop()}ed, all connections will be closed and + *

When the service is stopped, all connections will be closed and * the appropriate connectionClosed() calls must be made.

*/ public interface ClientConnectionManager extends Service { diff --git a/core/src/main/java/org/bitcoinj/net/NioServer.java b/core/src/main/java/org/bitcoinj/net/NioServer.java index cfe025186ed..e5fb232a993 100644 --- a/core/src/main/java/org/bitcoinj/net/NioServer.java +++ b/core/src/main/java/org/bitcoinj/net/NioServer.java @@ -123,7 +123,7 @@ protected void run() throws Exception { /** * Invoked by the Execution service when it's time to stop. * Calling this method directly will NOT stop the service, call - * {@link com.google.common.util.concurrent.AbstractExecutionThreadService#stop()} instead. + * {@link AbstractExecutionThreadService#stopAsync()} stop()} instead. */ @Override public void triggerShutdown() { diff --git a/core/src/main/java/org/bitcoinj/net/ProtobufConnection.java b/core/src/main/java/org/bitcoinj/net/ProtobufConnection.java index dec49870eda..ed86ec94b7d 100644 --- a/core/src/main/java/org/bitcoinj/net/ProtobufConnection.java +++ b/core/src/main/java/org/bitcoinj/net/ProtobufConnection.java @@ -84,7 +84,7 @@ public interface Listener { * * @param handler The callback listener * @param prototype The default instance of the message type used in both directions of this channel. - * This should be the return value from {@link MessageType#getDefaultInstanceForType()} + * This should be the return value from {@code MessageType#getDefaultInstanceForType()} * @param maxMessageSize The maximum message size (not including the 4-byte length prefix). * Note that this has an upper bound of {@link Integer#MAX_VALUE} - 4 * @param timeoutMillis The timeout between messages before the connection is automatically closed. Only enabled diff --git a/core/src/main/java/org/bitcoinj/net/discovery/DnsDiscovery.java b/core/src/main/java/org/bitcoinj/net/discovery/DnsDiscovery.java index 1d05a8379bb..5c7b05d8c9b 100644 --- a/core/src/main/java/org/bitcoinj/net/discovery/DnsDiscovery.java +++ b/core/src/main/java/org/bitcoinj/net/discovery/DnsDiscovery.java @@ -31,7 +31,7 @@ * However, if all hosts passed fail to resolve a PeerDiscoveryException will be thrown during getPeers(). *

* - *

DNS seeds do not attempt to enumerate every peer on the network. {@link DnsDiscovery#getPeers(long, java.util.concurrent.TimeUnit)} + *

DNS seeds do not attempt to enumerate every peer on the network. {@link #getPeers(long, long, java.util.concurrent.TimeUnit)} * will return up to 30 random peers from the set of those returned within the timeout period. If you want more peers * to connect to, you need to discover them via other means (like addr broadcasts).

*/ diff --git a/core/src/main/java/org/bitcoinj/net/discovery/PeerDiscovery.java b/core/src/main/java/org/bitcoinj/net/discovery/PeerDiscovery.java index 72452c25d01..e0792bc0bef 100644 --- a/core/src/main/java/org/bitcoinj/net/discovery/PeerDiscovery.java +++ b/core/src/main/java/org/bitcoinj/net/discovery/PeerDiscovery.java @@ -29,7 +29,7 @@ public interface PeerDiscovery { /** * Returns an array of addresses. This method may block. - * @param services Required services as a bitmask, e.g. {@link VersionMessage#NODE_NETWORK}. + * @param services Required services as a bitmask, e.g. {@link org.bitcoinj.core.VersionMessage#NODE_NETWORK}. */ InetSocketAddress[] getPeers(long services, long timeoutValue, TimeUnit timeoutUnit) throws PeerDiscoveryException; diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/IPaymentChannelClient.java b/core/src/main/java/org/bitcoinj/protocols/channels/IPaymentChannelClient.java index 398cf2cefc2..0bb31e5f436 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/IPaymentChannelClient.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/IPaymentChannelClient.java @@ -46,7 +46,7 @@ public interface IPaymentChannelClient { * intending to reopen the channel later. There is likely little reason to use this in a stateless protocol.

* *

Note that this MUST still be called even after either - * {@link PaymentChannelClient.ClientConnection#destroyConnection(org.bitcoinj.protocols.channels.PaymentChannelCloseException.CloseReason)} or + * {@link ClientConnection#destroyConnection(org.bitcoinj.protocols.channels.PaymentChannelCloseException.CloseReason)} or * {@link IPaymentChannelClient#settle()} is called, to actually handle the connection close logic.

*/ void connectionClosed(); @@ -55,7 +55,7 @@ public interface IPaymentChannelClient { *

Settles the channel, notifying the server it can broadcast the most recent payment transaction.

* *

Note that this only generates a CLOSE message for the server and calls - * {@link PaymentChannelClient.ClientConnection#destroyConnection(org.bitcoinj.protocols.channels.PaymentChannelCloseException.CloseReason)} + * {@link ClientConnection#destroyConnection(org.bitcoinj.protocols.channels.PaymentChannelCloseException.CloseReason)} * to settle the connection, it does not actually handle connection close logic, and * {@link PaymentChannelClient#connectionClosed()} must still be called after the connection fully settles.

* diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClient.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClient.java index 3bb0ed1b8ae..ed469c2f8d4 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClient.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClient.java @@ -566,7 +566,7 @@ private void receiveClose(Protos.TwoWayChannelMessage msg) throws VerificationEx * intending to reopen the channel later. There is likely little reason to use this in a stateless protocol.

* *

Note that this MUST still be called even after either - * {@link ClientConnection#destroyConnection(org.bitcoinj.protocols.channels.PaymentChannelCloseException.CloseReason)} or + * {@link IPaymentChannelClient.ClientConnection#destroyConnection(PaymentChannelCloseException.CloseReason)} or * {@link PaymentChannelClient#settle()} is called, to actually handle the connection close logic.

*/ @Override @@ -586,7 +586,7 @@ public void connectionClosed() { * payment transaction.

* *

Note that this only generates a CLOSE message for the server and calls - * {@link ClientConnection#destroyConnection(CloseReason)} to settle the connection, it does not + * {@link IPaymentChannelClient.ClientConnection#destroyConnection(PaymentChannelCloseException.CloseReason)} to settle the connection, it does not * actually handle connection close logic, and {@link PaymentChannelClient#connectionClosed()} must still be called * after the connection fully closes.

* diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientConnection.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientConnection.java index 43491ed85a6..038bc06a140 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientConnection.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientConnection.java @@ -104,7 +104,7 @@ public PaymentChannelClientConnection(InetSocketAddress server, int timeoutSecon /** * Attempts to open a new connection to and open a payment channel with the given host and port, blocking until the - * connection is open. The server is requested to keep the channel open for {@param timeWindow} + * connection is open. The server is requested to keep the channel open for {@code timeWindow} * seconds. If the server proposes a longer time the channel will be closed. * * @param server The host/port pair where the server is listening. @@ -134,7 +134,7 @@ public PaymentChannelClientConnection(InetSocketAddress server, int timeoutSecon /** * Attempts to open a new connection to and open a payment channel with the given host and port, blocking until the - * connection is open. The server is requested to keep the channel open for {@param timeWindow} + * connection is open. The server is requested to keep the channel open for {@code timeWindow} * seconds. If the server proposes a longer time the channel will be closed. * * @param server The host/port pair where the server is listening. diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientState.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientState.java index b9b5785b3da..d1e27d60e8a 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientState.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientState.java @@ -211,7 +211,7 @@ public synchronized State getState() { * Creates the initial multisig contract and incomplete refund transaction which can be requested at the appropriate * time using {@link PaymentChannelV1ClientState#getIncompleteRefundTransaction} and * {@link PaymentChannelV1ClientState#getContract()}. The way the contract is crafted can be adjusted by - * overriding {@link PaymentChannelV1ClientState#editContractSendRequest(org.bitcoinj.wallet.Wallet.SendRequest)}. + * overriding {@link PaymentChannelV1ClientState#editContractSendRequest(org.bitcoinj.wallet.SendRequest)}. * By default unconfirmed coins are allowed to be used, as for micropayments the risk should be relatively low. * * @throws ValueOutOfRangeException if the value being used is too small to be accepted by the network @@ -225,7 +225,7 @@ public void initiate() throws ValueOutOfRangeException, InsufficientMoneyExcepti * Creates the initial multisig contract and incomplete refund transaction which can be requested at the appropriate * time using {@link PaymentChannelV1ClientState#getIncompleteRefundTransaction} and * {@link PaymentChannelV1ClientState#getContract()}. The way the contract is crafted can be adjusted by - * overriding {@link PaymentChannelV1ClientState#editContractSendRequest(org.bitcoinj.wallet.Wallet.SendRequest)}. + * overriding {@link PaymentChannelV1ClientState#editContractSendRequest(org.bitcoinj.wallet.SendRequest)}. * By default unconfirmed coins are allowed to be used, as for micropayments the risk should be relatively low. * @param userKey Key derived from a user password, needed for any signing when the wallet is encrypted. * The wallet KeyCrypter is assumed. @@ -426,7 +426,7 @@ public synchronized Coin getValueSpent() { /** * Gets the contract without changing the state machine - * @return + * @return the {@link Transaction} */ protected abstract Transaction getContractInternal(); @@ -435,7 +435,7 @@ public synchronized Coin getValueSpent() { /** * Gets the script that is signed. In the case of a P2SH contract this is the * script inside the P2SH script. - * @return + * @return the {@link Script} */ protected abstract Script getSignedScript(); } diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServer.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServer.java index f53daf22ba2..826a4f8dba9 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServer.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServer.java @@ -551,7 +551,7 @@ public void onFailure(Throwable t) { * resume this channel in the future and stops generating messages for the client.

* *

Note that this MUST still be called even after either - * {@link ServerConnection#destroyConnection(CloseReason)} or + * {@link ServerConnection#destroyConnection(PaymentChannelCloseException.CloseReason)} or * {@link PaymentChannelServer#close()} is called to actually handle the connection close logic.

*/ public void connectionClosed() { @@ -594,7 +594,7 @@ public void connectionOpen() { /** *

Closes the connection by generating a settle message for the client and calls - * {@link ServerConnection#destroyConnection(CloseReason)}. Note that this does not broadcast + * {@link ServerConnection#destroyConnection(PaymentChannelCloseException.CloseReason)}. Note that this does not broadcast * the payment transaction and the client may still resume the same channel if they reconnect

*

*

Note that {@link PaymentChannelServer#connectionClosed()} must still be called after the connection fully diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServerState.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServerState.java index 568e1d9ac9d..3bfa75aed4c 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServerState.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelServerState.java @@ -374,7 +374,7 @@ public Script getContractScript() { /** * Gets the script that signatures should sign against. This is never a P2SH * script, rather the script that would be inside a P2SH script. - * @return + * @return the {@link Script} */ protected abstract Script getSignedScript(); diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ClientState.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ClientState.java index 86e32bc0a6d..30562274b1f 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ClientState.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ClientState.java @@ -116,7 +116,7 @@ public int getMajorVersion() { * Creates the initial multisig contract and incomplete refund transaction which can be requested at the appropriate * time using {@link PaymentChannelV1ClientState#getIncompleteRefundTransaction} and * {@link PaymentChannelV1ClientState#getContract()}. The way the contract is crafted can be adjusted by - * overriding {@link PaymentChannelV1ClientState#editContractSendRequest(org.bitcoinj.core.Wallet.SendRequest)}. + * overriding {@link PaymentChannelV1ClientState#editContractSendRequest(org.bitcoinj.wallet.SendRequest)}. * By default unconfirmed coins are allowed to be used, as for micropayments the risk should be relatively low. * @param userKey Key derived from a user password, needed for any signing when the wallet is encrypted. * The wallet KeyCrypter is assumed. diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ServerState.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ServerState.java index da07ae0c0b6..60951a3a104 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ServerState.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV1ServerState.java @@ -179,12 +179,13 @@ private void signMultisigInput(Transaction tx, Transaction.SigHash hashType, boo /** *

Closes this channel and broadcasts the highest value payment transaction on the network.

* - *

This will set the state to {@link State#CLOSED} if the transaction is successfully broadcast on the network. - * If we fail to broadcast for some reason, the state is set to {@link State#ERROR}.

+ *

This will set the state to {@link PaymentChannelServerState.State#CLOSED} if the transaction is successfully + * broadcast on the network. If we fail to broadcast for some reason, the state is set to + * {@link PaymentChannelServerState.State#ERROR}.

* - *

If the current state is before {@link State#READY} (ie we have not finished initializing the channel), we - * simply set the state to {@link State#CLOSED} and let the client handle getting its refund transaction confirmed. - *

+ *

If the current state is before {@link PaymentChannelServerState.State#READY} (ie we have not finished + * initializing the channel), we simply set the state to {@link PaymentChannelServerState.State#CLOSED} and let the + * client handle getting its refund transaction confirmed.

* * @return a future which completes when the provided multisig contract successfully broadcasts, or throws if the * broadcast fails for some reason. Note that if the network simply rejects the transaction, this future diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV2ServerState.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV2ServerState.java index d1f94bc6bf1..18fe59127ab 100644 --- a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV2ServerState.java +++ b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelV2ServerState.java @@ -116,7 +116,6 @@ protected void verifyContract(final Transaction contract) { /** * Creates a P2SH script outputting to the client and server pubkeys - * @return */ @Override protected Script createOutputScript() { diff --git a/core/src/main/java/org/bitcoinj/protocols/payments/PaymentProtocol.java b/core/src/main/java/org/bitcoinj/protocols/payments/PaymentProtocol.java index 26df1e534f1..a19bcb453be 100644 --- a/core/src/main/java/org/bitcoinj/protocols/payments/PaymentProtocol.java +++ b/core/src/main/java/org/bitcoinj/protocols/payments/PaymentProtocol.java @@ -54,8 +54,8 @@ public class PaymentProtocol { /** * Create a payment request with one standard pay to address output. You may want to sign the request using - * {@link #signPaymentRequest}. Use {@link Protos.PaymentRequest.Builder#build} to get the actual payment - * request. + * {@link #signPaymentRequest}. Use {@link org.bitcoin.protocols.payments.Protos.PaymentRequest.Builder#build} + * to get the actual payment request. * * @param params network parameters * @param amount amount of coins to request, or null @@ -74,7 +74,7 @@ public static Protos.PaymentRequest.Builder createPaymentRequest(NetworkParamete /** * Create a payment request. You may want to sign the request using {@link #signPaymentRequest}. Use - * {@link Protos.PaymentRequest.Builder#build} to get the actual payment request. + * {@link org.bitcoin.protocols.payments.Protos.PaymentRequest.Builder#build} to get the actual payment request. * * @param params network parameters * @param outputs list of outputs to request coins to @@ -157,7 +157,7 @@ public static void signPaymentRequest(Protos.PaymentRequest.Builder paymentReque * * @param paymentRequest Payment request to verify. * @param trustStore KeyStore of trusted root certificate authorities. - * @return verification data, or null if no PKI method was specified in the {@link Protos.PaymentRequest}. + * @return verification data, or null if no PKI method was specified in the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest}. * @throws PaymentProtocolException if payment request could not be verified. */ @Nullable diff --git a/core/src/main/java/org/bitcoinj/protocols/payments/PaymentSession.java b/core/src/main/java/org/bitcoinj/protocols/payments/PaymentSession.java index 8988f89c6d5..82a7347f60e 100644 --- a/core/src/main/java/org/bitcoinj/protocols/payments/PaymentSession.java +++ b/core/src/main/java/org/bitcoinj/protocols/payments/PaymentSession.java @@ -46,8 +46,8 @@ * *
    *
  • A {@link BitcoinURI} object that conforms to BIP 0072
    • - *
  • A url where the {@link Protos.PaymentRequest} can be fetched
    • - *
  • Directly with a {@link Protos.PaymentRequest} object
    • + *
  • A url where the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} can be fetched
    • + *
  • Directly with a {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} object
    • *
* *

If initialized with a BitcoinURI or a url, a network request is made for the payment request object and a @@ -57,10 +57,10 @@ * amount and recipient are correct, perform any additional steps, and then construct a list of transactions to pass to * the sendPayment method.

* - *

Call sendPayment with a list of transactions that will be broadcast. A {@link Protos.Payment} message will be sent + *

Call sendPayment with a list of transactions that will be broadcast. A {@link org.bitcoin.protocols.payments.Protos.Payment} message will be sent * to the merchant if a payment url is provided in the PaymentRequest. NOTE: sendPayment does NOT broadcast the * transactions to the bitcoin network. Instead it returns a ListenableFuture that will be notified when a - * {@link Protos.PaymentACK} is received from the merchant. Typically a wallet will show the message to the user + * {@link org.bitcoin.protocols.payments.Protos.PaymentACK} is received from the merchant. Typically a wallet will show the message to the user * as a confirmation message that the payment is now "processing" or that an error occurred, and then broadcast the * tx itself later if needed.

* @@ -81,7 +81,7 @@ public class PaymentSession { /** *

Returns a future that will be notified with a PaymentSession object after it is fetched using the provided uri. - * uri is a BIP-72-style BitcoinURI object that specifies where the {@link Protos.PaymentRequest} object may + * uri is a BIP-72-style BitcoinURI object that specifies where the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} object may * be fetched in the r= parameter.

* *

If the payment request object specifies a PKI method, then the system trust store will be used to verify @@ -94,7 +94,7 @@ public static ListenableFuture createFromBitcoinUri(final Bitcoi /** * Returns a future that will be notified with a PaymentSession object after it is fetched using the provided uri. - * uri is a BIP-72-style BitcoinURI object that specifies where the {@link Protos.PaymentRequest} object may + * uri is a BIP-72-style BitcoinURI object that specifies where the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} object may * be fetched in the r= parameter. * If verifyPki is specified and the payment request object specifies a PKI method, then the system trust store will * be used to verify the signature provided by the payment request. An exception is thrown by the future if the @@ -107,7 +107,7 @@ public static ListenableFuture createFromBitcoinUri(final Bitcoi /** * Returns a future that will be notified with a PaymentSession object after it is fetched using the provided uri. - * uri is a BIP-72-style BitcoinURI object that specifies where the {@link Protos.PaymentRequest} object may + * uri is a BIP-72-style BitcoinURI object that specifies where the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} object may * be fetched in the r= parameter. * If verifyPki is specified and the payment request object specifies a PKI method, then the system trust store will * be used to verify the signature provided by the payment request. An exception is thrown by the future if the @@ -128,7 +128,7 @@ public static ListenableFuture createFromBitcoinUri(final Bitcoi /** * Returns a future that will be notified with a PaymentSession object after it is fetched using the provided url. - * url is an address where the {@link Protos.PaymentRequest} object may be fetched. + * url is an address where the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} object may be fetched. * If verifyPki is specified and the payment request object specifies a PKI method, then the system trust store will * be used to verify the signature provided by the payment request. An exception is thrown by the future if the * signature cannot be verified. @@ -139,7 +139,7 @@ public static ListenableFuture createFromUrl(final String url) t /** * Returns a future that will be notified with a PaymentSession object after it is fetched using the provided url. - * url is an address where the {@link Protos.PaymentRequest} object may be fetched. + * url is an address where the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} object may be fetched. * If the payment request object specifies a PKI method, then the system trust store will * be used to verify the signature provided by the payment request. An exception is thrown by the future if the * signature cannot be verified. @@ -151,7 +151,7 @@ public static ListenableFuture createFromUrl(final String url, f /** * Returns a future that will be notified with a PaymentSession object after it is fetched using the provided url. - * url is an address where the {@link Protos.PaymentRequest} object may be fetched. + * url is an address where the {@link org.bitcoin.protocols.payments.Protos.PaymentRequest} object may be fetched. * If the payment request object specifies a PKI method, then the system trust store will * be used to verify the signature provided by the payment request. An exception is thrown by the future if the * signature cannot be verified. @@ -182,7 +182,7 @@ public PaymentSession call() throws Exception { } /** - * Creates a PaymentSession from the provided {@link Protos.PaymentRequest}. + * Creates a PaymentSession from the provided {@link org.bitcoin.protocols.payments.Protos.PaymentRequest}. * Verifies PKI by default. */ public PaymentSession(Protos.PaymentRequest request) throws PaymentProtocolException { @@ -190,7 +190,7 @@ public PaymentSession(Protos.PaymentRequest request) throws PaymentProtocolExcep } /** - * Creates a PaymentSession from the provided {@link Protos.PaymentRequest}. + * Creates a PaymentSession from the provided {@link org.bitcoin.protocols.payments.Protos.PaymentRequest}. * If verifyPki is true, also validates the signature and throws an exception if it fails. */ public PaymentSession(Protos.PaymentRequest request, boolean verifyPki) throws PaymentProtocolException { @@ -198,7 +198,7 @@ public PaymentSession(Protos.PaymentRequest request, boolean verifyPki) throws P } /** - * Creates a PaymentSession from the provided {@link Protos.PaymentRequest}. + * Creates a PaymentSession from the provided {@link org.bitcoin.protocols.payments.Protos.PaymentRequest}. * If verifyPki is true, also validates the signature and throws an exception if it fails. * If trustStoreLoader is null, the system default trust store is used. */ diff --git a/core/src/main/java/org/bitcoinj/script/Script.java b/core/src/main/java/org/bitcoinj/script/Script.java index 99a098acb8e..2a76ba05481 100644 --- a/core/src/main/java/org/bitcoinj/script/Script.java +++ b/core/src/main/java/org/bitcoinj/script/Script.java @@ -305,7 +305,6 @@ public byte[] getPubKey() throws ScriptException { /** * Retrieves the sender public key from a LOCKTIMEVERIFY transaction - * @return * @throws ScriptException */ public byte[] getCLTVPaymentChannelSenderPubKey() throws ScriptException { @@ -317,7 +316,6 @@ public byte[] getCLTVPaymentChannelSenderPubKey() throws ScriptException { /** * Retrieves the recipient public key from a LOCKTIMEVERIFY transaction - * @return * @throws ScriptException */ public byte[] getCLTVPaymentChannelRecipientPubKey() throws ScriptException { diff --git a/core/src/main/java/org/bitcoinj/script/ScriptBuilder.java b/core/src/main/java/org/bitcoinj/script/ScriptBuilder.java index 9fc4e8d7844..1c6dca7fd3e 100644 --- a/core/src/main/java/org/bitcoinj/script/ScriptBuilder.java +++ b/core/src/main/java/org/bitcoinj/script/ScriptBuilder.java @@ -135,7 +135,7 @@ public ScriptBuilder number(int index, long num) { * Adds the given number as a OP_N opcode to the end of the program. * Only handles values 0-16 inclusive. * - * @see #number(int) + * @see #number(long) */ public ScriptBuilder smallNum(int num) { return smallNum(chunks.size(), num); @@ -146,7 +146,7 @@ public ScriptBuilder smallNum(int num) { * it will accept numbers in the range 0-16 inclusive, the encoding would be * considered non-standard. * - * @see #number(int) + * @see #number(long) */ protected ScriptBuilder bigNum(long num) { return bigNum(chunks.size(), num); @@ -156,7 +156,7 @@ protected ScriptBuilder bigNum(long num) { * Adds the given number as a OP_N opcode to the given index in the program. * Only handles values 0-16 inclusive. * - * @see #number(int) + * @see #number(long) */ public ScriptBuilder smallNum(int index, int num) { checkArgument(num >= 0, "Cannot encode negative numbers with smallNum"); @@ -170,7 +170,7 @@ public ScriptBuilder smallNum(int index, int num) { * it will accept numbers in the range 0-16 inclusive, the encoding would be * considered non-standard. * - * @see #number(int) + * @see #number(long) */ protected ScriptBuilder bigNum(int index, long num) { final byte[] data; diff --git a/core/src/main/java/org/bitcoinj/signers/LocalTransactionSigner.java b/core/src/main/java/org/bitcoinj/signers/LocalTransactionSigner.java index e290a7dddc3..e840b63e9fd 100644 --- a/core/src/main/java/org/bitcoinj/signers/LocalTransactionSigner.java +++ b/core/src/main/java/org/bitcoinj/signers/LocalTransactionSigner.java @@ -35,7 +35,7 @@ *

*

This signer is always implicitly added into every wallet and it is the first signer to be executed during tx * completion. As the first signer to create a signature, it stores derivation path of the signing key in a given - * {@link ProposedTransaction} object that will be also passed then to the next signer in chain. This allows other + * {@link TransactionSigner.ProposedTransaction} object that will be also passed then to the next signer in chain. This allows other * signers to use correct signing key for P2SH inputs, because all the keys involved in a single P2SH address have * the same derivation path.

*

This signer always uses {@link org.bitcoinj.core.Transaction.SigHash#ALL} signing mode.

diff --git a/core/src/main/java/org/bitcoinj/utils/BtcFormat.java b/core/src/main/java/org/bitcoinj/utils/BtcFormat.java index a8d2bbfdf53..babf72aac5b 100644 --- a/core/src/main/java/org/bitcoinj/utils/BtcFormat.java +++ b/core/src/main/java/org/bitcoinj/utils/BtcFormat.java @@ -1378,7 +1378,6 @@ private static DecimalFormatSymbols setSymbolAndCode(DecimalFormat numberFormat, * * @param scale Number of places the decimal point will be shifted when formatting * a quantity of satoshis. - * @return The DecimalFormatSymbols before changing */ protected static void prefixUnitsIndicator(DecimalFormat numberFormat, int scale) { checkState(Thread.holdsLock(numberFormat)); // make sure caller intends to reset before changing diff --git a/core/src/main/java/org/bitcoinj/wallet/KeyChainGroup.java b/core/src/main/java/org/bitcoinj/wallet/KeyChainGroup.java index 6aba8d79d79..368626ee4df 100644 --- a/core/src/main/java/org/bitcoinj/wallet/KeyChainGroup.java +++ b/core/src/main/java/org/bitcoinj/wallet/KeyChainGroup.java @@ -594,7 +594,6 @@ public BloomFilter getBloomFilter(int size, double falsePositiveRate, long nTwea return filter; } - /** {@inheritDoc} */ public boolean isRequiringUpdateAllBloomFilter() { throw new UnsupportedOperationException(); // Unused. } diff --git a/core/src/main/java/org/bitcoinj/wallet/SendRequest.java b/core/src/main/java/org/bitcoinj/wallet/SendRequest.java index a706758e6c6..9325de473aa 100644 --- a/core/src/main/java/org/bitcoinj/wallet/SendRequest.java +++ b/core/src/main/java/org/bitcoinj/wallet/SendRequest.java @@ -52,7 +52,7 @@ public class SendRequest { * *

If there are already inputs to the transaction, make sure their out point has a connected output, * otherwise their value will be added to fee. Also ensure they are either signed or are spendable by a wallet - * key, otherwise the behavior of {@link Wallet#completeTx(Wallet.SendRequest)} is undefined (likely + * key, otherwise the behavior of {@link Wallet#completeTx(SendRequest)} is undefined (likely * RuntimeException).

*/ public Transaction tx; diff --git a/core/src/main/java/org/bitcoinj/wallet/Wallet.java b/core/src/main/java/org/bitcoinj/wallet/Wallet.java index 044d349df10..29fe173fe47 100644 --- a/core/src/main/java/org/bitcoinj/wallet/Wallet.java +++ b/core/src/main/java/org/bitcoinj/wallet/Wallet.java @@ -3426,7 +3426,7 @@ public void setDescription(String description) { } /** - * Get the description of the wallet. See {@link Wallet#setDescription(String))} + * Get the description of the wallet. See {@link Wallet#setDescription(String)} */ public String getDescription() { return description; @@ -3703,7 +3703,7 @@ public enum MissingSigsMode { USE_DUMMY_SIG, /** * If signature is missing, {@link org.bitcoinj.signers.TransactionSigner.MissingSignatureException} - * will be thrown for P2SH and {@link ECKey.MissingPrivateKeyException} for other tx types. + * will be thrown for P2SH and {@link org.bitcoinj.core.ECKey.MissingPrivateKeyException} for other tx types. */ THROW } @@ -3718,7 +3718,7 @@ public enum MissingSigsMode { * and lets you see the proposed transaction before anything is done with it.

* *

This is a helper method that is equivalent to using {@link SendRequest#to(Address, Coin)} - * followed by {@link Wallet#completeTx(Wallet.SendRequest)} and returning the requests transaction object. + * followed by {@link Wallet#completeTx(SendRequest)} and returning the requests transaction object. * Note that this means a fee may be automatically added if required, if you want more control over the process, * just do those two steps yourself.

* @@ -3751,7 +3751,7 @@ public Transaction createSend(Address address, Coin value) throws InsufficientMo * Sends coins to the given address but does not broadcast the resulting pending transaction. It is still stored * in the wallet, so when the wallet is added to a {@link PeerGroup} or {@link Peer} the transaction will be * announced to the network. The given {@link SendRequest} is completed first using - * {@link Wallet#completeTx(Wallet.SendRequest)} to make it valid. + * {@link Wallet#completeTx(SendRequest)} to make it valid. * * @return the Transaction that was created * @throws InsufficientMoneyException if the request could not be completed due to not enough balance. @@ -4660,8 +4660,8 @@ public BloomFilter getBloomFilter(double falsePositiveRate) { *

This is used to generate a BloomFilter which can be {@link BloomFilter#merge(BloomFilter)}d with another. * It could also be used if you have a specific target for the filter's size.

* - *

See the docs for {@link BloomFilter(int, double)} for a brief explanation of anonymity when using bloom - * filters.

+ *

See the docs for {@link BloomFilter#BloomFilter(int, double, long, BloomFilter.BloomUpdate)} for a brief explanation of + * anonymity when using bloom filters.

*/ @Override @GuardedBy("keyChainGroupLock") public BloomFilter getBloomFilter(int size, double falsePositiveRate, long nTweak) { diff --git a/core/src/main/java/org/bitcoinj/wallet/WalletProtobufSerializer.java b/core/src/main/java/org/bitcoinj/wallet/WalletProtobufSerializer.java index a698f6df34e..c6ccf9cfc34 100644 --- a/core/src/main/java/org/bitcoinj/wallet/WalletProtobufSerializer.java +++ b/core/src/main/java/org/bitcoinj/wallet/WalletProtobufSerializer.java @@ -398,7 +398,7 @@ public Wallet readWallet(InputStream input, @Nullable WalletExtension... walletE * Wallet object with {@code forceReset} set {@code true}. It won't work.

* *

If {@code forceReset} is {@code true}, then no transactions are loaded from the wallet, and it is configured - * to replay transactions from the blockchain (as if the wallet had been loaded and {@link Wallet.reset} + * to replay transactions from the blockchain (as if the wallet had been loaded and {@link Wallet#reset()} * had been called immediately thereafter). * *

A wallet can be unreadable for various reasons, such as inability to open the file, corrupt data, internally @@ -447,7 +447,7 @@ public Wallet readWallet(NetworkParameters params, @Nullable WalletExtension[] e * Wallet object with {@code forceReset} set {@code true}. It won't work.

* *

If {@code forceReset} is {@code true}, then no transactions are loaded from the wallet, and it is configured - * to replay transactions from the blockchain (as if the wallet had been loaded and {@link Wallet.reset} + * to replay transactions from the blockchain (as if the wallet had been loaded and {@link Wallet#reset()} * had been called immediately thereafter). * *

A wallet can be unreadable for various reasons, such as inability to open the file, corrupt data, internally diff --git a/core/src/main/java/org/bitcoinj/wallet/listeners/WalletCoinsReceivedEventListener.java b/core/src/main/java/org/bitcoinj/wallet/listeners/WalletCoinsReceivedEventListener.java index 3242146af8a..08b0128ff4a 100644 --- a/core/src/main/java/org/bitcoinj/wallet/listeners/WalletCoinsReceivedEventListener.java +++ b/core/src/main/java/org/bitcoinj/wallet/listeners/WalletCoinsReceivedEventListener.java @@ -29,7 +29,7 @@ public interface WalletCoinsReceivedEventListener { * This is called when a transaction is seen that sends coins to this wallet, either because it * was broadcast across the network or because a block was received. If a transaction is seen when it was broadcast, * onCoinsReceived won't be called again when a block containing it is received. If you want to know when such a - * transaction receives its first confirmation, register a {@link TransactionConfidence} event listener using + * transaction receives its first confirmation, register a {@link org.bitcoinj.core.TransactionConfidence} event listener using * the object retrieved via {@link org.bitcoinj.core.Transaction#getConfidence()}. It's safe to modify the * wallet in this callback, for example, by spending the transaction just received. *