github/scroll

mirror of https://github.com/scroll-tech/scroll.git synced 2026-01-11 06:58:20 -05:00

Files

History

Xi Lin 38f64e70b7 feat(contracts): bench test for ScrollChain (#721 )

Co-authored-by: HAOYUatHZ <37070449+HAOYUatHZ@users.noreply.github.com>
Co-authored-by: HAOYUatHZ <HAOYUatHZ@users.noreply.github.com>
Co-authored-by: Haichen Shen <shenhaichen@gmail.com>
Co-authored-by: zimpha <zimpha@users.noreply.github.com>
Co-authored-by: icemelon <icemelon@users.noreply.github.com>

2023-08-31 23:52:50 -07:00

..

style(contracts): add linter precommit hook for .ts and .sol files (#484 )

2023-06-07 13:21:35 +02:00

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

fix(contracts): check actual number of transactions in each chunk (#887 )

2023-08-31 20:28:54 -07:00

integration-test

feat(contracts): bench test for ScrollChain (#721 )

2023-08-31 23:52:50 -07:00

feat: allow to override L2 deployment when address is provided (#293 )

2023-02-10 14:28:38 +01:00

feat(contracts): add usdc gateway (#426 )

2023-08-29 00:28:29 -07:00

fix(contracts): check actual number of transactions in each chunk (#887 )

2023-08-31 20:28:54 -07:00

.env.example

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

.eslintignore

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

.eslintrc.js

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

.gitignore

build(contracts): use Foundry for deployment scripts (#52 )

2022-11-03 15:52:49 +08:00

.npmignore

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

.prettierignore

style(contracts): reformat contract codes with prettier (#376 )

2023-03-20 13:43:55 +08:00

.prettierrc

feat(contracts): gateway to add enforced transaction (#400 )

2023-05-16 15:13:09 -07:00

.solhint.json

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

.solhintignore

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

circomlib.d.ts

feat(contracts): add ScrollChainCommitmentVerifier (#344 )

2023-03-14 15:49:55 +08:00

foundry.toml

fix(contracts): OZ-L1-L10 Unpinned Compiler Version (#636 )

2023-07-20 20:57:43 +08:00

genesis.json.example

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

hardhat.config.ts

feat(contracts): bench test for ScrollChain (#721 )

2023-08-31 23:52:50 -07:00

package.json

fix(contracts): OZ-L1-L05 Outdated OpenZeppelin Library Version (#622 )

2023-07-20 16:54:43 +08:00

README.md

style(contracts): add linter precommit hook for .ts and .sol files (#484 )

2023-06-07 13:21:35 +02:00

remappings.txt

feat: add contracts (#22 )

2022-10-10 21:04:30 +08:00

tsconfig.json

feat(contracts): add ScrollChainCommitmentVerifier (#344 )

2023-03-14 15:49:55 +08:00

yarn.lock

fix(contracts): OZ-L1-L05 Outdated OpenZeppelin Library Version (#622 )

2023-07-20 16:54:43 +08:00

README.md

Scroll Contracts

Note: For more comprehensive documentation, see ./docs/.

Directory Structure

integration-test
|- xxx.test.ts - "Hardhat integration tests"
lib
|- forge-std - "foundry dependency"
scripts
|- deploy_xxx.ts - "hardhat deploy script"
|- foundry - "foundry deploy scripts"
src
|- test
|  `- xxx.t.sol - "Unit testi in solidity"
`- xxx.sol - "solidity contract"
.gitmodules -  "foundry dependecy modules"
foundry.toml - "configure foundry"
hardhat.config.ts - "configure hardhat"
remappings.txt - "foundry dependency mappings"
...

Dependencies

Foundry

First run the command below to get foundryup, the Foundry toolchain installer:

curl -L https://foundry.paradigm.xyz | bash

If you do not want to use the redirect, feel free to manually download the foundryup installation script from here.

Then, run foundryup in a new terminal session or after reloading your PATH.

Other ways to install Foundry can be found here.

Hardhat

yarn install

Build

Run git submodule update --init --recursive to initialise git submodules.
Run yarn prettier:solidity to run linting in fix mode, will auto-format all solidity codes.
Run yarn prettier to run linting in fix mode, will auto-format all typescript codes.
Run yarn prepare to install the precommit linting hook
Run forge build to compile contracts with foundry.
Run npx hardhat compile to compile with hardhat.
Run forge test -vvv to run foundry units tests. It will compile all contracts before running the unit tests.
Run npx hardhat test to run integration tests. It may not compile all contracts before running, it's better to run npx hardhat compile first.

TODO

unit tests
- L1 Messenger
- L1 Gateways
- L1 Gateway Router
- L2 Messenger
- L2 Gateways
- L2 Gateway Router
- ScrollStandardERC20Factory
- Whitelist
- SimpleGasOracle
integration tests
- ERC20Gateway
- GatewayRouter
ZKRollup contracts
Gas Oracle contracts for cross chain message call
ERC721/ERC115 interface design
add proof verification codes
security analysis