BitShares-Core  7.0.2
BitShares blockchain node software and command-line wallet software
Public Member Functions | Public Attributes | List of all members
graphene::chain::limit_order_object Class Reference

an offer to sell an amount of an asset at a specified exchange rate by a certain time More...

#include <market_object.hpp>

Inheritance diagram for graphene::chain::limit_order_object:
graphene::db::abstract_object< limit_order_object, protocol_ids, limit_order_object_type > graphene::db::base_abstract_object< limit_order_object > graphene::db::object

Public Member Functions

const create_take_profit_order_actionget_take_profit_action () const
 Returns the configured automatic action that will create a take profit order when this limit order is filled. More...
 
pair< asset_id_type, asset_id_type > get_market () const
 
asset amount_for_sale () const
 
asset amount_to_receive () const
 
asset_id_type sell_asset_id () const
 
asset_id_type receive_asset_id () const
 
- Public Member Functions inherited from graphene::db::abstract_object< limit_order_object, protocol_ids, limit_order_object_type >
 abstract_object ()
 
object_id< SpaceID, TypeID > get_id () const
 
- Public Member Functions inherited from graphene::db::base_abstract_object< limit_order_object >
std::unique_ptr< objectclone () const override
 
void move_from (object &obj) override
 
fc::variant to_variant () const override
 
std::vector< char > pack () const override
 
 object ()=default
 
 object (uint8_t space_id, uint8_t type_id)
 
- Public Member Functions inherited from graphene::db::object
 object ()=default
 
 object (uint8_t space_id, uint8_t type_id)
 
virtual ~object ()=default
 
virtual std::unique_ptr< objectclone () const =0
 
virtual fc::variant to_variant () const =0
 
virtual std::vector< char > pack () const =0
 

Public Attributes

time_point_sec expiration
 When this limit order will expire. More...
 
account_id_type seller
 Who is selling. More...
 
share_type for_sale
 The amount for sale, asset id is sell_price.base.asset_id. More...
 
price sell_price
 The seller's asking price. More...
 
fc::uint128_t filled_amount = 0
 The amount that has been sold, asset id is sell_price.base.asset_id. More...
 
share_type deferred_fee
 fee converted to CORE More...
 
asset deferred_paid_fee
 originally paid fee More...
 
bool is_settled_debt = false
 Whether this order is an individual settlement fund. More...
 
vector< limit_order_auto_actionon_fill
 Automatic actions when the limit order is filled or partially filled. More...
 
optional< limit_order_id_type > take_profit_order_id
 ID of the take profit limit order linked to this limit order. More...
 
- Public Attributes inherited from graphene::db::object
object_id_type id
 

Additional Inherited Members

- Static Public Attributes inherited from graphene::db::abstract_object< limit_order_object, protocol_ids, limit_order_object_type >
static constexpr uint8_t space_id
 
static constexpr uint8_t type_id
 

Detailed Description

an offer to sell an amount of an asset at a specified exchange rate by a certain time

The objects are indexed by expiration and are automatically deleted on the first block after expiration.

Definition at line 45 of file market_object.hpp.

Member Function Documentation

◆ amount_for_sale()

asset graphene::chain::limit_order_object::amount_for_sale ( ) const
inline

Definition at line 77 of file market_object.hpp.

◆ amount_to_receive()

asset graphene::chain::limit_order_object::amount_to_receive ( ) const
inline

Definition at line 78 of file market_object.hpp.

◆ get_market()

pair<asset_id_type,asset_id_type> graphene::chain::limit_order_object::get_market ( ) const
inline

Definition at line 70 of file market_object.hpp.

◆ get_take_profit_action()

const create_take_profit_order_action& graphene::chain::limit_order_object::get_take_profit_action ( ) const
inline

Returns the configured automatic action that will create a take profit order when this limit order is filled.

Definition at line 64 of file market_object.hpp.

◆ receive_asset_id()

asset_id_type graphene::chain::limit_order_object::receive_asset_id ( ) const
inline

Definition at line 80 of file market_object.hpp.

◆ sell_asset_id()

asset_id_type graphene::chain::limit_order_object::sell_asset_id ( ) const
inline

Definition at line 79 of file market_object.hpp.

Member Data Documentation

◆ deferred_fee

share_type graphene::chain::limit_order_object::deferred_fee

fee converted to CORE

Definition at line 53 of file market_object.hpp.

◆ deferred_paid_fee

asset graphene::chain::limit_order_object::deferred_paid_fee

originally paid fee

Definition at line 54 of file market_object.hpp.

◆ expiration

time_point_sec graphene::chain::limit_order_object::expiration

When this limit order will expire.

Definition at line 48 of file market_object.hpp.

◆ filled_amount

fc::uint128_t graphene::chain::limit_order_object::filled_amount = 0

The amount that has been sold, asset id is sell_price.base.asset_id.

Definition at line 52 of file market_object.hpp.

◆ for_sale

share_type graphene::chain::limit_order_object::for_sale

The amount for sale, asset id is sell_price.base.asset_id.

Definition at line 50 of file market_object.hpp.

◆ is_settled_debt

bool graphene::chain::limit_order_object::is_settled_debt = false

Whether this order is an individual settlement fund.

Definition at line 55 of file market_object.hpp.

◆ on_fill

vector< limit_order_auto_action > graphene::chain::limit_order_object::on_fill

Automatic actions when the limit order is filled or partially filled.

Definition at line 58 of file market_object.hpp.

◆ sell_price

price graphene::chain::limit_order_object::sell_price

The seller's asking price.

Definition at line 51 of file market_object.hpp.

◆ seller

account_id_type graphene::chain::limit_order_object::seller

Who is selling.

Definition at line 49 of file market_object.hpp.

◆ take_profit_order_id

optional<limit_order_id_type> graphene::chain::limit_order_object::take_profit_order_id

ID of the take profit limit order linked to this limit order.

Definition at line 61 of file market_object.hpp.


The documentation for this class was generated from the following file: