{"id":20987409,"url":"https://github.com/stacks-sbtc/sbtc-bridge","last_synced_at":"2025-10-29T01:20:32.920Z","repository":{"id":256841197,"uuid":"818672316","full_name":"stacks-network/sbtc-bridge","owner":"stacks-network","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-18T02:54:07.000Z","size":624,"stargazers_count":2,"open_issues_count":10,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-18T03:34:52.796Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://sbtc-bridge.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stacks-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-22T14:13:35.000Z","updated_at":"2024-11-05T15:42:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"188a34ab-908f-4385-899b-41322ede3cca","html_url":"https://github.com/stacks-network/sbtc-bridge","commit_stats":null,"previous_names":["strata-labs/sbtc-bridge","stacks-network/sbtc-bridge"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fsbtc-bridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fsbtc-bridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fsbtc-bridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fsbtc-bridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stacks-network","download_url":"https://codeload.github.com/stacks-network/sbtc-bridge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225303944,"owners_count":17453037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T06:16:52.351Z","updated_at":"2025-10-29T01:20:32.894Z","avatar_url":"https://github.com/stacks-network.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sBTC Bridge\n\n## Getting Started\n\nClone 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\nMust have [docker](https://docs.docker.com/get-started/get-docker/) installed\n```\ngit clone https://github.com/stacks-sbtc/sbtc.git\ncd sbtc\nmake devenv-up\n```\n\nInstall dependencies and run the development server:\n\n```bash\ncp .env.sample .env\nyarn \u0026\u0026 yarn dev\n```\n\nThe development server will be running at [http://localhost:3000](http://localhost:3000)\n\n## Feature flags\n\nSome 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\n\nCurrently supported flags are:\n\n- `reskin`: is for the bridge reskin that can be accessed at /reskin\n\nThese flags can be enabled in the .env file comma separated values style like so:\n\n```bash\nFEATURE_FLAGS=reskin,feature1,feature2\n```\n\n## Learn More\n\nTo learn more about sBTC please visit the [sBTC Bridge Documentation](https://docs.stacks.co/concepts/sbtc).\n\n\n## Git commit ID for health endpoint\n\nTo push the Git Commit version during the building phase you have to build the image passing the $GIT_COMMIT value:\n\n```bash\nexport GIT_COMMIT=$(git rev-parse HEAD)\n\ndocker build --build-arg GIT_COMMIT=$GIT_COMMIT\n```\n\nor passing through the docker compose file:\n\n```yaml\nsbtc-bridge:\n    restart: on-failure\n    build:\n      context: ./sbtc-bridge\n      dockerfile: Dockerfile\n      args:\n        GIT_COMMIT: ${GIT_COMMIT}\n```\n\n## GitHub Actions CI/CD\n\nThis project includes GitHub Actions workflows for automated building and publishing to AWS ECR.\n\n### Build Workflow (`.github/workflows/docker-build.yml`)\n\nAutomatically builds and pushes Docker images to Amazon ECR on push to `environment/*`.\nCreate environments for each environment branch (e.g. `environment/private-mainnet`, `environment/mainnet`)\n\n**Required GitHub Secrets:**\n- `AWS_ROLE_ARN`: ARN of the AWS role for ECR access\n\n**Required GitHub Variables:**\n- `AWS_REGION`: AWS region (e.g., `eu-west-1`)\n- `AWS_ECR`: ECR repository name (e.g., `sbtc-bridge`)\n\n### Setup Instructions\n\n1. **Configure AWS IAM Role:**\n   - Create an IAM role with ECR\n   - Configure OIDC trust relationship for GitHub Actions\n   - Add the role ARN as `AWS_ROLE_ARN` secret\n\n2. **Set up GitHub Variables:**\n   - Go to repository Settings → Secrets and variables → Actions\n   - Add the required variables listed above\n\n### Image Tags\n\nThe build workflow creates the following image tags:\n- `sbtc-bridge-{branch}`: Branch-specific tag\n- `sbtc-bridge-{commit-sha}`: Commit-specific tag\n- `sbtc-bridge-latest`: Latest tag (only on main branch)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacks-sbtc%2Fsbtc-bridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstacks-sbtc%2Fsbtc-bridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacks-sbtc%2Fsbtc-bridge/lists"}