Skip to content

Commit dc3bc5e

Browse files
authored
Update dApp docs: links, paths, and cleanup (#415)
Update dApp listing, optimization, and debugging guides listing-guide.md: - Fix broken optimization link (dApps/mobile-optimize.md → mobile-optimize.md) - Update Twitter handle (trustwalletapp → TrustWallet) - Remove defunct community.trustwallet.com reference - Remove outdated checklist items (logo upload, AMA session, Barn of Trust vault) - Remove stale "Technical Requirements" section with outdated asset upload instructions — replaced with a warning to wait for BD review before submitting any assets to the Trust Wallet Assets repository mobile-optimize.md: - Replace referral link with download link for Android - Remove dead MetaMask Provider Migration Guide link (docs.metamask.io/guide/provider-migration.html no longer exists) - Replace broken "How to Identify Trust Provider" anchor with pointer to trust-web3-provider README - Fix broken deep links path (deeplinking/deeplinking.md → ../develop-for-trust/deeplinking/deeplinking.md) - Update dead Solana web3.js docs URL with GitHub repo link - Remove redundant "Flag issues" section (covered by debugging.md) debugging.md: - Fix typo in section header ("Rmote" → "Remote") - Fix capitalization ("we use" → "We use") - Add missing download link to app version reference - Update trust-web3-provider iOS demo path to correct packages/ subpath - Remove outdated "Contact us" section
1 parent a7e2e52 commit dc3bc5e

3 files changed

Lines changed: 13 additions & 52 deletions

File tree

dapps/debugging.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# How to debug your DApp on Trust Wallet
22

3-
Make sure you have the latest app version, check if there is any new update on Google Play or App Store
3+
Make sure you have the [latest app version](https://trustwallet.com/download), check if there is any new update on Google Play or App Store
44

55
## 1. Install a mobile web console
66

7-
we use [vConsole](https://github.com/Tencent/vConsole) on our test dapp: https://js-eth-sign.surge.sh/, click the bottom green `vConsole` button to see logs.
7+
We use [vConsole](https://github.com/Tencent/vConsole) on our test dapp: https://js-eth-sign.surge.sh/, click the bottom green `vConsole` button to see logs.
88

99
<img src="../media/js-eth-sign.png" width="45%" /> <img src="../media/js-eth-sign-console.png" width="45%" />
1010

11-
## 2. [Android] Chrome Rmote debugging
11+
## 2. [Android] Chrome Remote debugging
1212

13-
Download Trust Wallet apk from [trustwallet.com](https://trustwallet.com) and drag it to your emulator. (app installed from Google Play won't work)
13+
Download Trust Wallet apk from [trustwallet.com](https://trustwallet.com/download) and drag it to your emulator. (app installed from Google Play won't work)
1414

1515
Open the dapp in Trust Wallet (1inch.io as example)
1616

@@ -23,13 +23,4 @@ Visit `chrome://inspect/#devices` or `edge://inspect/#devices` to inspect the we
2323

2424
## 3. [iOS] Safari WebView debugging
2525

26-
iOS doesn't support debugging app built for distribution, you can try to build this iOS demo in [trust-web3-provider](https://github.com/trustwallet/trust-web3-provider) and check if it can connect to your DApp or not, please follow this [guide](https://webkit.org/web-inspector/enabling-web-inspector/) to inspect.
27-
28-
## Contact us
29-
30-
If above doesn't help, please create an issue on [trust-web3-provider](https://github.com/trustwallet/trust-web3-provider) and elaborate your question as detail as possible.
31-
32-
1. What's your app version and OS version?
33-
2. Do you see any js error?
34-
3. How to reproduce? please record a video if possible
35-
4. what's the url of your dapp?
26+
iOS doesn't support debugging app built for distribution, you can try to build this iOS demo in [trust-web3-provider](https://github.com/trustwallet/trust-web3-provider/tree/main/packages/ios-web3-provider) and check if it can connect to your DApp or not, please follow this [guide](https://webkit.org/web-inspector/enabling-web-inspector/) to inspect.

dapps/listing-guide.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,22 @@ Joining the Trust Wallet ecosystem with an already established base of users, pr
44

55
Trust Wallet is proud of the high standards of quality required for listed dApps, where the user and their experience are the key areas of focus. The app is one of the most popular wallets available for easy access to digital assets and dApps in one place.
66

7-
By improving the functionality of your project and its overall optimization, you allow users already familiar with the Trust Wallet space the best chance of using your dApp. Taking advantage of the vibrant [community](https://twitter.com/trustwalletapp) is a logical step to take. Marketing efforts also help, so get in touch with the Trust Wallet team via [Trust Wallet Community](https://community.trustwallet.com/) to explore more promotional opportunities.
7+
By improving the functionality of your project and its overall optimization, you allow users already familiar with the Trust Wallet space the best chance of using your dApp. Taking advantage of the vibrant [community](https://twitter.com/TrustWallet) is a logical step to take.
88

99
Missing out on just any one part of the optimization and application process will ultimately lead to an unsuccessful application. The journey involves rounds of:
1010

11-
1. [Optimization](dApps/mobile-optimize.md)
11+
1. [Optimization](mobile-optimize.md)
1212
2. [Application Form](https://forms.gle/bdZPHseXypr72S8E7)
1313

1414
The whole process can be divided into these key stages, along with some recommended marketing activities to help give your project a better chance of success.
1515

1616
- [ ] Optimization of your dApp for the Trust Wallet browser
1717
- [ ] Optimization of your dApp for desktop users
18-
- [ ] Uploading of required logo assets
1918
- [ ] Application to join the Trust Wallet dApp listing
20-
- [ ] Hosting a Trust Wallet AMA session
21-
- [ ] Creating a Barn of Trust staking vault
2219

2320
Only by following closely the clearly defined instructions and recommendations will your dApp be able to join the list after careful scrutiny from the Trust Wallet team.
2421

25-
### Technical Requirements and Preparation
26-
27-
Optimizing your application will require checking off a series of key areas noted in the following optimization sections. Some technical preparation will however be required whenever assets are added to the Trust Wallet GitHub repo.
28-
29-
Therefore, it is required that you have a [GitHub](https://github.com) account to interact with the [Assets repo](https://github.com/trustwallet/assets) and submit your dApp logo for listing. Before uploading any image files, you must make sure they meet the following requirements:
30-
31-
- File Extension: `png`
32-
- Uppercase `PNG` is considered invalid
33-
- File Name:logo.png
34-
- Size: 256px by 256px
35-
- Background: Avoid transparency. White is preferred to fit in with app white/dark theme designs.
36-
- File size: maximum 100kB. Tip: optimize your image size using a simple drag-and-drop online service such as tinypng. Your logo’s file name must also meet the following criteria: <subdomain>.<domain_name>.png
37-
- For example: https://app.compound.finance/ => app.compound.finance.png
38-
https://kyberswap.com/ => kyberswap.com.png
39-
40-
Some basic information is also required on your dApp project as part of the submission process. This includes:
41-
42-
- A short and clear explanation of your dApp functionality
43-
- Your Telegram channel
44-
- A description of your dApp for listing
45-
- Your dApp name for the listing
46-
- The URL of your dApp for listing
22+
> **Important:** Do not submit any assets (logos, metadata) to the Trust Wallet Assets repository until your application has been reviewed by the Business Development team and an agreement has been reached. Premature asset submissions will be rejected.
4723
4824
### Applying for the Trust Wallet dApp Listing
4925

dapps/mobile-optimize.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,18 @@ There are simple steps for blockchain developers to implement to take full advan
1616

1717
## Metamask/Phantom/Keplr/Petra is a good place to start
1818

19-
Familiarity with MetaMask interaction for Ethereum DApps, Phantom for Solana, Keplr for Cosmos or Petra for Aptos puts you off to a good start in terms of optimizing or developing a DApps for Trust Wallet. The web3 development process is the same when using MetaMask/Phantom/Keplr/Petra as a dev tool. Its our recommended choice for DApp development and gives you a quick, golden rule to use: if it works well with MetaMask, Phantom, Keplr or Petra it works well with Trust Wallet.
19+
Familiarity with MetaMask interaction for Ethereum DApps, Phantom for Solana, Keplr for Cosmos or Petra for Aptos puts you off to a good start in terms of optimizing or developing a DApps for Trust Wallet. The web3 development process is the same when using MetaMask/Phantom/Keplr/Petra as a dev tool. It's our recommended choice for DApp development and gives you a quick, golden rule to use: if it works well with MetaMask, Phantom, Keplr or Petra it works well with Trust Wallet.
2020

2121
## Create a UI that Is mobile-friendly
2222

23-
It cant be forgotten that Trust Wallet is accessed by two groups of people: those using the app on [Android](https://trustwallet.com/referral) and those using an iOS device. Your project must be developed to have a mobile-friendly UI as the Trust Wallet inbuilt browser is the primary point of access for the majority of our users.
23+
It can't be forgotten that Trust Wallet is accessed by two groups of people: those using the app on [Android](https://trustwallet.com/download) and those using an iOS device. Your project must be developed to have a mobile-friendly UI as the Trust Wallet inbuilt browser is the primary point of access for the majority of our users.
2424

2525
iOS users require the latest build from Apple App Store. UI/UX design needs to also be considered in your mobile design to provide the best in-wallet experience.
2626

2727
## Master Web3
2828

2929
All Ethereum DApps should be [EIP1193](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md) (Ethereum Improvement Protocol 1193) compatible. This allows for a high degree of wallet interoperability when exposing an API through JavaScript objects in the Ethereum DApp.
3030

31-
If you have decided upon using MetaMask as your dev tool, do not forget their [Provider Migration Guide](https://docs.metamask.io/guide/provider-migration.html). This will seriously affect the degree of compatibility between your DApp and the Trust Wallet browser without proper planning.
32-
3331
For Solana integration the best way would be to use the official [Wallet Adapter](https://github.com/solana-labs/wallet-adapter) which supports Trust Wallet and include it as the connection point to your DApp.
3432

3533
For Cosmos you can refer to the official [Keplr guide](https://docs.keplr.app/api/), just make sure to use `window.trustwallet.cosmos` instead of `window.keplr`.
@@ -40,7 +38,7 @@ Consider including an explicit Trust Wallet icon or button in your DApp. This wi
4038

4139
Recommended steps to improve the user experience when a user clicks or taps the Trust Wallet icon:
4240

43-
1. Check [How to Identify Trust Provider](https://github.com/trustwallet/trust-web3-provider#how-to-identify-trust-provider) guide.
41+
1. Check the [trust-web3-provider](https://github.com/trustwallet/trust-web3-provider) README for provider identification guidance.
4442
2. Verify that the DApp is open in desktop browsers or no `window.trustwallet.(ethereum/solana/cosmos/aptos)` -> Display the WalletConnect pairing popup
4543
3. Verify that the DApp is open in the Trust Wallet DApp browser -> Access the `window.trustwallet.(ethereum/solana/cosmos/aptos)` directly.
4644

@@ -50,14 +48,10 @@ Trust Wallet users access their wallets on both Android and iOS devices, so your
5048

5149
This is one of the most important areas to optimize for but is often brushed over. Just open up your DApp with the Trust Wallet browser on both an iOS and Android device, then test the DApps functionalities such as sending or depositing tokens.
5250

53-
## Flag issues in the trust-web3-provider repo
54-
55-
It may be that you have issues with the TrustWeb3Provider while optimizing your DApp. The web3 javascript wrapper provider allows you to directly file any issues through [GitHub](https://github.com/trustwallet/trust-web3-provider). The Trust Wallet team will then provide support for any queries you have in due time.
56-
5751
## Implement deep links
5852

59-
There is no native support for Web3 in iOS or Android mobile browsers. Your DApps links must be [deep links](deeplinking/deeplinking.md) that combine numerous steps into one simple, easy click. Without them, users will need to follow tedious and long chains of links that greatly impact the user experience.
53+
There is no native support for Web3 in iOS or Android mobile browsers. Your DApp's links must be [deep links](../develop-for-trust/deeplinking/deeplinking.md) that combine numerous steps into one simple, easy click. Without them, users will need to follow tedious and long chains of links that greatly impact the user experience.
6054

6155
## References
6256

63-
Web3 is incredibly powerful for developing DApps and outlining their interactions with Ethereum or Solana nodes. The most up-to-date Web3 open-source [Ethereum JavaScript library](https://github.com/ethers-io/ethers.js/) or [Solana JavaScript library](https://solana-labs.github.io/solana-web3.js/modules.html) needs to be implemented for your DApp to be well optimized for the Trust Wallet browser.
57+
Web3 is incredibly powerful for developing DApps and outlining their interactions with Ethereum or Solana nodes. The most up-to-date Web3 open-source [Ethereum JavaScript library](https://github.com/ethers-io/ethers.js/) or [Solana JavaScript library](https://github.com/solana-labs/solana-web3.js) needs to be implemented for your DApp to be well optimized for the Trust Wallet browser.

0 commit comments

Comments
 (0)