Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: flashloans docs refactoring #189

Closed
wants to merge 4 commits into from

Conversation

sotnikov-s
Copy link
Contributor

@sotnikov-s sotnikov-s commented Jun 27, 2024

This PR replaces code and text duplications related to neutron-flashloans with links to source code

@sotnikov-s sotnikov-s marked this pull request as ready for review June 27, 2024 11:19
When writing a borrower contract, ensure that the `ProcessLoan` handler has proper permissions. It should only be
callable when your contract has previously requested a loan and only by the `neutron-flashloans` contract.
- **contract address**: TODO add celatone link to the contract instance when deployed
- **usage**: https://github.com/neutron-org/neutron-dao/blob/main/contracts/dao/neutron-flashloans
Copy link
Contributor Author

@sotnikov-s sotnikov-s Jun 27, 2024

Choose a reason for hiding this comment

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

in the future, when we have neutron-dao published to crates.io, this link should be replaced with a link to crates.io/docs.rs/whatever

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should give a link to an example contract that uses the flashloan contract instead? (cause you say usage).

And have a separate link to the actual implementation of Flashloan contract that leads to crate.io

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 got your point. I'll see how to improve it and let you know

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added the link to the neutron-dao PR cuz find it the proper place for it: neutron-org/neutron-dao#108

docs/other_tools/flashloans/overview.md Outdated Show resolved Hide resolved
When writing a borrower contract, ensure that the `ProcessLoan` handler has proper permissions. It should only be
callable when your contract has previously requested a loan and only by the `neutron-flashloans` contract.
- **contract address**: TODO add celatone link to the contract instance when deployed
- **usage**: https://github.com/neutron-org/neutron-dao/blob/main/contracts/dao/neutron-flashloans
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should give a link to an example contract that uses the flashloan contract instead? (cause you say usage).

And have a separate link to the actual implementation of Flashloan contract that leads to crate.io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants