-
Notifications
You must be signed in to change notification settings - Fork 23
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
created a custom-connector folder > custom-connector.md documentation #70
Closed
mimiprosper
wants to merge
2
commits into
Scaffold-Stark:main
from
mimiprosper:custom-connectors-docs
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
## Introduction | ||
|
||
Custom wallet connectors allow users to connect their preferred wallets to your decentralized application (dApp). This provides flexibility and improves the user experience by giving users options beyond popular default wallets like MetaMask. | ||
|
||
|
||
## Install Dependencies | ||
First, install the necessary packages: | ||
|
||
``` | ||
npm install @scaffold-stark/stark-burner | ||
``` | ||
OR | ||
|
||
``` | ||
yarn add @scaffold-stark/stark-burner | ||
``` | ||
|
||
## Handle Errors | ||
Implement proper error handling throughout the connector: | ||
``` | ||
handleError(error) { | ||
console.error('Error in StarknetCustomConnector:', error); | ||
// Implement appropriate error handling logic | ||
} | ||
``` | ||
|
||
## Integrate with User Interface | ||
Create a React component to integrate the custom connector with the user interface: | ||
|
||
``` | ||
import React, { useState } from 'react'; | ||
import { BurnerConnector } from '@scaffold-stark/stark-burner'; | ||
const WalletConnect = () => { | ||
const [connected, setConnected] = useState(false); | ||
const [address, setAddress] = useState(''); | ||
handleError(error) { | ||
console.error('Error in StarknetCustomConnector:', error); | ||
// Implement appropriate error handling logic | ||
} | ||
const connectWallet = async () => { | ||
try { | ||
const result = await BurnerConnector.connect(); | ||
setConnected(true); | ||
setAddress(result.address); | ||
} catch (error) { | ||
handleError(error); | ||
} | ||
}; | ||
const disconnectWallet = async () => { | ||
await BurnerConnector.disconnect(); | ||
setConnected(false); | ||
setAddress(''); | ||
}; | ||
return ( | ||
<div> | ||
{!connected ? ( | ||
<button onClick={connectWallet}>Connect Wallet</button> | ||
) : ( | ||
<div> | ||
<p>Connected Address: {address}</p> | ||
<button onClick={disconnectWallet}>Disconnect</button> | ||
</div> | ||
)} | ||
</div> | ||
); | ||
}; | ||
export default WalletConnect; | ||
``` | ||
|
||
## Summary | ||
This custom Starknet wallet connector provides a flexible and extensible solution for connecting various wallets to a dApp built on the Starknet blockchain. It includes: | ||
|
||
- Support for injected wallets and web wallets | ||
- Error handling for robust connectivity | ||
- Customizable connector options | ||
- Integration with React components for user interaction | ||
|
||
Best practices followed include: | ||
- Modular design allowing for easy extension | ||
- Proper error handling and logging | ||
- Separation of concerns between connector logic and UI | ||
- Flexibility to support multiple wallet types | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant breaking down the burner wallet as an example connector ser. not installing it, this would defeat the purpose of the documentation