Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markeljan/chainswitch
Change networks, share urls, share urls with networks, share networks with urls?
https://github.com/markeljan/chainswitch
chainlist chains ethereum-tools metamask url
Last synced: 27 days ago
JSON representation
Change networks, share urls, share urls with networks, share networks with urls?
- Host: GitHub
- URL: https://github.com/markeljan/chainswitch
- Owner: Markeljan
- License: mit
- Created: 2024-02-21T15:53:45.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-03T19:35:07.000Z (9 months ago)
- Last Synced: 2024-04-14T01:55:53.700Z (8 months ago)
- Topics: chainlist, chains, ethereum-tools, metamask, url
- Language: JavaScript
- Homepage: https://chainswitch.xyz
- Size: 213 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChainSwitch
Welcome to ChainSwitch, your gateway to seamless network transitions in the Ethereum Virtual Machine (EVM) ecosystem. ChainSwitch is a tool designed to facilitate the easy switch of blockchain networks before accessing decentralized applications (dApps). This ensures that users are always on the correct network required by the dApp they wish to interact with, enhancing the user experience and preventing common errors associated with network mismatches.
## Features
- **Network Switching**: ChainSwitch enables users to switch blockchain networks with just one click, ensuring they are on the correct network for their intended actions.
- **Link Sharing**: Easily generate and share links that automatically prompt users to switch to the appropriate network before redirecting them to the desired dApp. This is especially useful for token swaps and other network-specific operations.
- **EVM Network Support**: ChainSwitch supports adding any EVM-compatible network, making it a versatile tool for a wide range of blockchain applications.
- **User-Friendly**: Designed with simplicity in mind, ChainSwitch provides an intuitive interface for both creating and using network switch links.
## How It Works
ChainSwitch leverages URL parameters to specify the desired blockchain network and the target dApp URL. Here's the structure of a ChainSwitch URL:
```
https://chainswitch.xyz/?chain=&redirect=
```
- `chain`: Specifies the blockchain network to switch to. This can be the name or ID of any EVM-compatible network.
- `redirect`: The URL of the dApp to redirect to after the network switch has been completed.
### Example Usage
Suppose you want to share a link to a token swap on SushiSwap that requires the user to be on the Base network. Your ChainSwitch link would look like this:
```
https://chainswitch.xyz/?chain=base&redirect=www.sushi.com/swap?token1=0xAC1Bd2486aAf3B5C0fc3Fd868558b082a531B2B4
```
When a user clicks on this link, ChainSwitch will prompt them to switch to the Base network (if they're not already on it) before automatically redirecting them to the SushiSwap token swap page.
## Getting Started
To start using ChainSwitch, follow these simple steps:
1. **Visit ChainSwitch**: Go to [https://chainswitch.xyz](https://chainswitch.xyz) to access the tool.
2. **Generate a Link**: Use the ChainSwitch interface to select the desired network and enter the redirect URL for your dApp.
3. **Share Your Link**: Share your newly generated ChainSwitch link with your audience. Users who click on your link will be prompted to switch networks (if necessary) before being redirected to the specified dApp URL.
## Contributing
We welcome contributions to ChainSwitch! If you have suggestions for improvements or want to help with development, please feel free to fork the repository and submit a pull request.
## Support
If you encounter any issues or have questions about using ChainSwitch, please open an issue on our GitHub repository, and we'll be happy to help.
## License
ChainSwitch is released under the MIT License. See the [LICENSE](LICENSE.md) file for more details.
---
Thank you for using ChainSwitch. We're excited to see how you'll use it to enhance your dApps and blockchain experiences!