sysio::sub_chain_plugin Class Reference

#include <sub_chain_plugin.hpp>

Inheritance diagram for sysio::sub_chain_plugin:

Collaboration diagram for sysio::sub_chain_plugin:

Public Member Functions
	sub_chain_plugin ()
virtual	~sub_chain_plugin ()
virtual void	set_program_options (options_description &, options_description &cfg) override
void	plugin_initialize (const variables_map &options)
void	plugin_startup ()
void	plugin_shutdown ()
sysio::chain::account_name &	get_contract_name () const
sysio::chain::checksum256_type &	get_prev_s_id () const
void	update_prev_s_id (const sysio::chain::checksum256_type &new_s_id)
sysio::chain::checksum256_type	calculate_s_root (const std::vector< sysio::chain::transaction > &transactions)
sysio::chain::checksum256_type	compute_curr_s_id (const sysio::chain::checksum256_type &curr_s_root)
uint32_t	extract_s_block_number (const sysio::chain::checksum256_type &s_id)
std::vector< sysio::chain::transaction >	find_relevant_transactions (sysio::chain::controller &curr_chain)
bool	is_relevant_s_root_transaction (const sysio::chain::transaction &trx)
Public Member Functions inherited from appbase::plugin< sub_chain_plugin >
	plugin ()
virtual	~plugin ()
virtual state	get_state () const override
virtual const std::string &	name () const override
virtual void	register_dependencies ()
virtual void	initialize (const variables_map &options) override
virtual void	handle_sighup () override
virtual void	startup () override
virtual void	shutdown () override
Public Member Functions inherited from appbase::abstract_plugin
virtual	~abstract_plugin ()

Additional Inherited Members
Public Types inherited from appbase::abstract_plugin
enum	state { registered , initialized , started , stopped }
Protected Member Functions inherited from appbase::plugin< sub_chain_plugin >
	plugin (const string &name)

Detailed Description

Definition at line 22 of file sub_chain_plugin.hpp.

Constructor & Destructor Documentation

sub_chain_plugin()

sysio::sub_chain_plugin::sub_chain_plugin

(

)

Definition at line 15 of file sub_chain_plugin.cpp.

: my(new sub_chain_plugin_impl()) {}

~sub_chain_plugin()

sysio::sub_chain_plugin::~sub_chain_plugin ( )

virtual

Definition at line 16 of file sub_chain_plugin.cpp.

{}

Member Function Documentation

calculate_s_root()

checksum256_type sysio::sub_chain_plugin::calculate_s_root

(

const std::vector< sysio::chain::transaction > &

transactions

)

Calculate the S-Root from a vector of relevant s-transactions.

S-Root Fields (according to doc)

• Previous Block S-ID
• Current Block S-Root

Parameters

transactions

a vector of relevant s-transactions

Returns

the merkle S-Root calculated from the orderd s-leaves

Definition at line 84 of file sub_chain_plugin.cpp.

                                                                                              {
   // Build s-leaves from relevant s-transactions
   vector<digest_type> s_leaves;
   for( const auto& trx : transactions ){
      s_leaves.emplace_back( trx.id() );
   }
   // Create and return the merkle S-Root 
   return merkle( move(s_leaves) );
}

Here is the call graph for this function:

compute_curr_s_id()

checksum256_type sysio::sub_chain_plugin::compute_curr_s_id

(

const sysio::chain::checksum256_type &

curr_s_root

)

Compute the new S-ID from the previous S-ID and the current S-Root.

Parameters

curr_s_root

the current S-Root

Returns

the new S-ID

