message.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2020 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_UTIL_MESSAGE_H
#define BITCOIN_UTIL_MESSAGE_H

#include <uint256.h>

#include <string>

class CChainParams;
class CKey;

extern const std::string MESSAGE_MAGIC;

enum class MessageVerificationResult {
    ERR_INVALID_ADDRESS,

    ERR_ADDRESS_NO_KEY,

    ERR_MALFORMED_SIGNATURE,

    ERR_PUBKEY_NOT_RECOVERED,

    ERR_NOT_SIGNED,

    OK
};

enum class SigningResult {
    OK, 
    PRIVATE_KEY_NOT_AVAILABLE,
    SIGNING_FAILED,
};

MessageVerificationResult MessageVerify(const CChainParams &params,
                                        const std::string &address,
                                        const std::string &signature,
                                        const std::string &message);

bool MessageSign(const CKey &privkey, const std::string &message,
                 std::string &signature);

uint256 MessageHash(const std::string &message);

std::string SigningResultString(const SigningResult res);

#endif // BITCOIN_UTIL_MESSAGE_H