Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
guoshijiang committed Dec 19, 2024
1 parent 4a5475a commit db78af6
Showing 1 changed file with 25 additions and 34 deletions.
59 changes: 25 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
## Foundry

**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**

Foundry consists of:

- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
- **Chisel**: Fast, utilitarian, and verbose solidity REPL.

## Documentation

https://book.getfoundry.sh/
## Finality Provider Contracts for evm layer2

<!--
parent:
order: false
-->

<div align="center">
<h1> l2-fp-contracts </h1>
</div>

<div align="center">
<a href="https://github.com/dapplink-labs/l2-fp-contracts/releases/latest">
<img alt="Version" src="https://img.shields.io/github/tag/dapplink-labs/l2-fp-contracts.svg" />
</a>
<a href="https://github.com/dapplink-labs/l2-fp-contracts/blob/main/LICENSE">
<img alt="License: Apache-2.0" src="https://img.shields.io/github/license/dapplink-labs/l2-fp-contracts.svg" />
</a>
<a href="https://pkg.go.dev/github.com/dapplink-labs/l2-fp-contracts">
<img alt="GoDoc" src="https://godoc.org/github.com/dapplink-labs/l2-fp-contracts?status.svg" />
</a>
</div>

l2-fp-contracts is a finality bls signature verify and submit stateroot to layer2's contracts in Ethereum(layer1),

## Usage

Expand Down Expand Up @@ -39,28 +49,9 @@ $ forge fmt
$ forge snapshot
```

### Anvil

```shell
$ anvil
```

### Deploy

```shell
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
```

### Cast

```shell
$ cast <subcommand>
$ forge script script/deployFinalityRelayer.s.sol:deployFinalityRelayerScript --rpc-url <your_rpc_url> --private-key <your_private_key> --broadcast
```

### Help

```shell
$ forge --help
$ anvil --help
$ cast --help
```

0 comments on commit db78af6

Please sign in to comment.