https://github.com/magicblock-labs/soar
Solana Onchain Achievements and Rewards
https://github.com/magicblock-labs/soar
Last synced: about 1 year ago
JSON representation
Solana Onchain Achievements and Rewards
- Host: GitHub
- URL: https://github.com/magicblock-labs/soar
- Owner: magicblock-labs
- License: mit
- Created: 2023-04-22T20:35:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T08:28:42.000Z (about 2 years ago)
- Last Synced: 2025-04-19T18:00:43.376Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://magicblock-labs.github.io/SOAR/
- Size: 1.75 MB
- Stars: 34
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
SOAR
👑 Solana On-chain Achievements & Rankings 👑
SOAR is a program that provides a seamless solution for managing leaderboards, achievements, players' profiles and automatic rewards distribution on the Solana blockchain. Currently supporting invocation from a TypeScript client and with the [Solana.Unity-SDK](https://github.com/magicblock-labs/Solana.Unity-SDK). The program IDL is public and other clients can be easily auto-generated.
## ⚙ Features
- Leaderboard Creation: Easily create leaderboards to track and display user rankings based on specific criteria or metrics.
- Achievement Management: Define and manage achievements that can be unlocked by users based on their on-chain activities.
- Typescript Client Support: Invoke SOAR functionalities using a TypeScript client, allowing for seamless integration with your Solana application.
- CPI Invocation: Interact with SOAR through CPI (Cross-Program Invocation) calls, enabling secure and efficient communication between programs.
- Solana.Unity-SDK Integration (Coming Soon): Integration with the Solana.Unity-SDK is currently underway, providing an additional layer of functionality for Unity-based applications.
## 📁 Repository Structure
The SOAR repository is structured as follows:
SOAR/
├── program/
│ ├── soar_program.rs
├── client/
│ ├── sdk
│ ├── tests
├── examples/
│ ├── tens
├── .....
├── README.md
program/: Contains the SOAR program source code for deployment on the Solana blockchain.
client/: Includes the TypeScript sdk and the tests.
examples/: Provides example scripts demonstrating how to use the SOAR program trough CPI.
README.md: The document you are currently reading, providing an overview of the SOAR program repository.
## 🚀 Getting Started
- For the Typescript SDK see the detailed [documentation](https://magicblock-labs.github.io/SOAR/).
- For using SOAR from your solana program trough CPI, see the [tens](https://github.com/magicblock-labs/SOAR/tree/main/examples/tens) example.
- Solana.Unity-SDK integration (Coming Soon)
## 📚 Documentation
For detailed usage instructions, API reference, and examples, refer to the SOAR Documentation.
## :floppy_disk: Program
The program is available at [SoarNNzwQHMwcfdkdLc6kvbkoMSxcHy89gTHrjhJYkk](https://solscan.io/account/SoarNNzwQHMwcfdkdLc6kvbkoMSxcHy89gTHrjhJYkk#anchorProgramIDL)
## 🤝 Contributing
Contributions to SOAR are welcome! To contribute, please follow the guidelines outlined in [CONTRIBUTING.md](https://github.com/magicblock-labs/Solana.Unity-SDK/blob/main/CONTRIBUTING.md).
## 📃 License
SOAR is licensed under the MIT License.
## 📧 Contact
For any inquiries or support requests, please email us at dev@magicblock.gg.
We appreciate your interest in SOAR! Let's unlock achievements and rise through the ranks together on the Solana blockchain! 🚀✨