UNPKG

@btc-vision/walletconnect

Version:

The OP_NET Wallet Connect library helps your dApp connect to any compatible wallet.

59 lines (41 loc) 2 kB
# OP_NET - WalletConnect ![Bitcoin](https://img.shields.io/badge/Bitcoin-000?style=for-the-badge&logo=bitcoin&logoColor=white) ![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white) ![NodeJS](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white) ![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white) ![Gulp](https://img.shields.io/badge/GULP-%23CF4647.svg?style=for-the-badge&logo=gulp&logoColor=white) ![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) ## Introduction The OP_NET WalletConnect library is a TypeScript library that provides a simple interface for interacting with the WalletConnect protocol. It allows you to create a WalletConnect session, send transactions, and receive notifications from the connected wallet. ## Getting Started ### Prerequisites - Node.js version 22.x - npm (Node Package Manager) ### Installation ```shell npm i @btc-vision/walletconnect ``` ### Documentation Documentation is available at [docs.opnet.org](https://docs.opnet.org) #### Development 1. Clone the repository: ```bash git clone https://github.com/btc-vision/walletconnect.git ``` 2. Navigate to the repository directory: ```bash cd walletconnect ``` 3. Install the required dependencies: ```bash npm i ``` ## Contribution Contributions are welcome! Please read through the `CONTRIBUTING.md` file for guidelines on how to submit issues, feature requests, and pull requests. We appreciate your input and encourage you to help us improve OP_NET. ## License This project is open source and available under the [MIT License](LICENSE). If you have any suggestions or contributions, please feel free to submit a pull request.