From 96d2aaac7fdcf4d0d767d4278524f8c428dadc68 Mon Sep 17 00:00:00 2001 From: "Muhammad-Jibril B.A. (Khalifa MBA)" Date: Fri, 12 Apr 2024 06:21:37 +0800 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5eb2ec93..b79fc1db 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,8 @@ Ethical DeFi Suite is the DeFi powerhouse of the Setheum Network, providing all #### 1.2.1. Ethical DeFi Projects: -- `Edfis`: DEX (Decentralized Exchange) +- `Edfis`: Ethical DeFi Suite + - `Edfis Pay`: Decentralised Payments Protocol - `Edfis Exchange`: AMM (Automated Market Maker) DEX Protocol inspired by Uniswap v3 design - `Edfis Launchpad`: Launchpad Crowdsales protocol for bootstrapping pools on Edfis Exchange - `Edfis Launchpool`: Launchpool protocol for bootstrapping pools on Edfis Exchange @@ -90,6 +91,22 @@ Ethical DeFi Suite is the DeFi powerhouse of the Setheum Network, providing all - `Setter`: Unpegged ECDP Stablecoin - `SlickUSD`: USD Pegged ECDP Stablecoin +##### Edfis Pay - Transfers + +Create these measures as a part of `Edfis Pay` so that users can opt-in and out at will. +1. `ensure_account_exists()`: If the account doesn't exist, fail the transaction. +2. `ensure-account_has_ed()`: If the account doesn't have ED, fail the transaction. + +Provide various types of transfer options to users, each of which must handle both `ensure_account_exists()` and `account_has_ed()` options (they are optional for users to use, so they should be of type `Boolean`). + +###### Transfer Types that Handle this issue: +1. `red_packet_transfer`: to `automatically_unlock` the funds to the sender if the receiver does not opened the red packet within `TransferUnlockPeriod` , therefore reversing the transaction. +2. `reclaimable_transfer`: allows the sender to `reclaim` (unlock) the funds if the receiver does not `claim` the transfer within `TransferUnlockPeriod` , therefore reversing the transaction. +3. `willing_transfer`: allows the receiver to `accept` or `reject` the funds. +4. `reversible_willing_transfer`: allows the receiver to `accept` or `reject` the funds. The transfer will automatically unlock if the receiver does not `claim` the transfer within `TransferUnlockPeriod` , therefore reversing the transaction. +5. `protected_transfer`: allows the receiver to `claim` the transfer only if the receiver knows the `password` to the transfer, else the transfer cannot be claimed therefore the `TransferStatus` stays as `Unclaimed`. +6. `reversible_protected_transfer`: allows the receiver to `claim` the transfer only if the receiver knows the `password` to the transfer, else the transfer cannot be claimed. The transfer will `automatically_unlock` the funds to the sender if the receiver does not claim the transfer within `TransferUnlockPeriod`. + ## 2.0. Getting Started This project contains some configuration files to help get started :hammer_and_wrench: