io.blockfrost.sdk.api.EpochService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of blockfrost-java Show documentation
Show all versions of blockfrost-java Show documentation
Java SDK for the Blockfrost.io API
package io.blockfrost.sdk.api;
import io.blockfrost.sdk.api.exception.APIException;
import io.blockfrost.sdk.api.model.Epoch;
import io.blockfrost.sdk.api.model.EpochParam;
import io.blockfrost.sdk.api.model.Stake;
import io.blockfrost.sdk.api.util.OrderEnum;
import java.util.List;
public interface EpochService {
/**
* Latest epoch
* Return the information about the latest, therefore current, epoch.
*
* @return Epoch
*/
Epoch getLatestEpoch() throws APIException;
/**
* Latest epoch protocol parameters
* Return the protocol parameters for the latest epoch.
*
* @return EpochParam
*/
EpochParam getLatestEpochParam() throws APIException;
/**
* Specific epoch
* Return the content of the requested epoch.
*
* @param number Number of the epoch (required)
* @return Epoch
*/
Epoch getEpoch(int number) throws APIException;
/**
* Listing of next epochs
* Return the list of epochs following a specific epoch.
*
* @param number Number of the requested epoch. (required)
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @return List<Epoch>
*/
List getNextEpochs(int number, int count, int page) throws APIException;
/**
* Listing of next epochs
* Return the list of all epochs following a specific epoch.
*
* @param number Number of the requested epoch. (required)
* @return List<Epoch>
*/
List getAllNextEpochs(int number) throws APIException;
/**
* Listing of previous epochs
* Return the list of epochs following a specific epoch.
*
* @param number Number of the requested epoch. (required)
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @return List<Epoch>
*/
List getPreviousEpochs(int number, int count, int page) throws APIException;
/**
* Listing of previous epochs
* Return the list of all epochs preceding a specific epoch.
*
* @param number Number of the requested epoch. (required)
* @return List<Epoch>
*/
List getAllPreviousEpochs(int number) throws APIException;
/**
* Stake distribution
* Return the active stakes for the epoch specified.
*
* @param number Number of the epoch (required)
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @return List<Stake>
*/
List getActiveStakesForEpoch(int number, int count, int page) throws APIException;
/**
* Stake distribution
* Return all active stakes for the epoch specified.
*
* @param number Number of the epoch (required)
* @return List<Stake>
*/
List getAllActiveStakesForEpoch(int number) throws APIException;
/**
* Stake distribution
* Return the active stakes for the epoch specified by networkStake pool.
*
* @param number Number of the epoch (required)
* @param poolId
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @return List<Stake>
*/
List getActiveStakesForEpochAndPool(int number, String poolId, int count, int page) throws APIException;
/**
* Stake distribution
* Return all the active stakes for the epoch specified by networkStake pool.
*
* @param number Number of the epoch (required)
* @param poolId
* @return List<Stake>
*/
List getAllActiveStakesForEpochAndPool(int number, String poolId) throws APIException;
/**
* Protocol parameters
* Return the protocol parameters for the epoch specified.
*
* @param number Number of the epoch (required)
* @return EpochParam
*/
EpochParam getEpochParam(int number) throws APIException;
/**
* Block distribution
* Return the blocks minted for the epoch specified.
*
* @param number Number of the epoch (required)
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
* @return List<String>
*/
List getBlocksForEpoch(int number, int count, int page, OrderEnum order) throws APIException;
/**
* Block distribution
* Return the blocks minted for the epoch specified ordered ascending from the point of view of the blockchain, not the page listing itself.
*
* @param number Number of the epoch (required)
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @return List<String>
*/
List getBlocksForEpoch(int number, int count, int page) throws APIException;
/**
* Block distribution
* Return all the blocks minted for the epoch specified
*
* @param number Number of the epoch (required)
* @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
* @return List<String>
*/
//TODO Commented as it's not practical to get all the blocks in an epoch
// List getBlocksForEpoch(int number, OrderEnum order) throws APIException;
/**
* Block distribution
* Return the blocks minted for the epoch specified ordered ascending from the point of view of the blockchain, not the page listing itself.
*
* @param number Number of the epoch (required)
* @return List<String>
*/
//TODO Commented as it's not practical to get all the blocks in an epoch
//List getBlocksForEpoch(int number) throws APIException;
/**
* Block distribution
* Return the blocks minted for the epoch specified by stake pool
*
* @param number Number of the epoch (required)
* @param poolId NetworkStake pool ID to filter (required)
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
* @return List<String>
*/
List getBlocksForEpochAndPool(int number, String poolId, int count, int page, OrderEnum order) throws APIException;
/**
* Block distribution
* Return the blocks minted for the epoch specified by stake pool ordered ascending from the point of view of the blockchain, not the page listing itself.
*
* @param number Number of the epoch (required)
* @param poolId NetworkStake pool ID to filter (required)
* @param count The number of results displayed on one page. (<=100)
* @param page The page number for listing the results.
* @return List<String>
*/
List getBlocksForEpochAndPool(int number, String poolId, int count, int page) throws APIException;
/**
* Block distribution
* Return all the blocks minted for the epoch specified by stake pool
*
* @param number Number of the epoch (required)
* @param poolId NetworkStake pool ID to filter (required)
* @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
* @return List<String>
*/
List getAllBlocksForEpochAndPool(int number, String poolId, OrderEnum order) throws APIException;
/**
* Block distribution
* Return the blocks minted for the epoch specified by stake pool ordered ascending from the point of view of the blockchain, not the page listing itself.
*
* @param number Number of the epoch (required)
* @param poolId NetworkStake pool ID to filter (required)
* @return List<String>
*/
List getAllBlocksForEpochAndPool(int number, String poolId) throws APIException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy