Skip to content

Commit

Permalink
fix typos in readme (#276)
Browse files Browse the repository at this point in the history
* fix typos in readme

* Capitalize first word in lists
  • Loading branch information
benschac authored Feb 21, 2023
1 parent 13afc77 commit e1e460e
Showing 1 changed file with 49 additions and 47 deletions.
96 changes: 49 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Entropy Core

This repo contains the Entropy blockchain node, the validator server (evaulates constraints, stores threshold keyshares, and coordinates threshold-signing), and misc. testing utilities for the network.
This repo contains the Entropy blockchain node, the validator server (evaluates constraints, stores threshold keyshares, and coordinates threshold-signing), and misc. testing utilities for the network.

Our blockchain node is written with Substrate, and its documentation can be found [here](https://github.com/substrate-developer-hub/substrate-node-template).

Expand Down Expand Up @@ -41,14 +41,11 @@ RUST_BACKTRACE=1 ./target/release/entropy -ldebug --dev --ws-external
### Connect with Polkadot-JS Apps Front-end

Once the node template is running locally, you can connect it with **Polkadot-JS Apps** front-end
to interact with your chain. [Click
here](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944) connecting the Apps to your
local node template.
to interact with your chain. [Click here](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944) connecting the Apps to your local node template.

### Run in Docker

First, install [Docker](https://docs.docker.com/get-docker/) and
[Docker Compose](https://docs.docker.com/compose/install/).
First, install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).

Then run the following command to start a single node development chain.

Expand All @@ -75,72 +72,77 @@ by appending your own. A few useful ones are as follow.
## Testnet

- Currently our network requires 2 binaries
- ``` cargo build --release ``` will build both
- to run both you can reference /scripts/sdk-entropy-node.sh for the chain and /scripts/sdk-alice-tss.sh for the threshold client
- `cargo build --release` will build both
- To run both you can reference /scripts/sdk-entropy-node.sh for the chain and /scripts/sdk-alice-tss.sh for the threshold client

### Changing Defaults

### changing defaults
- All defaults are ready to go out the box but can be changed if needed with varying degrees of difficult

* all defaults are ready to go out the box but can be changed if needed with varying degrees of difficult
- to change chain address away from default ws://127.0.0.1:9944 you need to inform the sig client which can be done with the env variable ```export ENDPOINT=```
- To change the default of the sig client from ```http://127.0.0.1:3001/sign``` you need to tell the chain after it is running by making an rpc call. Example code can be found here ```https://github.com/entropyxyz/util-scripts/blob/master/setEndpoint.ts```. You also need to maintain the route as /sign
- To change chain address away from default ws://127.0.0.1:9944 you need to inform the sig client which can be done with the env variable `export ENDPOINT=`
- To change the default of the sig client from `http://127.0.0.1:3001/sign` you need to tell the chain after it is running by making an rpc call. Example code can be found here `https://github.com/entropyxyz/util-scripts/blob/master/setEndpoint.ts`. You also need to maintain the route as /sign

## Threshold keys
## Threshold Keys

* keys for internal testnet use only, not secure, here for convience do not use them for anything real
- Keys for internal testnet use only, not secure, here for convenience do not use them for anything real

#### Alice

Alice
Secret phrase `alarm mutual concert decrease hurry invest culture survey diagram crash snap click` is account:
Network ID/version: substrate
Secret seed: 0x29b55504652cedded9ce0ee1f5a25b328ae6c6e97827f84eee6315d0f44816d8
Public key (hex): 0xe0543c102def9f6ef0e8b8ffa31aa259167a9391566929fd718a1ccdaabdb876
Account ID: 0xe0543c102def9f6ef0e8b8ffa31aa259167a9391566929fd718a1ccdaabdb876
SS58 Address: 5H8qc7f4mXFY16NBWSB9qkc6pTks98HdVuoQTs1aova5fRtN
Network ID/version: `substrate`
Secret seed: `0x29b55504652cedded9ce0ee1f5a25b328ae6c6e97827f84eee6315d0f44816d8`
Public key (hex): `0xe0543c102def9f6ef0e8b8ffa31aa259167a9391566929fd718a1ccdaabdb876`
Account ID: `0xe0543c102def9f6ef0e8b8ffa31aa259167a9391566929fd718a1ccdaabdb876`
SS58 Address: `5H8qc7f4mXFY16NBWSB9qkc6pTks98HdVuoQTs1aova5fRtN`

#### Bob

Bob
Secret phrase `where sight patient orphan general short empower hope party hurt month voice` is account:
Network ID/version: substrate
Secret seed: 0xb0b5348db82db32d10a37b578e4c6242e148f14648661dccf8b3002fafa72cdd
Public key (hex): 0x2a8200850770290c7ea3b50a8ff64c6761c882ff8393dc95fccb5d1475eff17f
Account ID: 0x2a8200850770290c7ea3b50a8ff64c6761c882ff8393dc95fccb5d1475eff17f
SS58 Address: 5D2SVCUkK5FgFiBwPTJuTN65J6fACSEoZrL41thZBAycwnQV
Network ID/version: `substrate`
Secret seed: `0xb0b5348db82db32d10a37b578e4c6242e148f14648661dccf8b3002fafa72cdd`
Public key (hex): `0x2a8200850770290c7ea3b50a8ff64c6761c882ff8393dc95fccb5d1475eff17f`
Account ID: `0x2a8200850770290c7ea3b50a8ff64c6761c882ff8393dc95fccb5d1475eff17f`
SS58 Address: `5D2SVCUkK5FgFiBwPTJuTN65J6fACSEoZrL41thZBAycwnQV`

## Running Devnet

* devnet requires 2 validator nodes, 2 threshold clients running on the same machine
- Devnet requires 2 validator nodes, 2 threshold clients running on the same machine

- open 5 terminals lol
- Open 5 terminals lol

- In terminal 1 set up chain 1
- ```cargo build --release```
- ```./scripts/alice.sh```

- `cargo build --release`
- `./scripts/alice.sh`

- In terminal 2 run alice threshold client
- ```cargo build --release --features="alice unsafe"```
- ```./scripts/server.sh```

- In termainl 3 run chain 2
- ```./scripts/bob.sh```
- `cargo build --release --features="alice unsafe"`
- `./scripts/server.sh`

- In terminal 3 run chain 2

- `./scripts/bob.sh`

- In termainl 5run bob threshold client
- ```cargo build --release --features="bob unsafe"```
- ```./scripts/server_bob.sh```
- In terminal 5run bob threshold client
- `cargo build --release --features="bob unsafe"`
- `./scripts/server_bob.sh`

With all 4 nodes running the chain is now working, next we now have a clash where both chains by default send their OCW messages to port 3001, you need to change one of those

- from this repo <https://github.com/entropyxyz/util-scripts>
- need to setup the repo and link the wasm first
- ```cd pkg```
- ```npm link```
- ```cd ..```
- ```npm link x25519-chacha20poly1305-wasm```
- run setEndpoint.ts
- ```ts-node setEndpoint.ts```
- From this repo <https://github.com/entropyxyz/util-scripts>
- Need to setup the repo and link the wasm first
- `cd pkg`
- `npm link`
- `cd ..`
- `npm link x25519-chacha20poly1305-wasm`
- Run setEndpoint.ts
- `ts-node setEndpoint.ts`

next register

- ```ts-node register.ts```
- `ts-node register.ts`

now you can sign

- ```ts-node sign.ts```
- `ts-node sign.ts`

0 comments on commit e1e460e

Please sign in to comment.