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

feat: add foundry in SDK #81

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions docs/starknet/ecosystem/sdks/foundry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: Foundry
sidebar_position: 3
---

> [Foundry](https://github.com/foundry-rs/foundry) is a development environment for Ethereum which is wriiten in Rust

You can clone [this](https://github.com/ChiHaoLu/kakarot-foundry) template repo to begin your Kakarot journey w/ Foundry.

### Setup

You can declare a alias in `foundry.toml`:
```
[profile.default]
src = "src"
out = "out"
libs = ["lib"]
evm_version = 'shanghai' # Kakarot Sepolia supports `PUSH0`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we even support TLOAD / TSTORE -> dencun


[rpc_endpoints]
kakarot_starknet_sepolia = "https://sepolia-rpc.kakarot.org"
```

### Fork Testing

```shell
$ forge test --fork-url "https://sepolia-rpc.kakarot.org"
# or $ forge test --fork-url kakarot_starknet_sepolia
```

### Config Setting

```
[rpc_endpoints]
kakarot_starknet_sepolia = "https://sepolia-rpc.kakarot.org"

[etherscan]
kakarot_starknet_sepolia = { key = "kakarot_starknet_sepolia", chain = 920637907288165, url = "https://api.routescan.io/v2/network/testnet/evm/920637907288165/etherscan" }

```

### Deployment

You can use the deploy script to deploy contract:

```shell
$ forge script ./script/Deploy.s.sol --broadcast --rpc-url "https://sepolia-rpc.kakarot.org"
# or $ forge script ./script/Deploy.s.sol --broadcast --rpc-url kakarot_starknet_sepolia
```

or directly use the [forge command](https://book.getfoundry.sh/reference/forge/forge-create):
```shell
$ forge create <path-to-contract>:<contract-name> --rpc-url "https://sepolia-rpc.kakarot.org" --private-key <your_private_key>
# or $ forge create <path-to-contract>:<contract-name> --rpc-url kakarot_starknet_sepolia --private-key <your_private_key>
```

### Verify

Please make sure your optimizer, solidity version, contract path and address are all correct.

Use the [forge command](https://book.getfoundry.sh/reference/forge/forge-verify-contract) to verify your contract:

```
$ forge verify-contract <your_contract_address> <path-to-contract>:<contract-name> \
--verifier-url 'https://api.routescan.io/v2/network/testnet/evm/920637907288165/etherscan' \
--etherscan-api-key "kakarot_starknet_sepolia" \
--num-of-optimizations 200 \
--compiler-version "v0.8.26+commit.8a97fa7a"
```