org.bitcoinj.crypto.EncodedPrivateKey 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 2011 Google Inc.
 * Copyright 2018 Andreas Schildbach
 *
 * 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.crypto;

import org.bitcoinj.base.Network;
import org.bitcoinj.core.NetworkParameters;

import java.util.Arrays;
import java.util.Objects;

/**
 * Some form of string-encoded private key. This form is useful for noting them down, e.g. on paper wallets.
 */
public abstract class EncodedPrivateKey {
    protected final Network network;
    protected final byte[] bytes;

    protected EncodedPrivateKey(Network network, byte[] bytes) {
        this.network = Objects.requireNonNull(network);
        this.bytes = Objects.requireNonNull(bytes);
    }

    @Deprecated
    protected EncodedPrivateKey(NetworkParameters params, byte[] bytes) {
        this(Objects.requireNonNull(params).network(), Objects.requireNonNull(bytes));
    }

    /**
     * Get the network this data is prefixed with.
     * @return the Network.
     */
    public Network network() {
        return network;
    }

    /**
     * @return network this data is valid for
     * @deprecated Use {@link #network()}
     */
    @Deprecated
    public final NetworkParameters getParameters() {
        return NetworkParameters.of(network);
    }

    @Override
    public int hashCode() {
        return Objects.hash(network, Arrays.hashCode(bytes));
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        EncodedPrivateKey other = (EncodedPrivateKey) o;
        return this.network.equals(other.network) && Arrays.equals(this.bytes, other.bytes);
    }
}