Skip to content

Commit

Permalink
Merge 431319e into bbb97a6
Browse files Browse the repository at this point in the history
  • Loading branch information
patitonar committed Jun 19, 2019
2 parents bbb97a6 + 431319e commit 59aa4bc
Show file tree
Hide file tree
Showing 9 changed files with 17,908 additions and 2,610 deletions.
10 changes: 0 additions & 10 deletions .solcover.js

This file was deleted.

4 changes: 4 additions & 0 deletions Dockerfile
@@ -1,5 +1,9 @@
FROM node:10

RUN apt-get update
RUN apt-get install -y netcat
RUN apt-get clean

WORKDIR /contracts

COPY package.json .
Expand Down
15 changes: 15 additions & 0 deletions README.md
@@ -1,5 +1,6 @@
[![Join the chat at https://gitter.im/poanetwork/poa-bridge](https://badges.gitter.im/poanetwork/poa-bridge.svg)](https://gitter.im/poanetwork/poa-bridge?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/poanetwork/poa-parity-bridge-contracts.svg?branch=master)](https://travis-ci.org/poanetwork/poa-parity-bridge-contracts)
[![Coverage Status](https://coveralls.io/repos/github/poanetwork/poa-bridge-contracts/badge.svg?branch=master)](https://coveralls.io/github/poanetwork/poa-bridge-contracts?branch=master)

# POA Bridge Smart Contracts
These contracts provide the core functionality for the POA bridge. They implement the logic to relay assests between two EVM-based blockchain networks. The contracts collect bridge validator's signatures to approve and facilitate relay operations.
Expand Down Expand Up @@ -80,6 +81,13 @@ Please the [README.md](deploy/README.md) in the `deploy` folder for instructions
npm test
```

#### Run coverage tests
```bash
npm run coverage
```

The results can be found in the `coverage` directory.

#### Flatten
Fattened contracts can be used to verify the contract code in a block explorer like BlockScout or Etherscan.
The following command will prepare flattened version of the contracts:
Expand Down Expand Up @@ -120,6 +128,13 @@ _Note: The container must be rebuilt every time the code in a contract or deploy
docker cp name-of-your-container:/contracts/flats ./
```

#### Test contract and run coverage (if needed)
```bash
$ docker-compose run bridge-contracts bash
$ npm test
$ npm run coverage
```

#### Shutdown the container
If the container is no longer needed, it can be shutdown:
```bash
Expand Down

0 comments on commit 59aa4bc

Please sign in to comment.