feat: sdk deeplinking protocol

[abretonc7s]

Description

Deep Linking Based Communication Layer for MetaMask iOS SDK

The objective is to introduce a MetaMask SDK communication layer for iOS that enables direct interaction between a mobile iOS DApp and the MetaMask Mobile app, bypassing the Socket.io server. This direct communication approach aims to enhance speed and reliability. Initially, this will be an optional feature, not the default setting, as it necessitates specific app customizations outlined in the document below.

Document that explain in detail the feature:
https://docs.google.com/document/d/1211R1kIQmhuUSox-nBXh1k1Dq64TrELNAR31QdSHJns/edit?usp=sharing

Related issues

Fixes:

Manual testing steps

1. Go to this page...

Screenshots/Recordings

Before

After

Here there are all the flows:

• Connect with Request
• Connect and Sign
• Normal Connection and then Sign

Screen.Recording.2024-04-10.at.17.35.57.mov

Here there is a Connection and then batch RPC requests:

Screen.Recording.2024-04-10.at.17.34.32.mov

Pre-merge author checklist

• I’ve followed MetaMask Coding Standards.
• I've completed the PR template to the best of my ability
• I’ve included tests if applicable
• I’ve documented my code using JSDoc format if applicable
• I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

• I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
• I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

[github-actions]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 26.66667% with 11 lines in your changes are missing coverage. Please review.

Project coverage is 45.29%. Comparing base (35915bb) to head (7081398).

Files	Patch %	Lines
...linkManager/ParseManager/handleMetaMaskDeeplink.ts	10.00%	7 Missing and 2 partials ⚠️
...ect/SDKDeeplinkProtocol/DeeplinkProtocolService.ts	33.33%	2 Missing ⚠️

Additional details and impacted files

@@                Coverage Diff                @@
##           feat/sdk_conn    #9114      +/-   ##
=================================================
- Coverage          45.30%   45.29%   -0.02%     
=================================================
  Files               1272     1273       +1     
  Lines              31285    31296      +11     
  Branches            3198     3202       +4     
=================================================
+ Hits               14174    14175       +1     
- Misses             16263    16271       +8     
- Partials             848      850       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@walletconnect/encoding@1.0.2	None	0	294 kB	bkrem

View full report↗︎

[github-actions]

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 56c200d
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/d470e35f-fbfd-44a1-a204-2d437fef9955

Note

• You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

[github-actions]

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 198815b
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/113d3850-63e9-4cde-b1af-5592bb46784d

Note

• You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

[andreahaku]

LGTM

[christopherferreira9]

Tests performed:

• regression test on iOS Deeplink communication with iOS Dapp
• regression test Socket.io communication with iOS Dapp
• regression test on Android SDK
• regression test WalletConnect
• regression test on JS SDK
• regression tests on the overall deeplink behaviours

Compatibility with both communication formats was ensured.

Observations:
The Connection prompt is sometimes showing before unlocking the device when face ID is enabled and Deeplink communication is used. This causes the wallet to return “server” error sometimes. Could be a race condition. Given that this is not consistent and it doesn't block the overall behaviour of the SDK we're safe to move forward.
Steps: Lock MM -> Go to dapp -> Connect (and cover faceid) -> See the connection appear.

ChainId and selectedAddress are not currently being synced when using the deeplink communication since we haven't decided on what the behaviour should be when it comes to this flow as we don't want to deeplink to all available deeplink connection to let the Dapps know the selectedAddress or chainId was changed.
This same applies for the terminating of sessions from both Dapp -> MetaMask and MetaMask -> Dapp

[github-actions]

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 35c6938
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/fb7358a4-ac8b-4dc3-b86d-36e9d5420592

Note

• You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
2 Accepted issues

Measures
0 Security Hotspots
9.2% Coverage on New Code
2.8% Duplication on New Code

See analysis details on SonarCloud