https://github.com/alpenlabs/strata-bridge

PoC Implementation of the Strata Bridge
https://github.com/alpenlabs/strata-bridge

bitcoin bitvm2 bridge strata zk-snarks

Last synced: 10 months ago
JSON representation

PoC Implementation of the Strata Bridge

• Host: GitHub
• URL: https://github.com/alpenlabs/strata-bridge
• Owner: alpenlabs
• License: apache-2.0
• Created: 2024-10-27T07:29:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-31T12:07:20.000Z (over 1 year ago)
• Last Synced: 2024-12-31T13:18:41.891Z (over 1 year ago)
• Topics: bitcoin, bitvm2, bridge, strata, zk-snarks
• Language: Rust
• Homepage:
• Size: 4.26 MB
• Stars: 7
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

          
# Strata Bridge

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![License: Apache-2.0](https://img.shields.io/badge/License-Apache-blue.svg)](https://opensource.org/licenses/apache-2-0)

[![codecov](https://codecov.io/github/alpenlabs/strata-bridge/graph/badge.svg?token=UYZ5YPKGL2)](https://codecov.io/github/alpenlabs/strata-bridge)

[![build](https://github.com/alpenlabs/strata-bridge/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/alpenlabs/strata-bridge/actions)

[![lint](https://github.com/alpenlabs/strata-bridge/actions/workflows/lint.yml/badge.svg?event=push)](https://github.com/alpenlabs/strata-bridge/actions)

[![Release: v0.2.0](https://badgen.net/static/release/v0.2.0/yellow)](https://github.com/alpenlabs/strata-bridge/releases/tag/v0.2.0-rc3)

A reference implementation of Strata Bridge by your friends at [Alpen Labs](https://www.alpenlabs.io/).

> [!IMPORTANT]

> This software is a work-in-progress and as such, is _not_ meant to be used in a production environment!

## Transaction Graph

The following is the transaction graph that has been implemented in this repository:

    

    The transaction graph for this repository.

## How To Run Locally

### Prerequisites

-   [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html).

-   [SP1 Toolchain](https://docs.succinct.xyz/docs/sp1/getting-started/install) and associated [linkers](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/tag/v14.2.0-2).

    -   Install the SP1 toolchain: `curl -L https://sp1up.succinct.xyz | bash`

    -   After installation, run `sp1up` to complete the setup

-   Credentials to connect to SP1's [infra](https://explorer.succinct.xyz).

-   [Docker](https://docs.docker.com/get-docker/).

-   [`sqlx-cli`](https://lib.rs/crates/sqlx-cli) to run database migrations.

-   [`bitcoind`](https://bitcoin.org/en/download) to run the unit tests.

-   [`just`](https://just.systems/) to run the commands in this repository.

### Running

Run the Strata stack (`strata-client`, `strata-reth`, `bitcoind`) as per the instructions

in the [`alpen`](https://github.com/alpenlabs/alpen/tree/bitvm2) repository.

Then, see the instructions in [`docker/README.md`](./docker/README.md) to run the bridge nodes

and their corresponding secret-service nodes.

## Contributing

Contributions are generally welcome.

If you intend to make larger changes, please discuss them in an issue

before opening a PR to avoid duplicate work and architectural mismatches.

For more information please see [`CONTRIBUTING.md`](/CONTRIBUTING.md).

## License

This work is dual-licensed under MIT and Apache 2.0.

You can choose between one of them if you use this work.