Skip to content

Commit f12c29e

Browse files
authored
Create README.md
1 parent 4f38057 commit f12c29e

File tree

1 file changed

+111
-0
lines changed

1 file changed

+111
-0
lines changed

README.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# BTBBackendV1
2+
3+
4+
5+
## Overview
6+
7+
BTBBackendV1 is a sophisticated backend service designed for managing decentralized finance (DeFi) operations on the Raydium platform. This service provides automated liquidity management, including adding and removing liquidity, claiming rewards, rebalancing, and reinvesting funds. It empowers users to customize how their earned fees are managed, offering options to reinvest all or part of their fees back into liquidity pools or to claim their fees in any token of their choice.
8+
9+
## Features
10+
11+
- **🌊 Add Liquidity**: Seamlessly add liquidity to Raydium pools.
12+
- **🔄 Remove Liquidity**: Effortlessly remove liquidity from pools as needed.
13+
- **🏆 Claim Rewards**: Automatically claim rewards and update positions.
14+
- **⚖️ Rebalance Liquidity**: Automate the rebalancing of liquidity positions based on predefined conditions.
15+
- **💰 Reinvest Rewards**: Reinvest claimed rewards back into liquidity pools or convert them to preferred tokens.
16+
- **🎛️ Custom Fee Management**:
17+
- **Reinvest Fees**: Choose to reinvest all or a specific percentage of earned fees back into the pool.
18+
- **Claim Fees in Preferred Tokens**: Opt to claim fees in any preferred token, rather than the pool's native token.
19+
20+
## Getting Started
21+
22+
### Prerequisites
23+
24+
Before you begin, ensure you have the following installed:
25+
26+
- [Rust](https://www.rust-lang.org/tools/install)
27+
- [Node.js and npm](https://nodejs.org/en/download/)
28+
- [Anchor](https://project-serum.github.io/anchor/getting-started/installation.html)
29+
30+
### Installation
31+
32+
1. Clone the repository:
33+
```bash
34+
git clone https://github.com/btb-finance/BTBBackendV1.git
35+
cd BTBBackendV1
36+
```
37+
38+
2. Install dependencies:
39+
```bash
40+
anchor build
41+
```
42+
43+
### Quick Start
44+
45+
1. Deploy the program:
46+
```bash
47+
anchor deploy
48+
```
49+
50+
2. Run tests:
51+
```bash
52+
anchor test
53+
```
54+
55+
## Building and Deployment
56+
57+
### Building the Project
58+
59+
To build the project, run:
60+
61+
```bash
62+
anchor build
63+
```
64+
65+
### Deploying to Solana Devnet
66+
67+
To deploy the program to the Solana Devnet:
68+
69+
```bash
70+
anchor deploy
71+
```
72+
73+
### Deploying to Solana Mainnet
74+
75+
To deploy to the Solana Mainnet:
76+
77+
1. Set the Solana cluster to Mainnet:
78+
```bash
79+
solana config set --url https://api.mainnet-beta.solana.com
80+
```
81+
82+
2. Deploy the program:
83+
```bash
84+
anchor deploy
85+
```
86+
87+
## Testing
88+
89+
Run the included tests to ensure everything is working correctly:
90+
91+
```bash
92+
anchor test
93+
```
94+
95+
This will compile and run the tests located in the `tests/` directory.
96+
97+
## Contributing
98+
99+
We welcome contributions to BTBBackendV1! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
100+
101+
## License
102+
103+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
104+
105+
## Support
106+
107+
If you encounter any issues or have questions, please file an issue on our [GitHub issue tracker](https://github.com/btb-finance/BTBBackendV1/issues).
108+
109+
---
110+
111+
Made with ❤️ by the BTB Finance Team

0 commit comments

Comments
 (0)