update readme

rarimo · Jan 15, 2024 · 2e5ce66 · 2e5ce66
1 parent 2aff460
commit 2e5ce66
Showing 1 changed file with 7 additions and 189 deletions.
diff --git a/README.md b/README.md
@@ -1,184 +1,16 @@
-# Distributed Lab react started template
-
-## Project setup
-```
-yarn | yarn install
-```
+# World ID
+---------------
+---------------
 
 ## Getting started
 
-### Env configuration
-
-```dotenv
-# API url of deployed services(issuer, kyc-service, ...etc), https://gitlab.com/rarimo/polygonid/developer-edition
-VITE_API_URL=
-# APP title name
-VITE_APP_NAME='PolyginID identity'
-
-# https://0xpolygonid.github.io/tutorials/issuer/cred-issue-methods/#verifiable-presentations-leveraging-zk-proofs
-# Get this hash by generate Keccak256(<JSON-LD schema_url>) last 16 bytes
-VITE_AUTH_BJJ_CREDENTIAL_HASH=
-
-# Issuer DID
-VITE_REQUEST_BUILD_SENDER=
-
-# Contract addresses ========================================
-VITE_QUERY_VERIFIER_CONTRACT_ADDRESS_POLYGON_TESTNET=
-VITE_VERIFIED_SBT_CONTRACT_ADDRESS_POLYGON_TESTNET=
-
-VITE_QUERY_VERIFIER_CONTRACT_ADDRESS_SEPOLIA=
-VITE_VERIFIED_SBT_CONTRACT_ADDRESS_SEPOLIA=
-
-VITE_DEFAULT_CHAIN='SEPOLIA'
-# ========================================
-
-# Url which polygonID wallet will respond to send zk Proof
-VITE_CALLBACK_URL=
+### Project setup
 ```
-
-Go to https://gitlab.com/rarimo/polygonid/contracts to get more info about contracts or deploy them by yourself
-
-To setup contract addresses follow this format:
-```dotenv
-VITE_QUERY_VERIFIER_CONTRACT_ADDRESS_[CHAIN_NAME]=0x000000000
-VITE_VERIFIED_SBT_CONTRACT_ADDRESS_[CHAIN_NAME]=0x000000000
-```
-
-And set the default chain you'll work with
-
-e. g:
-```dotenv
-VITE_DEFAULT_CHAIN='SEPOLIA'
-```
-
-Where `CHAIN_NAME` and `VITE_DEFAULT_CHAIN` is one of object `keys` you can define by your self, by following [this](./src/assets/fallback-supported-chains.json) format, or use one of predefined in file
-### Chains List
-By following [this](./src/assets/fallback-supported-chains.json) scheme, you can define a list of supported chains, e. g.
-
-`JSON stringify` this js object:
-```json
-{
-  "SEPOLIA": {
-    "id": "11155111",
-    "name": "Sepolia chain",
-    "rpcUrl": "https://endpoints.omniatech.io/v1/eth/sepolia/public",
-    "explorerUrl": "https://sepolia.etherscan.io",
-    "token": {
-      "name": "Sepolia",
-      "symbol": "Sepolia",
-      "decimals": 18
-    },
-    "type": "EVM",
-    "icon": "ethereum"
-  },
-  "POLYGON": {
-    "id": "137",
-    "name": "Polygon chain",
-    "rpcUrl": "https://polygon-rpc.com/",
-    "explorerUrl": "https://polygonscan.com/",
-    "token": {
-      "name": "MATIC",
-      "symbol": "MATIC",
-      "decimals": 18
-    },
-    "type": "EVM",
-    "icon": "polygon"
-  },
-  "POLYGON_TESTNET": {
-    "id": "80001",
-    "name": "Polygon Testnet chain",
-    "rpcUrl": "https://endpoints.omniatech.io/v1/matic/mumbai/public",
-    "explorerUrl": "https://mumbai.polygonscan.com/",
-    "token": {
-      "name": "Matic",
-      "symbol": "Matic",
-      "decimals": 18
-    },
-    "type": "EVM",
-    "icon": "polygon"
-  },
-  "MAINNET": {
-    "id": "1",
-    "name": "Ethereum",
-    "rpcUrl": "https://eth.llamarpc.com",
-    "explorerUrl": "https://etherscan.io/",
-    "token": {
-      "name": "Ethereum",
-      "symbol": "Eth",
-      "decimals": 18
-    },
-    "type": "EVM",
-    "icon": "ethereum"
-  },
-  "ARBITRUM": {
-    "id": "42161",
-    "name": "Arbitrum",
-    "rpcUrl": "https://arbitrum.meowrpc.com",
-    "explorerUrl": "https://arbiscan.io/",
-    "token": {
-      "name": "Ethereum",
-      "symbol": "Eth",
-      "decimals": 18
-    },
-    "type": "EVM",
-    "icon": "arbitrum"
-  },
-  "XDC": {
-    "id": "50",
-    "name": "XDC",
-    "rpcUrl": "https://rpc-xdc.icecreamswap.com",
-    "explorerUrl": "https://xdc.blocksscan.io/",
-    "token": {
-      "name": "XDC",
-      "symbol": "XDC",
-      "decimals": 18
-    },
-    "type": "EVM",
-    "icon": "ethereum"
-  }
-}
-```
-
-where key - is a supported chain and value is a chain details
-
-then put into .env file or env.js file
-
-.env
-```dotenv
-VITE_SUPPORTED_CHAINS_DETAILS='{"SEPOLIA":{"id":"11155111","name":"Sepolia chain","rpcUrl":"https://endpoints.omniatech.io/v1/eth/sepolia/public","explorerUrl":"https://sepolia.etherscan.io","token":{"name":"Sepolia","symbol":"Sepolia","decimals":18},"type":"EVM","icon":"ethereum"},"POLYGON":{"id":"137","name":"Polygon chain","rpcUrl":"https://polygon-rpc.com/","explorerUrl":"https://polygonscan.com/","token":{"name":"MATIC","symbol":"MATIC","decimals":18},"type":"EVM","icon":"polygon"},"POLYGON_TESTNET":{"id":"80001","name":"Polygon Testnet chain","rpcUrl":"https://endpoints.omniatech.io/v1/matic/mumbai/public","explorerUrl":"https://mumbai.polygonscan.com/","token":{"name":"Matic","symbol":"Matic","decimals":18},"type":"EVM","icon":"polygon"},"MAINNET":{"id":"1","name":"Ethereum","rpcUrl":"https://eth.llamarpc.com","explorerUrl":"https://etherscan.io/","token":{"name":"Ethereum","symbol":"Eth","decimals":18},"type":"EVM","icon":"ethereum"},"ARBITRUM":{"id":"42161","name":"Arbitrum","rpcUrl":"https://arbitrum.meowrpc.com","explorerUrl":"https://arbiscan.io/","token":{"name":"Ethereum","symbol":"Eth","decimals":18},"type":"EVM","icon":"arbitrum"},"XDC":{"id":"50","name":"XDC","rpcUrl":"https://rpc-xdc.icecreamswap.com","explorerUrl":"https://xdc.blocksscan.io/","token":{"name":"XDC","symbol":"XDC","decimals":18},"type":"EVM","icon":"ethereum"}}'
-```
-
-env.js
-```js
-{
-  VITE_APP_SUPPORTED_CHAINS_DETAILS: '{"SEPOLIA":{"id":"11155111","name":"Sepolia chain","rpcUrl":"https://endpoints.omniatech.io/v1/eth/sepolia/public","explorerUrl":"https://sepolia.etherscan.io","token":{"name":"Sepolia","symbol":"Sepolia","decimals":18},"type":"EVM","icon":"ethereum"},"POLYGON":{"id":"137","name":"Polygon chain","rpcUrl":"https://polygon-rpc.com/","explorerUrl":"https://polygonscan.com/","token":{"name":"MATIC","symbol":"MATIC","decimals":18},"type":"EVM","icon":"polygon"},"POLYGON_TESTNET":{"id":"80001","name":"Polygon Testnet chain","rpcUrl":"https://endpoints.omniatech.io/v1/matic/mumbai/public","explorerUrl":"https://mumbai.polygonscan.com/","token":{"name":"Matic","symbol":"Matic","decimals":18},"type":"EVM","icon":"polygon"},"MAINNET":{"id":"1","name":"Ethereum","rpcUrl":"https://eth.llamarpc.com","explorerUrl":"https://etherscan.io/","token":{"name":"Ethereum","symbol":"Eth","decimals":18},"type":"EVM","icon":"ethereum"},"ARBITRUM":{"id":"42161","name":"Arbitrum","rpcUrl":"https://arbitrum.meowrpc.com","explorerUrl":"https://arbiscan.io/","token":{"name":"Ethereum","symbol":"Eth","decimals":18},"type":"EVM","icon":"arbitrum"},"XDC":{"id":"50","name":"XDC","rpcUrl":"https://rpc-xdc.icecreamswap.com","explorerUrl":"https://xdc.blocksscan.io/","token":{"name":"XDC","symbol":"XDC","decimals":18},"type":"EVM","icon":"ethereum"}}'
-}
+yarn | yarn install
 ```
 
