[MINOR] text edits to plugins javadoc (#5115)

* light edits and fix to BlockBody type reference
* updated plugin api hash

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
This commit is contained in:
Sally MacFarlane
2023-02-21 12:43:07 +10:00
committed by GitHub
parent 17455d62e9
commit 11a4f734a4
12 changed files with 22 additions and 22 deletions

View File

@@ -66,7 +66,7 @@ Calculated : ${currentHash}
tasks.register('checkAPIChanges', FileStateChecker) {
description = "Checks that the API for the Plugin-API project does not change without deliberate thought"
files = sourceSets.main.allJava.files
knownHash = '0SzhbPysuW7BDEZzHE4szFg9gPlNu5nfdoKP68Xl4T0='
knownHash = 'sh5/mQlcilXjb/z51QbcvJTlqpI2uBe2EMli1WBV2tw='
}
check.dependsOn('checkAPIChanges')

View File

@@ -52,7 +52,7 @@ public interface BesuPlugin {
/**
* Called once when besu has loaded configuration but before external services have been started
* e.g metrics and http
* e.g. metrics and http
*/
default void beforeExternalServices() {}
@@ -64,7 +64,7 @@ public interface BesuPlugin {
void start();
/**
* Called when the plugin is being reloaded. This method will be called trough a dedicated JSON
* Called when the plugin is being reloaded. This method will be called through a dedicated JSON
* RPC endpoint. If not overridden this method does nothing for convenience. The plugin should
* only implement this method if it supports dynamic reloading.
*

View File

@@ -16,7 +16,7 @@ package org.hyperledger.besu.plugin.data;
import java.util.List;
/** The minimum set of data for a AddedBlockContext. */
/** The minimum set of data for an AddedBlockContext. */
public interface AddedBlockContext {
/**
@@ -27,9 +27,9 @@ public interface AddedBlockContext {
BlockHeader getBlockHeader();
/**
* A {@link BlockHeader} object.
* A {@link BlockBody} object.
*
* @return A {@link BlockHeader}
* @return A {@link BlockBody}
*/
BlockBody getBlockBody();

View File

@@ -31,14 +31,14 @@ public interface BlockBody {
*
* @return The list of transactions of the block.
*/
public List<? extends Transaction> getTransactions();
List<? extends Transaction> getTransactions();
/**
* Returns the list of ommers of the block.
*
* @return The list of ommers of the block.
*/
public List<? extends BlockHeader> getOmmers();
List<? extends BlockHeader> getOmmers();
/**
* Returns the list of withdrawals of the block.

View File

@@ -54,10 +54,10 @@ public interface BlockHeader {
/**
* The Keccak 256-bit hash of the root node of the state trie, after all transactions are executed
* and finalisations applied.
* and finalizations applied.
*
* @return The Keccak 256-bit hash of the root node of the state trie, after all transactions are
* executed and finalisations applied.
* executed and finalizations applied.
*/
Hash getStateRoot();

View File

@@ -58,7 +58,7 @@ public interface EnodeURL {
int getListeningPortOrZero();
/**
* Enode To URI .
* Enode To URI.
*
* @return the uri
*/

View File

@@ -27,9 +27,9 @@ public interface PropagatedBlockContext {
BlockHeader getBlockHeader();
/**
* A {@link BlockHeader} object.
* A {@link BlockBody} object.
*
* @return A {@link BlockHeader}
* @return A {@link BlockBody}
*/
BlockBody getBlockBody();

View File

@@ -106,7 +106,7 @@ public interface Transaction {
/**
* A scalar value equal to the number of Wei to be transferred to the message calls recipient or,
* in the case of contract creation, as an endowment to the newly created account
* in the case of contract creation, as an endowment to the newly created account.
*
* @return value equal to the number of Wei to be transferred
*/
@@ -143,7 +143,7 @@ public interface Transaction {
/**
* The chainId, computed from the 'V' portion of the signature. Used for replay protection. If
* replay protection is not enabled this value will not be present.
* replay protection is not enabled, this value will not be present.
*
* @return The chainId for transaction.
*/

View File

@@ -19,7 +19,7 @@ import java.util.Optional;
import org.apache.tuweni.bytes.Bytes;
/** A transaction receipt, containing information pertaining a transaction execution. */
/** A transaction receipt, containing information pertaining to a transaction execution. */
public interface TransactionReceipt {
/**
* Returns the total amount of gas consumed in the block after the transaction has been processed.

View File

@@ -80,7 +80,7 @@ public enum TransactionType {
}
/**
* Does transaction type supports access list.
* Does transaction type support access list.
*
* @return the boolean
*/
@@ -89,7 +89,7 @@ public enum TransactionType {
}
/**
* Does transaction type supports EIP-1559 fee market.
* Does transaction type support EIP-1559 fee market.
*
* @return the boolean
*/
@@ -98,7 +98,7 @@ public enum TransactionType {
}
/**
* Does transaction type requires chain id.
* Does transaction type require chain id.
*
* @return the boolean
*/
@@ -107,7 +107,7 @@ public enum TransactionType {
}
/**
* Does transaction type supports data blobs.
* Does transaction type support data blobs.
*
* @return the boolean
*/

View File

@@ -45,7 +45,7 @@ public interface Withdrawal {
Address getAddress();
/**
* Amount of ether to be withdrawn that be credit to the recipient address
* Amount of ether to be withdrawn and credited to the recipient address
*
* @return withdrawn ether amount
*/

View File

@@ -67,7 +67,7 @@ public class RocksDBPlugin implements BesuPlugin {
if (cmdlineOptions.isEmpty()) {
throw new IllegalStateException(
"Expecting a PicoCLIO options to register CLI options with, but none found.");
"Expecting a PicoCLI options to register CLI options with, but none found.");
}
cmdlineOptions.get().addPicoCLIOptions(NAME, options);