Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,32 @@
**fairyring** is a Cosmos SDK blockchain that leverages identity-based encryption (IBE) to enable pre-execution privacy on Cosmos SDK app-chains.
`fairyring` consists of two main components, a blockchain purpose-built for management of decryption keys in a decentralized manner, as well as a Cosmos SDK module that other app-chains can use to integrate with fairyring.

## Requirement


## Get started

### Compiling & Installing FairyRing chain executable

1. Building fairyring
1. Clone the repo

```bash
git clone https://github.com/Fairblock/fairyring.git && cd fairyring
```

2. Building fairyring

```bash
make build
```

2. Installing the fairyringd
3. Installing the fairyringd

```bash
make install
```

3. Running fairyringd
4. Running fairyringd

```bash
fairyringd
Expand Down Expand Up @@ -57,6 +66,8 @@ fairyringd start

### Running a validator locally with Docker

Make sure that you have installed Docker already

1. Build docker image

```
Expand All @@ -65,6 +76,8 @@ docker build -t fairyring .

2. Setup validator

Chance <moniker> with your name

```
docker run -it -p 1317:1317 -p 9090:9090 -p 26657:26657 -p 26656:26656 -v ~/.fairyring:/root/.fairyring fairyring setup.sh <moniker>
```
Expand Down