Merge pull request #1220 from hyperledger/develop

0.28.1

.circleci/config.yml

@@ -39,6 +39,16 @@ jobs:
       - codecov/upload:
           file: coverage.html
 
+  test_js:
+    machine:
+      image: circleci/classic:201808-01
+    steps:
+      - checkout
+      # js tests do not need to in docker, however nodejs crashes
+      # while running mocha when not using image above (not OOM).
+      # above image needs newer go so docker is used.
+      - run: docker-compose run burrow make npm_install test_js
+
   test_integration:
     machine:
       image: circleci/classic:201808-01
@@ -90,6 +100,10 @@ workflows:
           filters:
             <<: *tags_filters
 
+      - test_js:
+          filters:
+            <<: *tags_filters
+
       - build_docker:
           filters:
             # tags filters and branch filters are applied disjunctively, so we
@@ -101,6 +115,7 @@ workflows:
           requires:
           - test
           - test_integration
+          - test_js
           filters:
             branches:
               only: develop
@@ -109,6 +124,7 @@ workflows:
           requires:
           - test
           - test_integration
+          - test_js
           filters:
             <<: *tags_filters
             branches:

.gitignore

@@ -21,4 +21,5 @@ commit_hash.txt
 
 tests/keys/
 .output.json
-vendor/
+vendor/
+node_modules

CHANGELOG.md

@@ -1,5 +1,11 @@
 # [Hyperledger Burrow](https://github.com/hyperledger/burrow) Changelog
-## [Unreleased]
+## [0.28.1] - 2019-08-21
+### Fixed
+- [Vent] Log for _vent_log insert now faithfully captures what is being inserted
+- [Vent] Remove arbitrary 100 character limits on system table text fields
+
+### Added
+- [JS] Burrow.js now included in Burrow repo and tested with Burrow CI! Future burrow.js releases will now match version of Burrow.
 
 
 ## [0.28.0] - 2019-08-14
@@ -541,7 +547,7 @@ This release marks the start of Eris-DB as the full permissioned blockchain node
   - [Blockchain] Fix getBlocks to respect block height cap.
 
 
-[Unreleased]: https://github.com/hyperledger/burrow/compare/v0.28.0...HEAD
+[0.28.1]: https://github.com/hyperledger/burrow/compare/v0.28.0...v0.28.1
 [0.28.0]: https://github.com/hyperledger/burrow/compare/v0.27.0...v0.28.0
 [0.27.0]: https://github.com/hyperledger/burrow/compare/v0.26.2...v0.27.0
 [0.26.2]: https://github.com/hyperledger/burrow/compare/v0.26.1...v0.26.2

Makefile

@@ -174,6 +174,17 @@ solidity: $(SOLIDITY_GO_FILES)
 .PHONY: solang
 solang: $(SOLANG_GO_FILES)
 
+# node/js
+#
+# Install dependency
+.PHONY: npm_install
+npm_install:
+	npm install
+
+.PHONY: test_js
+test_js: bin/solc build_burrow
+	./tests/scripts/bin_wrapper.sh npm test
+
 # Test
 
 .PHONY: test

NOTES.md

@@ -1,21 +1,7 @@
-### Changed
-- [State] IterateStreamEvents now takes inclusive start and end points (end used to be exclusive) avoid bug-prone conversion
-- [Dump] Improved structure and API
-- [Dump] Default to JSON output and use protobuf for binary output
-
 ### Fixed
-- [Dump] Fix dump missing events emitted at end height provided
-- [Dump] EVM events were not dumped if no height was provided to burrow dump remote commandline
-- [RPC/Info] Fix panic in /names and implement properly - now accepts a 'regex' parameter which is a regular expression to match names. Empty for all names.
-- [Configure] burrow configure flags --separate-genesis-doc and --pool now work together
+- [Vent] Log for _vent_log insert now faithfully captures what is being inserted
+- [Vent] Remove arbitrary 100 character limits on system table text fields
 
 ### Added
-- [State] Burrow now remembers contact ABIs (which describe how to pack bits when calling contracts) - burrow deploy and vent will both use chain-hosted ABI if they are available
-- [State] Bond and unbond transactions are now implement to allow validators to transfer native token into validator power.
-- [Dump] Better tests, mock, and benchmarks - suitable for profiling IAVL
-- [Events] Filters now support OR connective
-- [Vent] Projection filters can now have filters longer than 100 characters.
-- [Vent] Falls back to local ABI
-- [CLI/RPC] Contracts now hold metadata, including contract name, source file, and function names
-
+- [JS] Burrow.js now included in Burrow repo and tested with Burrow CI! Future burrow.js releases will now match version of Burrow.
 

README.md

@@ -1,4 +1,4 @@
-# Hyperledger Burrow
+# [Hyperledger Burrow](https://hyperledger.github.io/burrow)
 
 [![version](https://img.shields.io/github/tag/hyperledger/burrow.svg)](https://github.com/hyperledger/burrow/releases/latest)
 [![GoDoc](https://godoc.org/github.com/burrow?status.png)](https://godoc.org/github.com/hyperledger/burrow)
@@ -13,7 +13,7 @@ Branch    | Linux
 
 Hyperledger Burrow is a permissioned Ethereum smart-contract blockchain node. It executes Ethereum EVM smart contract code (usually written in [Solidity](https://solidity.readthedocs.io)) on a permissioned virtual machine. Burrow provides transaction finality and high transaction throughput on a proof-of-stake [Tendermint](https://tendermint.com) consensus engine.
 
-![burrow logo](docs/assets/images/burrow.png)
+![burrow logo](docs/assets/burrow.png)
 
 ## What is Burrow
 
@@ -26,6 +26,10 @@ Hyperledger Burrow is a permissioned blockchain node that executes smart contrac
 - **Application Binary Interface (ABI):** Transactions need to be formulated in a binary format that can be processed by the blockchain node. Current tooling provides functionality to compile, deploy and link solidity smart contracts and formulate transactions to call smart contracts on the chain.
 - **API Gateway:** Burrow exposes REST and JSON-RPC endpoints to interact with the blockchain network and the application state through broadcasting transactions, or querying the current state of the application. Websockets allow subscribing to events, which is particularly valuable as the consensus engine and smart contract application can give unambiguously finalised results to transactions within one blocktime of about one second.
 
+## JavaScript Client
+
+There is a [JavaScript API](https://github.com/hyperledger/burrow/tree/develop/js)
+
 ## Project Roadmap
 
 Project information generally updated on a quarterly basis can be found on the [Hyperledger Burrow Wiki](https://wiki.hyperledger.org/display/burrow).

docs/INSTALL.md

@@ -1,22 +1,40 @@
-## Minimum requirements
+# Installation
 
-Requirement|Notes
----|---
-Go version | Go1.11 or higher
+## Binary
 
-## Installation
+Download a binary from our list of [releases](https://github.com/hyperledger/burrow/releases)
+and copy it to a suitable location.
 
-- [Install go](https://golang.org/doc/install) version 1.11 or above and have `$GOPATH` set
+
+## Source
+
+[Install Go](https://golang.org/doc/install) (Version >= 1.11) and set `$GOPATH`.
 
 ```
 go get github.com/hyperledger/burrow
 cd $GOPATH/src/github.com/hyperledger/burrow
-# We need to force enable module support to build from within GOPATH (our protobuf build depends on path, otherwise any checkout location should work)
-export GO111MODULE=on
 make build
 ```
 
 This will build the `burrow` binary and put it in the `bin/` directory. It can be executed from there or put wherever is convenient.
 
 You can also install `burrow` into `$BIN_PATH/bin` with `make install`, where `$BIN_PATH` defaults to `$HOME/go/bin`
 if not set in environment.
+
+
+## Docker
+
+Each release is also tagged and pushed to [Docker Hub](https://hub.docker.com/r/hyperledger/burrow).
+This can act as a direct replacement for the burrow binary, for example the following commands are equivalent:
+
+```bash
+burrow spec -v4
+docker run hyperledger/burrow spec -v4
+```
+
+Note: ensure to mount local volumes for secrets / configurations when running a container to prevent data loss.
+
+## Kubernetes
+
+Use our official [helm charts](https://github.com/helm/charts/tree/master/stable/burrow) to configure and run 
+a burrow chain in your cluster.

docs/README.md

@@ -2,9 +2,9 @@
 
 Hyperledger Burrow is a permissioned Ethereum smart-contract blockchain node. It executes Ethereum EVM smart contract code (usually written in [Solidity](https://solidity.readthedocs.io)) on a permissioned virtual machine. Burrow provides transaction finality and high transaction throughput on a proof-of-stake [Tendermint](https://tendermint.com) consensus engine.
 
-![burrow logo](assets/images/burrow.png)
+![burrow logo](assets/burrow.png)
 
-## What is Burrow
+## What is Burrow?
 
 Hyperledger Burrow is a permissioned blockchain node that executes smart contract code following the Ethereum specification. Burrow is built for a multi-chain universe with application specific optimization in mind. Burrow as a node is constructed out of three main components: the consensus engine, the permissioned Ethereum virtual machine and the rpc gateway. More specifically Burrow consists of the following:
 

docs/_sidebar.md

@@ -1,15 +1,20 @@
 - Burrow
     - [Introduction](README.md)
     - [Installation](INSTALL.md)
+    - [JS API](js-api.md)
+
+- Transactions
+    - [Bond / Unbond](txs/bond.md)
+
 - Tutorials
-    - [Single Node](quickstart/single-full-node.md)
-    - [Send Transactions](quickstart/send-transactions.md)
-    - [Deploy Contracts](quickstart/deploy-contracts.md)
-    - [Multiple Validators](quickstart/multiple-validators.md)
-    - [Add Validators](quickstart/bonding-validators.md)
-    - [Seed Nodes](quickstart/seed-nodes.md)
-    - [Dump-Restore](quickstart/dump-restore.md)
-    - [Kubernetes](https://github.com/helm/charts/tree/master/stable/burrow)
+    - [Single Node](tutorials/1-run-full-node.md)
+    - [Send Transactions](tutorials/2-send-transactions.md)
+    - [Deploy Contracts](tutorials/3-deploy-contracts.md)
+    - [Multiple Validators](tutorials/4-multiple-validators.md)
+    - [Bonding](tutorials/5-bonding-validators.md)
+    - [Seed Nodes](tutorials/6-seed-nodes.md)
+    - [Dump / Restore](tutorials/7-dump-restore.md)
+
 - Reference
     - [Genesis](reference/genesis.md)
     - [Logging](reference/logging.md)

docs/index.html

@@ -2,9 +2,9 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8">
-  <title>Document</title>
+  <title>Hyperledger Burrow</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Description">
+  <meta name="description" content="Hyperledger Burrow is a permissioned Ethereum smart-contract blockchain node.">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
   <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
 </head>
@@ -14,8 +14,10 @@
     window.$docsify = {
       name: 'Hyperledger Burrow',
       repo: 'https://github.com/hyperledger/burrow',
+      auto2top: true,
       loadSidebar: true,
-      subMaxLevel: 2
+      subMaxLevel: 2,
+      themeColor: '#3FBB86'
     }
   </script>
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>