org.bitcoinj.wallet.CoinSelection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bitcoinj-core Show documentation

A Java Bitcoin library

There is a newer version: 0.17-beta1

/*
 * Copyright by the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.bitcoinj.wallet;

import org.bitcoinj.base.Coin;
import org.bitcoinj.core.TransactionOutput;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * Represents the results of a {@link CoinSelector#select(Coin, List)} operation. A coin selection represents a list
 * of spendable transaction outputs that sum together to a {@link #totalValue()} value gathered. Different coin selections
 * could be produced by different coin selectors from the same input set, according to their varying policies.
 */
public class CoinSelection {
    /**
     * @deprecated Use {@link #totalValue()}
     */
    @Deprecated
    public final Coin valueGathered;
    /**
     * @deprecated Use {@link #outputs()}
     */
    @Deprecated
    public final List gathered;

    public CoinSelection(List gathered) {
        this.valueGathered = sumOutputValues(gathered);
        this.gathered = gathered;
    }

    /**
     * @deprecated use {@link #CoinSelection(List)}
     */
    @Deprecated
    public CoinSelection(Coin valueGathered, Collection gathered) {
        // ignore valueGathered
        this(new ArrayList<>(gathered));
    }

    private static Coin sumOutputValues(List outputs) {
        return outputs.stream()
                .map(TransactionOutput::getValue)
                .reduce(Coin.ZERO, Coin::add);
    }

    /**
     * @return Total value of gathered outputs.
     */
    public Coin totalValue() {
        return valueGathered;
    }

    /**
     * @return List of gathered outputs
     */
    public List outputs() {
        return gathered;
    }
}