From ff3fcd39aca9e52c9a44b7e73a924f54aa7c44c0 Mon Sep 17 00:00:00 2001 From: Jasso Date: Sun, 19 Nov 2023 06:54:13 +0300 Subject: [PATCH] update readme.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 261d954..bb5d79f 100644 --- a/README.md +++ b/README.md @@ -66,10 +66,15 @@ The Anti Money Laundry Agent is an off chain bot that uses a risk scoring API to Users that wish to prove to that Anti Money Landry Agent that they are not malicious must always exclude all the UTXOs in the agent's list from their inclusion proofs. If they do not exclude all the UTXOs in the list, the agent will flag their transaction as malicious and the user will not be able to interact with off chain agents that use the Anti Money Laundry Agent as their compliance threshold. +The agent listens to all transactions into the protocol and performs the following evaluation: +1. If the transaction is a deposit, it fetches the risk score of the deposit's UTXO from the risk scoring API +2. If the transaction is a withdrawal or an internal transfer, it evaluates the subset membership proof provided with the transaction. If it successfully excludes all UTXOs considered malicious or not +3. If either evaluation (1) or (2) does not pass, all UTXOs created by the transaction are deemed to be invalid and are added to the list of malicious UTXOs + **more considerations regarding the AML agent are given in the agent package's readme.md file** -### Metamask Snap frontend +### Frontend -The frontend is a metamask snap that allows users to deposit and withdraw funds from the protocol. It can be used as a model that integrates with any Anti Money Laundry Agent. The snap fetches the denylist from the AML agent and uses that as a base for their subset proofs. +The frontend is a simple interface through which the user can interact with the protocol. It creates a key pair to be used inside of the protocol and keeps track of the user's UTXOs. It also creates the inclusion proofs for each transaction and fetches the list of malicious UTXOs from the AML agent. -**more considerations regarding the snap frontend are given in the site and snap packages' readme.md files** \ No newline at end of file +**more considerations regarding the frontend are given in the front package's readme.md files** \ No newline at end of file