Mark Plugins Data and Events as stable (#346)

* Mark Plugins Data and Events as stable

Remove the @Unstable annotations form the data and BesuEvents services.
This means that no breaking changes (like removing methods or
changing signatures) will occur without proper notice and versioning
bumps.

* tweak build check

Signed-off-by: Danno Ferrin <danno.ferrin@gmail.com>

Co-authored-by: Tim Beiko <t.beiko23@gmail.com>
pull/348/head
Danno Ferrin 5 years ago committed by GitHub
parent 039c42eccb
commit 288c385ac0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      plugin-api/build.gradle
  2. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/Address.java
  3. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/BlockHeader.java
  4. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/Hash.java
  5. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/Log.java
  6. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/LogWithMetadata.java
  7. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/PropagatedBlockContext.java
  8. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/Quantity.java
  9. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/SyncStatus.java
  10. 3
      plugin-api/src/main/java/org/hyperledger/besu/plugin/data/Transaction.java
  11. 2
      plugin-api/src/main/java/org/hyperledger/besu/plugin/services/BesuEvents.java

@ -65,7 +65,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 = 'rwbtDgw6h2e4Rly7JpNvl12jVSohlCaWQtvJwADYYOU='
knownHash = '+vZGHbG9d/X21cBYgDMG8rinX0gJiATbSsmWtaeYvo0='
}
check.dependsOn('checkAPIChanges')

@ -14,10 +14,7 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
import org.apache.tuweni.bytes.Bytes;
/** An interface for {@link Bytes} that also represents an Ethereum account address. */
@Unstable
public interface Address extends Bytes {}

@ -14,15 +14,12 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
import org.apache.tuweni.bytes.Bytes;
/**
* The minimum set of data for a BlockHeader, as defined in the <a href=
* "https://ethereum.github.io/yellowpaper/paper.pdf">Ethereum Yellow Paper</a>.
*/
@Unstable
public interface BlockHeader {
/**

@ -14,13 +14,10 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
import org.apache.tuweni.bytes.Bytes32;
/**
* A marker interface indicating that this {@link Bytes32} represents a hash of some sort. The
* particular algorithm depends on the source, it may be ripemd, keccak, or some other algorithm.
*/
@Unstable
public interface Hash extends Bytes32 {}

@ -14,15 +14,12 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
import java.util.List;
import org.apache.tuweni.bytes.Bytes;
import org.apache.tuweni.bytes.Bytes32;
/** A Log entry from a transaction execution. */
@Unstable
public interface Log {
/**

@ -14,15 +14,12 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
import java.util.List;
import org.apache.tuweni.bytes.Bytes;
import org.apache.tuweni.bytes.Bytes32;
/** A Log entry from a transaction execution. */
@Unstable
public interface LogWithMetadata {
/**

@ -14,12 +14,9 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
import org.apache.tuweni.units.bigints.UInt256;
/** The minimum set of data for a PropagatedBlockContext. */
@Unstable
public interface PropagatedBlockContext {
/**

@ -14,13 +14,10 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
/**
* An interface to mark objects that also represents a disceete quantity, such as an unsigned
* integer value.
*/
@Unstable
public interface Quantity {
/**

@ -14,9 +14,6 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
@Unstable
public interface SyncStatus {
/**

@ -14,8 +14,6 @@
*/
package org.hyperledger.besu.plugin.data;
import org.hyperledger.besu.plugin.Unstable;
import java.math.BigInteger;
import java.util.Optional;
@ -31,7 +29,6 @@ import org.apache.tuweni.bytes.Bytes;
* creation). Message call transactions will have an address present in the {@link #getTo} method
* whereas contract creation transactions will not.
*/
@Unstable
public interface Transaction {
/**

@ -14,7 +14,6 @@
*/
package org.hyperledger.besu.plugin.services;
import org.hyperledger.besu.plugin.Unstable;
import org.hyperledger.besu.plugin.data.Address;
import org.hyperledger.besu.plugin.data.LogWithMetadata;
import org.hyperledger.besu.plugin.data.PropagatedBlockContext;
@ -41,7 +40,6 @@ import org.apache.tuweni.bytes.Bytes32;
* <li><b>SynchronizerStatus </b> - Fired when the status of the synchronizer changes.
* </ul>
*/
@Unstable
public interface BesuEvents {
/**

Loading…
Cancel
Save