-
Notifications
You must be signed in to change notification settings - Fork 24
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
ChiHaoLu
wants to merge
3
commits into
kkrt-labs:main
Choose a base branch
from
ChiHaoLu:add-foundry
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` | ||
|
||
[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" | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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