Definition at line 127 of file sub_chain_plugin.cpp.

                                                                                        {
    // ilog("Computing new S-ID from \n\tcurr_s_root: ${curr_s_root}\n\t${prev_s_id}", ("curr_s_root", curr_s_root)("prev_s_id", my->prev_s_id));
 
    // Serialize both the previous S-ID and the current S-Root
    auto data = fc::raw::pack(std::make_pair(my->prev_s_id, curr_s_root));
    // Hash the serialized data to generate the new S-ID
    checksum256_type curr_s_id = checksum256_type::hash(data);
 
    ilog("Computed interim S-ID: ${curr_s_id}", ("curr_s_id", curr_s_id));
    // Extract the block number from the previous S-ID and increment it by 1
    uint32_t prev_s_block_number = sub_chain_plugin::extract_s_block_number(my->prev_s_id);
    uint32_t next_s_block_number = prev_s_block_number + 1;
 
    ilog("Extracted prev_s_block_number from prev_s_id: ${prev_s_block_number}, next: ${next_s_block_number}", 
        ("prev_s_block_number", prev_s_block_number)("next_s_block_number", next_s_block_number));
 
    // Modify the first 4 bytes directly
    uint32_t next_s_block_number_reversed = fc::endian_reverse_u32(next_s_block_number);
    std::memcpy(curr_s_id.data(), &next_s_block_number_reversed, sizeof(uint32_t)); // Modify the first 4 bytes
 
    // ilog("Computed curr_s_id with block number embedded: ${c}", ("c", curr_s_id.str()));
    return curr_s_id;
}

Here is the call graph for this function:

extract_s_block_number()

uint32_t sysio::sub_chain_plugin::extract_s_block_number

(

const sysio::chain::checksum256_type &

s_id

)

Extract the block number from an S-ID. Takes the 32 least-significant bits from the previous S-ID to get the previous S-Block number

Parameters

s_id	the S-ID to extract the block number from

Returns

the previous block number

Definition at line 100 of file sub_chain_plugin.cpp.

                                                                              {
//    auto s_id_data = s_id.data();
//    return fc::endian_reverse_u32(s_id_data[0]);
 
    // Extract the pointer to the data from the checksum.
    auto s_id_data = s_id.data();
    
    // Since we are dealing with a checksum256_type, which is typically an array of bytes,
    // we need to correctly handle the conversion to uint32_t considering endianess.
    uint32_t s_block_number;
    
    // Copy the first 4 bytes of the data into a uint32_t variable.
    // memcpy ensures that we handle any alignment issues.
    std::memcpy(&s_block_number, s_id_data, sizeof(uint32_t));
 
    // Reverse the endianess if necessary.
    // You might need to adjust this based on how the data is stored (big-endian vs little-endian).
    return fc::endian_reverse_u32(s_block_number);
}

Here is the call graph for this function:

Here is the caller graph for this function:

find_relevant_transactions()

std::vector< sysio::chain::transaction > sysio::sub_chain_plugin::find_relevant_transactions

(

sysio::chain::controller &

curr_chain

)

Find transactions that are relevant for the S-Root calculation.

Parameters

chain

the active chain controller

Returns

a vector of transactions deemed relevant

