Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typos #1005

Merged
merged 10 commits into from
Dec 22, 2023
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Examples of unacceptable behavior include:
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
* Other conduct that could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
## Directory Structure

<pre>
├── <a href="./bridge-history-api/">bridge-history-api</a>: Bridge history service that collects deposit and withdraw events from both L1 and L2 chain and generates withdrawal proofs
├── <a href="./bridge-history-api/">bridge-history-api</a>: Bridge history service that collects deposit and withdraw events from both L1 and L2 chains and generates withdrawal proofs
├── <a href="./common/">common</a>: Common libraries and types
├── <a href="./coordinator/">coordinator</a>: Prover coordinator service that dispatches proving tasks to provers
├── <a href="./database">database</a>: Database client and schema definition
Expand Down
10 changes: 5 additions & 5 deletions bridge-history-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The bridge-history-api contains three distinct components

### bridgehistoryapi-db-cli

Provide init, show version, rollback, check status services of DB
Provide init, show version, rollback, and check status services of DB
```
cd ./bridge-history-api
make bridgehistoryapi-db-cli
Expand Down Expand Up @@ -35,11 +35,11 @@ provides REST APIs. Please refer to the API details below.
## APIs provided by bridgehistoryapi-server

assume `bridgehistoryapi-server` listening on `https://localhost:8080`
can change this port thru modify `config.json`
can change this port by modifying `config.json`

1. `/txs`
```
// @Summary get all txs under given address
// @Summary get all txs under the given address
// @Accept plain
// @Produce plain
// @Param address query string true "wallet address"
Expand All @@ -61,7 +61,7 @@ can change this port thru modify `config.json`

3. `/claimable`
```
// @Summary get all claimable txs under given address
// @Summary get all claimable txs under the given address
// @Accept plain
// @Produce plain
// @Param address query string true "wallet address"
Expand All @@ -79,4 +79,4 @@ can change this port thru modify `config.json`
// @Param batch_index query string true "batch_index"
// @Success 200
// @Router /api/withdraw_root [get]
```
```
Loading