Skip to content

Commit

Permalink
revert changelog accidental formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@cwkang1998
cwkang1998 committed Nov 13, 2024
1 parent a8c1afb commit 0b8f0f7
Showing 1 changed file with 31 additions and 44 deletions.
75 changes: 31 additions & 44 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `account import` can be now used without specifying `--private-key` or `--private-key-file` flags. Instead private key will be read interactively from the user.

#### Fixed

- `account delete` command: It is no longer necessary to provide the `--url` argument each time. Either the `--url` or `--network` argument must be provided, but not both, as they are mutually exclusive.

### Forge
Expand Down Expand Up @@ -98,7 +97,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
#### Changed

- For Scarb >= `2.8.3` contract artifacts are built as part of the test target now. This process speeds up the compilation time, but the behavior of the contracts potentially may not be 100% consistent with the real networks. It can be disabled using the [--no-optimization flag](https://foundry-rs.github.io/starknet-foundry/appendix/snforge/test.html#--no-optimization)
- `snforge` now validates if your project is setup to generate debug info needed for `cairo-coverage` when running `--coverage` flag
- `snforge` now validates if your project is setup to generate debug info needed for `cairo-coverage` when running `--coverage` flag

### `snforge_scarb_plugin`

Expand All @@ -118,7 +117,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
#### Fixed

- `latest` fork block id tag validation in `Scarb.toml` is now consistent
- `RangeCheck96`, `AddMod`, `MulMod` builtins are now properly supported
- `RangeCheck96`, `AddMod`, `MulMod` builtins are now properly supported
- Fixed escaping `'` in `#[should_panic]`s
- Fixed `scarb init` with snforge runner

Expand All @@ -143,29 +142,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Bumped Cairo version to `2.7.0`
- Max steps in tests (configured by argument `--max-n-steps`) now defaults to 10 million
if not provided (changed from 4 million).
if not provided (changed from 4 million).

### Cast

#### Added

- Commands that commit transactions now display links to block explorers. When in human-readable mode, `invoke`, `declare`, `deploy`, `multicall run`, `account create` and `account deploy` will display additional information with an url. A new key in Cast configuration - `block-explorer` determines which block explorer service the displayed link leads to. Possible options are:` StarkScan`, `Voyager`, `ViewBlock`, `OkLink`, `NftScan`.

#### Changed

- `account create` outputs hint about the type of the tokens required to prefund a newly created account with before deployment

- `sncast` no longer expects `--url` as a common argument. It is now required specifically by commands that utilise it, i.e. `account add`, `account create`, `account delete`, `account deploy`, `multicall run`, `script run`, `call`, `declare`, `deploy`, `invoke`, `show-config`, `tx-status`.
Commands that do not require `--url` anymore: `account list`, `multicall new`, `script init`, `verify`
Commands that do not require `--url` anymore: `account list`, `multicall new`, `script init`, `verify`

### Forge

#### Changed

- Fork tests now discover chain ID via provided RPC URL, defaulting to `SN_SEPOLIA`
- `#[fork]` attribute parameters format. [Read more here](https://foundry-rs.github.io/starknet-foundry/snforge-advanced-features/fork-testing.html)
- steps counting
- Block tag changed name from `Latest` to `latest`
- Block tag changed name from `Latest` to `latest`
- `declare` cheatcode now returns `Result<DeclareResult, Array<felt252>>` [Read more here](https://foundry-rs.github.io/starknet-foundry/appendix/snforge-library/declare.html)

## [0.27.0] - 2024-07-24
Expand Down Expand Up @@ -198,9 +194,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Forge

#### Changed

- Updated event testing - read more [here](./docs/src/testing/testing-events.md) on how it now works and [here](./docs/src/appendix/cheatcodes/spy_events.md)
about updated `spy_events` cheatcode
about updated `spy_events` cheatcode

## [0.25.0] - 2024-06-12

Expand All @@ -213,7 +208,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Cast

#### Removed

- `--class-hash` flag from `account deploy` command

#### Added
Expand Down Expand Up @@ -262,19 +256,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
#### Changed

- the tool now always compiles Sierra contract artifacts to CASM using
[`USC`](https://github.com/software-mansion/universal-sierra-compiler) - before it used to consume CASM artifacts
produced by Scarb if they were present. Setting up `casm = true` in `Scarb.toml` is no longer recommended - it may slow
down the compilation.
[`USC`](https://github.com/software-mansion/universal-sierra-compiler) - before it used to consume CASM artifacts
produced by Scarb if they were present. Setting up `casm = true` in `Scarb.toml` is no longer recommended - it may slow
down the compilation.
- The `replace_bytecode` cheatcode now returns `Result` with a possible `ReplaceBytecodeError`, since it may cause unexpected errors down the line when not handled properly

### Cast

#### Changed

- the tool now always compiles Sierra contract artifacts to CASM using
[`USC`](https://github.com/software-mansion/universal-sierra-compiler) - before it used to consume CASM artifacts
produced by Scarb if they were present. Setting up `casm = true` in `Scarb.toml` is no longer recommended - it may slow
down the compilation.
[`USC`](https://github.com/software-mansion/universal-sierra-compiler) - before it used to consume CASM artifacts
produced by Scarb if they were present. Setting up `casm = true` in `Scarb.toml` is no longer recommended - it may slow
down the compilation.

#### Fixed

Expand All @@ -293,7 +287,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `var` now supports `ByteArray` with double quoting, and returns `Array<felt252>` instead of a single `felt252`

#### Removed

- `snforge_std::RevertedTransaction`

## [0.21.0] - 2024-04-03
Expand All @@ -309,7 +302,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
#### Added

- sncast script idempotency feature - every action done by the script that alters the network state will be tracked in state file,
and won't be replayed if previously succeeded
and won't be replayed if previously succeeded

## [0.20.1] - 2024-03-22

Expand Down Expand Up @@ -358,7 +351,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- result of the call to the trace
- added `--build-profile` flag to the `--test` command. Saves trace data and then builds profiles of test cases which pass and are not fuzz tests. You need [cairo-profiler](https://github.com/software-mansion/cairo-profiler) installed on your system.
- dependency on the [universal-sierra-compiler](https://github.com/software-mansion/universal-sierra-compiler)
binary, which will allow forge to be independent of sierra version
binary, which will allow forge to be independent of sierra version


#### Changed

Expand Down Expand Up @@ -458,7 +452,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Forge

#### Added

- Bump to cairo 2.5.0

#### Changed
Expand Down Expand Up @@ -574,7 +567,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `--rerun-failed` option to run tests that failed during the last run.

#### Changed

- `start_warp` and `stop_warp` now take `CheatTarget` as the first argument instead of `ContractAddress`. Read more [here](./docs/src/appendix/cheatcodes/block_timestamp/start_warp.md).
- `start_prank` and `stop_prank` now take `CheatTarget` as the first argument instead of `ContractAddress`. Read more [here](./docs/src/appendix/cheatcodes/caller_address/start_prank.md).
- `start_roll` and `stop_roll` now take `CheatTarget` as the first argument instead of `ContractAddress`. Read more [here](./docs/src/appendix/cheatcodes/block_number/start_roll.md).
Expand Down Expand Up @@ -662,7 +654,7 @@ PS: Credits to @bllu404 for the help with the new interfaces for cheats!
- tests in `src` folder now have to be in a module annotated with `#[cfg(test)]`
- `snforge_std::PrintTrait` will not convert values representing ASCII control characters to strings
- separated `snforge` to subcommands: `snforge test`, `snforge init` and `snforge clean-cache`.
Read more [here](https://foundry-rs.github.io/starknet-foundry/appendix/snforge.html).
Read more [here](https://foundry-rs.github.io/starknet-foundry/appendix/snforge.html).
- `starknet::get_block_info` now returns correct block info in a forked block

### Cast
Expand Down Expand Up @@ -696,15 +688,12 @@ PS: Credits to @bllu404 for the help with the new interfaces for cheats!
### Forge

#### Fixed

- incorrect caller address bug

## [0.8.1] - 2023-10-12

### Forge

#### Fixed

- significantly reduced ram usage

## [0.8.0] - 2023-10-11
Expand Down Expand Up @@ -732,7 +721,7 @@ PS: Credits to @bllu404 for the help with the new interfaces for cheats!
#### Changed

- dropped official support for cairo 1 compiled contracts. While they still should be working without any problems,
from now on the only officially supported cairo compiler version is 2
from now on the only officially supported cairo compiler version is 2

## [0.7.1] - 2023-09-27

Expand All @@ -743,7 +732,6 @@ PS: Credits to @bllu404 for the help with the new interfaces for cheats!
- `var` library function for reading environmental variables

#### Fixed

- Using any concrete `block_id` when using forking mode, would lead to crashes

## [0.7.0] - 2023-09-27
Expand Down Expand Up @@ -863,22 +851,21 @@ snforge_std = { git = "https://github.com/foundry-rs/starknet-foundry", tag = "v

- Moved `ForgeConfigFromScarb` to `scarb.rs` and renamed to `ForgeConfig`
- Made private:
- `print_collected_tests_count`
- `print_running_tests`
- `print_test_result`
- `print_test_summary`
- `TestCaseSummary::from_run_result`
- `TestCaseSummary::skipped`
- `extract_result_data`
- `StarknetArtifacts`
- `StarknetContractArtifactPaths`
- `StarknetContract`
- `print_collected_tests_count`
- `print_running_tests`
- `print_test_result`
- `print_test_summary`
- `TestCaseSummary::from_run_result`
- `TestCaseSummary::skipped`
- `extract_result_data`
- `StarknetArtifacts`
- `StarknetContractArtifactPaths`
- `StarknetContract`
- Split `dependencies_for_package` into separate methods:

- `paths_for_package`
- `corelib_for_package`
- `target_name_for_package`
- `compilation_unit_for_package`
- `paths_for_package`
- `corelib_for_package`
- `target_name_for_package`
- `compilation_unit_for_package`

- Fails test when user tries to use syscalls not supported by forge test runner
- Updated cairo-lang to 2.1.0, starknet-api to 0.4.1 and blockifier to 0.2.0-rc0
Expand Down

0 comments on commit 0b8f0f7

Please sign in to comment.