eu.bittrade.libs.steemj.protocol.operations.ClaimRewardBalanceOperation.java Source code

Java tutorial

Introduction

Here is the source code for eu.bittrade.libs.steemj.protocol.operations.ClaimRewardBalanceOperation.java

Source

/*
 *     This file is part of SteemJ (formerly known as 'Steem-Java-Api-Wrapper')
 * 
 *     SteemJ is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * 
 *     SteemJ is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 * 
 *     You should have received a copy of the GNU General Public License
 *     along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */
package eu.bittrade.libs.steemj.protocol.operations;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.security.InvalidParameterException;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang3.builder.ToStringBuilder;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

import eu.bittrade.libs.steemj.configuration.SteemJConfig;
import eu.bittrade.libs.steemj.enums.OperationType;
import eu.bittrade.libs.steemj.enums.PrivateKeyType;
import eu.bittrade.libs.steemj.enums.ValidationType;
import eu.bittrade.libs.steemj.exceptions.SteemInvalidTransactionException;
import eu.bittrade.libs.steemj.interfaces.SignatureObject;
import eu.bittrade.libs.steemj.protocol.AccountName;
import eu.bittrade.libs.steemj.protocol.Asset;
import eu.bittrade.libs.steemj.util.SteemJUtils;

/**
 * This class represents the Steem "claim_reward_balance_operation" object.
 * 
 * @author <a href="http://steemit.com/@dez1337">dez1337</a>
 */
public class ClaimRewardBalanceOperation extends Operation {
    @JsonProperty("account")
    private AccountName account;
    @JsonProperty("reward_steem")
    private Asset rewardSteem;
    @JsonProperty("reward_sbd")
    private Asset rewardSbd;
    @JsonProperty("reward_vests")
    private Asset rewardVests;

    /**
     * Create a new and empty claim reward balance operation.
     * 
     * @param account
     *            The account to claim the rewards for (see
     *            {@link #setAccount(AccountName)}).
     * @param rewardSteem
     *            The amount of Steem to claim (see
     *            {@link #setRewardSteem(Asset)}).
     * @param rewardSbd
     *            The amount of SBD to claim (see {@link #setRewardSbd(Asset)}).
     * @param rewardVests
     *            The amount of VESTS to claim (see
     *            {@link #setRewardVests(Asset)}).
     * @throws InvalidParameterException
     *             If one of the parameters does not fulfill the requirements.
     */
    @JsonCreator
    public ClaimRewardBalanceOperation(@JsonProperty("account") AccountName account,
            @JsonProperty("reward_steem") Asset rewardSteem, @JsonProperty("reward_sbd") Asset rewardSbd,
            @JsonProperty("reward_vests") Asset rewardVests) {
        super(false);

        this.setAccount(account);
        this.setRewardSbd(rewardSbd);
        this.setRewardSteem(rewardSteem);
        this.setRewardVests(rewardVests);
    }

    /**
     * Get the account the reward should be collected for.
     * 
     * @return The account name.
     */
    public AccountName getAccount() {
        return account;
    }

    /**
     * Set the account the reward should be collected for. <b>Notice:</b> The
     * private posting key of this account needs to be stored in the key
     * storage.
     * 
     * @param account
     *            The account name.
     * @throws InvalidParameterException
     *             If the <code>account</code> is null.
     */
    public void setAccount(AccountName account) {
        this.account = SteemJUtils.setIfNotNull(account, "The account can't be null.");
    }

    /**
     * Get the amount of Steem that should be collected.
     * 
     * @return The amount of Steem.
     */
    public Asset getRewardSteem() {
        return rewardSteem;
    }

    /**
     * Set the amount of Steem that should be collected. Please note that it is
     * not possible to collect more than that what is available. You can check
     * the available amount by requesting the Account information using
     * {@link eu.bittrade.libs.steemj.SteemJ#getAccounts(List)
     * getAccounts(List)} method.
     * 
     * @param rewardSteem
     *            The amount of Steem to collect.
     * @throws InvalidParameterException
     *             If the provided <code>rewardSteem</code> is null, does not
     *             have the symbol type STEEM or the amount to claim is
     *             negative.
     */
    public void setRewardSteem(Asset rewardSteem) {
        if (rewardSteem == null) {
            throw new InvalidParameterException("The STEEM reward can't be null.");
        }

        this.rewardSteem = rewardSteem;
    }

