Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into teleporter-registry
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Lam committed Oct 19, 2023
2 parents 4cff973 + 63e7132 commit 3c9bc0f
Show file tree
Hide file tree
Showing 29 changed files with 318 additions and 381 deletions.
7 changes: 3 additions & 4 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,11 @@ jobs:

- name: Install solhint
run: |
npm install solhint
npx solhint --version
npm install solhint -g
solhint --version
# "solhint **/*.sol" runs differently than "solhint '**/*.sol'", where the latter checks sol files
# in subdirectories. The former only checks sol files in the current directory and directories one level down.
- name: Run Lint
run: |
cd contracts/src
npx solhint '**/*.sol' --config ./.solhint.json --ignore-path ./.solhintignore --max-warnings 0
./scripts/local/lint.sh
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ The Teleporter protocol, on the other hand, is implemented at the smart contract

- [Overview](#overview)
- [Setup](#setup)
- [Docker Setup](#docker-setup)
- [General Setup](#general-setup)
- [Structure](#structure)
- [Building and Running](#building-and-running)
- [Build + Run + Test](#build--run--test)
- [Run tests on Fuji Testnet](#run-tests-on-fuji-testnet)
- [E2E tests](#e2e-tests)
- [Docs](#docs)
- [Resources](#resources)

Expand Down Expand Up @@ -70,7 +74,7 @@ The above steps are sufficient to run the included integration tests inside Dock
- `scripts/fuji/example-workflows/` includes example workflows that send transactions to interact with Teleporter contracts on Fuji subnets.
- `docker/` includes containerized setup for running a local setup of Teleporter, as well as a script to run each of the integration tests against the local network.

## Building and Running
## Build + Run + Test

- Get all submodules: `git submodule update --init --recursive`
- Install Docker as described in the setup section of the README in the root of this repository.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 3c9bc0f

Please sign in to comment.