Sawtooth Supply Chain
Switch branches/tags
Clone or download
Latest commit 56bf8b4 Dec 12, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
asset_client Update clients to use NUMBER instead of INT and FLOAT May 7, 2018
bin Remove deprecated scripts and dockerfiles Dec 6, 2018
docker/compose Remove deprecated scripts and dockerfiles Dec 6, 2018
docs Switch Dockerfiles to bionic base image Dec 6, 2018
fish_client Update clients to use NUMBER instead of INT and FLOAT May 7, 2018
images Include images referenced in README.md Nov 22, 2017
integration/sawtooth_integration Add `unit` field to Property in TP Jul 10, 2018
ledger_sync Switch Dockerfiles to bionic base image Dec 6, 2018
processor Add bionic installed dockerfiles Dec 6, 2018
protos Add `unit` field to Property in TP Jul 10, 2018
server Switch Dockerfiles to bionic base image Dec 6, 2018
shell Switch Dockerfiles to bionic base image Dec 6, 2018
tests/sawtooth_sc_test Add STRUCT data type to integration test May 21, 2018
.dockerignore Move npm installs and client builds to server Dockerfile Oct 23, 2017
.env Change docker .env so bionic is the default Dec 6, 2018
.gitignore Remove Cargo.lock from committed files May 21, 2018
.pep8 Exclude protobuf-generated files from linting Nov 13, 2016
.pylintrc Rename .pylintrc-strict to .pylintrc Feb 23, 2017
CONTRIBUTING.md Correct link in CONTRIBUTING.md file Sep 21, 2016
Jenkinsfile Fetch git tags in Jenkinsfile Jul 5, 2018
LICENSE Update Apache 2.0 LICENSE file Aug 29, 2018
README.md Remove Python transaction processor Apr 18, 2018
VERSION Increment version to v0.10.4 Dec 5, 2018
docker-compose-installed.yaml Rename installed dockerfiles to support multiple distros Dec 6, 2018
docker-compose.yaml Make sawtooth-supply-chain work in proxy environment Oct 27, 2018
nose2.cfg Move Track and Trade contents to root dir Oct 9, 2017

README.md

Hyperledger Sawtooth

Sawtooth Supply Chain

This is a distributed application to help you trace the provenance and other contextual information of any asset. It can be used as-is or customized for different use cases. This distributed application runs on top of Hyperledger Sawtooth, an enterprise blockchain. To learn more about Hyperledger Sawtooth please see its sawtooth-core repo or its published docs.

Contents

Components

Running alongside the core components from Hyperledger Sawtooth, Supply Chain includes a number of elements customizing the blockchain and user interaction with it:

  • a transaction processor which handles Supply Chain transaction logic
  • a server which provides an HTTP/JSON API for Supply Chain actions
  • a ledger sync which syncs blockchain data to a local database
  • the AssetTrack example client for tracking generic assets
  • the FishNet example client for tracking fish from catch to table
  • a shell container with the dependencies to run any commands and scripts

Usage

This project utilizes Docker to simplify dependencies and deployment. After cloning this repo, follow the instructions specific to your OS to install and run whatever components are required to use docker and docker-compose from your command line. This is only dependency required to run Supply Chain components.

Start Up

Once Docker is installed and you've cloned this repo, navigate to the root project directory and run:

docker-compose up

This will take awhile the first time it runs, but when complete will be running all required components in separate containers. Many of the components will be available through HTTP endpoints, including:

In bash you can shutdown these components with the key combination: ctrl-C. You can shutdown and remove the containers (destroying their data), with the command:

docker-compose down

Running Scripts in the Shell

Running docker-compose up, will automatically run all scripts necessary to use all Supply Chain components. However if you want to run any additional scripts, such as scripts to automatically update sample blockchain data, a shell container is provided with all necessary dependencies installed. To enter the shell, simply open a terminal window and run:

docker exec -it supply-shell bash

Once inside the shell, you might try running the one of the update scripts to see live updates populate in an example web app. First navigate to the server directory:

cd server/

Then run one of the two provided npm scripts:

npm run update-sample-assets
npm run update-sample-fish

You can customize how many updates are submitted per minute with the RATE environment variable (default 6), and use LIMIT to stop the updates after a certain number are submitted (default 25):

RATE=3 LIMIT=10 npm run update-sample-assets

If you just want to exit the shell, you can simply run:

exit

Configuring API Keys and Secrets

While the Server runs out of the box with sensible defaults, there are a number of secrets and API keys which will not be secure unless set explicitly. While this is fine for demo purposes, any actual deployment set the following properties:

  • JWT_SECRET: can be any random string
  • PRIVATE_KEY: must be 64 random hexadecimal characters
  • MAPS_API_KEY: provided by Google Maps

These properties can be set one of two ways, through an environment variable, or (preferably) by creating a file named config.json file in the server/ directory. A file named config.json.example is provided which should provide a template to follow.

Development

Restarting Components

The default Docker containers use the volumes command to link directly to the source code on your host machine. As a result any changes you make will immediately be reflected in Supply Chain components without having to rebuild them. However, typically you will have to restart a component before it can take advantage of any changes. Rather than restarting every container, you can restart a single component from separate terminal using the container name. For example:

docker restart supply-server

The available container names include:

  • supply-shell
  • supply-processor
  • supply-server
  • supply-asset-client
  • supply-fish-client
  • supply-rethink
  • supply-validator
  • supply-settings-tp
  • supply-rest-api

Manually Building Generated Files

The example clients are based on static files generated by build scripts. Any time changes are made to their source code they will need to be rebuilt. This is done automatically on up, but if you make changes to these files and wish to rebuild the generated files immediately, you can do so from within the Supply Chain Shell:

docker exec -it supply-shell bash

Once in the shell, you can generate the necessary JS files by navigating to a client's directory and running its build script:

cd asset_client/
npm run build
cd fish_client/
npm run build

Unlike other components, the clients do not typically need to be restarted in order to reflect changes, just rebuild the static files and refresh your browser (the browser cache may have to be emptied).

Building Protobuf Files

Files in the protos/ directory are used to generate classes for all of the other components. If any changes are made in this directory, these classes will need to be rebuilt for all components. While this can be done manually, the necessary commands are included in docker-compose.yaml, so simply stop all containers with ctrl-C and then docker-compose up again.

Documentation

The latest documentation for Sawtooth Supply Chain is available within this repo in the docs subdirectory.

License

Hyperledger Sawtooth software is licensed under the Apache License Version 2.0 software license.

Hyperledger Sawtooth Supply Chain documentation in the docs subdirectory is licensed under a Creative Commons Attribution 4.0 International License. You may obtain a copy of the license at: http://creativecommons.org/licenses/by/4.0/.

Open Source Award Badge