class database_api { public: database_api(graphene::chain::database& db); ~database_api(); ///////////// // Objects // ///////////// /** * @brief Get the objects corresponding to the provided IDs * @param ids IDs of the objects to retrieve * @return The objects retrieved, in the order they are mentioned in ids * * If any of the provided IDs does not map to an object, a null variant is returned in its position. */ fc::variants get_objects(const vector& ids)const; /////////////////// // Subscriptions // /////////////////// void set_subscribe_callback( std::function cb, bool clear_filter ); void set_pending_transaction_callback( std::function cb ); void set_block_applied_callback( std::function cb ); /** * @brief Stop receiving any notifications * * This unsubscribes from all subscribed markets and objects. */ void cancel_all_subscriptions(); ///////////////////////////// // Blocks and transactions // ///////////////////////////// /** * @brief Retrieve a block header * @param block_num Height of the block whose header should be returned * @return header of the referenced block, or null if no matching block was found */ optional get_block_header(uint32_t block_num)const; /** * @brief Retrieve a full, signed block * @param block_num Height of the block to be returned * @return the referenced block, or null if no matching block was found */ optional get_block(uint32_t block_num)const; /** * @brief used to fetch an individual transaction. */ processed_transaction get_transaction( uint32_t block_num, uint32_t trx_in_block )const; ///////////// // Globals // ///////////// /** * @brief Retrieve the @ref chain_property_object associated with the chain */ chain_property_object get_chain_properties()const; /** * @brief Retrieve the current @ref global_property_object */ global_property_object get_global_properties()const; /** * @brief Retrieve compile-time constants */ fc::variant_object get_config()const; /** * @brief Get the chain ID */ chain_id_type get_chain_id()const; /** * @brief Retrieve the current @ref dynamic_global_property_object */ dynamic_global_property_object get_dynamic_global_properties()const; ////////// // Keys // ////////// vector> get_key_references( vector key )const; ////////////// // Accounts // ////////////// /** * @brief Get a list of accounts by ID * @param account_ids IDs of the accounts to retrieve * @return The accounts corresponding to the provided IDs * * This function has semantics identical to @ref get_objects */ vector> get_accounts(const vector& account_ids)const; /** * @brief Fetch all objects relevant to the specified accounts and subscribe to updates * @param callback Function to call with updates * @param names_or_ids Each item must be the name or ID of an account to retrieve * @return Map of string from @ref names_or_ids to the corresponding account * * This function fetches all relevant objects for the given accounts, and subscribes to updates to the given * accounts. If any of the strings in @ref names_or_ids cannot be tied to an account, that input will be * ignored. All other accounts will be retrieved and subscribed. * */ std::map get_full_accounts( const vector& names_or_ids, bool subscribe ); optional get_account_by_name( string name )const; /** * @return all accounts that referr to the key or account id in their owner or active authorities. */ vector get_account_references( account_id_type account_id )const; /** * @brief Get a list of accounts by name * @param account_names Names of the accounts to retrieve * @return The accounts holding the provided names * * This function has semantics identical to @ref get_objects */ vector> lookup_account_names(const vector& account_names)const; /** * @brief Get names and IDs for registered accounts * @param lower_bound_name Lower bound of the first name to return * @param limit Maximum number of results to return -- must not exceed 1000 * @return Map of account names to corresponding IDs */ map lookup_accounts(const string& lower_bound_name, uint32_t limit)const; ////////////// // Balances // ////////////// /** * @brief Get an account's balances in various assets * @param id ID of the account to get balances for * @param assets IDs of the assets to get balances of; if empty, get all assets account has a balance in * @return Balances of the account */ vector get_account_balances(account_id_type id, const flat_set& assets)const; /// Semantically equivalent to @ref get_account_balances, but takes a name instead of an ID. vector get_named_account_balances(const std::string& name, const flat_set& assets)const; /** @return all unclaimed balance objects for a set of addresses */ vector get_balance_objects( const vector
& addrs )const; vector get_vested_balances( const vector& objs )const; vector get_vesting_balances( account_id_type account_id )const; /** * @brief Get the total number of accounts registered with the blockchain */ uint64_t get_account_count()const; //////////// // Assets // //////////// /** * @brief Get a list of assets by ID * @param asset_ids IDs of the assets to retrieve * @return The assets corresponding to the provided IDs * * This function has semantics identical to @ref get_objects */ vector> get_assets(const vector& asset_ids)const; /** * @brief Get assets alphabetically by symbol name * @param lower_bound_symbol Lower bound of symbol names to retrieve * @param limit Maximum number of assets to fetch (must not exceed 100) * @return The assets found */ vector list_assets(const string& lower_bound_symbol, uint32_t limit)const; /** * @brief Get a list of assets by symbol * @param asset_symbols Symbols or stringified IDs of the assets to retrieve * @return The assets corresponding to the provided symbols or IDs * * This function has semantics identical to @ref get_objects */ vector> lookup_asset_symbols(const vector& symbols_or_ids)const; ///////////////////// // Markets / feeds // ///////////////////// /** * @brief Get limit orders in a given market * @param a ID of asset being sold * @param b ID of asset being purchased * @param limit Maximum number of orders to retrieve * @return The limit orders, ordered from least price to greatest */ vector get_limit_orders(asset_id_type a, asset_id_type b, uint32_t limit)const; /** * @brief Get call orders in a given asset * @param a ID of asset being called * @param limit Maximum number of orders to retrieve * @return The call orders, ordered from earliest to be called to latest */ vector get_call_orders(asset_id_type a, uint32_t limit)const; /** * @brief Get forced settlement orders in a given asset * @param a ID of asset being settled * @param limit Maximum number of orders to retrieve * @return The settle orders, ordered from earliest settlement date to latest */ vector get_settle_orders(asset_id_type a, uint32_t limit)const; /** * @return all open margin positions for a given account id. */ vector get_margin_positions( const account_id_type& id )const; /** * @brief Request notification when the active orders in the market between two assets changes * @param callback Callback method which is called when the market changes * @param a First asset ID * @param b Second asset ID * * Callback will be passed a variant containing a vector>. The vector will * contain, in order, the operations which changed the market, and their results. */ void subscribe_to_market(std::function callback, asset_id_type a, asset_id_type b); /** * @brief Unsubscribe from updates to a given market * @param a First asset ID * @param b Second asset ID */ void unsubscribe_from_market(asset_id_type a, asset_id_type b); /////////////// // Witnesses // /////////////// /** * @brief Get a list of witnesses by ID * @param witness_ids IDs of the witnesses to retrieve * @return The witnesses corresponding to the provided IDs * * This function has semantics identical to @ref get_objects */ vector> get_witnesses(const vector& witness_ids)const; /** * @brief Get the witness owned by a given account * @param account The ID of the account whose witness should be retrieved * @return The witness object, or null if the account does not have a witness */ fc::optional get_witness_by_account(account_id_type account)const; /** * @brief Get names and IDs for registered witnesses * @param lower_bound_name Lower bound of the first name to return * @param limit Maximum number of results to return -- must not exceed 1000 * @return Map of witness names to corresponding IDs */ map lookup_witness_accounts(const string& lower_bound_name, uint32_t limit)const; /** * @brief Get the total number of witnesses registered with the blockchain */ uint64_t get_witness_count()const; /////////////////////// // Committee members // /////////////////////// /** * @brief Get a list of committee_members by ID * @param committee_member_ids IDs of the committee_members to retrieve * @return The committee_members corresponding to the provided IDs * * This function has semantics identical to @ref get_objects */ vector> get_committee_members(const vector& committee_member_ids)const; /** * @brief Get the committee_member owned by a given account * @param account The ID of the account whose committee_member should be retrieved * @return The committee_member object, or null if the account does not have a committee_member */ fc::optional get_committee_member_by_account(account_id_type account)const; /** * @brief Get names and IDs for registered committee_members * @param lower_bound_name Lower bound of the first name to return * @param limit Maximum number of results to return -- must not exceed 1000 * @return Map of committee_member names to corresponding IDs */ map lookup_committee_member_accounts(const string& lower_bound_name, uint32_t limit)const; /// WORKERS /** * Return the worker objects associated with this account. */ vector get_workers_by_account(account_id_type account)const; /////////// // Votes // /////////// /** * @brief Given a set of votes, return the objects they are voting for. * * This will be a mixture of committee_member_object, witness_objects, and worker_objects * * The results will be in the same order as the votes. Null will be returned for * any vote ids that are not found. */ vector lookup_vote_ids( const vector& votes )const; //////////////////////////// // Authority / validation // //////////////////////////// /// @brief Get a hexdump of the serialized binary form of a transaction std::string get_transaction_hex(const signed_transaction& trx)const; /** * This API will take a partially signed transaction and a set of public keys that the owner has the ability to sign for * and return the minimal subset of public keys that should add signatures to the transaction. */ set get_required_signatures( const signed_transaction& trx, const flat_set& available_keys )const; /** * This method will return the set of all public keys that could possibly sign for a given transaction. This call can * be used by wallets to filter their set of public keys to just the relevant subset prior to calling @ref get_required_signatures * to get the minimum subset. */ set get_potential_signatures( const signed_transaction& trx )const; set
get_potential_address_signatures( const signed_transaction& trx )const; /** * @return true of the @ref trx has all of the required signatures, otherwise throws an exception */ bool verify_authority( const signed_transaction& trx )const; /** * @return true if the signers have enough authority to authorize an account */ bool verify_account_authority( const string& name_or_id, const flat_set& signers )const; /** * Validates a transaction against the current state without broadcasting it on the network. */ processed_transaction validate_transaction( const signed_transaction& trx )const; /** * For each operation calculate the required fee in the specified asset type. If the asset type does * not have a valid core_exchange_rate */ vector get_required_fees( const vector& ops, asset_id_type id )const; /////////////////////////// // Proposed transactions // /////////////////////////// /** * @return the set of proposed transactions relevant to the specified account id. */ vector get_proposed_transactions( account_id_type id )const; ////////////////////// // Blinded balances // ////////////////////// /** * @return the set of blinded balance objects by commitment ID */ vector get_blinded_balances( const flat_set& commitments )const; private: std::shared_ptr< database_api_impl > my; };