https://github.com/jongan69/coinlocker
A rust tokio API for automation of swaps from Bitcoin to Solana Tokens using lightning network, mongodb, kraken api, and Jupiter Swaps
https://github.com/jongan69/coinlocker
bticoin crypto hackathon-project solana
Last synced: about 1 year ago
JSON representation
A rust tokio API for automation of swaps from Bitcoin to Solana Tokens using lightning network, mongodb, kraken api, and Jupiter Swaps
- Host: GitHub
- URL: https://github.com/jongan69/coinlocker
- Owner: jongan69
- Created: 2024-07-02T17:07:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-24T06:54:21.000Z (about 1 year ago)
- Last Synced: 2025-01-24T07:28:02.624Z (about 1 year ago)
- Topics: bticoin, crypto, hackathon-project, solana
- Language: Rust
- Homepage: https://devpost.com/software/bitlocker
- Size: 235 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Coinlocker Bot & API
A Python Telegram Bot and Rust AXUM API that automates the transaction process from bitcoin to Solana SPL Tokens using Lightning Payments on Kraken API, Mongodb, Jupiter Swap API, and Solana Blockchain.
## Prerequisites
1. **Install Rust**: Follow the instructions at [rust-lang.org](https://www.rust-lang.org/tools/install) to install Rust on your machine.
2. **API Keys and Configuration**:
- Create a `.env` file in the root of your project directory.
- Add your Kraken API keys, MongoDB URI, and Solana private key for the wallet that is registered in Kraken for withdrawals to the `.env` file:
```env
KRAKEN_API_KEY=your_kraken_api_key
KRAKEN_API_SECRET=your_kraken_api_secret
MONGO_URL=your_mongodb_uri
PRIVATE_KEY=your_solana_private_key
```
## Local Development
3. **Build the Project**:
- Run the following command to build the project:
```sh
cargo build
```
4. **Run the Project**:
- Use the following command to run the project:
```sh
cargo run
```
## Docker Usage
### Prerequisites
- **Install Docker**: Follow the instructions at [docker.com](https://www.docker.com/products/docker-desktop) to install Docker on your machine.
- **Install Docker Compose**: Docker Desktop includes Docker Compose, so no additional installation is needed if you have Docker Desktop.
### Making Scripts Executable
Unfinished:
Use `chmod +x scripts/clean_build.sh scripts/debug.sh` to ensure both scripts are executable:
```sh
chmod +x scripts/clean_build.sh scripts/debug.sh
```
Run Clean Build
```sh
scripts/clean_build.sh
```
### Deploy Docker Image to Cloud:
1. Create droplet / VM with root password
2. Run `Cargo clean` to slim down copy process
// scp -r ./ root@167.99.127.45:./
3. In project directory `scp -r ./ root@your_droplet_ip:./` to copy project to the root of the VM
4. Use with: `chmod +x ./scripts/install-docker.sh` then `./scripts/install-docker.sh` and check with `docker-compose --version`
5. `docker-compose up --build` in VM/Droplet root directory or where ever project was copied to
# Useful to knows:
- `chmod +x ./scripts/install-docker.sh` to make it executable
- `cargo build` builds and `cargo run` runs the rust axum api locally
- Kraken has a minimum 0.0001 BTC trade minimum
- Private key for wallet verified as Kraken Withdrawl address is needed for anything in `lockin.rs` to work