Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

docs: Written content for the liquidity pool advanced tutorial #549

Merged
merged 10 commits into from
Aug 22, 2023

Conversation

ElliotFriend
Copy link
Contributor

The LP tutorial currently just points to the example contract codebase, and provides no additional content/context for what is happening within the contract.

This change adds content in the form of a written guide that describes what is happening in the example contract and a few additional pieces of context/information that could be useful/helpful for developers as they write their own contracts.

A couple minor additional changes in this PR:

  • A TUTORIAL-TEMPLATE.mdx file that can be copied/pasted for new tutorial guides
  • Some minor markdown fixes/nitpicks in a couple other files.

@stellar-jenkins
Copy link

Copy link
Contributor

@Julian-dev28 Julian-dev28 left a comment

Choose a reason for hiding this comment

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

Please check for title case where applicable

docs/advanced-tutorials/fuzzing.mdx Outdated Show resolved Hide resolved
docs/advanced-tutorials/fuzzing.mdx Outdated Show resolved Hide resolved

```
```bash
cd fuzzing
cargo +nightly fuzz run fuzz_target_1
Copy link
Contributor

@Julian-dev28 Julian-dev28 Aug 22, 2023

Choose a reason for hiding this comment

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

Tried running this step and hit the following error

  = note: 0  0x10279471c  __assert_rtn + 140
          1  0x10271eeec  ld::passes::inits::doPass(Options&, ld::Internal&) + 1436
          2  0x1025d0ef8  main + 676
          A linker snapshot was created at:
              /tmp/libsoroban_fuzzing_contract.dylib-2023-08-21-202249.ld-snapshot
          ld: Assertion failed: (index < orderedInitOffsetAtoms.size()), function doPass, file inits.cpp, line 131.
          clang: error: linker command failed with exit code 1 (use -v to see invocation)
          

error: could not compile `soroban-fuzzing-contract` (lib) due to previous error
Error: failed to build fuzz script: ASAN_OPTIONS="detect_odr_violation=0" RUSTFLAGS="-Cpasses=sancov-module -Cllvm-args=-sanitizer-coverage-level=4 -Cllvm-args=-sanitizer-coverage-inline-8bit-counters -Cllvm-args=-sanitizer-coverage-pc-table -Cllvm-args=-sanitizer-coverage-trace-compares --cfg fuzzing -Clink-dead-code -Zsanitizer=address -Cdebug-assertions -C codegen-units=1" "cargo" "build" "--manifest-path" "/Users/julianmartinez/Documents/GitHub/soroban-examples/soroban-examples/fuzzing/fuzz/Cargo.toml" "--target" "aarch64-apple-darwin" "--release" "--bin" "fuzz_target_1"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm merging in the comment from @tyvdh in #550 that seems to resolve this linker error.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've begun working on the timelock example, so I'll dive a bit deeper into the fuzzing example, as well, since they're related. I'll save all that for another PR, though

@stellar-jenkins
Copy link

@stellar-jenkins
Copy link

@ElliotFriend ElliotFriend merged commit 7cb69db into stellar-deprecated:main Aug 22, 2023
2 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants