README
¶
Stratumn SDK
Stratumn's SDK to create Indigo applications and networks.
The SDK includes tools to build Proof of Process Networks using the Indigo Framework.
To get started, visit the Indigo Framework website:
https://indigoframework.com
Development
Install dependencies:
go get -u github.com/golang/dep/cmd/dep
dep ensure
To manage dependencies, see dep.
Run all tests:
make test
See test coverage in the browser:
make coverhtml
Run the linter:
go get -u github.com/golang/lint/golint
make lint
Build tagged docker images:
make docker_images
License
Copyright 2017 Stratumn SAS. All rights reserved.
Unless otherwise noted, the source files are distributed under the Apache License 2.0 found in the LICENSE file.
Third party dependencies included in the vendor directory are distributed under their respective licenses.
Documentation
¶
Overview ¶
Package sdk contains Stratumn tools and functionality to create Indigo applications and networks.
Unless otherwise noted, the source files are distributed under the Apache License 2.0 found in the LICENSE file.
Third party dependencies included in the vendor directory are distributed under their respective licenses.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
dummyfossilizer
The command dummnyfossilizer starts a fossilizerhttp server with a dummyfossilizer.
|
The command dummnyfossilizer starts a fossilizerhttp server with a dummyfossilizer. |
|
dummystore
The command dummystore starts a storehttp server with a dummystore.
|
The command dummystore starts a storehttp server with a dummystore. |
|
dummytmpop
The command filetmpop starts a tmpop node with a filestore.
|
The command filetmpop starts a tmpop node with a filestore. |
|
filestore
The command filestore starts a storehttp server with a filestore.
|
The command filestore starts a storehttp server with a filestore. |
|
filetmpop
The command filetmpop starts a tmpop node with a filestore.
|
The command filetmpop starts a tmpop node with a filestore. |
|
strat
The command strat contains various subcommands for the Stratumn SDK.
|
The command strat contains various subcommands for the Stratumn SDK. |
|
tmstore
The command tmstore starts an HTTP server with a tmstore.
|
The command tmstore starts an HTTP server with a tmstore. |
|
Package cs defines types to work with Chainscripts.
|
Package cs defines types to work with Chainscripts. |
|
cstesting
Package cstesting defines helpers to test Chainscripts.
|
Package cstesting defines helpers to test Chainscripts. |
|
Package dummyfossilizer implements a fossilizer that can be used for testing.
|
Package dummyfossilizer implements a fossilizer that can be used for testing. |
|
Package dummystore implements a store that saves all the segments in memory.
|
Package dummystore implements a store that saves all the segments in memory. |
|
Package filestore implements a store that saves all the segments to the file system.
|
Package filestore implements a store that saves all the segments to the file system. |
|
Package fossilizer defines types to implement a fossilizer.
|
Package fossilizer defines types to implement a fossilizer. |
|
fossilizerhttp
Package fossilizerhttp is used to create an HTTP server from a fossilizer adapter.
|
Package fossilizerhttp is used to create an HTTP server from a fossilizer adapter. |
|
fossilizertesting
Package fossilizertesting defines helpers to test fossilizers.
|
Package fossilizertesting defines helpers to test fossilizers. |
|
Package generator deals with creating projects from template files.
|
Package generator deals with creating projects from template files. |
|
repo
Package repo deals with a Github repository of generators.
|
Package repo deals with a Github repository of generators. |
|
Package jsonhttp defines a simple HTTP server that renders JSON.
|
Package jsonhttp defines a simple HTTP server that renders JSON. |
|
Package jsonws defines functionality to deal with web sockets and JSON.
|
Package jsonws defines functionality to deal with web sockets and JSON. |
|
jsonwstesting
Package jsonwstesting defines helpers to test web sockets.
|
Package jsonwstesting defines helpers to test web sockets. |
|
Package store defines types to implement a store.
|
Package store defines types to implement a store. |
|
storehttp
Package storehttp is used to create an HTTP server from a store adapter.
|
Package storehttp is used to create an HTTP server from a store adapter. |
|
storetestcases
Package storetestcases defines test cases to test stores.
|
Package storetestcases defines test cases to test stores. |
|
storetesting
Package storetesting defines helpers to test stores.
|
Package storetesting defines helpers to test stores. |
|
strat
|
|
|
cmd
Package cmd implements command line commands for strat.
|
Package cmd implements command line commands for strat. |
|
Package testutil contains helpers for tests.
|
Package testutil contains helpers for tests. |
|
Package tmstore implements a store that saves all the segments in a tendermint app
|
Package tmstore implements a store that saves all the segments in a tendermint app |
|
Package types defines common types.
|
Package types defines common types. |
Click to show internal directories.
Click to hide internal directories.