foundry-rs / starknet-foundry Goto Github PK

View Code? Open in Web Editor NEW

267.0 267.0 134.0 7.26 MB

Blazing fast toolkit for developing Starknet contracts.

Home Page: https://foundry-rs.github.io/starknet-foundry/

License: MIT License

Rust 83.27% Cairo 15.66% Shell 1.06% JavaScript 0.02%

blockchain cairo cairo-lang dapp framework rust starknet testing toolkit

starknet-foundry's People

Contributors

Stargazers

Watchers

Forkers

ftupas glihm zhu1971 lambda-0x maciektr omahs julio4 enitrat shramee utilitycoder drknzz anshulweb3 binsta 0xgoerlimainnet ametel01 gathin23 amlord dhruvdabhi101 cptartur dubzn tiagofneto nestorbonilla hasselalcala devnet0x tomek0123456789 test-github-fake-user abdulqs llabori-venehsoftw lstan robertkodra dsukruth chrisalexadams nethermindeth 0xicosahedron satyambnsal akhercha ptisserand atreay tensojka bllu404 jainkunal etimfon007 22wright duralsh bilanxsajo primojose koggard02 sstepanova597 svenogor urusalik227 kuhivan22 yalimovserg ilonapilipenko773 imokachov smiral1547 gekalbind anrienk61 alitovcenko157 easternbarpad rustkine kovalev887 lisicinmaksim krchebureck alvika1999 vakulovarit reshetkoev1 spokalini inadezhda452 budnikol215 geregao44 krolovecuu armorbikes trebolklass kinkharo delihusky nikolaevaoksana toninakuznets zajvladislav2 tirgoun ikolomiec838 chernenko3457 koloirgg tereshinkiria miroschvoda iliapostapov polochenko1532 emirbuzina jexudhz burdenkoyol zakruznijasx xiamogucci indev-d kasteph tkumor3 synthwave-systems bluenights004 0xbasar 0xmbcode buldazer23 oxbau

starknet-foundry's Issues

Scarb artifact name change

In new scarb version the artifact name will change. Right now it is:

[package name].starknet_artifacts.json

and it will change to

[target name].starknet_artifacts.json

In most cases target name is the same as package name, but it could be different. We should take a target name from scarb metadata, and use the information to search for starknet_artifacts.json file

starknet-foundry/crates/cast/src/starknet_commands/declare.rs

Line 109 in c045850

name.contains("starknet_artifacts").then_some(entry.path())

Docs for scarb metadata can be found here:
https://docs.rs/scarb-metadata/latest/scarb_metadata/struct.TargetMetadata.html#structfield.name

An example on how we retrieve some metadata can be found here:

starknet-foundry/crates/cast/src/starknet_commands/declare.rs

Line 91 in c045850

let metadata = scarb_metadata::MetadataCommand::new()

Modify dispatchers code in cairo to support error handling

software-mansion/protostar#2161

We should modify code in here https://github.com/starkware-libs/cairo/blob/05d4a9ec46885ac199025f829c9458989c1ddbba/crates/cairo-lang-starknet/src/plugin/dispatcher.rs#L259 to either change default dispatcher behavior, or introduce a separate dispatcher that will not unwrap call results by default.

We should then open a PR in original cairo repo.

Document public methods

software-mansion/protostar#2186

All public methods and structs should have rust docs strings ///. We should verify that docs.rs style docs generate correctly for our library.

@MaksymilianDemitraszek please share your thoughts 🙏

Cast - complete documentation

software-mansion/protostar#2116

docs docs docs
let's get inspired by current protostar docs https://docs.swmansion.com/protostar/docs/cairo-1/interacting-with-starknet
AND by foundry docs https://book.getfoundry.sh/reference/cast/transaction-commands

Allow passing block_number and block_hash as block_id

software-mansion/protostar#2119

Release builds

software-mansion/protostar#2100

We need a pipeline to release rust test runner. Installation as a scrb extension should be also taken into account: https://docs.swmansion.com/scarb/docs/extensions/json-output

Try to use number types to handle hex values

software-mansion/protostar#2182

For now, we use &str to handle hex values, we should try to use number types such as u32 to do this. I spotted that it works nicely with deserialization via Serde.

Request and check a receipt in tests

software-mansion/protostar#2173

Contract deploy tests

software-mansion/protostar#2108