-After that you can set into `VITE_DEFAULT_CHAIN` any of supported chains you've defined (keys of object)
-
-### Deploy
-To update variables in deployed app - setup .env variables from .env.example to [env.js](./static/env.js) but in `JSON` format, and change `VITE_` prefix to `VITE_APP`
-```js
-document.ENV = document.ENV || Object.freeze({
-  VITE_APP_API_URL: '',
-  VITE_APP_APP_NAME: 'PolyginID identity',
-
-  VITE_APP_AUTH_BJJ_CREDENTIAL_HASH: '',
-
-  VITE_APP_REQUEST_BUILD_SENDER: '',
-
-  VITE_APP_QUERY_VERIFIER_CONTRACT_ADDRESS_POLYGON_TESTNET: '',
-  VITE_APP_VERIFIED_SBT_CONTRACT_ADDRESS_POLYGON_TESTNET: '',
-
-  VITE_APP_QUERY_VERIFIER_CONTRACT_ADDRESS_SEPOLIA: '',
-  VITE_APP_VERIFIED_SBT_CONTRACT_ADDRESS_SEPOLIA: '',
-
-  VITE_APP_DEFAULT_CHAIN: 'SEPOLIA',
-
-  VITE_APP_CALLBACK_URL: '',
-})
-```
+#### env variables
+env-variables is setup by default, just run copy .env-development to .env.development or fill new with .env.example
 
 ### Compiles and hot-reloads for development
 ```
@@ -210,20 +42,6 @@ yarn rsc %release-version%
  docker build --no-cache --progress=plain --build-arg BUILD_VERSION=1.0.0-rc.0 -t react-template .
 ```
 
-## Some additional features
-
-### JsonApi lib
-
-[@distributedlab/jac](https://distributed-lab.github.io/web-kit/modules/_distributedlab_jac.html)
-
-### Web3 provider wrapper lib
-
-[@distributedlab/w3p](https://distributed-lab.github.io/web-kit/modules/_distributedlab_w3p.html)
-
-### Utils, tools, helpers, ...etc
-
-[@distributedlab/tools](https://distributed-lab.github.io/web-kit/modules/_distributedlab_tools.html)
-
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE) file for details