Browse Source

brief docs for libtestutils classes

cl-refactor
Marek Kotewicz 10 years ago
parent
commit
14115d96d5
  1. 3
      libtestutils/BlockChainLoader.h
  2. 4
      libtestutils/FixedClient.h
  3. 6
      libtestutils/FixedWebThreeServer.h
  4. 5
      libtestutils/ShortLivingDirectory.h
  5. 3
      libtestutils/StateLoader.h

3
libtestutils/BlockChainLoader.h

@ -32,7 +32,8 @@ namespace test
{
/**
* @brief - loads the blockchain from json, creates temporary directory to store it, removes this temporary directory on dealloc
* @brief Should be used to load test blockchain from json file
* Loads the blockchain from json, creates temporary directory to store it, removes the directory on dealloc
*/
class BlockChainLoader
{

4
libtestutils/FixedClient.h

@ -30,6 +30,10 @@ namespace dev
namespace test
{
/**
* @brief mvp implementation of ClientBase
* Doesn't support mining interface
*/
class FixedClient: public dev::eth::ClientBase
{
public:

6
libtestutils/FixedWebThreeServer.h

@ -24,6 +24,12 @@
#include <libdevcore/Exceptions.h>
#include <libweb3jsonrpc/WebThreeStubServerBase.h>
/**
* @brief dummy JSON-RPC api implementation
* Should be used for test purposes only
* Supports eth && db interfaces
* Doesn't support shh && net interfaces
*/
class FixedWebThreeServer: public dev::WebThreeStubServerBase, public dev::WebThreeStubDatabaseFace
{
public:

5
libtestutils/ShortLivingDirectory.h

@ -29,6 +29,11 @@ namespace dev
namespace test
{
/**
* @brief temporary directory implementation
* It creates temporary directory in the given path. On dealloc it removes the directory
* @throws if the given path already exists, throws an exception
*/
class ShortLivingDirectory
{
public:

3
libtestutils/StateLoader.h

@ -29,6 +29,9 @@ namespace dev
namespace test
{
/**
* @brief Friend of State, loads State from given JSON object
*/
class StateLoader
{
public:

Loading…
Cancel
Save