Fulfillment.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2016 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_CONDITIONS_FULFILLMENT_H
#define RIPPLE_CONDITIONS_FULFILLMENT_H
 
#include <ripple/basics/Buffer.h>
#include <ripple/basics/Slice.h>
#include <ripple/conditions/Condition.h>
#include <ripple/conditions/impl/utils.h>
#include <boost/optional.hpp>
 
namespace ripple {
namespace cryptoconditions {
 
struct Fulfillment
{
public:
    static constexpr std::size_t maxSerializedFulfillment = 256;
 
    static std::unique_ptr<Fulfillment>
    deserialize(Slice s, std::error_code& ec);
 
public:
    virtual ~Fulfillment() = default;
 
    virtual Buffer
    fingerprint() const = 0;
 
    virtual Type
    type() const = 0;
 
    virtual bool
    validate(Slice data) const = 0;
 
    virtual std::uint32_t
    cost() const = 0;
 
    virtual Condition
    condition() const = 0;
};
 
inline bool
operator==(Fulfillment const& lhs, Fulfillment const& rhs)
{
    // FIXME: for compound conditions, need to also check subtypes
    return lhs.type() == rhs.type() && lhs.cost() == rhs.cost() &&
        lhs.fingerprint() == rhs.fingerprint();
}
 
inline bool
operator!=(Fulfillment const& lhs, Fulfillment const& rhs)
{
    return !(lhs == rhs);
}
 
bool
match(Fulfillment const& f, Condition const& c);
 
bool
validate(Fulfillment const& f, Condition const& c, Slice m);
 
bool
validate(Fulfillment const& f, Condition const& c);
 
}  // namespace cryptoconditions
}  // namespace ripple
 
#endif