diff --git a/LICENSE.md b/LICENSE similarity index 93% rename from LICENSE.md rename to LICENSE index 0415b22c..7a374cc6 100644 --- a/LICENSE.md +++ b/LICENSE @@ -1,4 +1,5 @@ -Copyright (c) 2015 Cryptonomex, Inc., and contributors. +Copyright (c) 2015-2016 Cryptonomex Inc. +Copyright (c) 2015-2017 contributors The MIT License @@ -19,4 +20,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - diff --git a/README.md b/README.md index a83ba292..66a4612a 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,72 @@ -[![Slack](http://slack.bitshares.org/badge.svg)](http://slack.bitshares.org/) +BitShares Core +============== +BitShares Core is the BitShares blockchain implementation and command-line interface. +The web wallet is [BitShares UI](https://github.com/bitshares/bitshares-ui). -Intro for new developers ------------------------- +Visit [BitShares.org](https://bitshares.org/) to learn about BitShares. -This is a quick introduction to get new developers up to speed on BitShares. +Join the community at [BitSharesTalk.org](https://bitsharestalk.org/). -Starting BitShares ------------------ +**NOTE:** The official BitShares git repository location, default branch, and submodule remotes were recently changed. Existing +repositories can be updated with the following steps: -For Ubuntu 14.04 LTS users, see this link first: - https://github.com/cryptonomex/graphene/wiki/build-ubuntu + git remote set-url origin https://github.com/bitshares/bitshares-core.git + git checkout master + git remote set-head origin --auto + git pull + git submodule sync --recursive + git submodule update --init --recursive -and then proceed with: +Getting Started +--------------- +Build instructions and additional documentation are available in the +[wiki](https://github.com/bitshares/bitshares-core/wiki). - git clone https://github.com/bitshares/bitshares-2 - cd bitshares-2 +To build after all dependencies are installed: + + git clone https://github.com/bitshares/bitshares-core.git + cd bitshares-core + git checkout git submodule update --init --recursive cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo . make + +Alternate Boost versions can be specified using the `DBOOST_ROOT` CMake argument. After building, the witness node can +be launched with: + ./programs/witness_node/witness_node -This will launch the witness node. If you would like to launch the command-line wallet, you must first specify a port -for communication with the witness node. To do this, add text to `witness_node_data_dir/config.ini` as follows, then -restart the node: +The node will automatically create a data directory including a config file. It will take some time to fully synchronize +the blockchain. After syncing, you can exit the node using Ctrl+C and setup the command-line wallet by editing +`witness_node_data_dir/config.ini` as follows: rpc-endpoint = 127.0.0.1:8090 -Then, in a separate terminal window, start the command-line wallet `cli_wallet`: +After starting the witness node again, in a separate terminal you can run: ./programs/cli_wallet/cli_wallet -To set your iniital password to 'password' use: +Set your inital password: - >>> set_password password - >>> unlock password + >>> set_password + >>> unlock To import your initial balance: - >>> import_balance nathan [5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3] true + >>> import_balance [] true If you send private keys over this connection, `rpc-endpoint` should be bound to localhost for security. -A list of CLI wallet commands is available -[here](https://github.com/bitshares/bitshares-2/blob/bitshares/libraries/wallet/include/graphene/wallet/wallet.hpp). +Use `help` to see all available wallet commands. Source definition and listing of all commands is available +[here](https://github.com/bitshares/bitshares-core/blob/master/libraries/wallet/include/graphene/wallet/wallet.hpp). -Code coverage testing ---------------------- +Support +------- +Technical support is available in the [BitSharesTalk technical support subforum](https://bitsharestalk.org/index.php?board=45.0). -Check how much code is covered by unit tests, using gcov/lcov (see http://ltp.sourceforge.net/coverage/lcov.php ). +BitShares Core bugs can be reported directly to the [issue tracker](https://github.com/bitshares/bitshares-core/issues). - cmake -D ENABLE_COVERAGE_TESTING=true -D CMAKE_BUILD_TYPE=Debug . - make - lcov --capture --initial --directory . --output-file base.info --no-external - libraries/fc/bloom_test - libraries/fc/task_cancel_test - libraries/fc/api - libraries/fc/blind - libraries/fc/ecc_test test - libraries/fc/real128_test - libraries/fc/lzma_test README.md - libraries/fc/ntp_test - tests/intense_test - tests/app_test - tests/chain_bench - tests/chain_test - tests/performance_test - lcov --capture --directory . --output-file test.info --no-external - lcov --add-tracefile base.info --add-tracefile test.info --output-file total.info - lcov -o interesting.info -r total.info libraries/fc/vendor/\* libraries/fc/tests/\* tests/\* - mkdir -p lcov - genhtml interesting.info --output-directory lcov --prefix `pwd` - -Now open `lcov/index.html` in a browser. - -Unit testing ------------- - -We use the Boost unit test framework for unit testing. Most unit -tests reside in the `chain_test` build target. - -Witness node ------------- - -The role of the witness node is to broadcast transactions, download blocks, and optionally sign them. - -``` -./witness_node --rpc-endpoint 127.0.0.1:8090 --enable-stale-production -w '"1.6.0"' '"1.6.1"' '"1.6.2"' '"1.6.3"' '"1.6.4"' '"1.6.5"' '"1.6.6"' '"1.6.7"' '"1.6.8"' '"1.6.9"' '"1.6.10"' '"1.6.11"' '"1.6.12"' '"1.6.13"' '"1.6.14"' '"1.6.15"' '"1.6.16"' '"1.6.17"' '"1.6.18"' '"1.6.19"' '"1.6.20"' '"1.6.21"' '"1.6.22"' '"1.6.23"' '"1.6.24"' '"1.6.25"' '"1.6.26"' '"1.6.27"' '"1.6.28"' '"1.6.29"' '"1.6.30"' '"1.6.31"' '"1.6.32"' '"1.6.33"' '"1.6.34"' '"1.6.35"' '"1.6.36"' '"1.6.37"' '"1.6.38"' '"1.6.39"' '"1.6.40"' '"1.6.41"' '"1.6.42"' '"1.6.43"' '"1.6.44"' '"1.6.45"' '"1.6.46"' '"1.6.47"' '"1.6.48"' '"1.6.49"' '"1.6.50"' '"1.6.51"' '"1.6.52"' '"1.6.53"' '"1.6.54"' '"1.6.55"' '"1.6.56"' '"1.6.57"' '"1.6.58"' '"1.6.59"' '"1.6.60"' '"1.6.61"' '"1.6.62"' '"1.6.63"' '"1.6.64"' '"1.6.65"' '"1.6.66"' '"1.6.67"' '"1.6.68"' '"1.6.69"' '"1.6.70"' '"1.6.71"' '"1.6.72"' '"1.6.73"' '"1.6.74"' '"1.6.75"' '"1.6.76"' '"1.6.77"' '"1.6.78"' '"1.6.79"' '"1.6.80"' '"1.6.81"' '"1.6.82"' '"1.6.83"' '"1.6.84"' '"1.6.85"' '"1.6.86"' '"1.6.87"' '"1.6.88"' '"1.6.89"' '"1.6.90"' '"1.6.91"' '"1.6.92"' '"1.6.93"' '"1.6.94"' '"1.6.95"' '"1.6.96"' '"1.6.97"' '"1.6.98"' '"1.6.99"' '"1.6.100"' -``` - -Running specific tests ----------------------- - -- `tests/chain_tests -t block_tests/name_of_test` +BitShares UI bugs should be reported to the [UI issue tracker](https://github.com/bitshares/bitshares-ui/issues) Using the API ------------- @@ -164,13 +139,8 @@ If you want information which is not available from an API, it might be availabl from the [database](https://bitshares.github.io/doxygen/classgraphene_1_1chain_1_1database.html); it is fairly simple to write API methods to expose database methods. -Running private testnet ------------------------ - -See the [documentation](https://github.com/cryptonomex/graphene/wiki/private-testnet) if you want to run a private testnet. - -Questions ---------- +FAQ +--- - Is there a way to generate help with parameter names and method descriptions? @@ -240,3 +210,7 @@ Questions connecting to. Therefore the API to add p2p connections needs to be set up with proper access controls. +License +------- +BitShares Core is under the MIT license. See [LICENSE](https://github.com/bitshares/bitshares-core/blob/master/LICENSE) +for more information. diff --git a/docs b/docs index cc4a57cf..474c28bc 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit cc4a57cf18161d591bb2ad23a2cfa630fa2f9915 +Subproject commit 474c28bc7181739f25229b45b76646a693cad998