Skip to content

Commit

Permalink
Remove bold from headers
Browse files Browse the repository at this point in the history
  • Loading branch information
StanislavBreadless committed Apr 26, 2021
1 parent 18a6471 commit 38a051d
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 28 deletions.
20 changes: 10 additions & 10 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document covers development-related actions in zkSync.

## **Initializing the project**
## Initializing the project

To setup the main toolkit, `zk`, simply run:

Expand Down Expand Up @@ -50,7 +50,7 @@ zk up # Set up `geth` and `postgres` containers
zk down # Shut down `geth` and `postgres` containers
```

## **Committing changes**
## Committing changes

`zksync` uses pre-commit and pre-push git hooks for basic code integrity checks. Hooks are set up automatically
withinthe workspace initialization process. These hooks will not allow to commit the code which does not pass several
Expand All @@ -62,7 +62,7 @@ Currently the following criteria are checked:
- Other code should always be formatted via `zk fmt`.
- Dummy Prover should not be staged for commit (see below for the explanation).

## **Using Dummy Prover**
## Using Dummy Prover

Using the real prover for the development can be not really handy, since it’s pretty slow and resource consuming.

Expand Down Expand Up @@ -99,7 +99,7 @@ $ zk dummy-prover status
Dummy Prover status: disabled
```

## **Database migrations**
## Database migrations

zkSync uses PostgreSQL as a database backend, and `diesel-cli` for database migrations management.

Expand Down Expand Up @@ -130,7 +130,7 @@ Adding a new migration requires the following actions:
zk test db
```

## **Testing**
## Testing

- Running the `rust` unit-tests (heavy tests such as ones for `circuit` and database will not be run):

Expand Down Expand Up @@ -181,7 +181,7 @@ zk test db
**Note**. If you have compilation issues with `sqlx`, then make sure to run `zk up` before running the tests. Also,
ifyou see some tests fail, might need to call `zk db reset` and restart the tests.

## **Developing circuit**
## Developing circuit

- To generate proofs one must have the universal setup files (which are downloaded during the first initialization).
- To verify generated proofs one must have verification keys. Verification keys are generated for specific circuit
Expand All @@ -194,21 +194,21 @@ Steps to do after updating circuit:
2. Regenerate verification keys and Verifier contract using `zk run verify-keys gen` command.
3. Pack generated verification keys using `zk run verify-keys pack` command and commit resulting file to repo.

## **Build and push Docker images to dockerhub**
## Build and push Docker images to dockerhub

```
zk docker push <IMAGE>
```

## **Contracts**
## Contracts

### **Re-build contracts**
### Re-build contracts

```
zk contract build
```

### **Publish source code on etherscan**
### Publish source code on etherscan

```
zk contract publish
Expand Down
14 changes: 7 additions & 7 deletions docs/launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

This document covers common scenarios of launching zkSync applications set locally.

## **Prerequisites**
## Prerequisites

Prepare dev environment prerequisites: see

[Installing dependencies](./setup-dev.md)

## **Setup local dev environment**
## Setup local dev environment

Setup:

Expand Down Expand Up @@ -40,13 +40,13 @@ simplylaunch:
zk up
```

## **(Re)deploy db and contraсts**
## (Re)deploy db and contraсts

```
zk contract redeploy
```

## **Environment configurations**
## Environment configurations

Env config files are held in `etc/env/`

Expand All @@ -65,7 +65,7 @@ zk env <ENV_NAME>
Default confiruration is `dev.env`, which is generated automatically
from `dev.env.example` during `zk init` commandexecution.

## **Build and run server + prover locally for development**
## Build and run server + prover locally for development

Run server:

Expand Down Expand Up @@ -95,7 +95,7 @@ see `* dev` inoutput.

## Troubleshooting

### **SSL error: certificate verify failed**
### SSL error: certificate verify failed

**Problem**`zk init` fails with the following error:

Expand All @@ -106,7 +106,7 @@ SSL error: certificate verify failed

**Solution**. Make sure that the version of `axel` on your computer is `2.17.10`.

### **rmSync is not a function**
### rmSync is not a function

**Problem**`zk init` fails with the following error:

Expand Down
22 changes: 11 additions & 11 deletions docs/setup-dev.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installing dependencies

## **`Docker`**
## `Docker`

Install `docker`. It is recommended to follow the instructions from the
[official site](https://docs.docker.com/install/).
Expand Down Expand Up @@ -34,7 +34,7 @@ solvedat this step.

If logging out does not help, restarting the computer should.

## **`Node` & `Yarn`**
## `Node` & `Yarn`

1. Install `Node` (requires version 14.14.0 or higher). Since our team attempts to always use the latest LTS version
of`Node.js`, we suggest you to install [nvm](https://github.com/nvm-sh/nvm). It will allow you to
Expand All @@ -45,7 +45,7 @@ If logging out does not help, restarting the computer should.
official website. It contains a lot of troubleshootingguides in it.
3. Run `yarn global add @vue/cli-service`

## **`Axel`**
## `Axel`

Install `axel` for downloading keys:

Expand All @@ -69,7 +69,7 @@ axel --version

Make sure the version is `2.17.10`.

## **`Rust`**
## `Rust`

Install the latest `rust` version.

Expand All @@ -82,7 +82,7 @@ rustc --version
rustc 1.48.0 (7eac88abb 2020-11-16)
```

### **`lld`**
### `lld`

Optionally, you may want to optimize the build time with the LLVM linker, `lld`. Make sure you have it installed and
append `"-C", "link-arg=-fuse-ld=lld"` to the `rustflags` in your `.cargo/config` file, so it looks like this:
Expand All @@ -96,7 +96,7 @@ rustflags = [

**Warning:** This is only viable for linux since `lld` doesn’t work on mac.

## **PSQL**
## PSQL

Install `psql` CLI tool to interact with postgres.

Expand All @@ -106,7 +106,7 @@ On debian-based linux:
sudo apt-get install postgresql-client
```

## **`Diesel` CLI**
## `Diesel` CLI

Install `[diesel](https://diesel.rs/)` CLI (it is used for migrations management only):

Expand All @@ -128,7 +128,7 @@ If you still see the errors, install the `build-essential` package. On debian-
sudo apt install build-essential
```

## **`sqlx` CLI**
## `sqlx` CLI

Also, we need `[sqlx](https://github.com/launchbadge/sqlx)` CLI (it is used to generate database wrappers):

Expand Down Expand Up @@ -160,7 +160,7 @@ export OPENSSL_DIR=/usr/local/ssl
sudo apt-get install -y pkg-config
```

## **`solc`**
## `solc`

You have to install `solc` v0.5.16. Instructions can be found at
[readthedocs](https://solidity.readthedocs.io/en/v0.6.2/installing-solidity.html).
Expand Down Expand Up @@ -189,7 +189,7 @@ Finally, to prevent pacman from upgrading it, add this line to your /etc/pacman.
IgnorePkg = solidity
```

## **drone cli**
## drone cli

drone cli used to create promotion jobs [described here](https://docs.drone.io/cli/install/).

Expand All @@ -201,7 +201,7 @@ Required by `binaryen` to build C++ sources. In order to speed it up, you might
sudo apt-get install cmake clang lld
```

## **Environment**
## Environment

Edit the lines below and add them to your shell profile file (e.g. `~/.bash_profile`):

Expand Down

0 comments on commit 38a051d

Please sign in to comment.