net.osomahe.coinacrobat.api.exchange.boundary.Wallet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of coinacrobat-api Show documentation

The project with APIs to be able to create own strategy

There is a newer version: 0.4.0

package net.osomahe.coinacrobat.api.exchange.boundary;

import net.osomahe.coinacrobat.api.exchange.entity.Asset;
import net.osomahe.coinacrobat.api.exchange.entity.ExchangePair;


/**
 * This interface represents stock market wallet.
 * It provides information about balances of your account.
 *
 * @author Antonin Stoklasek
 */
public interface Wallet {

    /**
     * This method returns available balance of given asset.
     * How much can be used in next transaction.
     *
     * @param asset - commodity or payment currency which balance should be returned.
     * @return - available balance of given asset.
     */
    Double getAvailable(Asset asset);

    /**
     * This method returns reserved balance of given asset.
     * How much is stuck in open transactions.
     *
     * @param asset - commodity or payment currency which balance should be returned.
     * @return - reserved balance of given asset.
     */
    Double getReserved(Asset asset);

    /**
     * This method returns total balance of given asset.
     * available + reserved = total
     *
     * @param asset - commodity or payment currency which balance should be returned.
     * @return - total balance of given asset.
     */
    Double getTotal(Asset asset);


    /**
     * This method returns fee for given exchange pair in percent.
     * How much percent is the fee for transaction.
     *
     * @param exchangePair - exchange pair which fee percentage should be returned.
     * @return - fee percentage of given exchange pair.
     */
    Double getFeePercentage(ExchangePair exchangePair);
}