Skip to content

Commit

Permalink
readme: update
Browse files Browse the repository at this point in the history
  • Loading branch information
therealharpaljadeja committed Oct 10, 2023
1 parent fe1aa07 commit b538e38
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit b538e38

Please sign in to comment.