rippled/PaymentChannelHelpers_8h_source.html

#pragma once


#include <xrpl/basics/base_uint.h>

#include <xrpl/beast/utility/Journal.h>

#include <xrpl/ledger/ApplyView.h>

#include <xrpl/protocol/Rules.h>

#include <xrpl/protocol/STLedgerEntry.h>

#include <xrpl/protocol/TER.h>


#include <cstdint>

#include <optional>


namespace xrpl {


TER

closeChannel(SLE::Ref slep, ApplyView& view, UInt256 const& key, beast::Journal j);


uint32_t

saturatingAdd(Rules const& rules, uint32_t const lhs, uint32_t const rhs);


bool

isChannelExpired(ApplyView const& view, std::optional<std::uint32_t> timeField);


}  // namespace xrpl

xrpl::ApplyView
Writeable view to a ledger, for applying a transaction.
Definition ApplyView.h:141

xrpl::Rules
Rules controlling protocol behavior.
Definition Rules.h:40

xrpl::STLedgerEntry::Ref
std::shared_ptr< STLedgerEntry > const  & Ref
Definition STLedgerEntry.h:35

cstdint

xrpl
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:5

xrpl::isChannelExpired
bool isChannelExpired(ApplyView const &view, std::optional< std::uint32_t > timeField)
Determine whether a payment channel time field represents an expired time.

xrpl::closeChannel
TER closeChannel(SLE::Ref slep, ApplyView &view, UInt256 const &key, beast::Journal j)
Close a payment channel and return its remaining funds to the channel owner.
Definition PaymentChannelHelpers.cpp:25

xrpl::UInt256
BaseUInt< 256 > UInt256
Definition base_uint.h:580

xrpl::saturatingAdd
uint32_t saturatingAdd(Rules const &rules, uint32_t const lhs, uint32_t const rhs)
Add two uint32_t values with saturation at UINT32_MAX.
Definition PaymentChannelHelpers.cpp:70

xrpl::TER
TERSubset< CanCvtToTER > TER
Definition TER.h:654

optional