Definition at line 156 of file sub_chain_plugin.cpp.

                                                                                                              {
    std::vector<sysio::chain::transaction> relevant_transactions;
    auto& pending_trx_receipts = curr_chain.get_pending_trx_receipts(); // Access pending transactions directly
    for (const auto& trx_receipt : pending_trx_receipts) {
        if (std::holds_alternative<sysio::chain::packed_transaction>(trx_receipt.trx)) {
            const auto& packed_trx = std::get<sysio::chain::packed_transaction>(trx_receipt.trx);
            const auto& trx = packed_trx.get_transaction();
            if (is_relevant_s_root_transaction(trx)) {
                relevant_transactions.push_back(trx);
            }
        }
    }
    return relevant_transactions;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_contract_name()

account_name & sysio::sub_chain_plugin::get_contract_name

(

)

const

Definition at line 62 of file sub_chain_plugin.cpp.

                                                        {
   return my->contract_name;
}

get_prev_s_id()

checksum256_type & sysio::sub_chain_plugin::get_prev_s_id

(

)

const

Definition at line 65 of file sub_chain_plugin.cpp.

                                                        {
   return my->prev_s_id;
}

Here is the caller graph for this function:

is_relevant_s_root_transaction()

bool sysio::sub_chain_plugin::is_relevant_s_root_transaction

(

const sysio::chain::transaction &

trx

)

Determine if a transaction is relevant to the S-Root process.

Parameters

trx	the transaction to check

Returns

true if relevant, false otherwise

Definition at line 176 of file sub_chain_plugin.cpp.

                                                                            {
   for (const auto& action : trx.actions) {
      if (action.account == my->contract_name && std::find(my->action_names.begin(), my->action_names.end(), action.name) != my->action_names.end()){
         return true;
      }
   }
   return false;
}

Here is the caller graph for this function:

plugin_initialize()

void sysio::sub_chain_plugin::plugin_initialize

(

const variables_map &

options

)

Definition at line 23 of file sub_chain_plugin.cpp.

                                                                     {
   try {
      if (!options.count("s-chain-contract") || !options.count("s-chain-actions")) {
         SYS_ASSERT(false, plugin_config_exception, "sub_chain_plugin requires both --s-chain-contract and --s-chain-actions to be set");
      }
      else {
         std::string contract_name_str = options.at("s-chain-contract").as<std::string>();
         my->contract_name = sysio::chain::name(contract_name_str);  // Convert std::string to sysio::chain::name
 
         std::vector<std::string> actions = options.at("s-chain-actions").as<std::vector<std::string>>();
         my->action_names.clear();
         for (const std::string& action_name : actions) {
            my->action_names.push_back(sysio::chain::name(action_name));  // Convert std::string to action_name
         }
      }
      // my->chain_plug = app().find_plugin<chain_plugin>();
      // SYS_ASSERT( my->chain_plug, chain::missing_chain_plugin_exception, ""  );
 
   } FC_LOG_AND_RETHROW()
}

plugin_shutdown()

void sysio::sub_chain_plugin::plugin_shutdown

(

)

Definition at line 57 of file sub_chain_plugin.cpp.

                                       {
    ilog("sub_chain_plugin shutting down");
    // Cleanup code
}

plugin_startup()

void sysio::sub_chain_plugin::plugin_startup

(

)

Definition at line 43 of file sub_chain_plugin.cpp.

                                      {
    ilog("sub_chain_plugin starting up, adding /v3/sub_chain/get_last_s_id");
 
    app().get_plugin<http_plugin>().add_api({
        {"/v3/sub_chain/get_last_s_id", [this](string, string body, auto cb) { // Ensure correct use of auto for callback type inference
            try {
                checksum256_type last_s_id = get_prev_s_id();
                cb(200, last_s_id.str()); 
            } catch (fc::exception& e) {
                cb(500, "{\"error\": \"internal_error\", \"details\": \"" + e.to_detail_string() + "\"}");
            }
        }}
    });
}

Here is the call graph for this function:

set_program_options()

void sysio::sub_chain_plugin::set_program_options ( options_description & , options_description & cfg )

overridevirtual

Implements appbase::abstract_plugin.

Definition at line 18 of file sub_chain_plugin.cpp.

                                                                                         {
    cfg.add_options()
        ("s-chain-contract", bpo::value<std::string>()->default_value("settle.wns"), "Contract name for identifying relevant S-transactions.")
        ("s-chain-actions", bpo::value<std::vector<std::string>>()->composing(), "List of action names for relevant S-transactions for a given s-chain-contract");
}

update_prev_s_id()

void sysio::sub_chain_plugin::update_prev_s_id

(

const sysio::chain::checksum256_type &

new_s_id

)

Definition at line 68 of file sub_chain_plugin.cpp.

                                                                        {
   ilog("Updating OLD prev_s_id: \t${prev_s_id}", ("prev_s_id", my->prev_s_id));
   my->prev_s_id = new_s_id;
   ilog("Updated  NEW prev_s_id: \t${prev_s_id}", ("prev_s_id", my->prev_s_id));
}

---

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

• plugins/sub_chain_plugin/include/sysio/sub_chain_plugin/sub_chain_plugin.hpp
• plugins/sub_chain_plugin/sub_chain_plugin.cpp