    /**
     * Get the amount of Steem Doller that should be collected.
     * 
     * @return The amount of Steem Doller.
     */
    public Asset getRewardSbd() {
        return rewardSbd;
    }

    /**
     * Set the amount of Steem Dollers that should be collected. Please note
     * that it is not possible to collect more than that what is available. You
     * can check the available amount by requesting the Account information
     * using {@link eu.bittrade.libs.steemj.SteemJ#getAccounts(List)
     * getAccounts(List)} method.
     * 
     * @param rewardSbd
     *            The amount of Steem Dollers to collect.
     * @throws InvalidParameterException
     *             If the provided <code>rewardSbd</code> is null, does not have
     *             the symbol type SBD or the amount to claim is negative.
     */
    public void setRewardSbd(Asset rewardSbd) {
        if (rewardSbd == null) {
            throw new InvalidParameterException("The SBD reward can't be null.");
        }

        this.rewardSbd = rewardSbd;
    }

    /**
     * Get the amount of Vests that should be collected.
     * 
     * @return The amount of Vests.
     */
    public Asset getRewardVests() {
        return rewardVests;
    }

    /**
     * Set the amount of Vests that should be collected. Please note that it is
     * not possible to collect more than that what is available. You can check
     * the available amount by requesting the Account information using
     * {@link eu.bittrade.libs.steemj.SteemJ#getAccounts(List)
     * getAccounts(List)} method.
     * 
     * @param rewardVests
     *            The amount of Vests to collect.
     * @throws InvalidParameterException
     *             If the provided <code>rewardVests</code> is null, does not
     *             have the symbol type VESTS or the amount to claim is
     *             negative.
     */
    public void setRewardVests(Asset rewardVests) {
        if (rewardVests == null) {
            throw new InvalidParameterException("The VESTS reward can't be null.");
        }

        this.rewardVests = rewardVests;
    }

    @Override
    public byte[] toByteArray() throws SteemInvalidTransactionException {
        try (ByteArrayOutputStream serializedClaimRewardOperation = new ByteArrayOutputStream()) {
            serializedClaimRewardOperation.write(SteemJUtils
                    .transformIntToVarIntByteArray(OperationType.CLAIM_REWARD_BALANCE_OPERATION.getOrderId()));
            serializedClaimRewardOperation.write(this.getAccount().toByteArray());
            serializedClaimRewardOperation.write(this.getRewardSteem().toByteArray());
            serializedClaimRewardOperation.write(this.getRewardSbd().toByteArray());
            serializedClaimRewardOperation.write(this.getRewardVests().toByteArray());

            return serializedClaimRewardOperation.toByteArray();
        } catch (IOException e) {
            throw new SteemInvalidTransactionException(
                    "A problem occured while transforming the operation into a byte array.", e);
        }
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }

    @Override
    public Map<SignatureObject, PrivateKeyType> getRequiredAuthorities(
            Map<SignatureObject, PrivateKeyType> requiredAuthoritiesBase) {
        return mergeRequiredAuthorities(requiredAuthoritiesBase, this.getAccount(), PrivateKeyType.POSTING);
    }

    @Override
    public void validate(ValidationType validationType) {
        if (!ValidationType.SKIP_VALIDATION.equals(validationType)) {
            if ((rewardSbd.getAmount() + rewardSteem.getAmount() + rewardVests.getAmount()) <= 0) {
                throw new InvalidParameterException("Must claim something.");
            }

            if (!ValidationType.SKIP_ASSET_VALIDATION.equals(validationType)) {
                if (!rewardSbd.getSymbol().equals(SteemJConfig.getInstance().getDollarSymbol())) {
                    throw new InvalidParameterException("The SBD reward must be of symbol type SBD.");
                } else if (rewardSbd.getAmount() < 0) {
                    throw new InvalidParameterException("Cannot claim a negative SBD amount");
                } else if (!rewardVests.getSymbol().equals(SteemJConfig.getInstance().getVestsSymbol())) {
                    throw new InvalidParameterException("The VESTS reward must be of symbol type VESTS.");
                } else if (rewardVests.getAmount() < 0) {
                    throw new InvalidParameterException("Cannot claim a negative VESTS amount");
                } else if (!rewardSteem.getSymbol().equals(SteemJConfig.getInstance().getTokenSymbol())) {
                    throw new InvalidParameterException("The STEEM reward must be of symbol type STEEM.");
                } else if (rewardSteem.getAmount() < 0) {
                    throw new InvalidParameterException("Cannot claim a negative STEEM amount");
                }
            }
        }
    }
}