From b538e38611428bb60a3f731b92d888052d99f0f9 Mon Sep 17 00:00:00 2001 From: Harpal Jadeja Date: Tue, 10 Oct 2023 12:20:58 +0530 Subject: [PATCH] readme: update --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cf8b884..abdd527 100644 --- a/README.md +++ b/README.md @@ -35,4 +35,26 @@ MiniDApps for quick testing & prototyping in MiniPay. ngrok http 3000 ``` -7. Open the Site Tester dApp inside MiniPay and use the static url or the url you get from ngrok! +### How to test your DApp in MiniPay + +1. Open the MiniPay app on your phone and click on compass icon. + + ![minipay-app](https://github.com/celo-org/docs/blob/0712d6ec3231bd7d64a906d610a16deb1e6b037e/static/img/doc-images/minipay/minipay-1.png?raw=true) + +2. Click on "Test Page" to open the MiniPay test page. + + ![minipay-apps-screen](https://github.com/celo-org/docs/blob/0712d6ec3231bd7d64a906d610a16deb1e6b037e/static/img/doc-images/minipay/minipay-2.png?raw=true) + +3. Enter the URL of your DApp and click on "Go". + + ![minipay-site-tester](https://github.com/celo-org/docs/blob/0712d6ec3231bd7d64a906d610a16deb1e6b037e/static/img/doc-images/minipay/minipay-3.png?raw=true) + +### Important Notes + +- Ensure the "Connect Wallet" button is hidden when your DApp is loaded inside the MiniPay app, as the wallet connection is implicit. +- Always verify the existence of `window.provider` before initializing your web3 library to ensure seamless compatibility with the MiniPay wallet. +- Be cautious about exposing sensitive information or functionality when using public tunneling services like ngrok. Always use them in a controlled environment. +- MiniPay currently supports setting the `feeCurrency` property when running `eth_sendTransaction`. However, currency support is limited to `cUSD`. More currencies might be supported in future. +- MiniPay only accepts legacy transactions at the moment. EIP-1559 properties won't be considered when handling requests. +- Message signing is not currently supported. +- A developer mode will be available soon, allowing the use of testnet.