https://github.com/chorusone/opus-pool-demo
Opus Pool SDK Demo- Repository for customer testing
https://github.com/chorusone/opus-pool-demo
ethereum opus-team proof-of-stake staking
Last synced: 6 months ago
JSON representation
Opus Pool SDK Demo- Repository for customer testing
- Host: GitHub
- URL: https://github.com/chorusone/opus-pool-demo
- Owner: ChorusOne
- License: apache-2.0
- Created: 2023-12-19T12:13:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T16:24:48.000Z (over 1 year ago)
- Last Synced: 2025-02-15T03:29:39.938Z (8 months ago)
- Topics: ethereum, opus-team, proof-of-stake, staking
- Language: TypeScript
- Homepage: https://chorus-one.gitbook.io/opus-pool-sdk-1.0/
- Size: 454 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OPUS Pool SDK Example
## Prerequisites 📋
### Project Stack
- The project runs on **Node.js (version 18)** and **npm (version 8)**, please make sure these are installed
- It is built with **TypeScript** and **React**, and bundled using **Vite**.
- For data management, **React Query** is utilized.
- It leverages **Wagmi**, **viem**, and **WalletConnect** for web3 wallet connections.
### 📣 Environment Setup
To run OPUS Pool SDK Example it is required to configure **WalletConnect**. To set this up:
- **Copy** the `.env.dist` file to `.env` to create your local environment settings.
- **Create** a new project on [WalletConnect Cloud](https://cloud.walletconnect.com) to obtain your unique project ID.
- **Use** this `projectId` in your `.env` file, linking your development environment to the blockchain.
## Setup 🛠️
To get the frontend up and running, follow these steps:
1. Install the dependencies:
```bash
npm install
```
2. Start the development server:
```bash
npm run dev
```
3. Once the development server is started, open your browser and navigate to `http://localhost:5173/opus-pool-demo/`.
## Additional Resources 📚
- To see the OPUS Pool SDK Example in action, check out the live demo [here][demo].
- For a detailed guide on how to use the OPUS Pool SDK, based on this example, refer to our [Guide][guide].
- Comprehensive API documentation can be found at [API Docs][api].
- To explore more about the SDK, visit the official [Opus Pool SDK repository][sdk-repo].
[demo]: https://chorusone.github.io/opus-pool-demo/
[guide]: https://chorus-one.gitbook.io/opus-pool-sdk-1.0/opus-pool-guide/0-introduction
[api]: https://chorus-one.gitbook.io/opus-pool-sdk-1.0/api-docs/opuspool
[sdk-repo]: https://github.com/ChorusOne/opus-pool-sdk