feat: Added examples package with commands and flashloan examples

[mpsc0x]

No description provided.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@64c9c1d). Learn more about missing BASE report.
⚠️ Report is 15 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #51   +/-   ##
=======================================
  Coverage        ?   97.09%           
=======================================
  Files           ?       16           
  Lines           ?      516           
  Branches        ?        0           
=======================================
  Hits            ?      501           
  Misses          ?       15           
  Partials        ?        0           

Flag	Coverage Δ
move	97.09% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[meng-xu-cs]

Since this Move script is purely demonstrative purpose and is not part of the Aave protocol, I wouldn't recommend putting it under the aave-core directory, nor have it linked up with the Makefile.

Instead, if possible, we can have an examples or tutorial directory and put the flashloan scripts as a Move package there, i.e.,

<git-repo-directory>/examples/flashloan where in this directory we have Move.toml which already hardcode the addresses of relevant Aave packages in the .toml file (instead of passing them via the Makefile).

Users should be able to invoke the Move scripts via aptos move run-script command under that examples/flashloan directory.

[matchv]

Agree with @meng-xu-cs that we better create a separate folder for this script.

[mpsc0x]

Since this Move script is purely demonstrative purpose and is not part of the Aave protocol, I wouldn't recommend putting it under the aave-core directory, nor have it linked up with the Makefile.

Instead, if possible, we can have an examples or tutorial directory and put the flashloan scripts as a Move package there, i.e.,

<git-repo-directory>/examples/flashloan where in this directory we have Move.toml which already hardcode the addresses of relevant Aave packages in the .toml file (instead of passing them via the Makefile).

Users should be able to invoke the Move scripts via aptos move run-script command under that examples/flashloan directory.

I followed your advice and have moved the package into examples now. There is a separate Makefile inside examples as the commands are quite complex and I wanted the users to be guided all the way. Also, I have decided not to hardcore the values as we can elegantly pass them through the Makefile command without polluting the example. I find it more elegant and it naturally follows the root Makefile idea and structure. I have also added a pipeline compile check for them and updated the README. cc @matchv @meng-xu-cs

[matchv]

lgtm