Merge pull request #104 from QuickMythril/foreign-height

Add foreign chain height to API calls

src/main/java/org/qortal/api/resource/CrossChainBitcoinResource.java

@@ -14,6 +14,7 @@ import java.util.List;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.HeaderParam;
 import javax.ws.rs.POST;
+import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
@@ -35,6 +36,37 @@ public class CrossChainBitcoinResource {
 	@Context
 	HttpServletRequest request;
 
+	@GET
+	@Path("/height")
+	@Operation(
+		summary = "Returns current Bitcoin block height",
+		description = "Returns the height of the most recent block in the Bitcoin chain.",
+		responses = {
+			@ApiResponse(
+				content = @Content(
+					schema = @Schema(
+						type = "number"
+					)
+				)
+			)
+		}
+	)
+	@ApiErrors({ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE})
+	public String getBitcoinHeight() {
+		Bitcoin bitcoin = Bitcoin.getInstance();
+
+		try {
+			Integer height = bitcoin.getBlockchainHeight();
+			if (height == null)
+				throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+
+			return height.toString();
+
+		} catch (ForeignBlockchainException e) {
+			throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+		}
+	}
+
 	@POST
 	@Path("/walletbalance")
 	@Operation(

src/main/java/org/qortal/api/resource/CrossChainDigibyteResource.java

@@ -14,6 +14,7 @@ import java.util.List;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.HeaderParam;
 import javax.ws.rs.POST;
+import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
@@ -35,6 +36,37 @@ public class CrossChainDigibyteResource {
 	@Context
 	HttpServletRequest request;
 
+	@GET
+	@Path("/height")
+	@Operation(
+		summary = "Returns current Digibyte block height",
+		description = "Returns the height of the most recent block in the Digibyte chain.",
+		responses = {
+			@ApiResponse(
+				content = @Content(
+					schema = @Schema(
+						type = "number"
+					)
+				)
+			)
+		}
+	)
+	@ApiErrors({ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE})
+	public String getDigibyteHeight() {
+		Digibyte digibyte = Digibyte.getInstance();
+
+		try {
+			Integer height = digibyte.getBlockchainHeight();
+			if (height == null)
+				throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+
+			return height.toString();
+
+		} catch (ForeignBlockchainException e) {
+			throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+		}
+	}
+
 	@POST
 	@Path("/walletbalance")
 	@Operation(

src/main/java/org/qortal/api/resource/CrossChainDogecoinResource.java

@@ -21,6 +21,7 @@ import org.qortal.crosschain.SimpleTransaction;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.HeaderParam;
 import javax.ws.rs.POST;
+import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
@@ -33,6 +34,37 @@ public class CrossChainDogecoinResource {
 	@Context
 	HttpServletRequest request;
 
+	@GET
+	@Path("/height")
+	@Operation(
+		summary = "Returns current Dogecoin block height",
+		description = "Returns the height of the most recent block in the Dogecoin chain.",
+		responses = {
+			@ApiResponse(
+				content = @Content(
+					schema = @Schema(
+						type = "number"
+					)
+				)
+			)
+		}
+	)
+	@ApiErrors({ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE})
+	public String getDogecoinHeight() {
+		Dogecoin dogecoin = Dogecoin.getInstance();
+
+		try {
+			Integer height = dogecoin.getBlockchainHeight();
+			if (height == null)
+				throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+
+			return height.toString();
+
+		} catch (ForeignBlockchainException e) {
+			throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+		}
+	}
+
 	@POST
 	@Path("/walletbalance")
 	@Operation(

src/main/java/org/qortal/api/resource/CrossChainLitecoinResource.java

@@ -14,6 +14,7 @@ import java.util.List;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.HeaderParam;
 import javax.ws.rs.POST;
+import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
@@ -35,6 +36,37 @@ public class CrossChainLitecoinResource {
 	@Context
 	HttpServletRequest request;
 
+	@GET
+	@Path("/height")
+	@Operation(
+		summary = "Returns current Litecoin block height",
+		description = "Returns the height of the most recent block in the Litecoin chain.",
+		responses = {
+			@ApiResponse(
+				content = @Content(
+					schema = @Schema(
+						type = "number"
+					)
+				)
+			)
+		}
+	)
+	@ApiErrors({ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE})
+	public String getLitecoinHeight() {
+		Litecoin litecoin = Litecoin.getInstance();
+
+		try {
+			Integer height = litecoin.getBlockchainHeight();
+			if (height == null)
+				throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+
+			return height.toString();
+
+		} catch (ForeignBlockchainException e) {
+			throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+		}
+	}
+
 	@POST
 	@Path("/walletbalance")
 	@Operation(

src/main/java/org/qortal/api/resource/CrossChainPirateChainResource.java

@@ -20,6 +20,7 @@ import org.qortal.crosschain.SimpleTransaction;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.HeaderParam;
 import javax.ws.rs.POST;
+import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
@@ -32,6 +33,37 @@ public class CrossChainPirateChainResource {
 	@Context
 	HttpServletRequest request;
 
+	@GET
+	@Path("/height")
+	@Operation(
+		summary = "Returns current PirateChain block height",
+		description = "Returns the height of the most recent block in the PirateChain chain.",
+		responses = {
+			@ApiResponse(
+				content = @Content(
+					schema = @Schema(
+						type = "number"
+					)
+				)
+			)
+		}
+	)
+	@ApiErrors({ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE})
+	public String getPirateChainHeight() {
+		PirateChain pirateChain = PirateChain.getInstance();
+
+		try {
+			Integer height = pirateChain.getBlockchainHeight();
+			if (height == null)
+				throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+
+			return height.toString();
+
+		} catch (ForeignBlockchainException e) {
+			throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+		}
+	}
+
 	@POST
 	@Path("/walletbalance")
 	@Operation(

src/main/java/org/qortal/api/resource/CrossChainRavencoinResource.java

@@ -14,6 +14,7 @@ import java.util.List;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.HeaderParam;
 import javax.ws.rs.POST;
+import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
@@ -35,6 +36,37 @@ public class CrossChainRavencoinResource {
 	@Context
 	HttpServletRequest request;
 
+	@GET
+	@Path("/height")
+	@Operation(
+		summary = "Returns current Ravencoin block height",
+		description = "Returns the height of the most recent block in the Ravencoin chain.",
+		responses = {
+			@ApiResponse(
+				content = @Content(
+					schema = @Schema(
+						type = "number"
+					)
+				)
+			)
+		}
+	)
+	@ApiErrors({ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE})
+	public String getRavencoinHeight() {
+		Ravencoin ravencoin = Ravencoin.getInstance();
+
+		try {
+			Integer height = ravencoin.getBlockchainHeight();
+			if (height == null)
+				throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+
+			return height.toString();
+
+		} catch (ForeignBlockchainException e) {
+			throw ApiExceptionFactory.INSTANCE.createException(request, ApiError.FOREIGN_BLOCKCHAIN_NETWORK_ISSUE);
+		}
+	}
+
 	@POST
 	@Path("/walletbalance")
 	@Operation(

src/main/java/org/qortal/crosschain/Bitcoiny.java

@@ -167,6 +167,16 @@ public abstract class Bitcoiny implements ForeignBlockchain {
 		return blockTimestamps.get(5);
 	}
 
+	/**
+	 * Returns height from latest block.
+	 * <p>
+	 * @throws ForeignBlockchainException if error occurs
+	 */
+	public int getBlockchainHeight() throws ForeignBlockchainException {
+		int height = this.blockchainProvider.getCurrentHeight();
+		return height;
+	}
+
 	/** Returns fee per transaction KB. To be overridden for testnet/regtest. */
 	public Coin getFeePerKb() {
 		return this.bitcoinjContext.getFeePerKb();