Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 3.37 KB

readme.md

File metadata and controls

76 lines (51 loc) · 3.37 KB
Raw

SOAR

👑 Solana On-chain Achievements & Rankings 👑

Discord Chat License

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. 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.
  • For using SOAR from your solana program trough CPI, see the tens example.
  • Solana.Unity-SDK integration (Coming Soon)

📚 Documentation

For detailed usage instructions, API reference, and examples, refer to the SOAR Documentation.

💾 Program

The program is available at SoarNNzwQHMwcfdkdLc6kvbkoMSxcHy89gTHrjhJYkk

🤝 Contributing

Contributions to SOAR are welcome! To contribute, please follow the guidelines outlined in CONTRIBUTING.md.

📃 License

SOAR is licensed under the MIT License.

📧 Contact

For any inquiries or support requests, please email us at [email protected].

We appreciate your interest in SOAR! Let's unlock achievements and rise through the ranks together on the Solana blockchain! 🚀✨