feat: flashloans docs refactoring #108
Closed
Conversation
This file contains hidden or 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
pr0n00gler
approved these changes
Jun 29, 2024
…s contract readme
…ep-by-step interaction description
sotnikov-s
commented
Jul 1, 2024
Comment on lines
+9
to
+14
| Here's a brief description of what happens when a borrower requests a loan: | ||
| 1. The borrower sends a `RequestLoan` message to the flashloan contract; | ||
| 2. The flashloan contract validates the request and sends the requested amount of funds to the borrower from the source; | ||
| 3. The flashloan contract completes the send message with the `reply` callback by sending a `ProcessLoan` message to the borrower; | ||
| 4. Inside `ProcessLoan`, the borrower processes its custom logic with the loan and refunds the loan amount plus fee to the source; | ||
| 5. The flashloan contract completes the `ProcessLoan` message with the `reply` callback by confirming the loan amount plus fee refund to the source. |
There was a problem hiding this comment.
would be nice to have links to crates.io/docs.rs/whatever instead of RequestLoan and ProcessLoan where a reader can comfy read the descriptions and see the fields
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR moves
neutron-flashloansdescription from README to comments in the code