https://github.com/threshold-network/tbtc-crosschain-relayer
tBTC Crosschain Relayer Bot
https://github.com/threshold-network/tbtc-crosschain-relayer
Last synced: 10 months ago
JSON representation
tBTC Crosschain Relayer Bot
- Host: GitHub
- URL: https://github.com/threshold-network/tbtc-crosschain-relayer
- Owner: threshold-network
- License: gpl-3.0
- Created: 2025-01-30T18:02:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-16T05:16:18.000Z (about 1 year ago)
- Last Synced: 2025-06-26T14:50:45.464Z (11 months ago)
- Language: TypeScript
- Size: 738 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Threshold Network | tBTC Cross-Chain Relayer
Based on [L2 tBTC SDK Relayer Implementation](https://thresholdnetwork.notion.site/L2-tBTC-SDK-Relayer-Implementation-4dfedabfcf594c7d8ef80609541cf791?pvs=4)
## Table of Contents
- [Project Overview](#project-overview)
- [Docker Setup](#docker-setup)
- [Libraries Used](#libraries-used)
- [Dependencies](#dependencies)
- [DevDependencies](#devdependencies)
- [How to Start the Project](#how-to-start-the-project)
- [Project Scripts](#project-scripts)
## Project Overview
This project is built with NodeJS and includes a variety of libraries to facilitate development. The project is configured to use Docker for easy setup and deployment.
## Docker Setup
To run the project using Docker, follow these steps:
1. Edit `docker-compose.dev.yml` with your customizations:
- PRIVATE_KEY: The wallet private key you will use in your application.
- L1_RPC: URL for the Layer 1 RPC (e.g., Ethereum)
- L2_RPC: URL for the Layer 2 RPC (e.g., Arbitrum, Base, Optimism)
2. Run the following command to start the project:
```bash
docker compose -f docker-compose.dev.yml up
```
## Libraries Used
### Dependencies
- **@ethersproject/experimental**: ^5.7.0
- **axios**: ^1.7.2
- **bitcoinjs-lib**: ^6.0.1
- **compression**: ^1.7.4
- **cors**: ^2.8.5
- **eth-crypto**: ^2.6.0
- **ethers**: ^5.7.2
- **express**: ^4.18.2
- **helmet**: ^6.1.4
- **node-cron**: ^3.0.3
- **rimraf**: ^6.0.1
### DevDependencies
- **@types/axios**: ^0.14.0
- **@types/compression**: ^1.7.5
- **@types/express**: ^4.17.21
- **@types/helmet**: ^6.0.1
- **@types/node**: ^20.1.4
- **@types/node-cron**: ^3.0.11
- **ts-node**: ^10.9.2
- **ts-node-dev**: ^2.0.0
- **typescript**: ^5.5.3
## How to Start the Project (Local)
### Development Mode
To start the application in development mode, run:
```bash
npm run dev
```
## Project Scripts
The following npm scripts are avaliable:
- `npm run dev`: Runs the application in development mode.
- `npm start`: Runs the application in production mode