Add a project for FlashyFi

Author: backyard-coder

7-defi-devpost/flashyfi/.gitignore

@@ -0,0 +1 @@
+.idea

7-defi-devpost/flashyfi/README.md

@@ -0,0 +1,71 @@
+# FlashyFi
+
+FlashyFi is an application that leverages several powerful features of Radix to enable a completely new approach
+to flash loans. Unlike other flash loan applications that require users to deposit their tokens into a liquidity pool,
+FlashyFi allows each user to lend their tokens and NFTs without ever transferring them out of their accounts.
+
+With many other flash loan applications, the tokens to be lent must first be locked in a smart contract, preventing them
+from being used, traded, or transferred directly until they are withdrawn from the contract. However, FlashyFi takes a
+different approach by keeping all tokens in their user's account and allowing a central component to temporarily
+withdraw them, lend them to another user and return them before the transaction ends. As each flash loan lasts only for
+the duration of a single transaction, the tokens never truly leave the account.
+
+# Demo
+
+A demo frontend is available at https://backyard-coder.github.io/flashyfi  
+Please take a look at the about page for some usage instructions and a discussion of the demo's limitations.
+
+The publicly hosted frontend is offered as a bonus and should not be the basis for evaluation. The evaluation should be
+based solely on the code in the pull request. While I promise that I will not make any substantial changes to the
+application after the submission deadline, I reserve the right to fix bugs that significantly affect the liveness or
+functionality of the application.
+
+If you would like to deploy the frontend locally, you can follow the instructions described in the
+[frontend README](flashyfi-frontend/README.md).
+
+## Technical implementation
+
+FlashyFi is built on the following two characteristic features of the Radix network:
+
+- Transient resources: Transient resources can be used to securely implement flash loans. A user who takes out a loan
+  receives not only the lent tokens but also a special receipt NFT. As long as this NFT exists the transaction cannot
+  succeed. It thus acts as a safety, preventing the user from taking the loan and then ending the transaction
+  without repaying it. The only way to destroy the NFT is to give it back to the FlashyFi component, which will only
+  accept it if the loan is repaid.
+- Flexible access rule model: The Radix network has a flexible and powerful mechanism for defining access rules,
+  including the ability to exchange factors/keys that grant access to an account. FlashyFi takes advantage of this
+  feature and defines the account access rules such that not only the user but also the central FlashyFi component can
+  withdraw tokens from the account. This is secure because the FlashyFi component always returns the withdrawn tokens.
+
+For the technical details please take a look at the [Scrypto source code](flashyfi-scrypto/src/flashyfi.rs) as it
+contains extensive documentation.
+
+## Lender Usage
+
+To lend tokens, users must first "flashyfi" their account by registering it with the central FlashyFi component and
+granting that component access to the resources held in the account. Users can use the demo frontend to define which
+tokens or NFTs they want to lend and for what fee. Experienced Scryptonauts may examine the transaction manifests shown
+in their wallets to learn what's going on in the background.
+
+## Borrower Usage
+
+As a borrower, one would likely use flash loans in the context of automated processes, such as exploiting arbitrage
+opportunities. For this, a backend API would be required. This backend would select the optimal accounts from which to
+borrow each resource and would take into account the fees set by the account owner.
+
+As such a backend is unsuitable for demonstrations, the FlashyFi frontend includes the ability to simulate a flash loan.
+To do this, visit the app's homepage, select a resource, specify an amount to borrow and a transaction manifest will be
+generated for you. This manifest performs/simulates the following 4 steps:
+
+1. Borrow tokens from one or more accounts
+2. Exploit an arbitrage opportunity (in the generated manifest, the XRD Faucet component is used for this).
+3. Repay the borrowed tokens and pay the fee incurred.
+4. Deposit the profit generated, if any, into your account.
+
+## Outlook
+
+Currently, FlashyFi is primarily designed for many users to lend tokens from their individual accounts.
+However, the FlashyFi blueprint is flexible enough to connect not only account components but also any other components
+that implement the methods `withraw_by_amount`, `withraw_by_ids` and `deposit_batch`. This enables users to integrate
+components holding significantly more liquidity, such as AMM-style DEXs, giving a second purpose to the tokens that are
+currently locked away in those components.

7-defi-devpost/flashyfi/flashyfi-frontend/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*

7-defi-devpost/flashyfi/flashyfi-frontend/.npmrc

@@ -0,0 +1 @@
+engine-strict=true

7-defi-devpost/flashyfi/flashyfi-frontend/README.md

@@ -0,0 +1,28 @@
+# flashyfi-frontend
+
+The demo frontend is publicly available at https://backyard-coder.github.io/flashyfi
+
+If the public website has fallen victim to the ruthless grasp of the internet, or you just feel like running a test
+locally, simply execute the bellow commands.
+
+```shell
+npm install
+npm run dev -- --open
+```
+
+A possible failure mode is users smuggling data onto the Radix network that this frontend is not equipped to handle. I
+have taken some measures to guard against adversarial behavior but if those prove ineffective, you will probably have to
+perform your tests on a newly instantiated component of the FlashyFi blueprint.
+
+To instantiate a new component, submit the following manifest:
+
+```
+CALL_FUNCTION
+    PackageAddress("package_tdx_b_1q9lyy7eyqj05z8sywc82ajaxfzsrmcn3a4h9mmc063nsp0nvjg")
+    "Flashyfi"
+    "instantiate_global"
+    false;
+```
+
+You will then have to update the value of the `FLASHYFI_COMPONENT_ADDRESS` variable under `src/lib/constants` with the
+new component address.

7-defi-devpost/flashyfi/flashyfi-frontend/gh-pages.js

@@ -0,0 +1,17 @@
+import { publish } from 'gh-pages';
+
+publish(
+    'build', // path to public directory
+    {
+        branch: 'gh-pages',
+        repo: '[email protected]:backyard-coder/flashyfi.git',
+        user: {
+            name: 'backyard-coder',
+            email: '[email protected]'
+        },
+        dotfiles: true
+    },
+    () => {
+        console.log('Deploy Complete!');
+    }
+);