All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.blockfrost.sdk.api.PoolService Maven / Gradle / Ivy

package io.blockfrost.sdk.api;

import io.blockfrost.sdk.api.exception.APIException;
import io.blockfrost.sdk.api.model.*;
import io.blockfrost.sdk.api.util.OrderEnum;

import java.util.List;

public interface PoolService {

    /**
     * List of networkStake pools
     * List of registered networkStake pools.
     *
     * @param count The numbers of pools per page.
     * @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. We return oldest first, newest last.
     * @return Call<List<String>>
     */
    List getPools(int count, int page, OrderEnum order) throws APIException;

    /**
     * List of networkStake pools
     * List of registered networkStake pools ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param count The numbers of pools per page (<=100).
     * @param page  The page number for listing the results.
     * @return List<String>
     */
    List getPools(int count, int page) throws APIException;


    /**
     * List of networkStake pools
     * List of all registered networkStake pools.
     *
     * @param order The ordering of items from the point of view of the blockchain.
     * @return List<String>
     */
    List getAllPools(OrderEnum order) throws APIException;

    /**
     * List of networkStake pools
     * List of all registered networkStake pools in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @return List<String>
     */
    List getAllPools() throws APIException;


    /**
     * List of retired pools
     * List of retired networkStake pools.
     *
     * @param count The numbers of pools per page.
     * @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. We return oldest first, newest last.
     * @return Call<List<PoolRetirementInfo>>
     */
    List getRetiredPools(int count, int page, OrderEnum order) throws APIException;

    /**
     * List of retired pools
     * List of retired networkStake pools ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param count The numbers of pools per page (<=100).
     * @param page  The page number for listing the results.
     * @return List<PoolRetirementInfo>
     */
    List getRetiredPools(int count, int page) throws APIException;


    /**
     * List of retired pools
     * List of all retired networkStake pools.
     *
     * @param order The ordering of items from the point of view of the blockchain.
     * @return List<PoolRetirementInfo>
     */
    List getAllRetiredPools(OrderEnum order) throws APIException;

    /**
     * List of retired pools
     * List of all retired networkStake pools in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @return List<PoolRetirementInfo>
     */
    List getAllRetiredPools() throws APIException;

    /**
     * List of retiring pools
     * List of retiring networkStake pools.
     *
     * @param count The numbers of pools per page.
     * @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. We return oldest first, newest last.
     * @return Call<List<PoolRetirementInfo>>
     */
    List getRetiringPools(int count, int page, OrderEnum order) throws APIException;

    /**
     * List of retiring pools
     * List of retiring networkStake pools ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param count The numbers of pools per page (<=100).
     * @param page  The page number for listing the results.
     * @return List<PoolRetirementInfo>
     */
    List getRetiringPools(int count, int page) throws APIException;


    /**
     * List of retiring pools
     * List of all retiring networkStake pools.
     *
     * @param order The ordering of items from the point of view of the blockchain.
     * @return List<PoolRetirementInfo>
     */
    List getAllRetiringPools(OrderEnum order) throws APIException;

    /**
     * List of retiring pools
     * List of all retiring networkStake pools in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @return List<PoolRetirementInfo>
     */
    List getAllRetiringPools() throws APIException;

    /**
     * Specific networkStake pool
     * Pool information.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return Pool
     */
    Pool getPool(String poolId) throws APIException;

    /**
     * NetworkStake pool history
     * History of networkStake pool parameters over epochs.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page.
     * @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.  (optional, default to asc)
     * @return List<PoolHistory>
     */
    List getPoolHistory(String poolId, int count, int page, OrderEnum order) throws APIException;

    /**
     * NetworkStake pool history
     * History of networkStake pool parameters over epochs ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The numbers of pools per page (<=100).
     * @param page   The page number for listing the results.
     * @return List<PoolHistory>
     */
    List getPoolHistory(String poolId, int count, int page) throws APIException;


    /**
     * NetworkStake pool history
     * History of networkStake pool parameters over epochs.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param order  The ordering of items from the point of view of the blockchain.
     * @return List<PoolHistory>
     */
    List getEntirePoolHistory(String poolId, OrderEnum order) throws APIException;

    /**
     * NetworkStake pool history
     * History of networkStake pool parameters over epochs in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return List<PoolHistory>
     */
    List getEntirePoolHistory(String poolId) throws APIException;

    /**
     * NetworkStake pool metadata
     * NetworkStake pool registration metadata.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return PoolMetadata
     */
    PoolMetadata getPoolMetadata(String poolId) throws APIException;

    /**
     * NetworkStake pool relays
     * Relays of a networkStake pool.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return List<Object>
     */
    List getPoolRelays(String poolId) throws APIException;

    /**
     * NetworkStake pool delegators
     * List of current networkStake pools delegators.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page.
     * @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.  (optional, default to asc)
     * @return List<PoolDelegator>
     */
    List getPoolDelegators(String poolId, int count, int page, OrderEnum order) throws APIException;

    /**
     * List of networkStake pool delegators
     * List of networkStake pool delegators ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The numbers of pools per page (<=100).
     * @param page   The page number for listing the results.
     * @return List<PoolDelegator>
     */
    List getPoolDelegators(String poolId, int count, int page) throws APIException;


    /**
     * List of networkStake pool delegators
     * List of networkStake pool delegators
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param order  The ordering of items from the point of view of the blockchain.
     * @return List<PoolDelegator>
     */
    List getAllPoolDelegators(String poolId, OrderEnum order) throws APIException;

    /**
     * List of networkStake pool delegators
     * List of networkStake pool delegators in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return List<PoolDelegator>
     */
    List getAllPoolDelegators(String poolId) throws APIException;

    /**
     * NetworkStake pool blocks
     * List of networkStake pools blocks.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page.
     * @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.  (optional, default to asc)
     * @return List<String>
     */
    List getPoolBlocks(String poolId, int count, int page, OrderEnum order) throws APIException;

    /**
     * NetworkStake pool blocks
     * List of networkStake pools blocks. ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The numbers of pools per page (<=100).
     * @param page   The page number for listing the results.
     * @return List<String>
     */
    List getPoolBlocks(String poolId, int count, int page) throws APIException;


    /**
     * NetworkStake pool blocks
     * List of networkStake pools blocks.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param order  The ordering of items from the point of view of the blockchain.
     * @return List<String>
     */
    List getAllPoolBlocks(String poolId, OrderEnum order) throws APIException;

    /**
     * NetworkStake pool blocks
     * List of networkStake pools blocks. in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return List<String>
     */
    List getAllPoolBlocks(String poolId) throws APIException;

    /**
     * NetworkStake pool updates
     * List of certificate updates to the networkStake pool.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The number of results displayed on one page. (optional, default to 100)
     * @param page   The page number for listing the results. (optional, default to 1)
     * @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.  (optional, default to asc)
     * @return List<PoolUpdate>
     */
    List getPoolUpdates(String poolId, int count, int page, OrderEnum order) throws APIException;

    /**
     * NetworkStake pool updates
     * List of certificate updates to the networkStake pool. ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param count  The numbers of pools per page (<=100).
     * @param page   The page number for listing the results.
     * @return List<PoolUpdate>
     */
    List getPoolUpdates(String poolId, int count, int page) throws APIException;


    /**
     * NetworkStake pool updates
     * List of certificate updates to the networkStake pool.
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @param order  The ordering of items from the point of view of the blockchain.
     * @return List<PoolUpdate>
     */
    List getAllPoolUpdates(String poolId, OrderEnum order) throws APIException;

    /**
     * NetworkStake pool updates
     * List of certificate updates to the networkStake pool. in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @param poolId Bech32 or hexadecimal pool ID. (required)
     * @return List<PoolUpdate>
     */
    List getAllPoolUpdates(String poolId) throws APIException;

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy