Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanberckmans committed Jul 13, 2024
1 parent df2a488 commit 0f6be97
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
2 changes: 0 additions & 2 deletions packages/core/src/getConfirmationsToWait.ts
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion packages/interface/.env.local.template
Original file line number Diff line number Diff line change
@@ -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
8 changes: 6 additions & 2 deletions packages/interface/README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion packages/interface/tsconfig.json
Original file line number Diff line number Diff line change
@@ -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 */
Expand Down
6 changes: 3 additions & 3 deletions packages/verifier/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0f6be97

Please sign in to comment.