• Home
• com.bloxbean.cardano
• cardano-client-backend
• 0.6.2
• source code
• AccountService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.bloxbean.cardano.client.backend.api.AccountService Maven / Gradle / Ivy

package com.bloxbean.cardano.client.backend.api;

import com.bloxbean.cardano.client.api.common.OrderEnum;
import com.bloxbean.cardano.client.api.exception.ApiException;
import com.bloxbean.cardano.client.api.model.Result;
import com.bloxbean.cardano.client.backend.model.*;

import java.util.List;

/**
 * Get information specific to an account
 */
public interface AccountService {

    /**
     * Obtain information about a specific stake account.
     * @param stakeAddress Bech32 stake address.
     * @return account info of any staking address
     * @throws ApiException upon API Error
     */
    Result getAccountInformation(String stakeAddress) throws ApiException;

    /**
     * Obtain information about the reward history of a specific account.
     * @param stakeAddress Bech32 stake address.
     * @param count The number of results displayed on one page.
     * @param page The page number for listing the results.
     * @return staking history of an account
     * @throws ApiException upon API Error
     */
    Result> getAccountRewardsHistory(String stakeAddress, int count, int page) throws ApiException;

    /**
     * Obtain information about the reward history of a specific account.
     * @param stakeAddress Bech32 stake address.
     * @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.
     * @return staking history of an account
     * @throws ApiException upon API Error
     */
    Result> getAccountRewardsHistory(String stakeAddress, int count, int page, OrderEnum order) throws ApiException;

    /**
     * Obtain information about the history of a specific account.
     * @param stakeAddress Bech32 stake address.
     * @param count The number of results displayed on one page.
     * @param page The page number for listing the results.
     * @return staking history of an account
     * @throws ApiException upon API Error
     */
    Result> getAccountHistory(String stakeAddress, int count, int page) throws ApiException;

    /**
     * Obtain information about the history of a specific account.
     * @param stakeAddress Bech32 stake address.
     * @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.
     * @return staking history of an account
     * @throws ApiException upon API Error
     */
    Result> getAccountHistory(String stakeAddress, int count, int page, OrderEnum order) throws ApiException;

    /**
     * Obtain information about the addresses of a specific account.
     * @param stakeAddress Bech32 stake address.
     * @return List of {@link AccountAddress}
     */
    Result> getAllAccountAddresses(String stakeAddress) throws ApiException;

    /**
     * Obtain information about the addresses of a specific account.
     * @param stakeAddress Bech32 stake address.
     * @param count The number of results displayed on one page.
     * @param page The page number for listing the results.
     * @return List of {@link AccountAddress}
     */
    Result> getAccountAddresses(String stakeAddress, int count, int page) throws ApiException;

    /**
     * Obtain information about the addresses of a specific account.
     * @param stakeAddress Bech32 stake address.
     * @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.
     * @return List of {@link AccountAddress}
     */
    Result> getAccountAddresses(String stakeAddress, int count, int page, OrderEnum order) throws ApiException;

    /**
     * Obtain information about assets associated with addresses of a specific account.
     * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
     * @param stakeAddress Bech32 stake address.
     * @return List of {@link AccountAsset}
     */
    Result> getAllAccountAssets(String stakeAddress) throws ApiException;

    /**
     * Obtain information about assets associated with addresses of a specific account.
     * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
     * @param stakeAddress Bech32 stake address.
     * @param count The number of results displayed on one page.
     * @param page The page number for listing the results.
     * @return List of {@link AccountAsset}
     */
    Result> getAccountAssets(String stakeAddress, int count, int page) throws ApiException;

    /**
     * Obtain information about assets associated with addresses of a specific account.
     * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
     * @param stakeAddress Bech32 stake address.
     * @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.
     * @return List of Used Addresses
     */
    Result> getAccountAssets(String stakeAddress, int count, int page, OrderEnum order) throws ApiException;

    /**
     * Obtain information about transactions associated with a specific account.
     * @param stakeAddress Bech32 stake address.
     * @param count count
     * @param page page
     * @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.
     * @param fromBlockHeight from block number
     * @param toBlockHeight to block number
     * @return List of {@link TransactionContent}
     */
    Result> getAccountTransactions(String stakeAddress, int count, int page, OrderEnum order, Integer fromBlockHeight, Integer toBlockHeight) throws ApiException;

    /**
     * Obtain All information about transactions associated with a specific account.
     * @param stakeAddress Bech32 stake address.
     * @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.
     * @param fromBlockHeight from block number
     * @return List of {@link TransactionContent}
     */
    Result> getAllAccountTransactions(String stakeAddress, OrderEnum order, Integer fromBlockHeight, Integer toBlockHeight) throws ApiException;
}