https://github.com/stacks-sbtc/sbtc-bridge
https://github.com/stacks-sbtc/sbtc-bridge
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stacks-sbtc/sbtc-bridge
- Owner: stacks-network
- Created: 2024-06-22T14:13:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-18T02:54:07.000Z (7 months ago)
- Last Synced: 2024-11-18T03:34:52.796Z (7 months ago)
- Language: TypeScript
- Homepage: https://sbtc-bridge.vercel.app
- Size: 609 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sBTC Bridge
## Getting Started
Clone sBTC and run the dev env, this runs a devnet deployment of stacks and a regtest deployment of bitcoin and installs and runs sBTC against them
Must have [docker](https://docs.docker.com/get-started/get-docker/) installed
```
git clone https://github.com/stacks-sbtc/sbtc.git
cd sbtc
make devenv-up
```
Install dependencies and run the development server:
```bash
cp .env.sample .env
yarn && yarn dev
```
The development server will be running at [http://localhost:3000](http://localhost:3000)
## Feature flags
Some feature flags must be set at build time, so if you are building the image with docker and you want some specific feature flags you must pass them also when building to ensure they are in effect
Currently supported flags are:
- `reskin`: is for the bridge reskin that can be accessed at /reskin
These flags can be enabled in the .env file comma separated values style like so:
```bash
FEATURE_FLAGS=reskin,feature1,feature2
```
## Learn More
To learn more about sBTC please visit the [sBTC Bridge Documentation](https://docs.stacks.co/concepts/sbtc).
## Git commit ID for health endpoint
To push the Git Commit version during the building phase you have to build the image passing the $GIT_COMMIT value:
```bash
export GIT_COMMIT=$(git rev-parse HEAD)
docker build --build-arg GIT_COMMIT=$GIT_COMMIT
```
or passing through the docker compose file:
```yaml
sbtc-bridge:
restart: on-failure
build:
context: ./sbtc-bridge
dockerfile: Dockerfile
args:
GIT_COMMIT: ${GIT_COMMIT}
```