From 540a5362ab469cadd8b042b9d029195a8b794957 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Fri, 18 Jan 2019 12:02:47 -0300 Subject: [PATCH 1/8] add readme to libraries and programs --- libraries/README.md | 18 ++++++++++++++++++ programs/README.md | 20 ++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 libraries/README.md create mode 100644 programs/README.md diff --git a/libraries/README.md b/libraries/README.md new file mode 100644 index 0000000000..fa7e4d5ce4 --- /dev/null +++ b/libraries/README.md @@ -0,0 +1,18 @@ +# BitShares Libraries + +The libraries are the core of the project and defines everything where applications can build on top. + +A **graphene** blockchain software will use the `app` library to define what the application will do, what services it will offer. The blockchain is defined by the `chain` library and include all the objects, types, operations, protocols that builds current consensus blockchain. The lowest level in memory database of Bitshares is developed at the `db` library. The `fc` is a helper module broadly used in the libraries code, `egenesis` will help with the genesis file, `plugins` will be loaded optionally to the application. Wallet software like the cli_wallet will benefit from the `wallet` library. + +Code in libraries is the most important part of **bitshares-core** project and it is maintained by the Bitshares Core Team and contributors. +# Available Libraries + +Folder | Name | Description | Category | Status +-----------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|--------------- +[app](app) | Application | Control the behaviour of the `witness_node` application, connect to the seeds, open he API, load plugins, etc. | Library | Active +[chain](chain) | Blockchain | Define all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Library | Active +[db](db) | Database | Define the internal database graphene uses. | Library | Active +[egenesis](egenesis) | Genesis | | Library | Active +[fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Library | Active +[plugins](plugins) | Plugins | All plugin modules are stored here. | Library | Active +[wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Library | Active | \ No newline at end of file diff --git a/programs/README.md b/programs/README.md new file mode 100644 index 0000000000..2fb1def850 --- /dev/null +++ b/programs/README.md @@ -0,0 +1,20 @@ +# BitShares Programs + +The bitshares programs are a collection of binaries to run the blockchain, interact with it or utilities. + +The main program is the `witness_node`, used to run a bitshares block producer, API or plugin node. The second in importance is the `cli_wallet`, used to interact with the blockchain. This 2 programs are the most used by the community and updated by the developers, rest of the programs are utilities. + +Programs in here are part of the **bitshares-core** project and are maintained by the bitshares core team and contributors. + + +# Available Programs + +Folder | Name | Description | Category | Status | Help +-----------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------| +[witness_node](witness_node) | Witness Node | Main blockchain software | Node | Active | `./witness_node --help` +[cli_wallet](cli_wallet) | CLI Wallet | Command line wallet | Wallet | Active | `./cli_wallet --help` +[delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecatd in favour of `./witness_node --plugins "delayed_node"` | Node | Deprecated | `./delayed_node --help` +[js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` +[size_checker](size_checker) | Size Checker | Provides wire size average in bytes of all the operations | Tool | Old | `./size_checker` +[build_helpers](build_helpers) | Build Helpers | | Tool | Old | `./member_enumerator` and `./cat-parts` +[genesis_util](genesis_util) | Gensis Utils | | Tool | Old | \ No newline at end of file From f2acea8e1f25dc94177545bb94a21000c9c7999f Mon Sep 17 00:00:00 2001 From: Alfredo Date: Mon, 21 Jan 2019 11:01:57 -0300 Subject: [PATCH 2/8] add utilities, net libraries, change app description --- libraries/README.md | 20 +++++++++++--------- programs/README.md | 18 +++++++++--------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/libraries/README.md b/libraries/README.md index fa7e4d5ce4..c59fbf7135 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -7,12 +7,14 @@ A **graphene** blockchain software will use the `app` library to define what the Code in libraries is the most important part of **bitshares-core** project and it is maintained by the Bitshares Core Team and contributors. # Available Libraries -Folder | Name | Description | Category | Status ------------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|--------------- -[app](app) | Application | Control the behaviour of the `witness_node` application, connect to the seeds, open he API, load plugins, etc. | Library | Active -[chain](chain) | Blockchain | Define all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Library | Active -[db](db) | Database | Define the internal database graphene uses. | Library | Active -[egenesis](egenesis) | Genesis | | Library | Active -[fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Library | Active -[plugins](plugins) | Plugins | All plugin modules are stored here. | Library | Active -[wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Library | Active | \ No newline at end of file +Folder | Name | Description | Category | Status +---|---|---|---|--- +[app](app) | Application | Bundles component libraries (chain, network, plugins) into a useful application. Also provides API access. | Library | Active +[chain](chain) | Blockchain | Define all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Library | Active +[db](db) | Database | Define the internal database graphene uses. | Library | Active +[egenesis](egenesis) | Genesis | | Library | Active +[fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Library | Active +[net](net) | Network | The graphene p2p layer. | Library | Active +[plugins](plugins) | Plugins | All plugin modules are stored here. | Library | Active +[utilities](utilities) | Network | Provide common utility calls used in applications or other libraries. | Library | Active +[wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Library | Active diff --git a/programs/README.md b/programs/README.md index 2fb1def850..5f126447f1 100644 --- a/programs/README.md +++ b/programs/README.md @@ -9,12 +9,12 @@ Programs in here are part of the **bitshares-core** project and are maintained b # Available Programs -Folder | Name | Description | Category | Status | Help ------------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------| -[witness_node](witness_node) | Witness Node | Main blockchain software | Node | Active | `./witness_node --help` -[cli_wallet](cli_wallet) | CLI Wallet | Command line wallet | Wallet | Active | `./cli_wallet --help` -[delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecatd in favour of `./witness_node --plugins "delayed_node"` | Node | Deprecated | `./delayed_node --help` -[js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` -[size_checker](size_checker) | Size Checker | Provides wire size average in bytes of all the operations | Tool | Old | `./size_checker` -[build_helpers](build_helpers) | Build Helpers | | Tool | Old | `./member_enumerator` and `./cat-parts` -[genesis_util](genesis_util) | Gensis Utils | | Tool | Old | \ No newline at end of file +Folder | Name | Description | Category | Status | Help +---|---|---|---|---|--- +[witness_node](witness_node) | Witness Node | Main blockchain software | Node | Active | `./witness_node --help` +[cli_wallet](cli_wallet) | CLI Wallet | Command line wallet | Wallet | Active | `./cli_wallet --help` +[delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecatd in favour of `./witness_node --plugins "delayed_node"` | Node | Deprecated | `./delayed_node --help` +[js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` +[size_checker](size_checker) | Size Checker | Provides wire size average in bytes of all the operations | Tool | Old | `./size_checker` +[build_helpers](build_helpers) | Build Helpers | | Tool | Old | `./member_enumerator` and `./cat-parts` +[genesis_util](genesis_util) | Genesis Utils | | Tool | Old | \ No newline at end of file From 4f079fa86b69cd1eb5eae91b70ac49152c2909a9 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Tue, 22 Jan 2019 11:38:14 -0300 Subject: [PATCH 3/8] remove category column --- libraries/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/libraries/README.md b/libraries/README.md index c59fbf7135..36ded3611a 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -7,14 +7,14 @@ A **graphene** blockchain software will use the `app` library to define what the Code in libraries is the most important part of **bitshares-core** project and it is maintained by the Bitshares Core Team and contributors. # Available Libraries -Folder | Name | Description | Category | Status ----|---|---|---|--- -[app](app) | Application | Bundles component libraries (chain, network, plugins) into a useful application. Also provides API access. | Library | Active -[chain](chain) | Blockchain | Define all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Library | Active -[db](db) | Database | Define the internal database graphene uses. | Library | Active +Folder | Name | Description | Status +---|---|---|--- +[app](app) | Application | Bundles component libraries (chain, network, plugins) into a useful application. Also provides API access. | Active +[chain](chain) | Blockchain | Define all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Active +[db](db) | Database | Define the internal database graphene uses. | Active [egenesis](egenesis) | Genesis | | Library | Active -[fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Library | Active +[fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Active [net](net) | Network | The graphene p2p layer. | Library | Active -[plugins](plugins) | Plugins | All plugin modules are stored here. | Library | Active -[utilities](utilities) | Network | Provide common utility calls used in applications or other libraries. | Library | Active -[wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Library | Active +[plugins](plugins) | Plugins | All plugin modules are stored here. | Active +[utilities](utilities) | Network | Provide common utility calls used in applications or other libraries. | Active +[wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Active From f3da5289677fc2639542030c416cbc2e4247c0d6 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Tue, 22 Jan 2019 11:52:30 -0300 Subject: [PATCH 4/8] change some descriptions in libraries --- libraries/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/libraries/README.md b/libraries/README.md index 36ded3611a..39909d4c24 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -10,11 +10,11 @@ Code in libraries is the most important part of **bitshares-core** project and i Folder | Name | Description | Status ---|---|---|--- [app](app) | Application | Bundles component libraries (chain, network, plugins) into a useful application. Also provides API access. | Active -[chain](chain) | Blockchain | Define all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Active -[db](db) | Database | Define the internal database graphene uses. | Active -[egenesis](egenesis) | Genesis | | Library | Active +[chain](chain) | Blockchain | Defines all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Active +[db](db) | Database | Defines the internal database graphene uses. | Active +[egenesis](egenesis) | Genesis | | Active [fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Active -[net](net) | Network | The graphene p2p layer. | Library | Active -[plugins](plugins) | Plugins | All plugin modules are stored here. | Active -[utilities](utilities) | Network | Provide common utility calls used in applications or other libraries. | Active +[net](net) | Network | The graphene p2p layer. | Active +[plugins](plugins) | Plugins | Collection of singleton designed modules used for extending the bitshares-core. | Active +[utilities](utilities) | Network | Common utility calls used in applications or other libraries. | Active [wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Active From 8624fad31375dedaef86a0b1bb31c13223d24c53 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Tue, 22 Jan 2019 12:21:22 -0300 Subject: [PATCH 5/8] change some descriptions in programs --- programs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/programs/README.md b/programs/README.md index 5f126447f1..2726bcdf37 100644 --- a/programs/README.md +++ b/programs/README.md @@ -11,10 +11,10 @@ Programs in here are part of the **bitshares-core** project and are maintained b Folder | Name | Description | Category | Status | Help ---|---|---|---|---|--- -[witness_node](witness_node) | Witness Node | Main blockchain software | Node | Active | `./witness_node --help` -[cli_wallet](cli_wallet) | CLI Wallet | Command line wallet | Wallet | Active | `./cli_wallet --help` -[delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecatd in favour of `./witness_node --plugins "delayed_node"` | Node | Deprecated | `./delayed_node --help` +[witness_node](witness_node) | Witness Node | Main software used to sign blocks or provide services. | Node | Active | `./witness_node --help` +[cli_wallet](cli_wallet) | CLI Wallet | Software to interact with the blockchain by command line. | Wallet | Active | `./cli_wallet --help` +[delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecated in favour of `./witness_node --plugins "delayed_node"`. | Node | Deprecated | `./delayed_node --help` [js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` -[size_checker](size_checker) | Size Checker | Provides wire size average in bytes of all the operations | Tool | Old | `./size_checker` +[size_checker](size_checker) | Size Checker | Return wire size average in bytes of all the operations. | Tool | Old | `./size_checker` [build_helpers](build_helpers) | Build Helpers | | Tool | Old | `./member_enumerator` and `./cat-parts` [genesis_util](genesis_util) | Genesis Utils | | Tool | Old | \ No newline at end of file From a4588a620507b44c6ea67fd8096849de8b034485 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Tue, 22 Jan 2019 18:41:38 -0300 Subject: [PATCH 6/8] add subprograms --- programs/README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/programs/README.md b/programs/README.md index 2726bcdf37..794645c439 100644 --- a/programs/README.md +++ b/programs/README.md @@ -16,5 +16,8 @@ Folder | Name | Description | Category | Status | Help [delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecated in favour of `./witness_node --plugins "delayed_node"`. | Node | Deprecated | `./delayed_node --help` [js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` [size_checker](size_checker) | Size Checker | Return wire size average in bytes of all the operations. | Tool | Old | `./size_checker` -[build_helpers](build_helpers) | Build Helpers | | Tool | Old | `./member_enumerator` and `./cat-parts` -[genesis_util](genesis_util) | Genesis Utils | | Tool | Old | \ No newline at end of file +[cat-parts](build_helpers/cat-parts.cpp) | Cat parts | Used to create `hardfork.hpp` from individual files. | Tool | Old | `./cat-parts` +[check_reflect](build_helpers/check_reflect.py) | Check reflect | Check reflected fields automatically(https://github.com/cryptonomex/graphene/issues/562) | Tool | Old | `doxygen;cp -rf doxygen programs/build_helpers; ./check_reflect.py` +[member_enumerator](build_helpers/member_enumerator.cpp) | Member enumerator | | Tool | Deprecated | `./member_enumerator` +[get_dev_key](genesis_util/get_dev_key.cpp) | Get Dev Key | Create public, private and address keys. Useful in private testnets, `genesis.json` files, new blockchain creation and others. | Tool | Active | `/programs/genesis_util/get_dev_key -h` +[genesis_util](genesis_util) | Genesis Utils | Other utilities for genesis creation. | Tool | Old | From 41bff6ead331c4f340e874c5c9102d23deb487be Mon Sep 17 00:00:00 2001 From: Alfredo Date: Thu, 24 Jan 2019 16:08:23 -0300 Subject: [PATCH 7/8] add egenesis library description --- libraries/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libraries/README.md b/libraries/README.md index 39909d4c24..256d15029b 100644 --- a/libraries/README.md +++ b/libraries/README.md @@ -12,9 +12,9 @@ Folder | Name | Description | Status [app](app) | Application | Bundles component libraries (chain, network, plugins) into a useful application. Also provides API access. | Active [chain](chain) | Blockchain | Defines all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Active [db](db) | Database | Defines the internal database graphene uses. | Active -[egenesis](egenesis) | Genesis | | Active +[egenesis](egenesis) | Genesis | Hardcodes the `genesis.json` file into the `witness_node` executable.| Active [fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Active [net](net) | Network | The graphene p2p layer. | Active [plugins](plugins) | Plugins | Collection of singleton designed modules used for extending the bitshares-core. | Active -[utilities](utilities) | Network | Common utility calls used in applications or other libraries. | Active +[utilities](utilities) | Utilities | Common utility calls used in applications or other libraries. | Active [wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Active From bc48dae42c22a038754dd183012f6f06fb147cef Mon Sep 17 00:00:00 2001 From: Alfredo Date: Fri, 25 Jan 2019 18:45:49 -0300 Subject: [PATCH 8/8] change cat-parts from old to active --- programs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/programs/README.md b/programs/README.md index 794645c439..26b2b36886 100644 --- a/programs/README.md +++ b/programs/README.md @@ -16,7 +16,7 @@ Folder | Name | Description | Category | Status | Help [delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecated in favour of `./witness_node --plugins "delayed_node"`. | Node | Deprecated | `./delayed_node --help` [js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` [size_checker](size_checker) | Size Checker | Return wire size average in bytes of all the operations. | Tool | Old | `./size_checker` -[cat-parts](build_helpers/cat-parts.cpp) | Cat parts | Used to create `hardfork.hpp` from individual files. | Tool | Old | `./cat-parts` +[cat-parts](build_helpers/cat-parts.cpp) | Cat parts | Used to create `hardfork.hpp` from individual files. | Tool | Active | `./cat-parts` [check_reflect](build_helpers/check_reflect.py) | Check reflect | Check reflected fields automatically(https://github.com/cryptonomex/graphene/issues/562) | Tool | Old | `doxygen;cp -rf doxygen programs/build_helpers; ./check_reflect.py` [member_enumerator](build_helpers/member_enumerator.cpp) | Member enumerator | | Tool | Deprecated | `./member_enumerator` [get_dev_key](genesis_util/get_dev_key.cpp) | Get Dev Key | Create public, private and address keys. Useful in private testnets, `genesis.json` files, new blockchain creation and others. | Tool | Active | `/programs/genesis_util/get_dev_key -h`