sr25519_provider.hpp

/**
 * Copyright Quadrivium LLC
 * All Rights Reserved
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include "crypto/bip39/bip39_types.hpp"
#include "crypto/sr25519_types.hpp"

namespace kagome::crypto {

  /**
   * sr25519 provider error codes
   */
  enum class Sr25519ProviderError : uint8_t {
    SIGN_UNKNOWN_ERROR = 1,  // unknown error occured during call to `sign`
                             // method of bound function
    VERIFY_UNKNOWN_ERROR     // unknown error occured during call to `verify`
                             // method of bound function
  };

  class Sr25519Provider {
   public:
    using Keypair = Sr25519Keypair;
    using PublicKey = Sr25519PublicKey;
    using PrivateKey = Sr25519SecretKey;
    using Seed = Sr25519Seed;

    using Junctions = std::span<const bip39::RawJunction>;

    virtual ~Sr25519Provider() = default;

    /**
     * Generate random keypair from seed
     */
    virtual outcome::result<Sr25519Keypair> generateKeypair(
        const Sr25519Seed &seed, Junctions junctions) const = 0;

    /**
     * Sign message \param msg using \param keypair. If computed value is less
     * than \param threshold then return optional containing this value and
     * proof. Otherwise none returned
     * @param keypair pair of public and secret sr25519 keys
     * @param message bytes to be signed
     * @return signed message
     */
    virtual outcome::result<Sr25519Signature> sign(
        const Sr25519Keypair &keypair, common::BufferView message) const = 0;

    /**
     * Verifies that \param message was derived using \param public_key on
     * \param signature
     */
    virtual outcome::result<bool> verify(
        const Sr25519Signature &signature,
        common::BufferView message,
        const Sr25519PublicKey &public_key) const = 0;

    virtual outcome::result<bool> verify_deprecated(
        const Sr25519Signature &signature,
        common::BufferView message,
        const Sr25519PublicKey &public_key) const = 0;
  };
}  // namespace kagome::crypto

OUTCOME_HPP_DECLARE_ERROR(kagome::crypto, Sr25519ProviderError)