From 0f6be976df489c83869def88405042a61edd614d Mon Sep 17 00:00:00 2001 From: Ryan Berckmans Date: Sat, 13 Jul 2024 01:58:24 -0500 Subject: [PATCH] Update READMEs --- packages/core/src/getConfirmationsToWait.ts | 2 -- packages/interface/.env.local.template | 1 - packages/interface/README.md | 8 ++++++-- packages/interface/tsconfig.json | 2 +- packages/verifier/README.md | 6 +++--- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/packages/core/src/getConfirmationsToWait.ts b/packages/core/src/getConfirmationsToWait.ts index d32c142..c22c0e0 100644 --- a/packages/core/src/getConfirmationsToWait.ts +++ b/packages/core/src/getConfirmationsToWait.ts @@ -1,8 +1,6 @@ import { arbitrum, arbitrumNova, arbitrumSepolia, base, baseSepolia, blast, blastSepolia, chainsSupportedBy3cities, fluentTestnet, getChain, immutableZkEvm, linea, lineaSepolia, mainnet, mode, optimism, optimismSepolia, polygon, polygonAmoy, polygonZkEvm, polygonZkEvmCardona, scroll, scrollSepolia, sepolia, taiko, zkSync, zkSyncSepolia, zora, zoraSepolia } from './chains'; import { isProduction } from './isProduction'; -// TODO do mainnet, too - // These numbers were put together with low confidence // See https://developers.circle.com/circle-mint/docs/blockchain-confirmations // See https://developer.ipeakoin.com/docs/blockchain-confirmations diff --git a/packages/interface/.env.local.template b/packages/interface/.env.local.template index 5d2d5fe..ce0968d 100644 --- a/packages/interface/.env.local.template +++ b/packages/interface/.env.local.template @@ -1,6 +1,5 @@ # for local development, copy this file to .env.local and fill in the api keys below REACT_APP_ALCHEMY_API_KEY=get-'api-key'-from-https://dashboard.alchemy.com/ REACT_APP_INFURA_API_KEY=get-'project id'-from-https://app.infura.io/dashboard -REACT_APP_WEB3AUTH_CLIENT_ID=get-'client id'-from-https://dashboard.web3auth.io/home/web3auth REACT_APP_WALLETCONNECT_PROJECT_ID=get-'project id'-from-https://cloud.walletconnect.com/app/project?uuid=e236c0e6-0c84-4bcb-9a04-8d96c872b84f REACT_APP_DEVELOPMENT_INTRANET_IP=optional-intranet-ip-for-checkout-links-to-help-load-on-mobile diff --git a/packages/interface/README.md b/packages/interface/README.md index 4a853b6..cfb62f9 100644 --- a/packages/interface/README.md +++ b/packages/interface/README.md @@ -1,3 +1,7 @@ -# [3cities](https://3cities.xyz/) +# @3cities/interface -TODO +The primary customer-facing web app used to make payments, donations,deposits, and transfers. + +This web app is also used to generate payment request links. + +If you want to easily get paid on Ethereum, try sending them a [3cities Pay Link](https://3cities.xyz/#/pay-link). diff --git a/packages/interface/tsconfig.json b/packages/interface/tsconfig.json index 62b54be..92d6f6b 100644 --- a/packages/interface/tsconfig.json +++ b/packages/interface/tsconfig.json @@ -1,4 +1,4 @@ -/* TODO extend monorepo base tsconfig.json "../../tsconfig.json", */ +/* TODO extend monorepo base tsconfig.json "../../tsconfig.json", after switching to vite, as legacy create-react-app seems to be incompatible with extending the base tsconfig */ { "compilerOptions": { /* Visit https://aka.ms/tsconfig.json to read more about this file */ diff --git a/packages/verifier/README.md b/packages/verifier/README.md index 9389a59..14e0db9 100644 --- a/packages/verifier/README.md +++ b/packages/verifier/README.md @@ -1,6 +1,6 @@ -# Overview +# @3cities/verifier -TODO +A stateless library to verify token transfers and process payments offchain. -# Usage +@3cities/verifier is offered in grpc service format in @3cities/service.