From d3ced833c297a29f668f366fa2c26663d41d8674 Mon Sep 17 00:00:00 2001 From: BokkyPooBah Date: Tue, 19 Dec 2023 13:22:39 +1100 Subject: [PATCH] docs --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 795fb5a..87912ea 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ # ApprovalTool -Lightweigh tool to manage your approvals for ERC-20, ERC-721 and ERC-1155 contracts. +Lightweigh web3 dapp tool to manage your approvals for ERC-20, ERC-721 and ERC-1155 contracts. -To be run from GitHub pages at [https://bokkypoobah.github.io/ApprovalTool/](https://bokkypoobah.github.io/ApprovalTool/), or locally by cloning this repo and running e.g. [anywhere](https://www.npmjs.com/package/anywhere) in the ./docs folder +
+ +--- + +### How This Works + +* This tool scans for ERC-20, ERC-721 and ERC-1155 *Approval* and *ApprovalForAll* log events with the first parameter being the owner account being searched for. This is done using the `getFilter(...)` web3 call. +* These event logs are process to determine the approval states for the various ERC-20, ERC-721 and ERC-1155 contracts +* Aside from the web3 call to retrieve log events, this tool retrieves block timestamps from [https://api.thegraph.com/subgraphs/name/blocklytics/ethereum-blocks](https://api.thegraph.com/subgraphs/name/blocklytics/ethereum-blocks) + +
+ +--- + +### Running This Dapp + +* Run directly from [https://bokkypoobah.github.io/ApprovalTool/](https://bokkypoobah.github.io/ApprovalTool/) +* Fork [https://github.com/bokkypoobah/ApprovalTool](https://github.com/bokkypoobah/ApprovalTool) and set up your own GitHub Pages +* Clone [https://github.com/bokkypoobah/ApprovalTool](https://github.com/bokkypoobah/ApprovalTool) on your local computer and run using, e.g., [anywhere](https://www.npmjs.com/package/anywhere) in the ./docs folder + +
+ +--- ### Sample Screens