Merge pull request #262 from input-output-hk/jpraynaud/249-devnet-spo

Mithril/Cardano devnet with SPO nodes

.dockerignore

@@ -1,3 +1,4 @@
-/.git
+.git
 /mithril-test-lab
 /target
+/**/data

mithril-aggregator/Makefile

@@ -25,4 +25,10 @@ help:
 	@${CARGO} run -- -h
 
 doc:
-	${CARGO} doc --no-deps --open
+	${CARGO} doc --no-deps --open
+
+docker-build:
+	cd ../ && docker build -t mithril/mithril-aggregator -f mithril-aggregator/Dockerfile .
+
+docker-run:
+	docker run --rm -p 8080:8080 --name='mithril-aggregator' mithril/mithril-aggregator

mithril-aggregator/README.md

@@ -5,14 +5,16 @@
 This is a first version of the Mithril Aggregagator
 
 ---
-## Pre-requisites:
+
+## Pre-requisites
 
 **Install Rust**
 
 - Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.58.0+).
 - Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
 
-## Download source code:
+## Download source code
+
 ```bash
 # Download sources from github
 git clone https://github.com/input-output-hk/mithril
@@ -21,7 +23,8 @@ git clone https://github.com/input-output-hk/mithril
 cd mithril-aggregator
 ```
 
-## Development test and build:
+## Development test and build
+
 ```bash
 # Test
 make test
@@ -36,7 +39,8 @@ make doc
 make debug
 ```
 
-## Release build and run binary:
+## Release build and run binary
+
 ```bash
 # Build and run in release with default configuration
 make run
@@ -58,18 +62,18 @@ make build
 NETWORK=testnet URL_SNAPSHOT_MANIFEST=https://storage.googleapis.com/cardano-testnet/snapshots.json ./mithril-aggregator
 ```
 
-## Build and run Docker container:
+## Build and run Docker container
 
 ```bash
 # Build Docker image
-cd ../
-docker build -t mithril/mithril-aggregator -f mithril-aggregator/Dockerfile .
+make docker-build
 
 # Run Docker container
-docker run --rm -p 8080:8080 --name='mithril-aggregator' mithril/mithril-aggregator
+make docker-run
 ```
 
 ## Interact with the Mithril Aggregator
+
 ```bash
 # Interact with the aggregator through the OpenAPI UI
 open -u https://input-output-hk.github.io/mithril/openapi-ui/

mithril-client/Makefile

@@ -34,3 +34,9 @@ help:
 
 doc:
 	${CARGO} doc --no-deps --open
+
+docker-build:
+	cd ../ && docker build -t mithril/mithril-client -f mithril-client/Dockerfile .
+
+docker-run:
+	docker run --rm --name='mithril-client' mithril/mithril-client

mithril-client/README.md

@@ -7,15 +7,16 @@
 * This cli implements a MVP version of a **Mithril Client**.
 
 ---
-## Pre-requisites:
+
+## Pre-requisites
 
 **Install Rust**
 
-- Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.58.0+).
-- Install Rust [Clippy](https://github.com/rust-lang/rust-clippy) component.
+* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.58.0+).
+* Install Rust [Clippy](https://github.com/rust-lang/rust-clippy) component.
 
+## Download source code
 
-## Download source code:
 ```bash
 # Download sources from github
 git clone https://github.com/input-output-hk/mithril
@@ -24,7 +25,8 @@ git clone https://github.com/input-output-hk/mithril
 cd mithril-client
 ```
 
-## Development test and build:
+## Development test and build
+
 ```bash
 # Test
 make test
@@ -39,7 +41,8 @@ make doc
 make debug
 ```
 
-## Release build and run binary:
+## Release build and run binary
+
 ```bash
 # Build and run in release with default configuration
 make run list
@@ -62,13 +65,12 @@ make build
 NETWORK=testnet AGGREGATOR_ENDPOINT=http://aggregator.api.mithril.network/aggregator ./mithril-client
 ```
 
-## Build and run Docker container:
+## Build and run Docker container
 
 ```bash
 # Build Docker image
-cd ../
-docker build -t mithril/mithril-client -f mithril-client/Dockerfile .
+make docker-build
 
 # Run Docker container
-docker run --rm --name='mithril-client' mithril/mithril-client
+make docker-run
 ```

mithril-signer/Makefile

@@ -25,4 +25,10 @@ help:
 	@${CARGO} run -- -h
 
 doc:
-	${CARGO} doc --no-deps --open
+	${CARGO} doc --no-deps --open
+
+docker-build:
+	cd ../ && docker build -t mithril/mithril-signer -f mithril-signer/Dockerfile .
+
+docker-run:
+	docker run --rm --name='mithril-signer' mithril/mithril-signer

mithril-signer/README.md

@@ -5,14 +5,15 @@
 This is a first version of the Mithril Signer
 
 ---
-## Pre-requisites:
+
+## Pre-requisites
 
 **Install Rust**
 
 - Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.58.0+).
 
+## Download source code
 
-## Download source code:
 ```bash
 # Download sources from github
 git clone https://github.com/input-output-hk/mithril
@@ -21,7 +22,8 @@ git clone https://github.com/input-output-hk/mithril
 cd mithril-signer
 ```
 
-## Development test and build:
+## Development test and build
+
 ```bash
 # Test
 make test
@@ -36,7 +38,8 @@ make doc
 make debug
 ```
 
-## Release build and run binary:
+## Release build and run binary
+
 ```bash
 # Build and run in release with default configuration
 make run
@@ -58,13 +61,12 @@ make build
 NETWORK=testnet AGGREGATOR_ENDPOINT=http://aggregator.api.mithril.network/aggregator ./mithril-signer
 ```
 
-## Build and run Docker container:
+## Build and run Docker container
 
 ```bash
 # Build Docker image
-cd ../
-docker build -t mithril/mithril-signer -f mithril-signer/Dockerfile .
+make docker-build
 
 # Run Docker container
-docker run --rm --name='mithril-signer' mithril/mithril-signer
+make docker-run
 ```

mithril-test-lab/mithril-devnet/.gitignore

@@ -0,0 +1,9 @@
+tx
+logs
+ipc
+.log
+artifacts
+cardano-cli
+cardano-node
+tmp
+.tar.gz