From fa135938cf81cc3b315a21d0768d5ddf0e118ad1 Mon Sep 17 00:00:00 2001 From: Dhruv-2003 Date: Sun, 5 Mar 2023 14:31:25 +0530 Subject: [PATCH] docs: README.md Added and INFO.md hidden --- .gitignore | 3 ++- README.md | 49 +++++++------------------------------------------ 2 files changed, 9 insertions(+), 43 deletions(-) diff --git a/.gitignore b/.gitignore index 1e0339c..8a5ba6d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ node_modules dist -package-lock.json \ No newline at end of file +package-lock.json +info.md \ No newline at end of file diff --git a/README.md b/README.md index d6f052e..9aea96d 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,10 @@ -## Plan to implement Token - gating Bot / SDK or Component +## Token - Gating - SDK -- The bot must be able to verify the ownership of a user's tokens or NFTs. -- The bot must be able to grant or restrict access to a webpage based on the ownership verification. -- The bot must be easy to install and set up for website owners. -- The bot should be built for Ethereum or Polygon. -- The bot should be able to integrate with different types of wallets. -- The bot should have an interface for website owners to configure and set up. -- Make sure to use the Alchemy NFT API and Token API -- Write thorough documentation on how you built this. +Built in ESM module , For Webapplications to add token-gating with NFTs and TOKENs on-Chain on 4 Major Networks -- We'll go with SDK approach and create a UI element for the admin: +- ETHEREUM +- POLYGON +- OPTIMISM +- ARBITRUM ONE -## FINAL APPROACH - -- React Component can be created which can be used in React and Next Application - -- We can Wrap the component to the whole app , which check the current url and restricts the entry - -- The Selection of URL would be done via a public - private route constants - -- To implement the kind of check , we need to create a methods , like NFT or TOKEN addresses and the conditions for gating the access - -Or Create a full scale data base , to check the URL and assign the conditions - -- The wallet connection will be handeled by Rainbow wallet with multiple options , with ETH and Polygon as the networks - -## LAYDOWN - -- The best way is creating a database that can be called with to check the access , simply supplying the URL and the user Address and handling it all on the backend side -- Interface for controlling the websites pages for admin -- Wrapper to just simply check the access of the page , and allow to go ahead if authorised to be -- For page navigation, we need to find a good solution , maybe window.href or React Router - -## LINKS - -https://www.w3schools.com/howto/howto_js_get_url.asp - -## Questions - -- I got into them , because implementing the code as a developer is very easy to do , but doing the same for others to integrate comes up with a lot of other things. -- What type of webpage it should support ?? Are Next and React Just Fine , these are actually some router issues ? -- There will be some extra steps involved for the Client to integrate the same into the website , is that okay , for best wallet integrations and support the perfect chains ? I am thinking of using Rainbowkit , wagmi here -- Is it okay if we implement a config file method , where user would create a config file along with the steps involved in the docs ?? There will be not interface here , just the component and the docs to configure the same , this approach would not take much time to implement -- If we want to go the other way , where we build something that is applicable for all types of application , it is quite hard to implement and check every case , the comp might break in that case , moreover there will be time lag , in this thing to check and implement +It Supports all the major wallet by default , Like Metamask , Ledger, Wallet Connect , etc.