Deploy is already implemented in new runner (cheatcodes_hint_processor.rs). Tests verifying if it actually works should be added. If not, it should be fixed in this or follow-up issue.

Test cases to cover apart from basic cases:

Check if class_hash exists, is correct and declared (and what happens if non-existing one does get passed)
~~Check if contract_address is correct and aligned with the calculated one (and what hapens if incorrect one gets passeed~~) Contract address no longer provided in deploy
Check if the constructor is invoked
Check what happens when constructor panics

Add accesible protostar template with scarb

software-mansion/protostar#1950

Protostar init will be removed after the integration with scarb config. We should provide users a way to bootstrap their projects with scarb and protostar.

Add custom test result class instead of CairoTestRunner's RunResult

software-mansion/protostar#2176

Add tests for wait_for_tx

software-mansion/protostar#2142

Add unit tests for https://github.com/software-mansion/protostar/blob/master/cast/src/lib.rs#L132

Starknet CLI in rust MVP + declare contract command

software-mansion/protostar#1948

Use camino library for paths instead of &str in rust CLI

software-mansion/protostar#2104

Fix cheatcodes panic in rust runner

software-mansion/protostar#2148

Cheatcodes should use HintError::CustomHint or another mechanism so they fail in the way that can be handled by rust vm. Currently if cheatcodes panic for whatever reason, they panic "in rust" and cause the whole runner to fail which cannot be nicely handled.

consider using scarb manifest-path instead of current_dir

software-mansion/protostar#2154

Default arguments from scarb.toml

software-mansion/protostar#2113

Handle `panic_data` in `Deploy`

software-mansion/protostar#2024

Source: https://github.com/software-mansion/protostar/blob/0a0748e80ded1b03392daecda17e65efbce265dc/protostar-rust/src/cheatcodes_hint_processor.rs#L156

Edit:
Most of the errors should not be recoverable, excluding those with txn execution (which is handled by panic_data).

Separately, we should consider avoiding having error_code in cases which we always return 0

Edit2:
Delegated Invokes and Calls error handling to #2156

Fix clap arg default value in rust CLI

software-mansion/protostar#2147

Setup initial starknet foundry book

software-mansion/protostar#2185

Setup initial starknet foundry book. For now let's just create an template and include some content based on current protostar docs.

We can use the same tool as it's used for https://book.getfoundry.sh/ or another tool like docusaurs.

We should use GH pages for hosting.

Drop blockifier fork

Normalize outputs in CLI

software-mansion/protostar#2107

Migrate cheatcodes to use single cheatcode libfunc

software-mansion/protostar#2072

Instead of implementing custom library functions we should use one general library function with signature

extern fn cheatcode<const selector: felt252>(
    input: Span<felt252>
) -> Span<felt252> implicits() nopanic;

All cheatcodes should be implemented using this function

Add testing setup

software-mansion/protostar#2109

Handle dispatchers failed execution in syscall (Invoke/Call)

software-mansion/protostar#2156

Right now, we assert that the execution of invoke/call to contract succeeded and panic if it didn't. The code should be updated so panic data is returned to the test and can be handled.

Hoist common dependencies to workspace

--machine-readable flag for CLI

software-mansion/protostar#2146

Add deploy account command

software-mansion/protostar#2057

Add tests for declare

software-mansion/protostar#2139

Add max-fee arg to declare command

software-mansion/protostar#2125

Implement `StartWarp` cheat code in rust

software-mansion/protostar#1982

Cleanup devnet after tests panic

software-mansion/protostar#2184

When tests panic, the devnet is not being cleaned up. We should try to fix that; one way could be to run:

pkill -f "starknet-devnet.*5055.*1053545548"

before starting it

Add integration tests for specific cheatcodes

software-mansion/protostar#2124

Instead of running e2e tests for each of the cheatcodes, we should design some general e2e tests and only run specific cheatcodes in integration tests. This will avoid having to run a whole application binary for each cheatcode.

Create a crate for handling starknet_artifacts.json file from scarb

software-mansion/protostar#2141

We're handling starknet_artifacts.json file both in all our components. Code for deserializing and handling this file could be moved to a separate crate and used in all of those projects.

Should include swapping code parts in Cast/Forge/Cheatnet which parse the artifacts

Implement `StartRoll` cheat code in rust

software-mansion/protostar#1981