Sign.h

#pragma once
 
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/HashPrefix.h>
#include <xrpl/protocol/KeyType.h>
#include <xrpl/protocol/PublicKey.h>
#include <xrpl/protocol/Rules.h>
#include <xrpl/protocol/SField.h>
#include <xrpl/protocol/STObject.h>
#include <xrpl/protocol/SecretKey.h>
#include <xrpl/protocol/Serializer.h>
 
#include <optional>
 
namespace xrpl {

enum class SignatureRole {
    Transaction,
    Counterparty,
    Sponsor
};

[[nodiscard]] SField const*
signatureField(SignatureRole role);

[[nodiscard]] std::optional<SignatureRole>
signatureRole(SField const& sigField);

[[nodiscard]] HashPrefix
signingPrefix(SignatureRole role, bool multiSigning, Rules const& rules);

void
sign(
    STObject& st,
    HashPrefix const& prefix,
    KeyType type,
    SecretKey const& sk,
    SF_VL const& sigField = sfSignature);

bool
verify(
    STObject const& st,
    HashPrefix const& prefix,
    PublicKey const& pk,
    SF_VL const& sigField = sfSignature);

Serializer
buildMultiSigningData(STObject const& obj, AccountID const& signingID, HashPrefix prefix);

Serializer
startMultiSigningData(STObject const& obj, HashPrefix prefix);
 
inline void
finishMultiSigningData(AccountID const& signingID, Serializer& s)
{
    s.addBitString(signingID);
}
 
}  // namespace xrpl