From 8a25c3ceb24f73cbe6808d155aff4838c0c7df75 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Tue, 11 Sep 2018 15:40:33 -0300 Subject: [PATCH 1/7] add readme to plugins --- libraries/plugins/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 libraries/plugins/README.md diff --git a/libraries/plugins/README.md b/libraries/plugins/README.md new file mode 100644 index 0000000000..8c767501f1 --- /dev/null +++ b/libraries/plugins/README.md @@ -0,0 +1,21 @@ +# BitShares Plugins + +The bitshares plugins are a collection of tools that brings new functionality without the need of modifications in the consensus and more sensitive areas of the bitshares-core. + +The main source of I/O of the bitshares blockchain is the API. Plugins are a more powerful alternative to build more complex developments for when the current API is not enough. + +Plugins are optional to run by node operator according to their needs however all plugins here will be compiled. There are plans for optional build of plugins at: #533 + +# Available Plugins + +Number | Name | Description | Category | Status +--------------------|--------------------------|-----------------------------------------------------------------------------|----------------|-------- +[1](witness) | Witness | Generate and sign blocks | Block producer | Stable +[2](account_history)| Account History | Save account history data | History | Stable +[3](delayed_node) | Delayed Node | Avoid forks by running a several times confirmed and delayed blockchain | Business | Stable +[4](debug_witness) | Debug Witness | Run "what-if" tests | Debug | Stable +[5](market_history) | Market History | Save market history data | Market data | Stable +[6](snapshot) | Snapshot | Get a json of all objects in blockchain at a specificed time or block | Debug | Stable +[7](elasticsearch) | ElasticSearch | Save account history data into elasticsearch database | History | Experimental +[8](es_objects) | ES Objects | Save selected objects into elasticsearch database | History | Experimental +[9](grouped_orders) | Grouped Orders | Expose api to create a grouped order book of bitshares markets | Market data | Experimental \ No newline at end of file From 52279ae0d0142273c525736f3649393240c185f2 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Fri, 14 Sep 2018 10:37:07 -0300 Subject: [PATCH 2/7] change hashtag to link --- libraries/plugins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/plugins/README.md b/libraries/plugins/README.md index 8c767501f1..c9359a84be 100644 --- a/libraries/plugins/README.md +++ b/libraries/plugins/README.md @@ -4,7 +4,7 @@ The bitshares plugins are a collection of tools that brings new functionality wi The main source of I/O of the bitshares blockchain is the API. Plugins are a more powerful alternative to build more complex developments for when the current API is not enough. -Plugins are optional to run by node operator according to their needs however all plugins here will be compiled. There are plans for optional build of plugins at: #533 +Plugins are optional to run by node operator according to their needs however all plugins here will be compiled. There are plans for optional build of plugins at: [Issue 533](https://github.com/bitshares/bitshares-core/issues/533) # Available Plugins From 0a3c1e254fcb21a67a187aa25441a91729a646cd Mon Sep 17 00:00:00 2001 From: Alfredo Date: Fri, 14 Sep 2018 10:50:44 -0300 Subject: [PATCH 3/7] add space id column --- libraries/plugins/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/libraries/plugins/README.md b/libraries/plugins/README.md index c9359a84be..e0a2eb31ad 100644 --- a/libraries/plugins/README.md +++ b/libraries/plugins/README.md @@ -8,14 +8,14 @@ Plugins are optional to run by node operator according to their needs however al # Available Plugins -Number | Name | Description | Category | Status ---------------------|--------------------------|-----------------------------------------------------------------------------|----------------|-------- -[1](witness) | Witness | Generate and sign blocks | Block producer | Stable -[2](account_history)| Account History | Save account history data | History | Stable -[3](delayed_node) | Delayed Node | Avoid forks by running a several times confirmed and delayed blockchain | Business | Stable -[4](debug_witness) | Debug Witness | Run "what-if" tests | Debug | Stable -[5](market_history) | Market History | Save market history data | Market data | Stable -[6](snapshot) | Snapshot | Get a json of all objects in blockchain at a specificed time or block | Debug | Stable -[7](elasticsearch) | ElasticSearch | Save account history data into elasticsearch database | History | Experimental -[8](es_objects) | ES Objects | Save selected objects into elasticsearch database | History | Experimental -[9](grouped_orders) | Grouped Orders | Expose api to create a grouped order book of bitshares markets | Market data | Experimental \ No newline at end of file +Number | Name | Description | Category | Status | Space ID +--------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------| +[1](witness) | Witness | Generate and sign blocks | Block producer | Stable | 4 +[2](account_history)| Account History | Save account history data | History | Stable | +[3](delayed_node) | Delayed Node | Avoid forks by running a several times confirmed and delayed blockchain | Business | Stable | +[4](debug_witness) | Debug Witness | Run "what-if" tests | Debug | Stable | +[5](market_history) | Market History | Save market history data | Market data | Stable | 5 +[6](snapshot) | Snapshot | Get a json of all objects in blockchain at a specificed time or block | Debug | Stable | +[7](elasticsearch) | ElasticSearch | Save account history data into elasticsearch database | History | Experimental | 6 +[8](es_objects) | ES Objects | Save selected objects into elasticsearch database | History | Experimental | +[9](grouped_orders) | Grouped Orders | Expose api to create a grouped order book of bitshares markets | Market data | Experimental | \ No newline at end of file From ea6d6cd1359f232757c963484003d7669d1c2903 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Fri, 14 Sep 2018 10:52:51 -0300 Subject: [PATCH 4/7] join space and id in 1 word to make the table look better --- libraries/plugins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/plugins/README.md b/libraries/plugins/README.md index e0a2eb31ad..b9a18e32dc 100644 --- a/libraries/plugins/README.md +++ b/libraries/plugins/README.md @@ -8,7 +8,7 @@ Plugins are optional to run by node operator according to their needs however al # Available Plugins -Number | Name | Description | Category | Status | Space ID +Number | Name | Description | Category | Status | SpaceID --------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------| [1](witness) | Witness | Generate and sign blocks | Block producer | Stable | 4 [2](account_history)| Account History | Save account history data | History | Stable | From a613e44aab79ac2b6e5851fbbd5b88823d2e2804 Mon Sep 17 00:00:00 2001 From: Alfredo Date: Fri, 14 Sep 2018 11:52:28 -0300 Subject: [PATCH 5/7] sort plugins alphabetically --- libraries/plugins/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/libraries/plugins/README.md b/libraries/plugins/README.md index b9a18e32dc..7e8bb68c16 100644 --- a/libraries/plugins/README.md +++ b/libraries/plugins/README.md @@ -8,14 +8,14 @@ Plugins are optional to run by node operator according to their needs however al # Available Plugins -Number | Name | Description | Category | Status | SpaceID ---------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------| -[1](witness) | Witness | Generate and sign blocks | Block producer | Stable | 4 -[2](account_history)| Account History | Save account history data | History | Stable | -[3](delayed_node) | Delayed Node | Avoid forks by running a several times confirmed and delayed blockchain | Business | Stable | -[4](debug_witness) | Debug Witness | Run "what-if" tests | Debug | Stable | -[5](market_history) | Market History | Save market history data | Market data | Stable | 5 -[6](snapshot) | Snapshot | Get a json of all objects in blockchain at a specificed time or block | Debug | Stable | -[7](elasticsearch) | ElasticSearch | Save account history data into elasticsearch database | History | Experimental | 6 -[8](es_objects) | ES Objects | Save selected objects into elasticsearch database | History | Experimental | -[9](grouped_orders) | Grouped Orders | Expose api to create a grouped order book of bitshares markets | Market data | Experimental | \ No newline at end of file +Folder | Name | Description | Category | Status | SpaceID +-----------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------| +[account_history](account_history) | Account History | Save account history data | History | Stable | +[debug_witness](debug_witness) | Debug Witness | Run "what-if" tests | Debug | Stable | +[delayed_node](delayed_node) | Delayed Node | Avoid forks by running a several times confirmed and delayed blockchain | Business | Stable | +[elasticsearch](elasticsearch) | ElasticSearch Operations | Save account history data into elasticsearch database | History | Experimental | 6 +[es_objects](es_objects) | ElasticSearch Objects | Save selected objects into elasticsearch database | History | Experimental | +[grouped_orders](grouped_orders) | Grouped Orders | Expose api to create a grouped order book of bitshares markets | Market data | Experimental | +[market_history](market_history) | Market History | Save market history data | Market data | Stable | 5 +[snapshot](snapshot) | Snapshot | Get a json of all objects in blockchain at a specificed time or block | Debug | Stable | +[witness](witness) | Witness | Generate and sign blocks | Block producer | Stable | 4 From a387f9b844a70868a58a065d9af0851f562d5b2b Mon Sep 17 00:00:00 2001 From: Alfredo Date: Fri, 14 Sep 2018 11:55:06 -0300 Subject: [PATCH 6/7] fix account history space id --- libraries/plugins/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libraries/plugins/README.md b/libraries/plugins/README.md index 7e8bb68c16..19aa82e2f4 100644 --- a/libraries/plugins/README.md +++ b/libraries/plugins/README.md @@ -10,7 +10,7 @@ Plugins are optional to run by node operator according to their needs however al Folder | Name | Description | Category | Status | SpaceID -----------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------| -[account_history](account_history) | Account History | Save account history data | History | Stable | +[account_history](account_history) | Account History | Save account history data | History | Stable | 4 [debug_witness](debug_witness) | Debug Witness | Run "what-if" tests | Debug | Stable | [delayed_node](delayed_node) | Delayed Node | Avoid forks by running a several times confirmed and delayed blockchain | Business | Stable | [elasticsearch](elasticsearch) | ElasticSearch Operations | Save account history data into elasticsearch database | History | Experimental | 6 @@ -18,4 +18,4 @@ Folder | Name | Description [grouped_orders](grouped_orders) | Grouped Orders | Expose api to create a grouped order book of bitshares markets | Market data | Experimental | [market_history](market_history) | Market History | Save market history data | Market data | Stable | 5 [snapshot](snapshot) | Snapshot | Get a json of all objects in blockchain at a specificed time or block | Debug | Stable | -[witness](witness) | Witness | Generate and sign blocks | Block producer | Stable | 4 +[witness](witness) | Witness | Generate and sign blocks | Block producer | Stable | From 8664e8796f161118ee9c989ae122a59146c6389b Mon Sep 17 00:00:00 2001 From: Alfredo Date: Mon, 17 Sep 2018 19:04:19 -0300 Subject: [PATCH 7/7] fix english syntax --- libraries/plugins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/plugins/README.md b/libraries/plugins/README.md index 19aa82e2f4..18037d6c6e 100644 --- a/libraries/plugins/README.md +++ b/libraries/plugins/README.md @@ -4,7 +4,7 @@ The bitshares plugins are a collection of tools that brings new functionality wi The main source of I/O of the bitshares blockchain is the API. Plugins are a more powerful alternative to build more complex developments for when the current API is not enough. -Plugins are optional to run by node operator according to their needs however all plugins here will be compiled. There are plans for optional build of plugins at: [Issue 533](https://github.com/bitshares/bitshares-core/issues/533) +Plugins are optional to run by node operator according to their needs. However, all plugins here will be compiled. There are plans for optional build of plugins at: [Issue 533](https://github.com/bitshares/bitshares-core/issues/533) # Available Plugins