From 1e73aa8e0d4af4191719c2fbfccf46195c74c296 Mon Sep 17 00:00:00 2001 From: oxarbitrage Date: Tue, 7 Nov 2017 16:51:13 -0300 Subject: [PATCH 01/17] market_history default buckets https://github.com/bitshares/bitshares-core/issues/465 --- libraries/plugins/market_history/market_history_plugin.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/plugins/market_history/market_history_plugin.cpp b/libraries/plugins/market_history/market_history_plugin.cpp index 6ec38968bc..94633caf89 100644 --- a/libraries/plugins/market_history/market_history_plugin.cpp +++ b/libraries/plugins/market_history/market_history_plugin.cpp @@ -255,7 +255,7 @@ void market_history_plugin::plugin_set_program_options( ) { cli.add_options() - ("bucket-size", boost::program_options::value()->default_value("[15,60,300,3600,86400]"), + ("bucket-size", boost::program_options::value()->default_value("[60,300,900,1800,3600,14400,86400]"), "Track market history by grouping orders into buckets of equal size measured in seconds specified as a JSON array of numbers") ("history-per-size", boost::program_options::value()->default_value(1000), "How far back in time to track history for each bucket size, measured in the number of buckets (default: 1000)") From af2bce6a3b93f0f213d402466719a5fafc8c1b9d Mon Sep 17 00:00:00 2001 From: oxarbitrage Date: Tue, 7 Nov 2017 16:55:27 -0300 Subject: [PATCH 02/17] mistake sorry, i made a commit directly to master instead of sending as pull request to develop. this commit reverts back. --- libraries/plugins/market_history/market_history_plugin.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/plugins/market_history/market_history_plugin.cpp b/libraries/plugins/market_history/market_history_plugin.cpp index 94633caf89..6ec38968bc 100644 --- a/libraries/plugins/market_history/market_history_plugin.cpp +++ b/libraries/plugins/market_history/market_history_plugin.cpp @@ -255,7 +255,7 @@ void market_history_plugin::plugin_set_program_options( ) { cli.add_options() - ("bucket-size", boost::program_options::value()->default_value("[60,300,900,1800,3600,14400,86400]"), + ("bucket-size", boost::program_options::value()->default_value("[15,60,300,3600,86400]"), "Track market history by grouping orders into buckets of equal size measured in seconds specified as a JSON array of numbers") ("history-per-size", boost::program_options::value()->default_value(1000), "How far back in time to track history for each bucket size, measured in the number of buckets (default: 1000)") From d6fda25b25e8838d075e5992368e010b79742232 Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 9 May 2018 08:47:37 -0400 Subject: [PATCH 03/17] Add: Bug Report & Feature Request --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 34 +++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..46f4671897 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug Report +about: Create a detailed report about a deficiency in the BitShares Core implementation. + +--- + +**Bug Description** +A clear and concise description of what the bug is. + +**Steps To Reproduce** +Steps to reproduce the behavior: +1. Execute API call '...' +2. Using JSON payload '...' +3. Received response '...' +4. See error + +**Expected Behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain process flow and behavior. + +**witness_node --version (please complete the following information):** + - Version: [e.g. 2.0.180425] + - SHA: [e.g. bf263b1db47a91ea9748118df1abb5a22cafc40b] + - SSL: [e.g. OpenSSL 1.0.2g 1 Mar 2016] + - Boost: [e.g. 1.62] + - Websocket++: [e.g. 0.7.0] + - Host OS: [e.g. Ubuntu 17.10] + +**Additional Context** +Add any other context about the problem here. + +## CORE TEAM TASK LIST +- [ ] Evaluate / Prioritize Bug Request +- [ ] Refine User Stories / Requirements +- [ ] Define Test Cases +- [ ] Design / Develop Solution +- [ ] Perform QA/Testing +- [ ] Update Documentation diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..df5d009fb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,34 @@ +--- +name: Feature Request +about: Suggest an idea for the BitShares Core Team to evaluate and prioritize for development. + +--- + +**User Story** +Please tell us about your feature request using the User Story format: +As a `` I want `` so that ``. + +At minimum, please define the ``, `` and `` for your feature request. The `` may be the system software, a component thereof, the end user, etc.; please be specific describing the context. The `` details the solution your feature will provide; please describe the process flow for the functionality. The `` details the benefits the feature will deliver; consider referencing alternative implementations for context. + +**Impacts** +Describe which portion(s) of BitShares Core may be impacted by your request. Please tick at least one box. +- [ ] API (the application programming interface) +- [ ] Build (the build process or something prior to compiled code) +- [ ] CLI (the command line wallet) +- [ ] Consensus (the validation or commitment of data) +- [ ] Deployment (the deployment process after building such as Docker, Travis, etc.) +- [ ] P2P (the peer-to-peer network for transaction/block propagation) +- [ ] Performance (system or user efficiency, performance, etc.) +- [ ] Security (system or user security) +- [ ] Other (please add below) + +**Additional Context** +Add any other context about your request here. + +## CORE TEAM TASK LIST +- [ ] Evaluate / Prioritize Feature Request +- [ ] Refine User Stories / Requirements +- [ ] Define Test Cases +- [ ] Design / Develop Solution +- [ ] Perform QA/Testing +- [ ] Update Documentation From 16de19c9ee8d5b445b954ef83c6f68c60f04c16f Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 9 May 2018 09:54:47 -0400 Subject: [PATCH 04/17] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 46f4671897..25e2c59024 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,6 +4,17 @@ about: Create a detailed report about a deficiency in the BitShares Core impleme --- +**Instructions** +Pleaae include a detailed Title above. Next, please complete the following sections below: +* Bug Description +* Steps To Reproduce +* Expected Behavior +* Screenshots (optional) +* witness_node --version (optional) +* Aditional Context (optional) + +Finally, press the 'submit issue' button. The Core Team will evaluate and prioritize your Bug Report for future development. + **Bug Description** A clear and concise description of what the bug is. @@ -17,10 +28,10 @@ Steps to reproduce the behavior: **Expected Behavior** A clear and concise description of what you expected to happen. -**Screenshots** +**Screenshots (optional)** If applicable, add screenshots to help explain process flow and behavior. -**witness_node --version (please complete the following information):** +**witness_node --version (optional):** - Version: [e.g. 2.0.180425] - SHA: [e.g. bf263b1db47a91ea9748118df1abb5a22cafc40b] - SSL: [e.g. OpenSSL 1.0.2g 1 Mar 2016] @@ -28,7 +39,7 @@ If applicable, add screenshots to help explain process flow and behavior. - Websocket++: [e.g. 0.7.0] - Host OS: [e.g. Ubuntu 17.10] -**Additional Context** +**Additional Context (optional)** Add any other context about the problem here. ## CORE TEAM TASK LIST From 5f1f6d984c458267bb2f973646e623d26e281462 Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 9 May 2018 09:58:09 -0400 Subject: [PATCH 05/17] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index df5d009fb1..962fcffb23 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,6 +4,14 @@ about: Suggest an idea for the BitShares Core Team to evaluate and prioritize fo --- +**Instructions** +Pleaae include a detailed Title above. Next, please complete the following sections below: +* User Story +* Impacts +* Aditional Context (optional) + +Finally, press the 'submit issue' button. The Core Team will evaluate and prioritize your Feature Request for future development. + **User Story** Please tell us about your feature request using the User Story format: As a `` I want `` so that ``. @@ -22,7 +30,7 @@ Describe which portion(s) of BitShares Core may be impacted by your request. Ple - [ ] Security (system or user security) - [ ] Other (please add below) -**Additional Context** +**Additional Context (optional)** Add any other context about your request here. ## CORE TEAM TASK LIST From 54f72685ad6a6c3fd7ea7878de359bf4e65d2b2a Mon Sep 17 00:00:00 2001 From: Alfredo Date: Mon, 14 May 2018 10:08:17 -0300 Subject: [PATCH 06/17] update project number --- Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index fad32a549a..c0af095a2e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = "Bitshares-Core" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "2.0.180202" +PROJECT_NUMBER = "2.0.180425" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a From d23896db3b101196fb072b126d64871c1ad5c964 Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 23 May 2018 16:51:28 -0400 Subject: [PATCH 07/17] Fixup: ISSUE_TEMPLATE --- .github/ISSUE_TEMPLATE/bug_report.md | 16 +++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++++------ 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 25e2c59024..040adcb44b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -5,25 +5,25 @@ about: Create a detailed report about a deficiency in the BitShares Core impleme --- **Instructions** -Pleaae include a detailed Title above. Next, please complete the following sections below: +Please include a detailed Title above. Next, please complete the following sections below: * Bug Description * Steps To Reproduce * Expected Behavior * Screenshots (optional) * witness_node --version (optional) -* Aditional Context (optional) +* Additional Context (optional) -Finally, press the 'submit issue' button. The Core Team will evaluate and prioritize your Bug Report for future development. +Finally, press the 'Submit new issue' button. The Core Team will evaluate and prioritize your Bug Report for future development. **Bug Description** A clear and concise description of what the bug is. **Steps To Reproduce** -Steps to reproduce the behavior: +Steps to reproduce the behavior (example outlined below): 1. Execute API call '...' 2. Using JSON payload '...' 3. Received response '...' -4. See error +4. See error in screenshot **Expected Behavior** A clear and concise description of what you expected to happen. @@ -31,19 +31,17 @@ A clear and concise description of what you expected to happen. **Screenshots (optional)** If applicable, add screenshots to help explain process flow and behavior. -**witness_node --version (optional):** +**CLI output for `witness_node --version` (optional):** - Version: [e.g. 2.0.180425] - - SHA: [e.g. bf263b1db47a91ea9748118df1abb5a22cafc40b] - SSL: [e.g. OpenSSL 1.0.2g 1 Mar 2016] - Boost: [e.g. 1.62] - - Websocket++: [e.g. 0.7.0] - Host OS: [e.g. Ubuntu 17.10] **Additional Context (optional)** Add any other context about the problem here. ## CORE TEAM TASK LIST -- [ ] Evaluate / Prioritize Bug Request +- [ ] Evaluate / Prioritize Bug Report - [ ] Refine User Stories / Requirements - [ ] Define Test Cases - [ ] Design / Develop Solution diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 962fcffb23..de6e5b661c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -5,12 +5,12 @@ about: Suggest an idea for the BitShares Core Team to evaluate and prioritize fo --- **Instructions** -Pleaae include a detailed Title above. Next, please complete the following sections below: +Please include a detailed Title above. Next, please complete the following sections below: * User Story * Impacts -* Aditional Context (optional) +* Additional Context (optional) -Finally, press the 'submit issue' button. The Core Team will evaluate and prioritize your Feature Request for future development. +Finally, press the 'Submit new issue' button. The Core Team will evaluate and prioritize your Feature Request for future development. **User Story** Please tell us about your feature request using the User Story format: @@ -23,11 +23,13 @@ Describe which portion(s) of BitShares Core may be impacted by your request. Ple - [ ] API (the application programming interface) - [ ] Build (the build process or something prior to compiled code) - [ ] CLI (the command line wallet) -- [ ] Consensus (the validation or commitment of data) - [ ] Deployment (the deployment process after building such as Docker, Travis, etc.) +- [ ] DEX (the Decentralized EXchange, market engine, etc.) - [ ] P2P (the peer-to-peer network for transaction/block propagation) -- [ ] Performance (system or user efficiency, performance, etc.) -- [ ] Security (system or user security) +- [ ] Performance (system or user efficiency, etc.) +- [ ] Protocol (the blockchain logic, consensus, validation, etc.) +- [ ] Security (the security of system or user data, etc.) +- [ ] UX (the User Experience) - [ ] Other (please add below) **Additional Context (optional)** From 0ac87af0dd9152fa990fa6b3041c37d49a262075 Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 6 Jun 2018 10:48:58 -0400 Subject: [PATCH 08/17] Add: Build Error --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++----- .github/ISSUE_TEMPLATE/build_error.md | 42 +++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 7 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/build_error.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 040adcb44b..3b76358a4e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,10 +7,11 @@ about: Create a detailed report about a deficiency in the BitShares Core impleme **Instructions** Please include a detailed Title above. Next, please complete the following sections below: * Bug Description +* Impacts * Steps To Reproduce * Expected Behavior * Screenshots (optional) -* witness_node --version (optional) +* Host Environment (optional) * Additional Context (optional) Finally, press the 'Submit new issue' button. The Core Team will evaluate and prioritize your Bug Report for future development. @@ -18,6 +19,20 @@ Finally, press the 'Submit new issue' button. The Core Team will evaluate and pr **Bug Description** A clear and concise description of what the bug is. +**Impacts** +Describe which portion(s) of BitShares Core may be impacted by this bug. Please tick at least one box. +- [ ] API (the application programming interface) +- [ ] Build (the build process or something prior to compiled code) +- [ ] CLI (the command line wallet) +- [ ] Deployment (the deployment process after building such as Docker, Travis, etc.) +- [ ] DEX (the Decentralized EXchange, market engine, etc.) +- [ ] P2P (the peer-to-peer network for transaction/block propagation) +- [ ] Performance (system or user efficiency, etc.) +- [ ] Protocol (the blockchain logic, consensus, validation, etc.) +- [ ] Security (the security of system or user data, etc.) +- [ ] UX (the User Experience) +- [ ] Other (please add below) + **Steps To Reproduce** Steps to reproduce the behavior (example outlined below): 1. Execute API call '...' @@ -31,12 +46,14 @@ A clear and concise description of what you expected to happen. **Screenshots (optional)** If applicable, add screenshots to help explain process flow and behavior. -**CLI output for `witness_node --version` (optional):** - - Version: [e.g. 2.0.180425] - - SSL: [e.g. OpenSSL 1.0.2g 1 Mar 2016] - - Boost: [e.g. 1.62] - - Host OS: [e.g. Ubuntu 17.10] - +**Host Environment** +Please provide details about the host environment. Much of this information can be found running: `witness_node --version`. + - Host OS: [e.g. Ubuntu 18.04 LTS] + - Host Physical RAM [e.g. 4GB] + - BitShares Version: [e.g. 2.0.180425] + - OpenSSL Version: [e.g. 1.1.0g] + - Boost Version: [e.g. 1.65.1] + **Additional Context (optional)** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/build_error.md b/.github/ISSUE_TEMPLATE/build_error.md new file mode 100644 index 0000000000..2769078685 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/build_error.md @@ -0,0 +1,42 @@ +--- +name: Build Error +about: Create a detailed report about an error during in the BitShares Core build process. + +--- + +**Instructions** +Please include a detailed Title above. Next, please complete the following sections below: +* Build Error +* Build Environment +* Steps To Reproduce +* Screenshots (optional) + +Finally, press the 'Submit new issue' button. The Core Team will evaluate and prioritize your Bug Report for future development. + +**Build Error Description** +A clear and concise description of what the build error is. + +**Build Environment** +Please provide details about the build environment, including the relevant required libraries. Much of this information can be found in the `CMakeFiles/CMakeOutput.log`. + - Host OS: [e.g. Ubuntu 18.04 LTS] + - Host Physical RAM [e.g. 4GB] + - Source Branch/Tag: [e.g. master or 2.0.180425] + - OpenSSL Version: [e.g. 1.1.0g] + - Boost Version: [e.g. 1.65.1] + - C++ Compiler: [e.g. gcc version 4.8.5] + +**Steps To Reproduce** +Steps to reproduce the behavior (example outlined below): +1. Using installation guide from this URL... +2. This is my complete build script... +3. It fails at this step... +4. Here is the error output... +5. See the error in the screenshot below... + +**Screenshots (optional)** +If applicable, add screenshots to demonstrate the build process and error output. + +## CORE TEAM TASK LIST +- [ ] Evaluate `Build Error` +- [ ] Provide build guidance +- [ ] Create `Bug Report` From e591d639cd46aca9b03d3d40bacb6faa0fd82f60 Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 6 Jun 2018 13:08:54 -0400 Subject: [PATCH 09/17] Add: Build Error Template --- .github/ISSUE_TEMPLATE/build_error.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/build_error.md b/.github/ISSUE_TEMPLATE/build_error.md index 2769078685..511766a46d 100644 --- a/.github/ISSUE_TEMPLATE/build_error.md +++ b/.github/ISSUE_TEMPLATE/build_error.md @@ -9,7 +9,7 @@ Please include a detailed Title above. Next, please complete the following secti * Build Error * Build Environment * Steps To Reproduce -* Screenshots (optional) +* Console Logs (optional) Finally, press the 'Submit new issue' button. The Core Team will evaluate and prioritize your Bug Report for future development. @@ -33,8 +33,8 @@ Steps to reproduce the behavior (example outlined below): 4. Here is the error output... 5. See the error in the screenshot below... -**Screenshots (optional)** -If applicable, add screenshots to demonstrate the build process and error output. +**Console Logs (optional)** +Please provide the full console log, including all commands entered and their output. This will allow detailed troubleshooting. ## CORE TEAM TASK LIST - [ ] Evaluate `Build Error` From 6911192102733d669250fd045d990ec847bd9603 Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 6 Jun 2018 13:58:19 -0400 Subject: [PATCH 10/17] Add: Build Error Template --- .github/ISSUE_TEMPLATE/build_error.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/build_error.md b/.github/ISSUE_TEMPLATE/build_error.md index 511766a46d..403f5e8af8 100644 --- a/.github/ISSUE_TEMPLATE/build_error.md +++ b/.github/ISSUE_TEMPLATE/build_error.md @@ -29,9 +29,8 @@ Please provide details about the build environment, including the relevant requi Steps to reproduce the behavior (example outlined below): 1. Using installation guide from this URL... 2. This is my complete build script... -3. It fails at this step... -4. Here is the error output... -5. See the error in the screenshot below... +3. It fails at this step with the following output... +4. See the error in the console log below... **Console Logs (optional)** Please provide the full console log, including all commands entered and their output. This will allow detailed troubleshooting. From 1d1db0b1a85669d5abaae7f8d52c6a2a685a1fe1 Mon Sep 17 00:00:00 2001 From: "Ryan R. Fox" Date: Wed, 6 Jun 2018 15:21:47 -0400 Subject: [PATCH 11/17] Add: Build Error Template --- .github/ISSUE_TEMPLATE/build_error.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/build_error.md b/.github/ISSUE_TEMPLATE/build_error.md index 403f5e8af8..20be1bef17 100644 --- a/.github/ISSUE_TEMPLATE/build_error.md +++ b/.github/ISSUE_TEMPLATE/build_error.md @@ -1,6 +1,6 @@ --- name: Build Error -about: Create a detailed report about an error during in the BitShares Core build process. +about: Create a detailed report about an error encountered during the BitShares Core build process. --- @@ -17,7 +17,7 @@ Finally, press the 'Submit new issue' button. The Core Team will evaluate and pr A clear and concise description of what the build error is. **Build Environment** -Please provide details about the build environment, including the relevant required libraries. Much of this information can be found in the `CMakeFiles/CMakeOutput.log`. +Details about the build environment, including the relevant required libraries. Much of this information can be found in the `CMakeFiles/CMakeOutput.log`. - Host OS: [e.g. Ubuntu 18.04 LTS] - Host Physical RAM [e.g. 4GB] - Source Branch/Tag: [e.g. master or 2.0.180425] From 1297e1b9d3afd01071d9fcaebf5ee3e8c4a8ae0d Mon Sep 17 00:00:00 2001 From: oxarbitrage Date: Tue, 12 Jun 2018 09:59:58 -0700 Subject: [PATCH 12/17] update doxyfile and readme --- Doxyfile | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Doxyfile b/Doxyfile index c0af095a2e..f5bc590bd3 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,13 +38,13 @@ PROJECT_NAME = "Bitshares-Core" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "2.0.180425" +PROJECT_NUMBER = "2.0.180612" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "Your share in the Decentralized Exchange" +PROJECT_BRIEF = "The underlying software running the BitShares Blockchain" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 diff --git a/README.md b/README.md index d7e7a700af..c271550aeb 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ To build after all dependencies are installed: **NOTE:** BitShares requires an [OpenSSL](https://www.openssl.org/) version in the 1.0.x series. OpenSSL 1.1.0 and newer are NOT supported. If your system OpenSSL version is newer, then you will need to manually provide an older version of OpenSSL and specify it to CMake using `-DOPENSSL_INCLUDE_DIR`, `-DOPENSSL_SSL_LIBRARY`, and `-DOPENSSL_CRYPTO_LIBRARY`. -**NOTE:** BitShares requires a [Boost](http://www.boost.org/) version in the range [1.57, 1.63]. Versions earlier than +**NOTE:** BitShares requires a [Boost](http://www.boost.org/) version in the range [1.57, 1.65]. Versions earlier than 1.57 or newer than 1.63 are NOT supported. If your system Boost version is newer, then you will need to manually build an older version of Boost and specify it to CMake using `DBOOST_ROOT`. From c9a3c525415dcfe379e79e86956974bc17075d78 Mon Sep 17 00:00:00 2001 From: oxarbitrage Date: Tue, 12 Jun 2018 11:28:23 -0700 Subject: [PATCH 13/17] update max boost in sentence --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c271550aeb..a1e630a972 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ To build after all dependencies are installed: **NOTE:** BitShares requires an [OpenSSL](https://www.openssl.org/) version in the 1.0.x series. OpenSSL 1.1.0 and newer are NOT supported. If your system OpenSSL version is newer, then you will need to manually provide an older version of OpenSSL and specify it to CMake using `-DOPENSSL_INCLUDE_DIR`, `-DOPENSSL_SSL_LIBRARY`, and `-DOPENSSL_CRYPTO_LIBRARY`. **NOTE:** BitShares requires a [Boost](http://www.boost.org/) version in the range [1.57, 1.65]. Versions earlier than -1.57 or newer than 1.63 are NOT supported. If your system Boost version is newer, then you will need to manually build +1.57 or newer than 1.65 are NOT supported. If your system Boost version is newer, then you will need to manually build an older version of Boost and specify it to CMake using `DBOOST_ROOT`. After building, the witness node can be launched with: From bce877770f70952deb1e703fa29eab86efc07cef Mon Sep 17 00:00:00 2001 From: Alfredo Garcia Date: Fri, 15 Jun 2018 16:08:28 -0300 Subject: [PATCH 14/17] sync project description in doxyfile for https://github.com/bitshares/bitshares-core/pull/1062 --- Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index f5bc590bd3..469a3705cf 100644 --- a/Doxyfile +++ b/Doxyfile @@ -44,7 +44,7 @@ PROJECT_NUMBER = "2.0.180612" # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "The underlying software running the BitShares Blockchain" +PROJECT_BRIEF = "BitShares blockchain implementation and command-line interface software" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 From 859262acde1bcc0b3f982a10246f4e6a6448768f Mon Sep 17 00:00:00 2001 From: Alfredo Garcia Date: Mon, 2 Jul 2018 16:29:47 -0300 Subject: [PATCH 15/17] Update node requirements for #1107 --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ff894659ba..6641c2e4f4 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,12 @@ the blockchain. After syncing, you can exit the node using Ctrl+C and setup the rpc-endpoint = 127.0.0.1:8090 -**NOTE:** By default the witness node will start in reduced memory ram mode by using some of the commands detailed in [Memory reduction for nodes](https://github.com/bitshares/bitshares-core/wiki/Memory-reduction-for-nodes). -In order to run a full node with all the account history you need to remove `partial-operations` and `max-ops-per-account` from your config file. Please note that currently(2017-12-23) a full node need 54GB of RAM to operate and required memory is growing fast. +**IMPORTANT:** By default the witness node will start in reduced memory ram mode by using some of the commands detailed in [Memory reduction for nodes](https://github.com/bitshares/bitshares-core/wiki/Memory-reduction-for-nodes). +In order to run a full node with all the account history you need to remove `partial-operations` and `max-ops-per-account` from your config file. Please note that currently(2018-07-02) a full node need more than 100GB of RAM to operate and required memory is growing fast. Consider the following table before running a node: + +| Default | Full | Minimal | ElasticSearch +| --- | --- | --- | --- +| 20G RAM | 120G RAM | 4G RAM | 200G SSD HD, 16G RAM After starting the witness node again, in a separate terminal you can run: From 76c808a887e95724e9bd4a6b7afa568a109fa791 Mon Sep 17 00:00:00 2001 From: Alfredo Garcia Date: Mon, 2 Jul 2018 16:46:38 -0300 Subject: [PATCH 16/17] fix syntax error --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6641c2e4f4..cb20c2d76d 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ the blockchain. After syncing, you can exit the node using Ctrl+C and setup the rpc-endpoint = 127.0.0.1:8090 **IMPORTANT:** By default the witness node will start in reduced memory ram mode by using some of the commands detailed in [Memory reduction for nodes](https://github.com/bitshares/bitshares-core/wiki/Memory-reduction-for-nodes). -In order to run a full node with all the account history you need to remove `partial-operations` and `max-ops-per-account` from your config file. Please note that currently(2018-07-02) a full node need more than 100GB of RAM to operate and required memory is growing fast. Consider the following table before running a node: +In order to run a full node with all the account history you need to remove `partial-operations` and `max-ops-per-account` from your config file. Please note that currently(2018-07-02) a full node will need more than 100GB of RAM to operate and required memory is growing fast. Consider the following table before running a node: | Default | Full | Minimal | ElasticSearch | --- | --- | --- | --- From cabb3c9738ff1c451f0aa17a68863e96595099bb Mon Sep 17 00:00:00 2001 From: ryanRfox Date: Tue, 19 Jun 2018 15:29:47 -0400 Subject: [PATCH 17/17] Add: Require 64-bit OS --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cb20c2d76d..b80ce3ae17 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Getting Started Build instructions and additional documentation are available in the [wiki](https://github.com/bitshares/bitshares-core/wiki). -We recommend building on Ubuntu 16.04 LTS, and the build dependencies may be installed with: +We recommend building on Ubuntu 16.04 LTS (64-bit), and the build dependencies may be installed with: sudo apt-get update sudo apt-get install autoconf cmake make automake libtool git libboost-all-dev libssl-dev g++ libcurl4-openssl-dev @@ -55,6 +55,8 @@ To build after all dependencies are installed: 1.57 or newer than 1.63 are NOT supported. If your system Boost version is newer, then you will need to manually build an older version of Boost and specify it to CMake using `DBOOST_ROOT`. +**NOTE:** BitShares requires a 64-bit operating system to build, and will not build on a 32-bit OS. + After building, the witness node can be launched with: ./programs/witness_node/witness_node