From e1d7fe98b5eeea6769fb1705d645878e4e905776 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Ribo=CC=81?= Date: Thu, 2 Oct 2025 17:50:10 +0200 Subject: [PATCH] fix: update readme docs --- packages/sdk-multichain-ui/README.md | 24 ++++++++++++++++++++++++ packages/sdk-multichain/README.md | 20 ++++++++++++++++++++ playground/multichain-react/README.md | 23 ----------------------- 3 files changed, 44 insertions(+), 23 deletions(-) diff --git a/packages/sdk-multichain-ui/README.md b/packages/sdk-multichain-ui/README.md index 6ff73c155..a11f0c470 100644 --- a/packages/sdk-multichain-ui/README.md +++ b/packages/sdk-multichain-ui/README.md @@ -1 +1,25 @@ # sdk-install-modal-web + +Install modal web package for multichain, renders and uses the new mobile wallet protocol ConnectionRequest QRCodes. + +This project includes fully functional InstallModal web used in the Multichain SDK for Trusted flows. + +Untrusted flows use the OTPModal which exists but is not yet fully supported. + +## Development + +```bash +yarn dev +``` + +or + +```bash +yarn start +``` + +## Building locally + +```bash +yarn build +``` diff --git a/packages/sdk-multichain/README.md b/packages/sdk-multichain/README.md index aaf539148..6fd37f637 100644 --- a/packages/sdk-multichain/README.md +++ b/packages/sdk-multichain/README.md @@ -22,3 +22,23 @@ src/ ├── multichain/ # Concrete implementations └── store/ # Storage implementations ``` + + +## Building Locally +Either build with ```yarn build``` from the root workspace project or build directly the package, in this last case, it is required that u build [ui package first](../sdk-multichain-ui/README.md) + +```bash +yarn build +``` + +## Running Tests + +```bash +yarn test +``` + +with coverage + +```bash +yarn test:ci +``` diff --git a/playground/multichain-react/README.md b/playground/multichain-react/README.md index 4a1163f30..548236fed 100644 --- a/playground/multichain-react/README.md +++ b/playground/multichain-react/README.md @@ -6,29 +6,6 @@ A test dapp for the MetaMask Multichain API. `yarn` -## Configuration - -### Environment Variables - -This project supports optional environment variables for enhanced functionality: - -#### Helius RPC API Key (Optional) -For improved Solana RPC performance, you can configure a Helius API key: - -1. Copy the example environment file: - ```bash - cp .env.example .env.local - ``` - -2. Get a free API key from [Helius](https://www.helius.dev/) - -3. Add your API key to `.env.local`: - ``` - REACT_APP_HELIUS_API_KEY=your_actual_api_key_here - ``` - -**Note:** If no Helius API key is provided, the app will automatically fall back to public Solana RPC endpoints. - ## Usage To start the development server: