Skip to content

Commit

Permalink
📝 Add recording to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lukacan committed Aug 29, 2024
1 parent 87ed8ea commit 444cc4d
Show file tree
Hide file tree
Showing 8 changed files with 14,750 additions and 17 deletions.
40 changes: 29 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ incremented upon a breaking change and the patch version will be incremented for
## [dev] - Unreleased

## [0.7.0] - 2024-08-14
### Added

**Added**

- impr/ add feature flag to the AccountsSnapshots macro ([183](https://github.com/Ackee-Blockchain/trident/pull/183))
- feat/ add Support for CPI ([182](https://github.com/Ackee-Blockchain/trident/pull/182))
- feat/ add option to initialize Trident with Macro/File (for Snapshots) option based on preference ([179](https://github.com/Ackee-Blockchain/trident/pull/179))
Expand All @@ -20,17 +22,21 @@ incremented upon a breaking change and the patch version will be incremented for
- feat/unify dependencies provided by the Trident ([#172](https://github.com/Ackee-Blockchain/trident/pull/172))
- feat/fuzzer-stats-logging, an optional statistics output for fuzzing session ([#144](https://github.com/Ackee-Blockchain/trident/pull/144))

### Fixed
**Fixed**

- fix/in case of fuzzing failure throw error instead of only printing message ([#167](https://github.com/Ackee-Blockchain/trident/pull/167))
- fix/snapshot's zeroed account as optional ([#170](https://github.com/Ackee-Blockchain/trident/pull/170))

### Removed
**Removed**

- del/remove localnet subcommand ([178](https://github.com/Ackee-Blockchain/trident/pull/178))
- del/remove unnecessary fuzzing feature as trident is mainly fuzzer ([#176](https://github.com/Ackee-Blockchain/trident/pull/176))
- del/remove Trident explorer ([#171](https://github.com/Ackee-Blockchain/trident/pull/171))

## [0.6.0] - 2024-05-20
### Added

**Added**

- feat/anchor 0.30.0 support ([#148](https://github.com/Ackee-Blockchain/trident/pull/148))
- fix/allow to process duplicate transactions ([#147](https://github.com/Ackee-Blockchain/trident/pull/147))
- feat/possibility to implement custom transaction error handling ([#145](https://github.com/Ackee-Blockchain/trident/pull/145))
Expand Down Expand Up @@ -61,7 +67,8 @@ incremented upon a breaking change and the patch version will be incremented for
- feat/automatically add hfuzz_target to .gitignore file ([#99](https://github.com/Ackee-Blockchain/trident/pull/99))
- feat/support for dynamic templates. ([#98](https://github.com/Ackee-Blockchain/trident/pull/98))

### Fixed
**Fixed**

- fix/refactored fuzz test executor error handling ([#127](https://github.com/Ackee-Blockchain/trident/pull/127))
- fix/warn user on composite accounts and continue fuzz test generation ([#133](https://github.com/Ackee-Blockchain/trident/pull/133))
- fix/progress bar loop lock release ([#132](https://github.com/Ackee-Blockchain/trident/pull/132))
Expand All @@ -71,27 +78,38 @@ incremented upon a breaking change and the patch version will be incremented for


## [0.5.0] - 2023-08-28
### Added

**Added**

- cli: Added trident subcommand `fuzz` to run and debug fuzz tests using honggfuzz-rs.
- cli: Added trident `--skip-fuzzer` option for `init` subcommand to skip generation of fuzz test templates.
- client: Added new Cargo feature `fuzzing` that enables optional dependencies related to fuzz testing.

## [0.4.1] - 2023-08-21
### Changed

**Changed**

- Upgrade Solana (`=1.16.6`) and Anchor framework (`=0.28.0`) versions.
### Fixed

**Fixed**

- Implemented Anchor Client logic was not able to work with newer version of Anchor. Fixed with `async_rpc` and `async` feature.
- Trident init IDL Parse Error on newer version of Rust, fixed with updated `accounts` token.


## [0.3.0] - 2022-09-23
### Changed

**Changed**

- Upgrade Solana (`~1.10`) and Anchor framework (`~0.25`) versions

### Added
**Added**

- Custom Solana RPC error reporter. If the Solana RPC error is thrown, the error code, message and data (logs) are reported to the output.
- Custom imports in the `.program_client`. User is able to import custom types and structures into program client. The import part of the code would not be re-generated.

## [0.2.0] - 2022-07-27
### Added

**Added**

- Trident is now configurable. This requires `Trident.toml` file to exist in the project's root directory - without this file the execution will fail. To solve this re-run `trident init` or just create an empty `Trident.toml` file in the project's root directory.
5 changes: 3 additions & 2 deletions documentation/docs/fuzzing/execute/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ To debug your program with values from a crash file:
```bash
# fuzzer will run the <TARGET_NAME> with the specified <CRASH_FILE_PATH>
trident fuzz run-debug <TARGET_NAME> <CRASH_FILE_PATH>
# for example:
trident fuzz run-debug fuzz_0 trident-tests/fuzz_tests/fuzzing/fuzz_0/cr1.fuzz
```

!!! tip

By default, the crashfiles are stored in the `trident-tests/fuzz_tests/fuzzing/hfuzz_workspace/<FUZZ_TARGET>`.

## Debug Output

Expand Down
8 changes: 4 additions & 4 deletions documentation/docs/fuzzing/first-steps/writing-fuzz-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
For better fuzzing results and experience you can also manually adjust the following:

1. Define Invariants checks [Invariants Checks](../writing-fuzz-test-extra/invariants-checks.md).
2. Specify instruction sequences[Instruction sequences](../writing-fuzz-test-extra/instruction-sequences.md).
3. Specify custom data types[Custom Data types](../writing-fuzz-test-extra/custom-data-types.md).
4. Well structured data[Arbitrary](../writing-fuzz-test-extra/arbitrary.md).
4. AccountsSnapshots macro[AccountsSnapshots](../writing-fuzz-test-extra/accounts-snapshots.md).
2. Specify instruction sequences [Instruction sequences](../writing-fuzz-test-extra/instruction-sequences.md).
3. Specify custom data types [Custom Data types](../writing-fuzz-test-extra/custom-data-types.md).
4. Well structured data [Arbitrary](../writing-fuzz-test-extra/arbitrary.md).
4. AccountsSnapshots macro [AccountsSnapshots](../writing-fuzz-test-extra/accounts-snapshots.md).
Loading

0 comments on commit 444cc4d

Please sign in to comment.