Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add sdk support #331

Merged
merged 7 commits into from
May 3, 2024
Merged

feat: add sdk support #331

merged 7 commits into from
May 3, 2024

Conversation

seaona
Copy link
Contributor

@seaona seaona commented May 2, 2024

Description

This PR adds support for SDK Connection as well as moves the logic for WalletConnect + SDKConnect to its own file.

For the future, we could also move the provider logic and updatingButtons etc, to a utils file, since those functions are quite heavy and the index.js file is growing too big.
Leaving this out of scope of this PR as would be harder to review.

Screenshots

test-dapp-sdk.mp4

Manual QA

Check that WalletConnect continues to work (any tx or signature)
Check that SDK connect works as expected (any tx or signature)

@@ -122,7 +122,7 @@ <h3 class="card-title">
<div class="card">
<div class="card-body">
<h4 class="card-title">
Basic Actions
Connect Actions
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that this name might be more explicit

@@ -135,10 +135,17 @@ <h4 class="card-title">

<button
class="btn btn-primary btn-lg btn-block mb-3"
id="open-connect-modal"
id="walletConnect"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that this id is more explicit, since now we have 2 modals: walletConnect and sdk

</section>

<section>
<div class="row d-flex justify-content-center">
Copy link
Contributor Author

@seaona seaona May 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found this improves a little bit the alignment, by not taking so much space: now Connect Actions and Permission Actions will be in the same line

Screenshot from 2024-05-03 12-39-10

before:

Screenshot from 2024-05-03 12-40-11

@@ -494,49 +500,6 @@ const initialConnectedButtons = [
maliciousPermitIntAddress,
];

// Buttons that are available after connecting via Wallet Connect
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is now fixed, we can remove this section:

For Wallet Connect, we only have a subset of functionalities enabled for now: Sends/Signatures but excluding Contract Deployments, as needs some more investigation on how to get the contract address. This can be extended in the future (not currently needed for the purposes of PPOM).

see ref

projectId,
});

async function handleWalletConnectChange({ isConnected }) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all this logic is now moved in the connections.js file

Copy link

socket-security bot commented May 3, 2024

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

Package New capabilities Transitives Size Publisher
npm/@metamask/[email protected] Transitive: environment, filesystem, network, shell +66 59 MB metamaskbot
npm/[email protected] None +1 265 kB mysticatea
npm/[email protected] None +1 110 kB null_radix
npm/[email protected] None +1 91.9 kB rekmarks
npm/[email protected] None +13 6.29 MB axic
npm/[email protected] None 0 198 kB addons-robot

View full report↗︎

Copy link

socket-security bot commented May 3, 2024

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSource
Network access npm/[email protected]
New author npm/[email protected]
Shell access npm/[email protected]
Network access npm/[email protected]
Network access npm/[email protected]
Native code npm/[email protected]
Native code npm/[email protected]
Native code npm/[email protected]
New author npm/@metamask/[email protected]
New author npm/[email protected]
New author npm/@metamask/[email protected]

View full report↗︎

Next steps

What is network access?

This module accesses the network.

Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use.

What is new author?

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Scrutinize new collaborator additions to packages because they now have the ability to publish code into your dependency tree. Packages should avoid frequent or unnecessary additions or changes to publishing rights.

What is shell access?

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

What's wrong with native code?

Contains native code which could be a vector to obscure malicious code, and generally decrease the likelihood of reproducible or reliable installs.

Ensure that native code bindings are expected. Consumers may consider pure JS and functionally similar alternatives to avoid the challenges and risks associated with native code bindings.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

@seaona seaona marked this pull request as ready for review May 3, 2024 13:39
@seaona seaona changed the title feat: add sdk support and move connect logic to its own file feat: add sdk support May 3, 2024
Copy link
Member

@andreahaku andreahaku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

} from './onchain-sample-contracts';
import { getPermissionsDisplayString, stringifiableToHex } from './utils';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

taking the chance to re-order the imports by alphabetical order

isWalletConnectConnected &&
activeProviderNameResult.innerText === 'wallet-connect'
) {
for (const button of walletConnectButtons) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't have wallet connect specific buttons anymore since the previous issue was fixed, so we can remove this logic

@seaona seaona merged commit 2252b6e into main May 3, 2024
6 of 7 checks passed
@seaona seaona deleted the sdk-support branch May 3, 2024 16:16
@seaona seaona mentioned this pull request May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants